Skip to main content
Version: Next

Interface: IPriceScaleApi

Interface to control chart's price scale

Methods

applyOptions

applyOptions(options): void

Applies new options to the price scale

Parameters

NameTypeDescription
optionsDeepPartial<PriceScaleOptions>Any subset of options.

Returns

void


options

options(): Readonly<PriceScaleOptions>

Returns currently applied options of the price scale

Returns

Readonly<PriceScaleOptions>

Full set of currently applied options, including defaults


width

width(): number

Returns a width of the price scale if it's visible or 0 if invisible.

Returns

number