Action
    Preparing search index...

    Axis controlling the rotation of markers in a Spotfire.Dxp.Application.Visuals.ScatterPlot or Spotfire.Dxp.Application.Visuals.Maps.MarkerLayerVisualization. The expression set on this axis is expected to return an angle in degrees. The direction of the rotation is controlled by the Spotfire.Dxp.Application.Visuals.MarkerRotationAxis.RotateClockwise property.

    2.0

    Hierarchy (View Summary)

    • Axis
      • MarkerRotationAxis

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

      Gets the axis mode.

      Returns AxisMode

      2.0

    • get Binding(): AxisBinding

      Gets or sets the axis binding.

      Returns AxisBinding

      Axis bindings are used to bind the expression on an axis to the currently marked value in a column.

      The default value of this property is null.

      2.0

    • set Binding(value: AxisBinding): void

      Parameters

      Returns void

    • get CategoryMode(): CategoryMode

      Gets or sets a value controlling how a categorical axis responds to filtering. This property only affects axes where the categories are laid out spatially.

      Returns CategoryMode

      2.0

    • set CategoryMode(value: CategoryMode): void

      Parameters

      Returns void

    • 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 IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Name(): string

      Gets the axis name.

      Returns string

      2.0

    • get RotateClockwise(): boolean

      Gets or sets a value indicating whether rotation is clockwise, or counter clockwise.

      Returns boolean

      2.0

    • set RotateClockwise(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get TitleFontMetadata(): FontMetadata

      Gets or sets the title font for this axis.

      Returns FontMetadata

      2.0

    • set TitleFontMetadata(value: FontMetadata): void

      Parameters

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0