Winter Cardinal UI - v0.442.0 / DChartCoordinate

Interface: DChartCoordinate<CHART>

Type parameters

Name Type
CHART extends DBase = DBase

Implemented by

Table of contents

Properties

Methods

Properties

from

from: undefined | number

Defined in

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


id

Readonly id: number

Monotonic increasing ID for change detection.

Defined in

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


to

to: undefined | number

Defined in

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


transform

Readonly transform: DChartCoordinateTransform<CHART>

Defined in

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

Methods

bind

bind(container, direction): void

Parameters

Name Type
container DChartCoordinateContainerSub<CHART>
direction DChartCoordinateDirection

Returns

void

Defined in

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


blend

blend(ratio): void

Parameters

Name Type
ratio number

Returns

void

Defined in

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


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

Defined in

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


map

map(value): number

Transforms the given raw value to the untransformed value.

Parameters

Name Type Description
value number a raw value

Returns

number

Defined in

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


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

Defined in

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


mark

mark(from?, to?): void

Parameters

Name Type
from? number
to? number

Returns

void

Defined in

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


ticks

ticks(domainMin, domainMax, domainVisibleMin, domainVisibleMax, majorCount, majorCapacity, majorStep, minorCountPerMajor, minorCount, minorStep, majorResult, minorResult): void

Returns major / minor tick positions.

Parameters

Name Type Description
domainMin number domain lower bound
domainMax number domain upper bound
domainVisibleMin number visible domain lower bound
domainVisibleMax 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

Defined in

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


unbind

unbind(): void

Returns

void

Defined in

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


unmap

unmap(value): number

Transforms the given untransformed value to the raw value.

Parameters

Name Type Description
value number an untransformed value

Returns

number

Defined in

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


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

Defined in

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