Winter Cardinal UI - v0.457.0 / DChartCoordinateBase

Class: DChartCoordinateBase<CHART>

Type parameters

Name	Type
CHART	extends DBase = DBase

Hierarchy

• DChartCoordinateBase

  ↳ DChartCoordinateLinear

  ↳ DChartCoordinateLog

Implements

• DChartCoordinate<CHART>

Table of contents

Constructors

• constructor

Properties

• _container
• _direction
• _from
• _id
• _mark
• _theme
• _tick
• _to
• _transform
• _work

Accessors

• from
• id
• to
• transform

Methods

• bind
• blend
• doFit
• doFit_
• fit
• getPixelDomain
• getPixelRange
• getThemeDefault
• getType
• map
• mapAll
• mark
• newMark
• newRegion
• newTick
• newTransform
• ticks
• toFitDomain
• toFitRange
• toTheme
• unbind
• unmap
• unmapAll

Constructors

constructor

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

Type parameters

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

Parameters

Name	Type
options?	DChartCoordinateOptions

Returns

DChartCoordinateBase<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:46

Properties

_container

• Protected Optional _container: DChartCoordinateContainerSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:37

---

_direction

• Protected _direction: DChartCoordinateDirection

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:38

---

_from

• Protected Optional _from: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:43

---

_id

• Protected _id: number

Defined in

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

---

_mark

• Protected _mark: DChartCoordinateTransformMark

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:42

---

_theme

• Protected _theme: DThemeChartCoordinate

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:39

---

_tick

• Protected _tick: DChartCoordinateTick<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:41

---

_to

• Protected Optional _to: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:44

---

_transform

• Protected _transform: DChartCoordinateTransform<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:36

---

_work

• Protected _work: DChartRegionImpl

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:40

Accessors

from

• get from(): undefined | number

Returns

undefined | number

Implementation of

DChartCoordinate.from

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:74

• set from(from): void

Parameters

Name	Type
from	undefined | number

Returns

void

Implementation of

DChartCoordinate.from

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:78

---

id

• get id(): number

Monotonic increasing ID for change detection.

Returns

number

Implementation of

DChartCoordinate.id

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:237

---

to

• get to(): undefined | number

Returns

undefined | number

Implementation of

DChartCoordinate.to

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:82

• set to(to): void

Parameters

Name	Type
to	undefined | number

Returns

void

Implementation of

DChartCoordinate.to

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:86

---

transform

• get transform(): DChartCoordinateTransform<CHART>

Returns

DChartCoordinateTransform<CHART>

Implementation of

DChartCoordinate.transform

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:241

Methods

bind

▸ bind(container, direction): void

Parameters

Name	Type
container	DChartCoordinateContainerSub<CHART>
direction	DChartCoordinateDirection

Returns

void

Implementation of

DChartCoordinate.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:90

---

blend

▸ blend(ratio): void

Parameters

Name	Type
ratio	number

Returns

void

Implementation of

DChartCoordinate.blend

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:116

---

doFit

▸ doFit(from, to, result): void

Parameters

Name	Type
from	undefined | number
to	undefined | number
result	DChartCoordinateTransformMark | DChartCoordinateTransform<CHART>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:120

---

doFit_

▸ doFit_(pixelFrom, pixelTo, region, result): void

Parameters

Name	Type
pixelFrom	number
pixelTo	number
region	DChartRegion
result	DChartCoordinateTransformMark | DChartCoordinateTransform<CHART>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:208

---

fit

▸ fit(from?, to?): void

Adjusts the transform so that mapped points of the given range fit into the plot area if the plot area container’s localTransform is an identity matrix.

Parameters

Name	Type	Description
from?	number	a lower end of the range
to?	number	an upper end of the range

Returns

void

Implementation of

DChartCoordinate.fit

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:104

---

getPixelDomain

▸ getPixelDomain(plotArea, result): DChartRegion

Parameters

Name	Type
plotArea	DChartPlotArea<CHART> | DChartPlotAreaLike<CHART>
result	DChartRegion

Returns

DChartRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:152

---

getPixelRange

▸ getPixelRange(plotArea, result): DChartRegion

Parameters

Name	Type
plotArea	DChartPlotArea<CHART> | DChartPlotAreaLike<CHART>
result	DChartRegion

Returns

DChartRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:159

---

getThemeDefault

▸ getThemeDefault(): DThemeChartCoordinate

Returns

DThemeChartCoordinate

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:296

