Class DataFilteringSelection

This is a Spotfire.Dxp.Data.DataSelection representing a filtering in the Spotfire.Dxp.Data.DataTables as a subset of the rows.

Since

2.0

Hierarchy (view full)

Implements

Accessors

IsReadOnly

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Name Transactions GetRelationPropagationBehaviour GetSelection SetRelationPropagationBehavior

Accessors

IsReadOnly

  • get IsReadOnly(): boolean

  • Gets a value indicating whether the selection is read-only or not.

    Returns boolean

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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

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

GetRelationPropagationBehaviour

  • GetRelationPropagationBehaviour(toTable, fromTable): RelatedRowsPropagation

  • When two tables are related the filtering in one table may affect the other table. The setting of propagation of filtering between related tables can be retrieved from this method. Note that this is a property that is set in one direction only, filtering in one table may affect the filtering in another table while the filtering in that table may or may not affect the first table.

    Parameters

    • toTable: DataTable

      The table to propagate to.

    • fromTable: DataTable

      The table to propagate from.

    Returns RelatedRowsPropagation

    The relation propagation behavior.

    Since

    2.0

GetSelection

SetRelationPropagationBehavior

  • SetRelationPropagationBehavior(toTable, fromTable, relationPropagationBehavior): void

  • When two tables are related the filtering in one table may affect the other table. This propagation of filtering between related tables are modified by this method. Note that this is a property that is set in one direction only, filtering in one table may affect the filtering in another table while the filtering in that table may or may not affect the first table.

    Parameters

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability