About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DataSelection

This is the base class for all selections. A selection is an object that defines a subset of rows as a Spotfire.Dxp.Data.RowSelection for all data tables in the document.

See the Spotfire.Dxp.Data.DataMarkingSelection and Spotfire.Dxp.Data.DataFilteringSelection for concrete classes.

Remark

It is not possible in inherit from this class.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DataSelection
  - DataFilteringSelection
  - DataMarkingSelection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached IsReadOnly Name Transactions ForEachNodeInSubTree GetSelection TryGetSelectionExpression

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 DocumentNode.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 DocumentNode.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DocumentNode.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 DocumentNode.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 DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

IsReadOnly

get IsReadOnly(): boolean
Gets a value indicating whether the selection is read-only or not.

Returns boolean
Since
2.0

Name

get Name(): string
Gets or sets the name of the selection.

Returns string
Since
2.0
set Name(value: string): void
Parameters
- value: string
Returns void

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetSelection

GetSelection(dataTable: DataTable): RowSelection
Get the row selection for this selection in the given Spotfire.Dxp.Data.DataTable.
Parameters
- dataTable: DataTable
  The Spotfire.Dxp.Data.DataTable to get the selection for.
Returns RowSelection
The row selection in the given dataTable.

Since
2.0

TryGetSelectionExpression

TryGetSelectionExpression(
dataTable: DataTable,
expression: OutParam<String>,
): boolean
Tries to get the selection expression.
Parameters
- dataTable: DataTable
  The table to get the selection from.
- expression: OutParam<String>
  The selection expression.
Returns boolean
True if the expression could be retrieved; false otherwise. The method will fail if the selection contains index sets.

Since
2.1