Class IndexedScaleDock

Controls where an individual scale is displayed. An indexed property gives finer grained control of some settings of a visualization when Spotfire.Dxp.Application.Visuals.ScaleAxisBase.IndividualScaling is set to true. How to index an indexed property depends on the value of Spotfire.Dxp.Application.Visuals.ScaleAxisBase.IndividualScalingMode. If Spotfire.Dxp.Application.Visuals.ScaleAxisBase.IndividualScalingMode is set to Spotfire.Dxp.Application.Visuals.IndividualScalingMode.Color then indexed properties are indexed using values from the color axis. Some indexed properties cannot be indexed in this case and the root value should then be used. If Spotfire.Dxp.Application.Visuals.ScaleAxisBase.IndividualScalingMode is set to Spotfire.Dxp.Application.Visuals.IndividualScalingMode.Trellis then indexed properties are indexed using values from the applicable trellis axis. Some indexed properties cannot be indexed in this case and the root value should then be used. If Spotfire.Dxp.Application.Visuals.ScaleAxisBase.IndividualScalingMode is set to Spotfire.Dxp.Application.Visuals.IndividualScalingMode.Dual then most indexed properties are indexed using values from Spotfire.Dxp.Application.Visuals.ScaleDock. However, Spotfire.Dxp.Application.Visuals.Scale.IndexedDock is indexed using values from the color axis.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item RootValue Clear Contains

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

ReadonlyItem

Item: PropertyGet<TypedArray<System.Object>, ScaleDock> & PropertySet<TypedArray<System.Object>, ScaleDock> & PropertyGet<CategoryKey, ScaleDock> & PropertySet<CategoryKey, ScaleDock>

Gets or sets the value corresponding to the key.

Param: key

The key.

Returns

Value corresponding to the key.

Since

2.0

RootValue

  • get RootValue(): ScaleDock

  • Gets or sets the root value for the indexed property.

    Returns ScaleDock

    Since

    2.0

  • set RootValue(value): void

  • Parameters

    Returns void

Clear

  • Clear(): void

  • Clears all values except the root value.

    Returns void

    Since

    2.0

Contains

  • Contains(key): boolean

  • Check if the dictionary for the indexed property contains a key.

    Parameters

    Returns boolean

    true if the key is found in the dictionary, otherwise false.

    Since

    2.0

  • Contains(...keys): boolean

  • Check if the dictionary for the indexed property contains a key.

    Parameters

    • Rest...keys: any[]

      The key as an object array.

    Returns boolean

    true if the key is found in the dictionary, otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability