Action
    Preparing search index...

    Class BulletGraphScaleAxis

    Represents a bullet graph scale axis.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    AxisMode Binding Categorical CategoryMode Context Continuous EvaluationMode Expression IncludeZeroInAutoZoom IndexedIncludeZeroInAutoZoom IndexedRange IndexedReversed IndexedTransformType IndividualScaling IndividualScalingMode IsAttached ManualZoom Name Range Reversed Scale ShowAxisSelector TitleFontMetadata Transactions TransformType ZoomRange ForEachNodeInSubTree

    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 Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get EvaluationMode(): AxisEvaluationMode

      Gets or sets a value controlling whether the axis expression should be evaluated on all data or on filtered data.

      Returns AxisEvaluationMode

      2.0

    • set EvaluationMode(value: AxisEvaluationMode): 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 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 IndexedIncludeZeroInAutoZoom(): IndexedBool

      Controls the IncludeZeroInAutoZoom for individual scales.

      Returns IndexedBool

      2.0

    • get IndexedReversed(): IndexedBool

      Reverses the axis for individual scales. The returned indexedBool can be used to set and get reverse for individual scales.

      Returns IndexedBool

      2.0

    • get IndexedTransformType(): IndexedAxisTransformType

      Represents the axis transformation type for individual scales. The returned indexedTransformType can be used to set and get the axisTransformType for individual scales.

      Returns IndexedAxisTransformType

      2.0

    • 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 Range(): AxisRange

      Gets or sets the overall range of this axis.

      Returns AxisRange

      For categorical data, the range is expressed as two indices. Either end can be null, indicating a default value.

      2.0

    • set Range(value: AxisRange): void

      Parameters

      Returns void

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

      Gets the scale.

      Returns Scale

      2.0

    • 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

    • get TitleFontMetadata(): FontMetadata

      Gets or sets the title font.

      Returns FontMetadata

      2.0

    • set TitleFontMetadata(value: FontMetadata): void

      Gets or sets the title font for this axis.

      Parameters

      Returns void

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get ZoomRange(): AxisRange

      Get or sets the visible range of the axis.

      Returns AxisRange

      For categorical data, the range is expressed as two indices. Either end can be null, indicating a default value.

      This property is ignored unless Spotfire.Dxp.Application.Visuals.ScaleAxisBase.ManualZoom is set to true.

      2.0

    • set ZoomRange(value: AxisRange): void

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability