Action
    Preparing search index...

    Class DataMarkingSelection

    This is a Spotfire.Dxp.Data.DataSelection representing a marking of rows in the Spotfire.Dxp.Data.DataTables.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Color Context IsAttached IsReadOnly Name Transactions GetSelection SetSelection

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

      Gets or sets the color that should be used when drawing this marking selection.

      Returns Color

      The color may not be empty.

      2.0

    • set Color(value: Color): void

      Parameters

      Returns void

    • 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

    • Set the marking selection for a given table.

      Parameters

      Returns void

      2.0

    • Set the marking selection for a given table.

      Parameters

      • rowMask: RowSelection

        The row selection to set.

      • dataTable: DataTable

        The table to set the selection on.

      • dataSelectionOperation: DataSelectionOperation

        The operation to use when combining this selection with previously set selections.

      Returns void

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability