Class: ChartModel

Constructors

constructor

• new ChartModel(invalidateHandler, options)

Parameters

Name	Type
invalidateHandler	InvalidateHandler
options	ChartOptions

Defined in

model/chart-model.ts:55

Properties

_actionIndex

• Private _actionIndex: number = null

Defined in

model/chart-model.ts:52

---

_crosshair

• Private Readonly _crosshair: Crosshair

Defined in

model/chart-model.ts:47

---

_crosshairMoved

• Private _crosshairMoved: Subscription<TimePointIndex, Point>

Defined in

model/chart-model.ts:53

---

_hoverSource

• Private _hoverSource: IDataSource = null

Defined in

model/chart-model.ts:51

---

_invalidateHandler

• Private Readonly _invalidateHandler: InvalidateHandler

Defined in

model/chart-model.ts:44

---

_options

• Private _options: ChartOptions

Defined in

model/chart-model.ts:43

---

_panes

• Private _panes: Pane[] = []

Defined in

model/chart-model.ts:45

---

_rendererOptionsProvider

• Private Readonly _rendererOptionsProvider: PriceAxisRendererOptionsProvider

Defined in

model/chart-model.ts:48

---

_selectSource

• Private _selectSource: IDataSource = null

Defined in

model/chart-model.ts:50

---

_timeAxis

• Private _timeAxis: TimeAxis

Defined in

model/chart-model.ts:46

---

_width

• Private _width: number = 0

Defined in

model/chart-model.ts:49

Methods

_invalidate

▸ Private _invalidate(mask): void

Parameters

Name	Type
mask	InvalidateMask

Returns

void

Defined in

model/chart-model.ts:467

---

_invalidationMaskForSource

▸ Private _invalidationMaskForSource(source, invalidateType?): InvalidateMask

Parameters

Name	Type
source	IPriceDataSource
invalidateType?	InvalidationLevel

Returns

InvalidateMask

Defined in

model/chart-model.ts:459

---

_paneInvalidationMask

▸ Private _paneInvalidationMask(pane, level): InvalidateMask

Parameters

Name	Type
pane	Pane
level	InvalidationLevel

Returns

InvalidateMask

Defined in

model/chart-model.ts:449

---

actionIndex

▸ actionIndex(): number

Returns

number

Defined in

model/chart-model.ts:121

---

addDataSource

▸ addDataSource(source, paneId, priceAxisId?): void

Parameters

Name	Type	Default value
source	IPriceDataSource	undefined
paneId	string	undefined
priceAxisId	string	DefaultPriceAxisId.Right

Returns

void

Defined in

model/chart-model.ts:259

---

addShape

▸ addShape(source): void

Parameters

Name	Type
source	Shape<keyof ShapeOptionsMap>

Returns

void

Defined in

model/chart-model.ts:290

---

backgroundColor

▸ backgroundColor(): string

Returns

string

Defined in

model/chart-model.ts:125

---

clearCurrentPosition

▸ clearCurrentPosition(): void

Returns

void

Defined in

model/chart-model.ts:199

---

createPane

▸ createPane(options, index?): Pane

Parameters

Name	Type
options	PaneOptions
index?	number

Returns

Pane

Defined in

model/chart-model.ts:216

---

crosshairMoved

▸ crosshairMoved(): ISubscription<TimePointIndex, Point>

Returns

ISubscription<TimePointIndex, Point>

Defined in

model/chart-model.ts:94

---

crosshairSource

▸ crosshairSource(): Crosshair

Returns

Crosshair

Defined in

model/chart-model.ts:134

---

cursorUpdate

▸ cursorUpdate(): void

Returns

void

Defined in

model/chart-model.ts:146

---

dataSources

▸ dataSources(): IPriceDataSource[]

Returns

IPriceDataSource[]

Defined in

model/chart-model.ts:153

---

destroy

▸ destroy(): void

Returns

void

Defined in

model/chart-model.ts:67

---

endScalePrice

▸ endScalePrice(pane, priceAxis): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis

Returns

void

Defined in

model/chart-model.ts:333

---

endScaleTime

▸ endScaleTime(): void

Returns

void

Defined in

model/chart-model.ts:420

---

endScrollPrice

▸ endScrollPrice(pane, priceAxis): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis

Returns

void

Defined in

model/chart-model.ts:353

---

endScrollTime

▸ endScrollTime(): void

Returns

void

Defined in

model/chart-model.ts:433

---

fitContent

▸ fitContent(): void

Returns

void

Defined in

model/chart-model.ts:387

---

fullUpdate

▸ fullUpdate(): void

Returns

void

Defined in

model/chart-model.ts:138

---

hoverSource

▸ hoverSource(): IDataSource

Returns

IDataSource

Defined in

model/chart-model.ts:110

---

lightUpdate

▸ lightUpdate(): void

Returns

void

Defined in

model/chart-model.ts:142

---

loadShape

▸ loadShape(shapeOptions): void

Parameters

Name	Type
shapeOptions	ShapeOptions<keyof ShapeOptionsMap>[]

Returns

void

Defined in

model/chart-model.ts:275

---

options

▸ options(): ChartOptions

Returns

ChartOptions

Defined in

model/chart-model.ts:75

---

paneById

▸ paneById(id): Pane

Parameters

Name	Type
id	string

Returns

Pane

Defined in

model/chart-model.ts:169

---

paneForSource

