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 Summary)

Spotfire.Object
- RowSelection

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ExcludedRowCount IncludedRowCount IsEmpty IsFull TotalRowCount AsIndexSet Combine

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): 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.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from Object.Equals

Default capability

constructor

new RowSelection(indexSet: IndexSet): RowSelection
Initializes a new instance of the Spotfire.Dxp.Data.RowSelection class.
Parameters
- indexSet: IndexSet
  An index set containing the row indexes that should be selected.
Returns RowSelection
Since
2.0

Overrides Object.constructor
new RowSelection(
    rowCount: number | Int32,
    includedRows: OrExplicit<
        System.Collections.Generic.IEnumerable<number | Int32>,
    >,
): RowSelection
Initializes a new instance of the Spotfire.Dxp.Data.RowSelection class.
Parameters
- rowCount: number | Int32
  The total number of rows in the table.
- includedRows: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  An enumerator of the included row indexes.
Returns RowSelection
Since
2.0

Overrides Object.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

AsIndexSet(): IndexSet
Gets the row selection as an Spotfire.Dxp.Data.IndexSet.

Returns IndexSet
The row selection as an Spotfire.Dxp.Data.IndexSet

Since
2.0

`Static`Combine

Combine(
    selection1: RowSelection,
    selection2: RowSelection,
    operation: DataSelectionOperation,
): RowSelection
Combine using the specified operation two row selections to create a new combined row selection.
Parameters
- selection1: RowSelection
  The first selection.
- selection2: RowSelection
  The second selection.
- operation: DataSelectionOperation
  The operation that should be used to combine the selections.
Returns RowSelection
The combined selection.

Since
2.0

Class RowSelection

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns RowSelection

Since

Parameters

Returns RowSelection

Since

ExcludedRowCount

Returns number

Since

IncludedRowCount

Returns number

Since

IsEmpty

Returns boolean

Since

IsFull

Returns boolean

Since

TotalRowCount

Returns number

Since

AsIndexSet

Returns IndexSet

Since

StaticCombine

Parameters

Returns RowSelection

Since

Settings

On This Page

`Static`Equals

`Static`Combine