Interface PriceAxisState

What a host needs to render a menu over one price axis: which items are on, and which of them mean anything on this axis. See Chart.priceAxisState.

interface PriceAxisState {
    active: boolean;
    autoFit: boolean;
    inverted: boolean;
    lockRatio: boolean;
    mode: PriceScaleMode;
    movable: boolean;
    paneIndex: number;
    scaled: boolean;
    scaleId: PriceScaleId;
    side: "left" | "right";
}

Properties

active autoFit inverted lockRatio mode movable paneIndex scaled scaleId side

Properties

active

active: boolean

Some series on the pane maps to this scale.

autoFit

autoFit: boolean

Auto-fit: the range tracks the data rather than staying where it was put.

inverted

inverted: boolean

lockRatio

lockRatio: boolean

mode

mode: PriceScaleMode

movable

movable: boolean

Whether movePriceAxis would do anything: something to move, and a free side.

Deprecated

Removed in 3.0.0, with Chart.movePriceAxis, the only operation it describes. Placement through Chart.setPriceAxisPlacement (since 2.5.4) needs no such check.

paneIndex

paneIndex: number

scaled

scaled: boolean

False while the scale still sits on its 0..1 placeholder (nothing measured).

scaleId

scaleId: PriceScaleId

side

side: "left" | "right"

Current visible side; hidden scales report 'right'. Read priceAxisPlacement for hidden state.

Settings

Member Visibility

On This Page

Properties