Winter Cardinal UI - v0.442.0 / DChartCoordinateLinear

Class: DChartCoordinateLinear<CHART>

Type parameters

Name	Type
`CHART`	extends `DBase` = `DBase`

Hierarchy

DChartCoordinateBase<CHART>

↳ DChartCoordinateLinear

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Type parameters

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

Parameters

Name	Type
`options?`	`DChartCoordinateOptions`

Properties

_container

• Protected Optional _container: DChartCoordinateContainerSub<CHART>

Inherited from

DChartCoordinateBase._container

Defined in

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

_direction

• Protected _direction: DChartCoordinateDirection

Inherited from

DChartCoordinateBase._direction

Defined in

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

_from

• Protected Optional _from: number

Inherited from

DChartCoordinateBase._from

Defined in

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

_id

• Protected _id: number

Inherited from

DChartCoordinateBase._id

Defined in

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

_mark

• Protected _mark: DChartCoordinateTransformMark

Inherited from

DChartCoordinateBase._mark

Defined in

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

_theme

• Protected _theme: DThemeChartCoordinate

Inherited from

DChartCoordinateBase._theme

Defined in

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

_tick

• Protected _tick: DChartCoordinateTick<CHART>

Inherited from

DChartCoordinateBase._tick

Defined in

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

_to

• Protected Optional _to: number

Inherited from

DChartCoordinateBase._to

Defined in

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

_transform

• Protected _transform: DChartCoordinateTransform<CHART>

Inherited from

DChartCoordinateBase._transform

Defined in

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

_work

• Protected _work: DChartRegionImpl

Inherited from

DChartCoordinateBase._work

Defined in

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

Accessors

from

• get from(): undefined | number

Returns

undefined | number

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.id

Defined in

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

to

• get to(): undefined | number

Returns

undefined | number

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.to

Defined in

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

transform

• get transform(): DChartCoordinateTransform<CHART>

Returns

DChartCoordinateTransform<CHART>

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.doFit

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

Inherited from

DChartCoordinateBase.doFit_

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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.getPixelDomain

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

Inherited from

DChartCoordinateBase.getPixelRange

Defined in

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

getThemeDefault

▸ getThemeDefault(): DThemeChartCoordinate

Returns

DThemeChartCoordinate

Inherited from

DChartCoordinateBase.getThemeDefault

Defined in

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

getType

▸ getType(): string

Returns

string

Inherited from

DChartCoordinateBase.getType

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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.mark

Defined in

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

newMark

▸ newMark(): DChartCoordinateTransformMark

Returns

DChartCoordinateTransformMark

Inherited from

DChartCoordinateBase.newMark

Defined in

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

newRegion

▸ newRegion(): DChartRegion

Returns

DChartRegion

Inherited from

DChartCoordinateBase.newRegion

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>

Overrides

DChartCoordinateBase.newTick

Defined in

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

newTransform

▸ newTransform(options?): DChartCoordinateTransform<CHART>

Parameters

Name	Type
`options?`	`DChartCoordinateTransformOptions`

Returns

DChartCoordinateTransform<CHART>

Inherited from

DChartCoordinateBase.newTransform

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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.toFitDomain

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

Inherited from

DChartCoordinateBase.toFitRange

Defined in

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

toTheme

▸ toTheme(options?): DThemeChartCoordinate

Parameters

Name	Type
`options?`	`DChartCoordinateOptions`

Returns

DThemeChartCoordinate

Inherited from

DChartCoordinateBase.toTheme

Defined in

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

unbind

▸ unbind(): void

Returns

void

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.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

Inherited from

DChartCoordinateBase.unmapAll

Defined in

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

Edit this page.

Class: DChartCoordinateLinear<CHART>

Type parameters

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Parameters

Returns

Inherited from

Defined in

Properties

_container

Inherited from

Defined in

_direction

Inherited from

Defined in

_from

Inherited from

Defined in

_id

Inherited from

Defined in

_mark

Inherited from

Defined in

_theme

Inherited from

Defined in

_tick

Inherited from

Defined in

_to

Inherited from

Defined in

_transform

Inherited from

Defined in

_work

Inherited from

Defined in

Accessors

from

Returns

Inherited from

Defined in

Parameters

Returns

Inherited from

Defined in

id

Returns

Inherited from

Defined in

to

Returns

Inherited from

Defined in

Parameters

Returns

Inherited from

Defined in

transform

Returns

Inherited from

Defined in

Methods

bind

Parameters

Returns

Inherited from

Defined in

blend

Parameters

Returns