---

getType

▸ getType(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:300

---

map

▸ map(value): number

Transforms the given raw value to the untransformed value.

Parameters

Name	Type	Description
value	number	a raw value

Returns

number

Implementation of

DChartCoordinate.map

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:245

---

mapAll

▸ mapAll(values, ifrom, iend, stride, offset): void

Transforms the given raw values to untransformed values. Numbers whose indices are ifrom + i * stride + offset and less than iend will be transformed. Here, i is a non-negative integer.

Parameters

Name	Type	Description
values	number[]	raw values to be transformed
ifrom	number	an index on raw values at which to begin a transformation
iend	number	an index on raw values before which to end a transformation
stride	number	a stride of indices
offset	number	an offset of indices

Returns

void

Implementation of

DChartCoordinate.mapAll

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:249

---

mark

▸ mark(from?, to?): void

Parameters

Name	Type
from?	number
to?	number

Returns

void

Implementation of

DChartCoordinate.mark

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:108

---

newMark

▸ newMark(): DChartCoordinateTransformMark

Returns

DChartCoordinateTransformMark

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:70

---

newRegion

▸ newRegion(): DChartRegion

Returns

DChartRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:66

---

newTick

▸ newTick(options?): DChartCoordinateTick<CHART>

Parameters

Name	Type
options?	DChartCoordinateTickOptions

Returns

DChartCoordinateTick<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:64

---

newTransform

▸ newTransform(options?): DChartCoordinateTransform<CHART>

Parameters

Name	Type
options?	DChartCoordinateTransformOptions

Returns

DChartCoordinateTransform<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:58

---

ticks

▸ ticks(domainFrom, domainTo, domainVisibleFrom, domainVisibleTo, majorCount, majorCapacity, majorStep, minorCountPerMajor, minorCount, minorStep, majorResult, minorResult): void

Returns major / minor tick positions.

Parameters

Name	Type	Description
domainFrom	number	domain lower bound
domainTo	number	domain upper bound
domainVisibleFrom	number	visible domain lower bound
domainVisibleTo	number	visible domain upper bound
majorCount	number	Expected major tick count
majorCapacity	number	-
majorStep	undefined | number | DChartCoordinateTickMajorStepFunction	-
minorCountPerMajor	number	Expected minor tick count per major ticks
minorCount	number	Expected total minor tick count
minorStep	undefined | number | DChartCoordinateTickMinorStepFunction	-
majorResult	number[]	majorResult.length must be larger than majorCount * 3.
minorResult	number[]	minorResult.length must be larger than minorCount * 3.

Returns

void

Implementation of

DChartCoordinate.ticks

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:261

---

toFitDomain

▸ toFitDomain(from, to, plotArea, result): DChartRegion

Parameters

Name	Type
from	undefined | number
to	undefined | number
plotArea	DChartPlotArea<CHART> | DChartPlotAreaLike<CHART>
result	DChartRegion

Returns

DChartRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:166

---

toFitRange

▸ toFitRange(from, to, plotArea, result): DChartRegion

Parameters

Name	Type
from	undefined | number
to	undefined | number
plotArea	DChartPlotArea<CHART> | DChartPlotAreaLike<CHART>
result	DChartRegion

Returns

DChartRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:187

---

toTheme

▸ toTheme(options?): DThemeChartCoordinate

Parameters

Name	Type
options?	DChartCoordinateOptions

Returns

DThemeChartCoordinate

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:292

---

unbind

▸ unbind(): void

Returns

void

Implementation of

DChartCoordinate.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:99

---

unmap

▸ unmap(value): number

Transforms the given untransformed value to the raw value.

Parameters

Name	Type	Description
value	number	an untransformed value

Returns

number

Implementation of

DChartCoordinate.unmap

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:253

---

unmapAll

▸ unmapAll(values, ifrom, iend, stride, offset): void

Transforms the given untransformed values to raw values. Numbers whose indices are ifrom + i * stride + offset and less than iend will be transformed. Here, i is a non-negative integer.

Parameters

Name	Type	Description
values	number[]	untrasformed values to be transformed
ifrom	number	an index on raw values at which to begin a transformation
iend	number	an index on raw values at which to begin a transformation
stride	number	a stride of indices
offset	number	an offset of indices

Returns

void

Implementation of

DChartCoordinate.unmapAll

Defined in

src/main/typescript/wcardinal/ui/d-chart-coordinate-base.ts:257

Edit this page.