About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Scale

A Scale.

Since

2.0

Hierarchy (View Summary)

ScaleBase
- Scale

Implements

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from ScaleBase.Cast

Equals

Equals(obj: any): 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.

Inherited from ScaleBase.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from ScaleBase.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from ScaleBase.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from ScaleBase.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from ScaleBase.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from ScaleBase.Context

Dock

get Dock(): ScaleDock
Controls where the scale is displayed.

Returns ScaleDock
Since
2.0
set Dock(value: ScaleDock): void
Parameters
- value: ScaleDock
Returns void

FarSpan

get FarSpan(): number
Controls the size of the right/top scale area, when using multiple scales by color or dual scales. If setting -1, then a default span is used.

Returns number
Since
2.0
set FarSpan(value: number): void
Parameters
- value: number
Returns void

FontMetadata

get FontMetadata(): FontMetadata
Gets or sets the font.

Returns FontMetadata
Since
2.0

Inherited from ScaleBase.FontMetadata
set FontMetadata(value: FontMetadata): void
Parameters
- value: FontMetadata
Returns void
Inherited from ScaleBase.FontMetadata

Formatting

get Formatting(): Formatting
Gets the formatting for this scale.

Returns Formatting
Since
2.0

Inherited from ScaleBase.Formatting

IndexedDock

get IndexedDock(): IndexedScaleDock
Controls where an individual scale is displayed.

Returns IndexedScaleDock
Since
2.0

IndexedLabelOrientation

get IndexedLabelOrientation(): IndexedLabelOrientation
Controls the label orientation.

Returns IndexedLabelOrientation
Since
2.0

Inherited from ScaleBase.IndexedLabelOrientation

IndexedMaximumNumberOfTicks

get IndexedMaximumNumberOfTicks(): IndexedInt
Controls maximum number of ticks for dual scales. Use a Spotfire.Dxp.Application.Visuals.ScaleDock value to specify which scale to access.

Returns IndexedInt
Since
2.0

Inherited from ScaleBase.IndexedMaximumNumberOfTicks

IndexedScaleLabelLayout

get IndexedScaleLabelLayout(): IndexedScaleLabelLayout
Controls the method used for generating ticks and labels.

Returns IndexedScaleLabelLayout
Since
2.0

IndexedShowGridlines

get IndexedShowGridlines(): IndexedBool
Controls whether to render gridlines or not.

Returns IndexedBool
Since
2.0

Inherited from ScaleBase.IndexedShowGridlines

IndexedShowLabels

get IndexedShowLabels(): IndexedBool
Controls whether this Spotfire.Dxp.Application.Visuals.ScaleBase renders the labels.

Returns IndexedBool
Since
2.0

Inherited from ScaleBase.IndexedShowLabels

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from ScaleBase.IsAttached

LabelLayout

get LabelLayout(): ScaleLabelLayout
Gets or sets the method used for generating ticks and labels.

Returns ScaleLabelLayout
Since
2.0
set LabelLayout(value: ScaleLabelLayout): void
Parameters
- value: ScaleLabelLayout
Returns void

LabelOrientation

get LabelOrientation(): LabelOrientation
Gets or sets the label orientation.

Returns LabelOrientation
Since
2.0

Inherited from ScaleBase.LabelOrientation
set LabelOrientation(value: LabelOrientation): void
Parameters
- value: LabelOrientation
Returns void
Inherited from ScaleBase.LabelOrientation

MaximumNumberOfTicks

get MaximumNumberOfTicks(): number
Gets or sets the maximum number of ticks.

Returns number
Since
2.0

Inherited from ScaleBase.MaximumNumberOfTicks
set MaximumNumberOfTicks(value: number): void
Parameters
- value: number
Returns void
Inherited from ScaleBase.MaximumNumberOfTicks

NearSpan

get NearSpan(): number
Controls the size of the left/bottom scale area, when using multiple scales by color or dual scales. If setting -1, then a default span is used.

Returns number
Since
2.0
set NearSpan(value: number): void
Parameters
- value: number
Returns void

ShowGridlines

get ShowGridlines(): boolean
Gets or sets a value indicating whether to render gridlines or not.

Returns boolean
Since
2.0

Inherited from ScaleBase.ShowGridlines
set ShowGridlines(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ScaleBase.ShowGridlines

ShowLabels

get ShowLabels(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.ScaleBase renders the labels.

Returns boolean
Since
2.0

Inherited from ScaleBase.ShowLabels
set ShowLabels(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ScaleBase.ShowLabels

Span

get Span(): number
Gets or sets the span of the area. If setting -1, then a default span is used.

Returns number
Since
2.0

Overrides ScaleBase.Span
set Span(value: number): void
Gets or sets the span of the area.
Parameters
- value: number
Returns void
Since
2.0

Overrides ScaleBase.Span

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from ScaleBase.Transactions

Visible

get Visible(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.ScaleBase is visible.

Returns boolean
Since
2.0

Inherited from ScaleBase.Visible
set Visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ScaleBase.Visible