Class ScaleAxis

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

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

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

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

  • 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

  • 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

AxisMode

  • get AxisMode(): AxisMode

  • Gets the axis mode.

    Returns AxisMode

    Since

    2.0

Binding

  • get Binding(): AxisBinding

  • Gets or sets the axis binding.

    Returns AxisBinding

    Since

    2.0

  • set Binding(value): void

  • Parameters

    Returns void

Categorical

CategoryMode

  • 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

    Since

    2.0

  • set CategoryMode(value): void

  • Parameters

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Continuous

ErrorBars

EvaluationMode

  • 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

    Since

    2.0

  • set EvaluationMode(value): void

  • Parameters

    Returns void

Expression

  • get Expression(): string

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

    Returns string

    Since

    2.0

  • set Expression(value): void

  • Parameters

    • value: string

    Returns void

IncludeZeroInAutoZoom

  • get IncludeZeroInAutoZoom(): boolean

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

    Returns boolean

    Since

    2.0

  • set IncludeZeroInAutoZoom(value): void

  • Parameters

    • value: boolean

    Returns void

IndexedIncludeZeroInAutoZoom

  • get IndexedIncludeZeroInAutoZoom(): IndexedBool

  • Controls the IncludeZeroInAutoZoom for individual scales.

    Returns IndexedBool

    Since

    2.0

IndexedRange

IndexedReversed

  • 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

    Since

    2.0

IndexedTransformType

  • 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

    Since

    2.0

IndividualScaling

  • get IndividualScaling(): boolean

  • Enables individual scaling.

    Returns boolean

    Since

    2.0

  • set IndividualScaling(value): void

  • Parameters

    • value: boolean

    Returns void

IndividualScalingMode

  • get IndividualScalingMode(): IndividualScalingMode

  • Gets or sets the scaling mode that defines what the individual scaling is based on.

    Returns IndividualScalingMode

    Since

    2.0

  • set IndividualScalingMode(value): void

  • Parameters

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ManualZoom

  • 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

    Since

    2.0

  • set ManualZoom(value): void

  • Parameters

    • value: boolean

    Returns void

Name

  • get Name(): string

  • Gets the axis name.

    Returns string

    Since

    2.0

Range

  • get Range(): AxisRange

  • Gets or sets the overall range of this axis.

    Returns AxisRange

    Since

    2.0

  • set Range(value): void

  • Parameters

    Returns void

Reversed

  • get Reversed(): boolean

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

    Returns boolean

    Since

    2.0

  • set Reversed(value): void

  • Parameters

    • value: boolean

    Returns void

Scale

  • get Scale(): Scale

  • Gets the scale properties.

    Returns Scale

    Since

    2.0

ScaleLabels

ShowAxisSelector

  • get ShowAxisSelector(): boolean

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

    Returns boolean

    Since

    2.0

  • set ShowAxisSelector(value): void

  • Parameters

    • value: boolean

    Returns void

TitleFontMetadata

  • get TitleFontMetadata(): FontMetadata

  • Gets or sets the title font.

    Returns FontMetadata

    Since

    2.0

  • set TitleFontMetadata(value): void

  • Gets or sets the title font for this axis.

    Parameters

    Returns void

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

TransformType

  • get TransformType(): AxisTransformType

  • Represents the axis transformation type.

    Returns AxisTransformType

    Since

    2.0

  • set TransformType(value): void

  • Parameters

    Returns void

ZoomRange

  • get ZoomRange(): AxisRange

  • Get or sets the visible range of the axis.

    Returns AxisRange

    Since

    2.0

  • set ZoomRange(value): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Methods
Default capability