Action
    Preparing search index...

    Class DataFilteringSelectionCollection

    This a collection of the Spotfire.Dxp.Data.DataFilteringSelections. This collection can be retrieved from the Spotfire.Dxp.Data.DataManager.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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

    Gets the filtering selection with the given name.

    The name of the filtering selection.

    The data filtering selection.

    2.0

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Count(): number

      Gets the number of filtering selections.

      Returns number

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • Check if a filtering selection exists for the given name.

      Parameters

      • name: string | String

        The name of the filtering selection.

      Returns boolean

      True if the filtering selection exists, false otherwise.

      2.0

    • Try to get a filtering selection.

      Parameters

      • name: string | String

        The name of the filtering selection.

      • dataSelection: OutParam<DataFilteringSelection>

        The filtering selection will be assigned to this parameter if it exists, null will be assigned otherwise.

      Returns boolean

      True if the filtering selection was retrieved, false otherwise.

      2.0