Class: Pane

Constructors

constructor

• new Pane(options, model)

Parameters

Name	Type
options	PaneOptions
model	ChartModel

Defined in

model/pane.ts:47

Properties

_cachedOrderedShapes

• Private _cachedOrderedShapes: readonly Shape<keyof ShapeOptionsMap>[] = null

Defined in

model/pane.ts:41

---

_cachedOrderedSources

• Private _cachedOrderedSources: readonly IPriceDataSource[] = null

Defined in

model/pane.ts:40

---

_dataSources

• Private _dataSources: IPriceDataSource[] = []

Defined in

model/pane.ts:36

---

_grid

• Private Readonly _grid: Grid

Defined in

model/pane.ts:31

---

_height

• Private _height: number = 0

Defined in

model/pane.ts:32

---

_id

• Private Readonly _id: string

Defined in

model/pane.ts:30

---

_leftPriceAxis

• Private _leftPriceAxis: PriceAxis

Defined in

model/pane.ts:43

---

_model

• Private Readonly _model: ChartModel

Defined in

model/pane.ts:29

---

_overlaySourcesByScaleId

• Private _overlaySourcesByScaleId: Map<string, IPriceDataSource[]>

Defined in

model/pane.ts:45

---

_rightPriceAxis

• Private _rightPriceAxis: PriceAxis

Defined in

model/pane.ts:44

---

_shapeColorKeysMap

• Private _shapeColorKeysMap: Map<string, Shape<keyof ShapeOptionsMap>>

Defined in

model/pane.ts:38

---

_shapesMap

• Private _shapesMap: Map<string, Shape<keyof ShapeOptionsMap>>

Defined in

model/pane.ts:37

---

_timeScale

• Private Readonly _timeScale: TimeAxis

Defined in

model/pane.ts:28

---

_weight

• Private _weight: number = DEFAULT_STRETCH_FACTOR

Defined in

model/pane.ts:34

---

_width

• Private _width: number = 0

Defined in

model/pane.ts:33

Methods

_createPriceAxis

▸ Private _createPriceAxis(id, options): PriceAxis

Parameters

Name	Type
id	string
options	PriceAxisOptions

Returns

PriceAxis

Defined in

model/pane.ts:462

---

_getShapesZOrderMinMax

▸ Private _getShapesZOrderMinMax(): MinMaxOrderInfo

Returns

MinMaxOrderInfo

Defined in

model/pane.ts:411

---

_getZOrderMinMax

▸ Private _getZOrderMinMax(): MinMaxOrderInfo

Returns

MinMaxOrderInfo

Defined in

model/pane.ts:386

---

_insertDataSource

▸ Private _insertDataSource(source, priceAxisId, zOrder): void

Parameters

Name	Type
source	IPriceDataSource
priceAxisId	string
zOrder	number

Returns

void

Defined in

model/pane.ts:437

---

_onPriceAxisModeChanged

▸ Private _onPriceAxisModeChanged(priceAxis, oldMode, newMode): void

Parameters

Name	Type
priceAxis	PriceAxis
oldMode	PriceAxisState
newMode	PriceAxisState

Returns

void

Defined in

model/pane.ts:473

---

_recalculatePriceAxisImpl

▸ Private _recalculatePriceAxisImpl(priceAxis): void

Parameters

Name	Type
priceAxis	PriceAxis

Returns

void

Defined in

model/pane.ts:423

---

addDataSource

▸ addDataSource(source, targetPriceAxisId, zOrder?): void

Parameters

Name	Type
source	IPriceDataSource
targetPriceAxisId	string
zOrder?	number

Returns

void

Defined in

model/pane.ts:167

---

addShape

▸ addShape(shape): void

Parameters

Name	Type
shape	Shape<keyof ShapeOptionsMap>

Returns

void

Defined in

model/pane.ts:219

---

dataSources

▸ dataSources(): readonly IPriceDataSource[]

Returns

readonly IPriceDataSource[]

Defined in

model/pane.ts:163

---

defaultPriceAxis

▸ defaultPriceAxis(): PriceAxis

Returns

PriceAxis

Defined in

model/pane.ts:308

---

destroy

▸ destroy(): void

Returns

void

Defined in

model/pane.ts:63

---

endScalePrice

▸ endScalePrice(priceAxis): void

Parameters

Name	Type
priceAxis	PriceAxis

Returns

void

Defined in

model/pane.ts:370

---

endScrollPrice

▸ endScrollPrice(priceAxis): void

Parameters

Name	Type
priceAxis	PriceAxis

Returns

void

Defined in

model/pane.ts:382

---

getShape

▸ getShape(id): Shape<keyof ShapeOptionsMap>

Parameters

Name	Type
id	string

Returns

Shape<keyof ShapeOptionsMap>

Defined in

model/pane.ts:264

---

getShapeByColorKey

▸ getShapeByColorKey(colorKey): Shape<keyof ShapeOptionsMap>

Parameters

Name	Type
colorKey	string

Returns

Shape<keyof ShapeOptionsMap>

Defined in

model/pane.ts:272

---

grid

▸ grid(): Grid

Returns

Grid

Defined in

model/pane.ts:99

---

height

▸ height(): number

Returns

number

Defined in

model/pane.ts:120

---

id

▸ id(): string

Returns

string

Defined in

model/pane.ts:92

---

isOverlay

▸ isOverlay(source): boolean

Parameters

Name	Type
source	IPriceDataSource

Returns

boolean

Defined in

model/pane.ts:147

---

leftPriceAxis

▸ leftPriceAxis(): PriceAxis

Returns

PriceAxis

Defined in

model/pane.ts:300

---

location

▸ location(): string

Returns

string

Defined in

model/pane.ts:211

---

model

▸ model(): ChartModel

Returns

ChartModel

Defined in

model/pane.ts:95

---

momentaryAutoScale

▸ momentaryAutoScale(): void

Returns

void

Defined in

model/pane.ts:341

---

options

▸ options(): PaneOptions

Returns

PaneOptions

Defined in

model/pane.ts:84

---

orderedShapes

▸ orderedShapes(): readonly Shape<keyof ShapeOptionsMap>[]

Returns

readonly Shape<keyof ShapeOptionsMap>[]

Defined in

model/pane.ts:257

---

orderedSources

▸ orderedSources(): readonly IPriceDataSource[]

Returns

readonly IPriceDataSource[]

Defined in

model/pane.ts:204

---

priceAxisById

▸ priceAxisById(id): PriceAxis

Parameters

Name	Type
id	string

Returns

PriceAxis

Defined in

model/pane.ts:102

---

priceScalePosition

▸ priceScalePosition(priceAxis): PriceAxisPosition

Parameters

Name	Type
priceAxis	PriceAxis

Returns

PriceAxisPosition

Defined in

model/pane.ts:290

---

recalculate

▸ recalculate(): void

Returns

void

Defined in

model/pane.ts:346

---

recalculatePriceAxis

▸ recalculatePriceAxis(priceAxis): void

Parameters

Name	Type
priceAxis	PriceAxis

Returns

void

Defined in

model/pane.ts:325

---

removeAllShapes

▸ removeAllShapes(): void

Returns

void

Defined in

model/pane.ts:250

---

removeDataSource

▸ removeDataSource(source): void

Parameters

Name	Type
source	IPriceDataSource

Returns

void

Defined in

model/pane.ts:172

---

removeShape

▸ removeShape(id): void

Parameters

Name	Type
id	string

Returns

void

Defined in

model/pane.ts:238

---

resetPriceAxis

▸ resetPriceAxis(priceAxis): void

Parameters

Name	Type
priceAxis	PriceAxis

Returns

void

Defined in

model/pane.ts:332

---

rightPriceAxis

▸ rightPriceAxis(): PriceAxis

Returns

PriceAxis

Defined in

model/pane.ts:304

---

scalePriceTo

▸ scalePriceTo(priceAxis, x): void

Parameters

Name	Type
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/pane.ts:364

---

scrollPriceTo

▸ scrollPriceTo(priceAxis, x): void

Parameters

Name	Type
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/pane.ts:377

---

setHeight

▸ setHeight(height): void

Parameters

Name	Type
height	number

Returns

void

Defined in

model/pane.ts:128

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	PaneOptions

Returns

void

Defined in

model/pane.ts:79

---

setWeight

▸ setWeight(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

model/pane.ts:159

---

setWidth

▸ setWidth(width): void

Parameters

Name	Type
width	number

Returns

void

Defined in

model/pane.ts:123

---

startScalePrice

▸ startScalePrice(priceAxis, x): void

Parameters

Name	Type
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/pane.ts:360

---

startScrollPrice

▸ startScrollPrice(priceAxis, x): void

Parameters

Name	Type
priceAxis	PriceAxis
x	number

Returns

void

Defined in

model/pane.ts:373

---

updateAllSources

▸ updateAllSources(): void

Returns

void

Defined in

model/pane.ts:281

---

weight

▸ weight(): number

Returns

number

Defined in

model/pane.ts:155

---

width

▸ width(): number

Returns

number

Defined in

model/pane.ts:116