charton

Appearance

charton API

charton API / @chart-on/core / index / AlertLine

Class: AlertLine ​

Defined in: packages/core/src/annotations/lines.ts:150

Handle returned by chart.annotations.addAlertLine.

Extends ​

Constructors ​

Constructor ​

new AlertLine(options, owner): AlertLine

Defined in: packages/core/src/annotations/lines.ts:46

Parameters ​

options ​

AlertLineOptions

owner ​

LineOwner

Returns ​

AlertLine

Inherited from ​

AnnotationLine<AlertLineOptions>.constructor

Properties ​

owner ​

protected readonly owner: LineOwner

Defined in: packages/core/src/annotations/lines.ts:48

Inherited from ​

AnnotationLine.owner

Accessors ​

options ​

Get Signature ​

get options(): Readonly<O>

Defined in: packages/core/src/annotations/lines.ts:54

Returns ​

Readonly<O>

Inherited from ​

AnnotationLine.options

visible ​

Get Signature ​

get visible(): boolean

Defined in: packages/core/src/annotations/lines.ts:58

Returns ​

boolean

Inherited from ​

AnnotationLine.visible

Methods ​

applyOptions() ​

applyOptions(patch): void

Defined in: packages/core/src/annotations/lines.ts:63

Merge new options and redraw. Throws on invalid options, leaving the current ones.

Parameters ​

patch ​

Partial<O>

Returns ​

void

Inherited from ​

AnnotationLine.applyOptions

check() ​

protected check(o): void

Defined in: packages/core/src/annotations/lines.ts:151

Parameters ​

o ​

AlertLineOptions

Returns ​

void

Overrides ​

AnnotationLine.check

optionsChanged() ​

protected optionsChanged(): void

Defined in: packages/core/src/annotations/lines.ts:88

Drop caches derived from the options.

Returns ​

void

Inherited from ​

AnnotationLine.optionsChanged

prepare() ​

protected prepare(o): void

Defined in: packages/core/src/annotations/lines.ts:157

Its primitive moves to the new series first, so a series not on the chart is rejected.

Parameters ​

o ​

AlertLineOptions

Returns ​

void

Overrides ​

AnnotationLine.prepare

remove() ​

remove(): void

Defined in: packages/core/src/annotations/lines.ts:78

Returns ​

void

Inherited from ​

AnnotationLine.remove

setVisible() ​

setVisible(visible): void

Defined in: packages/core/src/annotations/lines.ts:73

Hide or show it; its options are kept.

Parameters ​

visible ​

boolean

Returns ​

void

Inherited from ​

AnnotationLine.setVisible