Winter Cardinal UI - v0.457.0 / DChartAxisGuideSimple

Class: DChartAxisGuideSimple<CHART>

Type parameters

Name	Type
CHART	extends DBase = DBase

Implements

• DChartAxisGuide<CHART>

Table of contents

Constructors

• constructor

Properties

• _axis
• _container
• _fixed
• _index
• _isShown
• _options
• _position
• _shape
• WORK_POINT
• WORK_REGION

Accessors

• position
• shape

Methods

• bind
• destroy
• getPositionX
• getPositionY
• hide
• isHidden
• isShown
• newShape
• show
• unbind
• update

Constructors

constructor

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

Type parameters

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

Parameters

Name	Type
options?	DChartAxisGuideSimpleOptions

Returns

DChartAxisGuideSimple<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:34

Properties

_axis

• Protected Optional _axis: DChartAxis<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:25

---

_container

• Protected Optional _container: DChartAxisContainer<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:27

---

_fixed

• Protected _fixed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:31

---

_index

• Protected _index: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:28

---

_isShown

• Protected _isShown: boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:32

---

_options

• Protected Optional _options: DChartAxisGuideSimpleOptions

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:26

---

_position

• Protected _position: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:30

---

_shape

• Protected Optional _shape: DChartAxisGuideSimpleShape<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:29

---

WORK_POINT

▪ Static Protected Optional WORK_POINT: Point

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:22

---

WORK_REGION

▪ Static Protected Optional WORK_REGION: DChartRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:23

Accessors

position

• get position(): number

Returns

number

Implementation of

DChartAxisGuide.position

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:60

• set position(position): void

Parameters

Name	Type
position	number

Returns

void

Implementation of

DChartAxisGuide.position

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:64

---

shape

• get shape(): DChartAxisGuideSimpleShape<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Returns

DChartAxisGuideSimpleShape<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:47

Methods

bind

▸ bind(container, index, axis): void

Parameters

Name	Type
container	DChartAxisContainer<CHART>
index	number
axis	DChartAxis<CHART>

Returns

void

Implementation of

DChartAxisGuide.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:86

---

destroy

▸ destroy(): void

Returns

void

Implementation of

DChartAxisGuide.destroy

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:193

---

getPositionX

▸ getPositionX(axis, plotArea, plotAreaX): number

Parameters

Name	Type
axis	DChartAxis<CHART>
plotArea	DChartPlotArea<CHART> | DChartPlotAreaLike<CHART>
plotAreaX	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:149

---

getPositionY

▸ getPositionY(axis, plotArea, plotAreaY): number

Parameters

Name	Type
axis	DChartAxis<CHART>
plotArea	DChartPlotArea<CHART> | DChartPlotAreaLike<CHART>
plotAreaY	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:171

---

hide

▸ hide(): this

Returns

this

Implementation of

DChartAxisGuide.hide

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:77

---

isHidden

▸ isHidden(): boolean

Returns

boolean

Implementation of

DChartAxisGuide.isHidden

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:82

---

isShown

▸ isShown(): boolean

Returns

boolean

Implementation of

DChartAxisGuide.isShown

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:73

---

newShape

▸ newShape(): DChartAxisGuideSimpleShape<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Returns

DChartAxisGuideSimpleShape<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:56

---

show

▸ show(): this

Returns

this

Implementation of

DChartAxisGuide.show

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:68

---

unbind

▸ unbind(): void

Returns

void

Implementation of

DChartAxisGuide.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:93

---

update

▸ update(): boolean

Returns

boolean

Implementation of

DChartAxisGuide.update

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-guide-simple.ts:103

Edit this page.