Action
    Preparing search index...

    This class represents either a visualization or a text area.

    The type is determined by the Spotfire.Dxp.Application.Visual.TypeId property, which typically is one of the Spotfire.Dxp.Application.Visuals.VisualTypeIdentifiers. By setting the TypeId property, the visual is converted to the new type. Since the user can convert any visual at any time via the user interface, the TypeId must always be determined before calling Spotfire.Dxp.Application.Visual.As to get the specific visualization (or text area) type. Although the visualization methods and properties are sometimes declared on abstract base classes such as Spotfire.Dxp.Application.Visuals.TablePlotBase and Spotfire.Dxp.Application.Visuals.TrellisVisualization, always use the concrete visualization classes, such as Spotfire.Dxp.Application.Visuals.BarChart, directly.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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 CustomNodes(): CustomNodes

      Gets the collection of custom nodes associated with this visual.

      Returns CustomNodes

      2.0

    • get Id(): Guid

      Gets the unique id for this instance.

      Returns Guid

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get ShowTitle(): boolean

      Gets or sets a flag indicating whether to show the title or not.

      Returns boolean

      2.0

    • set ShowTitle(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Title(): string

      Gets or sets the title.

      Returns string

      2.0

    • set Title(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • Applies user preferences to a newly created visual.

      Returns void

      2.0

    • Gets the visual as the specified type.

      Type Parameters

      • T

      Parameters

      Returns null | JsType<T>

      The visual; otherwise null.

      2.0

    • Configures a newly created visual with reasonable default values given the current data set.

      Returns void

      This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be called once. It implicity calls Spotfire.Dxp.Application.Visual.ApplyUserPreferences.

      2.0