Class ExpressionDetailItem

Represents a marker detail (tooltip) based on an expression.

Since

2.0

Hierarchy (view full)

Implements

Accessors

DisplayName

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Expression ImageSize IsAttached Transactions ValueRenderer Visible SetValueRenderer

Accessors

DisplayName

  • get DisplayName(): string

  • Gets the string value describing this item to be used in the user interface.

    Returns string

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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Expression

  • get Expression(): string

  • Gets or sets the expression string used to generate the output for this detail (tooltip) item.

    Returns string

    Since

    2.0

  • set Expression(value): void

  • Parameters

    • value: string

    Returns void

ImageSize

  • get ImageSize(): number

  • Gets or sets the image size of this detail item. The size is only used when the value renderer produces images. Allowed values are 1-1600 pixels.

    Returns number

    Since

    2.0

  • set ImageSize(value): void

  • Parameters

    • value: number

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

ValueRenderer

Visible

  • get Visible(): boolean

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

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

SetValueRenderer

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability