Class: Crosshair

Hierarchy

• DataSource

  ↳ Crosshair

Constructors

constructor

• new Crosshair(model, options)

Parameters

Name	Type
model	ChartModel
options	CrosshairOptions

Overrides

DataSource.constructor

Defined in

model/crosshair.ts:70

Properties

_currentPosPriceProvider

• Private Readonly _currentPosPriceProvider: PriceAndCoordinateProvider

Defined in

model/crosshair.ts:60

---

_index

• Private _index: TimePointIndex

Defined in

model/crosshair.ts:54

---

_model

• Private Readonly _model: ChartModel

Defined in

model/crosshair.ts:56

---

_options

• Private Readonly _options: CrosshairOptions

Defined in

model/crosshair.ts:61

---

_originX

• Private _originX: Coordinate

Defined in

model/crosshair.ts:67

---

_originY

• Private _originY: Coordinate

Defined in

model/crosshair.ts:68

---

_pane

• Private _pane: Pane = null

Defined in

model/crosshair.ts:52

---

_paneElem

• Private Readonly _paneElem: CrosshairPaneElem

Defined in

model/crosshair.ts:62

---

_price

• Private _price: number = NaN

Defined in

model/crosshair.ts:53

---

_priceAxis

• Protected _priceAxis: PriceAxis = null

Inherited from

DataSource._priceAxis

Defined in

model/data-source.ts:10

---

_priceAxisElems

• Private _priceAxisElems: Map<PriceAxis, CrosshairPriceAxisElem>

Defined in

model/crosshair.ts:57

---

_subscribed

• Private _subscribed: boolean = false

Defined in

model/crosshair.ts:59

---

_timeAxisElem

• Private Readonly _timeAxisElem: CrosshairTimeAxisElem

Defined in

model/crosshair.ts:58

---

_visible

• Private _visible: boolean = true

Defined in

model/crosshair.ts:55

---

_x

• Private _x: Coordinate

Defined in

model/crosshair.ts:64

---

_y

• Private _y: Coordinate

Defined in

model/crosshair.ts:65

Methods

_createPriceAxisElemOnDemand

▸ Private _createPriceAxisElemOnDemand(map, priceAxis, valueProvider): IPriceAxisElem

Parameters

Name	Type
map	Map<PriceAxis, CrosshairPriceAxisElem>
priceAxis	PriceAxis
valueProvider	PriceAndCoordinateProvider

Returns

IPriceAxisElem

Defined in

model/crosshair.ts:268

---

_priceScaleByPane

▸ Private _priceScaleByPane(pane): PriceAxis

Parameters

Name	Type
pane	Pane

Returns

PriceAxis

Defined in

model/crosshair.ts:215

---

_tryToUpdateData

▸ Private _tryToUpdateData(newIndex, newPrice, newPane): boolean

Parameters

Name	Type
newIndex	TimePointIndex
newPrice	number
newPane	Pane

Returns

boolean

Defined in

model/crosshair.ts:229

---

_tryToUpdateElems

▸ Private _tryToUpdateElems(index, price, pane): void

Parameters

Name	Type
index	TimePointIndex
price	number
pane	Pane

Returns

void

Defined in

model/crosshair.ts:223

---

appliedIndex

▸ appliedIndex(): TimePointIndex

Returns

TimePointIndex

Defined in

model/crosshair.ts:147

---

appliedX

▸ appliedX(): Coordinate

Returns

Coordinate

Defined in

model/crosshair.ts:151

---

appliedY

▸ appliedY(): Coordinate

Returns

Coordinate

Defined in

model/crosshair.ts:155

---

clearOriginCoord

▸ clearOriginCoord(): void

Returns

void

Defined in

model/crosshair.ts:124

---

clearPosition

▸ clearPosition(): void

Returns

void

Defined in

model/crosshair.ts:163

---

horzLineVisible

▸ horzLineVisible(pane): boolean

Parameters

Name	Type
pane	Pane

Returns

boolean

Defined in

model/crosshair.ts:180

---

labelPaneElems

▸ labelPaneElems(pane?): readonly IPaneElem[]

Parameters

Name	Type
pane?	Pane

Returns

readonly IPaneElem[]

Inherited from

DataSource.labelPaneElems

Defined in

model/data-source.ts:30

---

options

▸ options(): Readonly<CrosshairOptions>

Returns

Readonly<CrosshairOptions>

Defined in

model/crosshair.ts:115

---

originCoordX

▸ originCoordX(): Coordinate

Returns

Coordinate

Defined in

model/crosshair.ts:129

---

originCoordY

▸ originCoordY(): Coordinate

Returns

Coordinate

Defined in

model/crosshair.ts:133

---

pane

▸ pane(): Pane

Returns

Pane

Defined in

model/crosshair.ts:205

---

paneElems

▸ paneElems(pane): readonly IPaneElem[]

Parameters

Name	Type
pane	Pane

Returns

readonly IPaneElem[]

Overrides

DataSource.paneElems

Defined in

model/crosshair.ts:176

---

priceAxis

▸ priceAxis(): PriceAxis

Returns

PriceAxis

Inherited from

DataSource.priceAxis

Defined in

model/data-source.ts:20

---

priceAxisElems

▸ priceAxisElems(pane, priceAxis): IPriceAxisElem[]

Parameters

Name	Type
pane	Pane
priceAxis	PriceAxis

Returns

IPriceAxisElem[]

Overrides

DataSource.priceAxisElems

Defined in

model/crosshair.ts:188

---

saveOriginCoord

▸ saveOriginCoord(x, y): void

Parameters

Name	Type
x	Coordinate
y	Coordinate

Returns

void

Defined in

model/crosshair.ts:119

---

setPosition

▸ setPosition(index, price, pane): void

Parameters

Name	Type
index	TimePointIndex
price	number
pane	Pane

Returns

void

Defined in

model/crosshair.ts:137

---

setPriceAxis

▸ setPriceAxis(priceAxis): void

Parameters

Name	Type
priceAxis	PriceAxis

Returns

void

Inherited from

DataSource.setPriceAxis

Defined in

model/data-source.ts:23

---

setZorder

▸ setZorder(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

DataSource.setZorder

Defined in

model/data-source.ts:16

---

timeAxisElems

▸ timeAxisElems(): readonly ITimeAxisElem[]

Returns

readonly ITimeAxisElem[]

Overrides

DataSource.timeAxisElems

Defined in

model/crosshair.ts:201

---

updateAllElems

▸ updateAllElems(): void

Returns

void

Overrides

DataSource.updateAllElems

Defined in

model/crosshair.ts:209

---

vertLineVisible

▸ vertLineVisible(): boolean

Returns

boolean

Defined in

model/crosshair.ts:184

---

visible

▸ visible(): boolean

Returns

boolean

Overrides

DataSource.visible

Defined in

model/crosshair.ts:159

---

zorder

▸ zorder(): number

Returns

number

Inherited from

DataSource.zorder

Defined in

model/data-source.ts:13