▸ paneForSource(source): Pane

Parameters

Name	Type
source	IPriceDataSource

Returns

Pane

Defined in

model/chart-model.ts:160

---

paneForSourceId

▸ paneForSourceId(id): Pane

Parameters

Name	Type
id	string

Returns

Pane

Defined in

model/chart-model.ts:164

---

panes

▸ panes(): Pane[]

Returns

Pane[]

Defined in

model/chart-model.ts:131

---

priceAxisRendererOptions

▸ priceAxisRendererOptions(): Readonly<PriceAxisElemRendererOptions>

Returns

Readonly<PriceAxisElemRendererOptions>

Defined in

model/chart-model.ts:445

---

recalculateAllPanes

▸ recalculateAllPanes(): void

Returns

void

Defined in

model/chart-model.ts:317

---

removeAllShapes

▸ removeAllShapes(): void

Returns

void

Defined in

model/chart-model.ts:311

---

removeDataSource

▸ removeDataSource(source, pane): void

Parameters

Name	Type
source	IPriceDataSource
pane	Pane

Returns

void

Defined in

model/chart-model.ts:270

---

removePane

▸ removePane(paneId): void

Parameters

Name	Type
paneId	string

Returns

void

Defined in

model/chart-model.ts:237

---

removeShapes

▸ removeShapes(sources): void

Parameters

Name	Type
sources	{ id: string ; location: string }[]

Returns

void

Defined in

model/chart-model.ts:299

---

rendererOptionsProvider

▸ rendererOptionsProvider(): PriceAxisRendererOptionsProvider

Returns

PriceAxisRendererOptionsProvider

Defined in

model/chart-model.ts:442

---

resetPriceAxis

▸ resetPriceAxis(pane, priceAxis): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis

Returns

void

Defined in

model/chart-model.ts:437

---

resetTimeAxis

▸ resetTimeAxis(): void

Returns

void

Defined in

model/chart-model.ts:382

---

scalePriceTo

▸ scalePriceTo(pane, priceAxis, x): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/chart-model.ts:326

---

scaleTimeTo

▸ scaleTimeTo(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/chart-model.ts:415

---

scrollChart

▸ scrollChart(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/chart-model.ts:410

---

scrollPriceTo

▸ scrollPriceTo(pane, priceAxis, x): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/chart-model.ts:344

---

scrollTimeTo

▸ scrollTimeTo(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/chart-model.ts:428

---

selectSource

▸ selectSource(): IDataSource

Returns

IDataSource

Defined in

model/chart-model.ts:97

---

setAndSaveCurrentPosition

▸ setAndSaveCurrentPosition(x, y, pane): void

Parameters

Name	Type
x	Coordinate
y	Coordinate
pane	Pane

Returns

void

Defined in

model/chart-model.ts:177

---

setBarSpacing

▸ setBarSpacing(spacing): void

Parameters

Name	Type
spacing	number

Returns

void

Defined in

model/chart-model.ts:371

---

setHoverSource

▸ setHoverSource(source, index): void

Parameters

Name	Type
source	IDataSource
index	number

Returns

void

Defined in

model/chart-model.ts:113

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	DeepPartial<ChartOptions>

Returns

void

Defined in

model/chart-model.ts:78

---

setPaneHeight

▸ setPaneHeight(pane, height): void

Parameters

Name	Type
pane	Pane
height	number

Returns

void

Defined in

model/chart-model.ts:247

---

setRightOffset

▸ setRightOffset(offset): void

Parameters

Name	Type
offset	number

Returns

void

Defined in

model/chart-model.ts:377

---

setSelectSource

▸ setSelectSource(source, index): void

Parameters

Name	Type
source	IDataSource
index	number

Returns

void

Defined in

model/chart-model.ts:100

---

setTimeScaleAnimation

▸ setTimeScaleAnimation(animation): void

Parameters

Name	Type
animation	ITimeScaleAnimation

Returns

void

Defined in

model/chart-model.ts:361

---

setWidth

▸ setWidth(width): void

Parameters

Name	Type
width	number

Returns

void

Defined in

model/chart-model.ts:252

---

startScalePrice

▸ startScalePrice(pane, priceAxis, x): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/chart-model.ts:322

---

startScaleTime

▸ startScaleTime(position): void

Parameters

Name	Type
position	Coordinate

Returns

void

Defined in

model/chart-model.ts:393

---

startScrollPrice

▸ startScrollPrice(pane, priceAxis, x): void

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/chart-model.ts:337

---

startScrollTime

▸ startScrollTime(x): void

Parameters

Name	Type
x	Coordinate

Returns

void

Defined in

model/chart-model.ts:424

---

stopTimeScaleAnimation

▸ stopTimeScaleAnimation(): void

Returns

void

Defined in

model/chart-model.ts:366

---

timeAxis

▸ timeAxis(): TimeAxis

Returns

TimeAxis

Defined in

model/chart-model.ts:128

---

updateCrosshair

▸ updateCrosshair(): void

Returns

void

Defined in

model/chart-model.ts:205

---

updateSource

▸ updateSource(source): void

Parameters

Name	Type
source	IPriceDataSource

Returns

void

Defined in

model/chart-model.ts:149

---

zoomTime

▸ zoomTime(pointX, scale): void

Parameters

Name	Type
pointX	Coordinate
scale	number

Returns

void

Defined in

model/chart-model.ts:396