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.

2.0

Hierarchy (view full)

Implements

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

    2.0

  • set Binding(value): 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): 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): void
  • Parameters

    Returns void

  • get Expression(): string
  • Gets or sets the expression that defines how data is mapped to this axis.

    Returns string

    2.0

  • set Expression(value): 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): 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): void
  • Parameters

    • value: boolean

    Returns void

  • get IndividualScalingMode(): IndividualScalingMode
  • Gets or sets the scaling mode that defines what the individual scaling is based on.

    Returns IndividualScalingMode

    2.0

  • set IndividualScalingMode(value): void
  • Parameters

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

    2.0

  • set Range(value): 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): void
  • Parameters

    • value: boolean

    Returns void

  • get Scale(): Scale3D
  • Gets the scale properties.

    Returns Scale3D

    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): void
  • Parameters

    • value: boolean

    Returns void

  • get TitleFontMetadata(): FontMetadata
  • Gets or sets the title font.

    Returns FontMetadata

    2.0

  • set TitleFontMetadata(value): 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 TransformType(): AxisTransformType
  • Represents the axis transformation type.

    Returns AxisTransformType

    2.0

  • set TransformType(value): void
  • Parameters

    Returns void

  • get ZoomRange(): AxisRange
  • Get or sets the visible range of the axis.

    Returns AxisRange

    2.0

  • set ZoomRange(value): void
  • Parameters

    Returns void