Class RowSelection

This is a representation of a selection of rows in a table. It is currently created from an enumeration of row indexes or Spotfire.Dxp.Data.IndexSet but may be extended in the future to support symbolic marking.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ExcludedRowCount IncludedRowCount IsEmpty IsFull TotalRowCount AsIndexSet Combine

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

constructor

ExcludedRowCount

  • get ExcludedRowCount(): number

  • Gets the number of excluded rows.

    Returns number

    Since

    2.0

IncludedRowCount

  • get IncludedRowCount(): number

  • Gets the number of included rows.

    Returns number

    Since

    2.0

IsEmpty

  • get IsEmpty(): boolean

  • Gets a value indicating whether the row selection does not contain any rows or not.

    Returns boolean

    Since

    2.0

IsFull

  • get IsFull(): boolean

  • Gets a value indicating whether the row selection contains all rows or not.

    Returns boolean

    Since

    2.0

TotalRowCount

  • get TotalRowCount(): number

  • Gets the total number of rows in the table that this row selection refers to.

    Returns number

    Since

    2.0

AsIndexSet

StaticCombine

  • Combine(selection1, selection2, operation): RowSelection

  • Combine using the specified operation two row selections to create a new combined row selection.

    Parameters

    Returns RowSelection

    The combined selection.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability