Action
    Preparing search index...

    Class ExpressionDetailItem

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

    This class is creatable only via the AddExpression(expression) or the InsertExpression(index, expression) methods.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    DisplayName

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context Expression ImageSize IsAttached Transactions ValueRenderer Visible SetValueRenderer

    Accessors

    • get DisplayName(): string

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

      Returns string

    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 Expression(): string

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

      Returns string

      2.0

    • set Expression(value: string): void

      Parameters

      • value: string

      Returns void

    • 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

      2.0

    • set ImageSize(value: number): void

      Parameters

      • value: number

      Returns void

    • 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

    • get Visible(): boolean

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

      Returns boolean

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    Default capability