Action
    Preparing search index...

    Class DetailItemCollection

    A collection of parts that build up detail (tooltip) information.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    [iterator] Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Item Context Count IsAttached Transactions AddExpression IndexOf InsertExpression Move Remove

    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

    Item: PropertyGet<number | Int32, DetailItem>

    Gets the Spotfire.Dxp.Application.Visuals.DetailItem at the specified index.

    2.0

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Count(): number

      Gets the number of items in the collection.

      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

    • Determines the index of a specific item.

      Parameters

      Returns number

      The index of item if found in the collection; otherwise, -1.

      2.0

    • Moves the item at the specified index to a new location in the collection

      Parameters

      • oldIndex: number | Int32

        The zero-based index specifying the location of the item to be moved.

      • newIndex: number | Int32

        The zero-based index specifying the new location of the item.

      Returns void

      2.0

    • Removes the specified item from the collection.

      Parameters

      Returns boolean

      True if the item was succesfully removed. False if the item could not be removed or if it could not be found in the collection

      Only user defined items (Spotfire.Dxp.Application.Visuals.ExpressionDetailItem) can bed added and removed. The default items supplied by the owning plot cannot be removed, and hence return false.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability