Action
    Preparing search index...

    Represents an X, Y or Z axis in a 3D Scatter Plot. It is used to map values to an axis, typically by applying a range. When mapping, the scale axis can transform the values.

    The visualization type defines the axis characteristics.

    The scale axis always has only one Spotfire.Dxp.Application.Visuals.ScaleAxis3D.Scale, which is used to control how the scale is drawn in the user interface.

    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 T1 | null

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

      Gets or sets the expression that defines how data is mapped to this axis.

      Returns string

      Expressions are either continuous or categorical. Categorical expressions are embraced by angle brackets: The expression X is continuous, whereas the expression <X> is categorical.

      In its simplest form an expression is simply a column name, such as Sales. In aggregated visualization this is often combined with an aggregation method, as in Sum(Sales).

      An axis may support categorical expressions, continuous expressions, or both. This depends on the axis in question. The Y axis of a scatter plot, for instance, can be either continuous or categorical, but the Y axis of a bar chart only supports continuous expressions.

      When building expressions programmatically, identifiers such as column names should be escaped. This is to ensure that special characters such as square brackets and spaces are treated correctly. This can be done using the Spotfire.Dxp.Data.Expressions.ExpressionUtilities class, or by using the Spotfire.Dxp.Data.DataColumn.NameEscapedForExpression property of Spotfire.Dxp.Data.DataColumn.

      2.0

    • set Expression(value: string): void

      Parameters

      • value: string

      Returns void

    • get IncludeZeroInAutoZoom(): boolean

      Controls if zero should be included on numeric range when auto zooming.

      Returns boolean

      2.0

    • set IncludeZeroInAutoZoom(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IndividualScaling(): boolean

      Enables individual scaling.

      Returns boolean

      2.0

    • set IndividualScaling(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get ManualZoom(): boolean

      Controls whether this axis automatically zooms to show the filtered data, or zooms manually using the Spotfire.Dxp.Application.Visuals.ScaleAxisBase.ZoomRange.

      Returns boolean

      2.0

    • set ManualZoom(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Name(): string

      Gets the axis name.

      Returns string

      2.0

    • get Reversed(): boolean

      Gets or sets the value indicating whether the axis is reversed.

      Returns boolean

      2.0

    • set Reversed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowAxisSelector(): boolean

      Gets or sets a value indicating whether an axis selector should be shown for this axis.

      Returns boolean

      2.0

    • set ShowAxisSelector(value: boolean): void

      Parameters

      • value: boolean

      Returns void