Class Scale

A Scale.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Dock FarSpan FontMetadata Formatting IndexedDock IndexedLabelOrientation IndexedMaximumNumberOfTicks IndexedScaleLabelLayout IndexedShowGridlines IndexedShowLabels IsAttached LabelLayout LabelOrientation MaximumNumberOfTicks NearSpan ShowGridlines ShowLabels Span Transactions Visible

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

Context

Dock

  • get Dock(): ScaleDock

  • Controls where the scale is displayed.

    Returns ScaleDock

    Since

    2.0

  • set Dock(value): void

  • Parameters

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

  • Parameters

    • value: number

    Returns void

FontMetadata

  • get FontMetadata(): FontMetadata

  • Gets or sets the font.

    Returns FontMetadata

    Since

    2.0

  • set FontMetadata(value): void

  • Parameters

    Returns void

Formatting

  • get Formatting(): Formatting

  • Gets the formatting for this scale.

    Returns Formatting

    Since

    2.0

IndexedDock

IndexedLabelOrientation

IndexedMaximumNumberOfTicks

IndexedScaleLabelLayout

IndexedShowGridlines

  • get IndexedShowGridlines(): IndexedBool

  • Controls whether to render gridlines or not.

    Returns IndexedBool

    Since

    2.0

IndexedShowLabels

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

LabelLayout

LabelOrientation

  • get LabelOrientation(): LabelOrientation

  • Gets or sets the label orientation.

    Returns LabelOrientation

    Since

    2.0

  • set LabelOrientation(value): void

  • Parameters

    Returns void

MaximumNumberOfTicks

  • get MaximumNumberOfTicks(): number

  • Gets or sets the maximum number of ticks.

    Returns number

    Since

    2.0

  • set MaximumNumberOfTicks(value): void

  • Parameters

    • value: number

    Returns void

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

  • set ShowGridlines(value): void

  • Parameters

    • value: boolean

    Returns void

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

  • set ShowLabels(value): void

  • Parameters

    • value: boolean

    Returns void

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

  • set Span(value): void

  • Gets or sets the span of the area.

    Parameters

    • value: number

    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

Visible

  • get Visible(): boolean

  • Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.ScaleBase is visible.

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

Settings

Member Visibility

On This Page

Methods
Default capability