Action
    Preparing search index...

    Class VisualContent

    This class is an implementation detail and should never be used directly. Instead, always use the concrete visualization classes, such as Spotfire.Dxp.Application.Visuals.BarChart, directly.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context IsAttached Title Transactions TypeId Visual ApplyUserPreferences AutoConfigure

    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 Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Visual(): null | Visual

      Gets the visual instance, or null if this instance is not owned by a visual.

      Returns null | Visual

      2.0

    • Applies user preferences to a newly created visual.

      Returns void

      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 used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
      Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability