Action
    Preparing search index...

    Class DataFilteringSelection

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

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context IsAttached IsReadOnly Name Transactions ForEachNodeInSubTree GetRelationPropagationBehaviour GetSelection SetRelationPropagationBehavior TryGetSelectionExpression

    Methods

    • 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

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get IsReadOnly(): boolean

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

      Returns boolean

      2.0

    • get Name(): string

      Gets or sets the name of the selection.

      Returns string

      2.0

    • set Name(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • 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.

      2.0

    • 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

      If propagation of filtering in both directions between the two tables are needed then call this method twice with the toTable and fromTable switched.

      2.0

    • Tries to get the selection expression.

      Parameters

      Returns boolean

      True if the expression could be retrieved; false otherwise. The method will fail if the selection contains index sets.

      2.1

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability