Interface PriceScaleState

interface PriceScaleState {
    autoScale: boolean;
    fixedRange?: null | { max: number; min: number };
    indicatorRange?: { instanceId: string; manual: boolean };
    inverted: boolean;
    marginBottom: number;
    marginTop: number;
    minMove: number;
    minPrecision?: number;
    mode: PriceScaleMode;
    placement?: PriceAxisPlacement;
    range?: { max: number; min: number };
    ratioLock?: { barSpacing: number; height: number };
}

Properties

autoScale fixedRange? indicatorRange? inverted marginBottom marginTop minMove minPrecision? mode placement? range? ratioLock?

Properties

autoScale

autoScale: boolean

False when the user (or an indicator's fixed range) pinned the scale.

OptionalfixedRange

fixedRange?: null | { max: number; min: number }

The declared auto-fit band, independent of a temporary manual range.

OptionalindicatorRange

indicatorRange?: { instanceId: string; manual: boolean }

Study default ownership; manual records a host view override without losing the default.

inverted

inverted: boolean

marginBottom

marginBottom: number

marginTop

marginTop: number

minMove

minMove: number

OptionalminPrecision

minPrecision?: number

Optional in older snapshots, which used the current scale's precision floor.

mode

mode: PriceScaleMode

Optionalplacement

placement?: PriceAxisPlacement

Independent axis side and order. Omission restores the scale identity's default placement.

Optionalrange

range?: { max: number; min: number }

The pinned range, present only when autoScale is false.

OptionalratioLock

ratioLock?: { barSpacing: number; height: number }

Geometry paired with the saved range, so reopening at another size preserves its proportion.

Settings

Member Visibility

On This Page

Properties