Class LegendLayerTitleItem

Represents a legend item containing the title of a layer visualization.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CanBeHorizontal Context IsAttached ShowSubItemsInHorizontalLegend ShowTitle Text Title Transactions Visible

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

  • 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

  • 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

CanBeHorizontal

  • get CanBeHorizontal(): boolean

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

    Returns boolean

    Since

    2.0

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ShowSubItemsInHorizontalLegend

  • 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

    Since

    2.0

  • set ShowSubItemsInHorizontalLegend(value): void

  • Parameters

    • value: boolean

    Returns void

ShowTitle

  • get ShowTitle(): boolean

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

    Returns boolean

    Since

    2.0

  • set ShowTitle(value): void

  • Parameters

    • value: boolean

    Returns void

Text

  • get Text(): string

  • Gets the text contained in this legend item.

    Returns string

    Since

    2.0

Title

  • get Title(): string

  • Gets the title.

    Returns string

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Visible

  • get Visible(): boolean

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

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

Settings

Member Visibility

On This Page

Methods
Default capability