Winter Cardinal UI - v0.457.0 / DChartSelectionGridlineY

Class: DChartSelectionGridlineY<CHART>

Type parameters

Name	Type
CHART	extends DBase = DBase

Hierarchy

• DChartSelectionShapeBase<CHART>

  ↳ DChartSelectionGridlineY

Table of contents

Constructors

• constructor

Properties

• _isEnabled
• _newShape
• _options
• _shape
• _state
• _style
• _theme

Methods

• bind
• getTheme
• getType
• newShape
• set
• setStyle
• toTheme
• unbind
• unset
• update

Constructors

constructor

• new DChartSelectionGridlineY<CHART>(options?): DChartSelectionGridlineY<CHART>

Type parameters

Name	Type
CHART	extends DBase<DThemeBase, DBaseOptions<DThemeBase, any>> = DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Parameters

Name	Type
options?	DChartSelectionShapeOptions<CHART>

Returns

DChartSelectionGridlineY<CHART>

Inherited from

DChartSelectionShapeBase.constructor

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:35

Properties

_isEnabled

• Protected _isEnabled: boolean

Inherited from

DChartSelectionShapeBase._isEnabled

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:28

---

_newShape

• Protected Optional _newShape: (state: DBaseStateSet) => EShape

Type declaration

▸ (state): EShape

Parameters

Name	Type
state	DBaseStateSet

Returns

EShape

Inherited from

DChartSelectionShapeBase._newShape

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:30

---

_options

• Protected Optional _options: DChartSelectionShapeOptions<CHART>

Inherited from

DChartSelectionShapeBase._options

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:27

---

_shape

• Protected Optional _shape: EShape

Inherited from

DChartSelectionShapeBase._shape

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:29

---

_state

• Protected _state: DBaseStateSet

Inherited from

DChartSelectionShapeBase._state

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:32

---

_style

• Protected _style: DChartSelectionStyle<CHART>

Inherited from

DChartSelectionShapeBase._style

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:31

---

_theme

• Protected _theme: DThemeChartSelectionShape

Inherited from

DChartSelectionShapeBase._theme

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:33

Methods

bind

▸ bind(container): void

Parameters

Name	Type
container	DChartSeriesContainer<CHART>

Returns

void

Inherited from

DChartSelectionShapeBase.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:54

---

getTheme

▸ getTheme(type): DThemeChartSelectionShape

Parameters

Name	Type
type	string

Returns

DThemeChartSelectionShape

Inherited from

DChartSelectionShapeBase.getTheme

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:126

---

getType

▸ getType(): string

Returns

string

Overrides

DChartSelectionShapeBase.getType

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-gridline-y.ts:34

---

newShape

▸ newShape(state, theme): EShape

Parameters

Name	Type
state	DBaseStateSet
theme	DThemeChartSelectionShape

Returns

EShape

Inherited from

DChartSelectionShapeBase.newShape

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:79

---

set

▸ set(container, position, mappedPosition, series): void

Parameters

Name	Type
container	DChartSeriesContainer<CHART>
position	IPoint
mappedPosition	IPoint
series	null | DChartSeries<CHART>

Returns

void

Inherited from

DChartSelectionShapeBase.set

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:83

---

setStyle

▸ setStyle(this, shape, series): void

Parameters

Name	Type
this	unknown
shape	EShape
series	null | DChartSeries<CHART>

Returns

void

Inherited from

DChartSelectionShapeBase.setStyle

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:97

---

toTheme

▸ toTheme(options?): DThemeChartSelectionShape

Parameters

Name	Type
options?	DChartSelectionShapeOptions<CHART>

Returns

DThemeChartSelectionShape

Inherited from

DChartSelectionShapeBase.toTheme

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:115

---

unbind

▸ unbind(): void

Returns

void

Inherited from

DChartSelectionShapeBase.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:72

---

unset

▸ unset(): void

Returns

void

Inherited from

DChartSelectionShapeBase.unset

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-shape-base.ts:101

---

update

▸ update(container, position, mappedPosition, series): boolean

Parameters

Name	Type
container	DChartSeriesContainer<CHART>
position	IPoint
mappedPosition	IPoint
series	DChartSeries<CHART>

Returns

boolean

Overrides

DChartSelectionShapeBase.update

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-gridline-y.ts:15

Edit this page.