Action
    Preparing search index...

    Class ScaleLabels

    Represents properties such as renderer which apply to scale labels.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Item Context IsAttached Transactions ClearLevelSettings ContainsLevelSettings ForEachNodeInSubTree RemoveLevelSettings SetLevelSettings

    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

    Item: PropertyGet<string | String, ScaleLabelsLevelSettings> & PropertySet<
        string
        | String,
        ScaleLabelsLevelSettings,
    >

    Gets the Spotfire.Dxp.Application.Visuals.ScaleLabelsLevelSettings corresponding to the indicated expression.

    The display name of an expression on the Spotfire.Dxp.Application.Visuals.ScaleAxis which owns this setting.

    The Spotfire.Dxp.Application.Visuals.ScaleLabelsLevelSettings corresponding to the indicated expression.

    2.0

    • 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

    • Clears all values except the default value.

      Returns void

      2.0

    • Checks if there are settings for the indicated expression.

      Parameters

      Returns boolean

      true if the the indicated expression exists; otherwise false.

      2.0

    • Sets the scale value renderer type for a hierarchy level on a categorical axis.

      Parameters

      • expressionDisplayName: string | String

        The display name of the expression to be rendered.

      • typeId: TypeIdentifier

        The type id for the renderer.

      Returns void

      This feature will only have effect on the following axes: Bar chart x axis, Line chart x axis, Combination Chart x axis, Scatter plot x and y axes and Heat map x and y axes, and Cross Table horizontal and vertical axes. For the Cross Table the size can not be set via this API. Instead use the setters for cell and header size avaiable on the Cross Table plot itself. For the case when the axis can be both continuous and categorical, the feature will only have effect when the axis is in categorical mode.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability