Class: PriceAxis

Constructors

constructor

• new PriceAxis(id, options, commonOptions, localizationOptions)

Parameters

Name	Type
id	string
options	PriceAxisOptions
commonOptions	CommonOptions
localizationOptions	LocalizationOptions

Defined in

model/price-axis.ts:126

Properties

_cachedOrderedSources

• Private _cachedOrderedSources: IPriceDataSource[] = null

Defined in

model/price-axis.ts:116

---

_commonOptions

• Private Readonly _commonOptions: CommonOptions

Defined in

model/price-axis.ts:98

---

_dataSources

• Private _dataSources: IPriceDataSource[] = []

Defined in

model/price-axis.ts:115

---

_formatter

• Private _formatter: IPriceFormatter = defaultPriceFormatter

Defined in

model/price-axis.ts:122

---

_height

• Private _height: number = 0

Defined in

model/price-axis.ts:102

---

_id

• Private Readonly _id: string

Defined in

model/price-axis.ts:97

---

_internalHeightCache

• Private _internalHeightCache: number = null

Defined in

model/price-axis.ts:103

---

_invalidatedForRange

• Private _invalidatedForRange: RangeCache

Defined in

model/price-axis.ts:107

---

_localizationOptions

• Private Readonly _localizationOptions: LocalizationOptions

Defined in

model/price-axis.ts:99

---

_logFormula

• Private _logFormula: LogFormula

Defined in

model/price-axis.ts:124

---

_marginAbove

• Private _marginAbove: number = 0

Defined in

model/price-axis.ts:108

---

_marginBelow

• Private _marginBelow: number = 0

Defined in

model/price-axis.ts:109

---

_markBuilder

• Private _markBuilder: PriceTickMarkBuilder

Defined in

model/price-axis.ts:111

---

_marksCache

• Private _marksCache: MarksCache = null

Defined in

model/price-axis.ts:118

---

_modeChanged

• Private _modeChanged: Subscription<PriceAxisState, PriceAxisState>

Defined in

model/price-axis.ts:113

---

_onMarksChanged

• Private _onMarksChanged: Subscription<void, void>

Defined in

model/price-axis.ts:112

---

_options

• Private Readonly _options: PriceAxisOptions

Defined in

model/price-axis.ts:100

---

_priceRange

• Private _priceRange: PriceRangeImpl = null

Defined in

model/price-axis.ts:105

---

_priceRangeSnapshot

• Private _priceRangeSnapshot: PriceRangeImpl = null

Defined in

model/price-axis.ts:106

---

_scaleStartPoint

• Private _scaleStartPoint: number = null

Defined in

model/price-axis.ts:120

---

_scrollStartPoint

• Private _scrollStartPoint: number = null

Defined in

model/price-axis.ts:121

Methods

_bottomMarginPx

▸ Private _bottomMarginPx(): number

Returns

number

Defined in

model/price-axis.ts:674

---

_coordinateToLogical

▸ Private _coordinateToLogical(coordinate, baseValue): number

Parameters

Name	Type
coordinate	number
baseValue	number

Returns

number

Defined in

model/price-axis.ts:694

---

_formatPrice

▸ Private _formatPrice(price, fallbackFormatter?): string

Parameters

Name	Type
price	BarPrice
fallbackFormatter?	IPriceFormatter

Returns

string

Defined in

model/price-axis.ts:713

---

_formatterSource

▸ Private _formatterSource(): IPriceDataSource

Returns

IPriceDataSource

Defined in

model/price-axis.ts:664

---

_invalidateInternalHeightCache

▸ Private _invalidateInternalHeightCache(): void

Returns

void

Defined in

model/price-axis.ts:654

---

_logicalToCoordinate

▸ Private _logicalToCoordinate(logical, baseValue): Coordinate

Parameters

Name	Type
logical	number
baseValue	number

Returns

Coordinate

Defined in

model/price-axis.ts:680

---

_makeSureItIsValid

▸ Private _makeSureItIsValid(): void

Returns

void

Defined in

model/price-axis.ts:658

---

_onIsInvertedChanged

▸ Private _onIsInvertedChanged(): void

Returns

void

Defined in

model/price-axis.ts:708

---

_recalculatePriceRangeImpl

▸ Private _recalculatePriceRangeImpl(): void

Returns

void

Defined in

model/price-axis.ts:725

---

_topMarginPx

▸ Private _topMarginPx(): number

Returns

number

Defined in

model/price-axis.ts:668

---

addDataSource

▸ addDataSource(source): void

Parameters

Name	Type
source	IPriceDataSource

Returns

void

Defined in

model/price-axis.ts:421

---

coordinateToPrice

▸ coordinateToPrice(coordinate, baseValue): BarPrice

Parameters

Name	Type
coordinate	Coordinate
baseValue	number

Returns

BarPrice

Defined in

model/price-axis.ts:383

---

dataSources

▸ dataSources(): readonly IPriceDataSource[]

Returns

readonly IPriceDataSource[]

Defined in

model/price-axis.ts:397

---

destroy

▸ destroy(): void

Returns

void

Defined in

model/price-axis.ts:145

---

endScale

▸ endScale(): void

Returns

void

Defined in

model/price-axis.ts:582

---

endScroll

▸ endScroll(): void

Returns

void

Defined in

model/price-axis.ts:632

---

firstValue

▸ firstValue(): number

Returns

number

Defined in

model/price-axis.ts:326

---

fontSize

▸ fontSize(): number

Returns

number

Defined in

model/price-axis.ts:270

---

formatLogical

▸ formatLogical(logical): string

Parameters

Name	Type
logical	number

Returns

string

Defined in

model/price-axis.ts:516

---

formatPrice

▸ formatPrice(price, firstValue): string

Parameters

Name	Type
price	number
firstValue	number

Returns

string

Defined in

model/price-axis.ts:505

---

formatPriceAbsolute

▸ formatPriceAbsolute(price): string

Parameters

Name	Type
price	number

Returns

string

Defined in

model/price-axis.ts:526

---

formatPricePercentage

▸ formatPricePercentage(price, baseValue): string

Parameters

Name	Type
price	number
baseValue	number

Returns

string

Defined in

model/price-axis.ts:530

---

formatter

▸ formatter(): IPriceFormatter

Returns

IPriceFormatter

Defined in

model/price-axis.ts:489

---

height

▸ height(): number

Returns

number

Defined in

model/price-axis.ts:274

---

id

▸ id(): string

Returns

string

Defined in

model/price-axis.ts:150

---

internalHeight

▸ internalHeight(): number

Returns

number

Defined in

model/price-axis.ts:288

---

invalidateSourcesCache

▸ invalidateSourcesCache(): void

Returns

void

Defined in

model/price-axis.ts:451

---

invertedCoordinate

▸ invertedCoordinate(coordinate): number

Parameters

Name	Type
coordinate	number

Returns

number

Defined in

model/price-axis.ts:369

---

isAutoScale

▸ isAutoScale(): boolean

Returns

boolean

Defined in

model/price-axis.ts:189

---

isEmpty

▸ isEmpty(): boolean

Returns

boolean

Defined in

model/price-axis.ts:321

---

isIndexedTo100

▸ isIndexedTo100(): boolean

Returns

boolean

Defined in

model/price-axis.ts:199

---

isInverted

▸ isInverted(): boolean

Returns

boolean

Defined in

model/price-axis.ts:344

---

isLog

▸ isLog(): boolean

Returns

boolean

Defined in

model/price-axis.ts:192

---

isPercentage

▸ isPercentage(): boolean

Returns

boolean

Defined in

model/price-axis.ts:195

---

logicalToPrice

▸ logicalToPrice(logical, baseValue): BarPrice

Parameters

Name	Type
logical	number
baseValue	number

Returns

BarPrice

Defined in

model/price-axis.ts:388

---

marks

▸ marks(): PriceMark[]

Returns

PriceMark[]

Defined in

model/price-axis.ts:347

---

mode

▸ mode(): PriceAxisState

Returns

PriceAxisState

Defined in

model/price-axis.ts:203

---

modeChanged

▸ modeChanged(): ISubscription<PriceAxisState, PriceAxisState>

Returns

ISubscription<PriceAxisState, PriceAxisState>

Defined in

model/price-axis.ts:266

---

onMarksChanged

▸ onMarksChanged(): ISubscription<void, void>

Returns

ISubscription<void, void>

Defined in

model/price-axis.ts:298

---

options

▸ options(): PriceAxisOptions

Returns

PriceAxisOptions

Defined in

model/price-axis.ts:153

---

orderedSources

▸ orderedSources(): readonly IPriceDataSource[]

Returns

readonly IPriceDataSource[]

Defined in

model/price-axis.ts:401

---

precision

▸ precision(): number

Returns

number

Defined in

model/price-axis.ts:497

---

priceRange

▸ priceRange(): PriceRangeImpl

Returns

PriceRangeImpl

Defined in

model/price-axis.ts:302

---

priceToCoordinate

▸ priceToCoordinate(price, baseValue): Coordinate

Parameters

Name	Type
price	number
baseValue	number

Returns

Coordinate

Defined in

model/price-axis.ts:373

---

recalculatePriceRange

▸ recalculatePriceRange(visibleBars): void

Parameters

Name	Type
visibleBars	RangeImpl<TimePointIndex>

Returns

void

Defined in

model/price-axis.ts:644

---

removeDataSource

▸ removeDataSource(source): void

Parameters

Name	Type
source	IPriceDataSource

Returns

void

Defined in

model/price-axis.ts:431

---

scaleTo

▸ scaleTo(x): void

Parameters

Name	Type
x	number

Returns

void

Defined in

model/price-axis.ts:553

---

scrollTo

▸ scrollTo(x): void

Parameters

Name	Type
x	number

Returns

void

Defined in

model/price-axis.ts:608

---

setHeight

▸ setHeight(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

model/price-axis.ts:278

---

setMode

▸ setMode(newMode): void

Parameters

Name	Type
newMode	Partial<PriceAxisState>

Returns

void

Defined in

model/price-axis.ts:212

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	DeepPartial<PriceAxisOptions>

Returns

void

Defined in

model/price-axis.ts:157

---

setPriceRange

▸ setPriceRange(newPriceRange, isForceSetValue?): void

Parameters

Name	Type
newPriceRange	PriceRangeImpl
isForceSetValue?	boolean

Returns

void

Defined in

model/price-axis.ts:307

---

sourcesForAutoScale

▸ sourcesForAutoScale(): readonly IPriceDataSource[]

Returns

readonly IPriceDataSource[]

Defined in

model/price-axis.ts:486

---

startScale

▸ startScale(x): void

Parameters

Name	Type
x	number

Returns

void

Defined in

model/price-axis.ts:535

---

startScroll

▸ startScroll(x): void

Parameters

Name	Type
x	number

Returns

void

Defined in

model/price-axis.ts:591

---

updateAllElems

▸ updateAllElems(): void

Returns

void

Defined in

model/price-axis.ts:650

---

updateFormatter

▸ updateFormatter(): void

Returns

void

Defined in

model/price-axis.ts:454

---

visible

▸ visible(): boolean

Returns

boolean

Defined in

model/price-axis.ts:185