Action
    Preparing search index...

    Class LegendItem

    Base class for legend items contained in a Spotfire.Dxp.Application.Visuals.Legend.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    CanBeHorizontal Context IsAttached ShowSubItemsInHorizontalLegend ShowTitle Title Transactions Visible ForEachNodeInSubTree

    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 CanBeHorizontal(): boolean

      Gets a value indicating whether this item can be placed in the horizontal legend.

      Returns boolean

      2.0

    • 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 ShowSubItemsInHorizontalLegend(): boolean

      Gets or sets a value whether the sub items will be displayed in the horizontal legend or in the vertical legend. Only sub items that return true for CanBeHorizontal will show up in the horizontal legend.

      Returns boolean

      2.0

    • set ShowSubItemsInHorizontalLegend(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowTitle(): boolean

      Gets or sets a value indicating whether the title of this Spotfire.Dxp.Application.Visuals.LegendItem is shown.

      Returns boolean

      2.0

    • set ShowTitle(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Title(): string

      Gets the title of this legend item.

      Returns string

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Visible(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.LegendItem is visible.

      Returns boolean

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability