Action
    Preparing search index...

    Class Legend

    Representation of a plot legend. The legend is a key to the features (that is, symbols or pictures) used in the plot.

    Each legend contains a series of Legend Items, each of which describes a feature.

    A Legend can be turned on/off by setting the Spotfire.Dxp.Application.Visuals.Legend.Visible property. A Legend that is turned off can be shown as a popover when requested.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context Dock FontMetadata IsAttached Items MaxValuesPerLegendItem Transactions Visible Width

    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 MaxValuesPerLegendItem(): number

      Gets or sets the max values per legend item. This value controls how many legend items are shown before the list is truncated.

      Returns number

      2.0

    • set MaxValuesPerLegendItem(value: number): void

      Parameters

      • value: number

      Returns void

    • 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 or not this Spotfire.Dxp.Application.Visuals.Legend is visible.

      Returns boolean

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Width(): number

      Gets or sets the width, in pixels, of the legend as it is displayed in the user interface.

      Returns number

      2.0

    • set Width(value: number): void

      Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability