Class: DatasetController<TType, TElement, TDatasetElement, TParsedData>

Class: DatasetController<TType, TElement, TDatasetElement, TParsedData>

Type parameters

Name	Type
`TType`	extends `ChartTypeChartType`
`TElement`	extends `ElementElement`
`TDatasetElement`	extends `ElementElement`
`TParsedData`	`ParsedDataType`<`TType`>

Hierarchy

DatasetController

↳ DoughnutController

Constructors

constructor

• new DatasetController<TType, TElement, TDatasetElement, TParsedData>(chart, datasetIndex)

Type parameters

Name	Type
`TType`	extends `“bar”` \| `“line”` \| `“scatter”` \| `“bubble”` \| `“pie”` \| `“doughnut”` \| `“polarArea”` \| “radar”````”bar” \| `“line”` \| `“scatter”` \| `“bubble”` \| `“pie”` \| `“doughnut”` \| `“polarArea”` \| `“radar”`
`TElement`	extends `Element`<`Object`, `Object`, `TElement`>`Element`<`Object`, `Object`>
`TDatasetElement`	extends `Element`<`Object`, `Object`, `TDatasetElement`>`Element`<`Object`, `Object`>
`TParsedData`	`ParsedDataType`<`TType`>

Parameters

Name	Type
`chart`	`Chart`<`“bar”` \| `“line”` \| `“scatter”` \| `“bubble”` \| `“pie”` \| `“doughnut”` \| `“polarArea”` \| `“radar”`, (`number` \| `ScatterDataPoint` \| `BubbleDataPoint`)[], `unknown`>
`datasetIndex`	`number`

Defined in

index.esm.d.ts:545 (opens new window)

Properties

_cachedMeta

• Readonly _cachedMeta: ChartMeta<TElement, TDatasetElement>

Defined in

index.esm.d.ts:550 (opens new window)

chart

Defined in

index.esm.d.ts:548 (opens new window)

enableOptionSharing

• enableOptionSharing: boolean

Defined in

index.esm.d.ts:551 (opens new window)

index

• Readonly index: number

Defined in

index.esm.d.ts:549 (opens new window)

Methods

addElements

▸ addElements(): void

Returns

void

Defined in

index.esm.d.ts:567 (opens new window)

applyStack

▸ Protected applyStack(scale, parsed): number

Parameters

Name	Type
`scale`	`Scale`<`CoreScaleOptions`>
`parsed`	`unknown`[]

Returns

number

Defined in

index.esm.d.ts:603 (opens new window)

buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

Parameters

Name	Type
`resetNewElements?`	`boolean`

Returns

void

Defined in

index.esm.d.ts:568 (opens new window)

configure

▸ configure(): void

Returns

void

Defined in

index.esm.d.ts:565 (opens new window)

draw

▸ draw(): void

Returns

void

Defined in

index.esm.d.ts:560 (opens new window)

getAllParsedValues

▸ getAllParsedValues(scale): number[]

Parameters

Name	Type
`scale`	`Scale`<`CoreScaleOptions`>

Returns

number[]

Defined in

index.esm.d.ts:554 (opens new window)

getDataset

Returns

Defined in

index.esm.d.ts:562 (opens new window)

getLabelAndValue

▸ Protected getLabelAndValue(index): Object

Parameters

Name	Type
`index`	`number`

Returns

Object

Name	Type
`label`	`string`
`value`	`string`

Defined in

index.esm.d.ts:555 (opens new window)

getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

Returns

number | boolean

Defined in

index.esm.d.ts:559 (opens new window)

getMeta

▸ getMeta(): ChartMeta<TElement, TDatasetElement>

Returns

ChartMeta<TElement, TDatasetElement>

Defined in

index.esm.d.ts:563 (opens new window)

getMinMax

▸ Protected getMinMax(scale, canStack?): Object

Parameters

Name	Type
`scale`	`Scale`<`CoreScaleOptions`>
`canStack?`	`boolean`

Returns

Object

Name	Type
`max`	`number`
`min`	`number`

Defined in

index.esm.d.ts:610 (opens new window)

getParsed

▸ Protected getParsed(index): TParsedData

Parameters

Name	Type
`index`	`number`

Returns

TParsedData

Defined in

index.esm.d.ts:602 (opens new window)

getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

Parameters

Name	Type
`scaleID`	`string`

Returns

Scale<CoreScaleOptions>

Defined in

index.esm.d.ts:564 (opens new window)

getSharedOptions

▸ Protected getSharedOptions(options): Record<string, unknown>

Utility for checking if the options are shared and should be animated separately.

Parameters

Name	Type
`options`	`Record`<`string`, `unknown`>

Returns

Record<string, unknown>

Defined in

index.esm.d.ts:577 (opens new window)

getStyle

▸ getStyle(index, active): Record<string, unknown>

Parameters

Name	Type
`index`	`number`
`active`	`boolean`

Returns

Record<string, unknown>

Defined in

index.esm.d.ts:570 (opens new window)

includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

Parameters

Name	Type
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`
`sharedOptions`	`Record`<`string`, `unknown`>

Returns

boolean

Defined in

index.esm.d.ts:582 (opens new window)

initialize

▸ initialize(): void

Returns

void

Defined in

index.esm.d.ts:566 (opens new window)

linkScales

▸ linkScales(): void

Returns

void

Defined in

index.esm.d.ts:553 (opens new window)

parse

▸ parse(start, count): void

Parameters

Name	Type
`start`	`number`
`count`	`number`

Returns

void

Defined in

index.esm.d.ts:598 (opens new window)

parseArrayData

▸ Protected parseArrayData(meta, data, start, count): Record<string, unknown>[]

Parameters

Name	Type
`meta`	`ChartMeta`<`TElement`, `TDatasetElement`>
`data`	`Record`<`string`, `unknown`>[]
`start`	`number`
`count`	`number`

Returns

Record<string, unknown>[]

Defined in

index.esm.d.ts:600 (opens new window)

parseObjectData

▸ Protected parseObjectData(meta, data, start, count): Record<string, unknown>[]

Parameters

Name	Type
`meta`	`ChartMeta`<`TElement`, `TDatasetElement`>
`data`	`Record`<`string`, `unknown`>[]
`start`	`number`
`count`	`number`

Returns

Record<string, unknown>[]

Defined in

index.esm.d.ts:601 (opens new window)

parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): Record<string, unknown>[]

Parameters

Name	Type
`meta`	`ChartMeta`<`TElement`, `TDatasetElement`>
`data`	`Record`<`string`, `unknown`>[]
`start`	`number`
`count`	`number`

Returns

Record<string, unknown>[]

Defined in

index.esm.d.ts:599 (opens new window)

removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

Parameters

Name	Type
`element`	`TElement`
`datasetIndex`	`number`
`index`	`number`

Returns

void

Defined in

index.esm.d.ts:595 (opens new window)

reset

▸ reset(): void

Returns

void

Defined in

index.esm.d.ts:561 (opens new window)

resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): Record<string, unknown>

Parameters

Name	Type
`index`	`number`
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`

Returns

Record<string, unknown>

Defined in

index.esm.d.ts:572 (opens new window)

resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): Record<string, unknown>

Parameters

Name	Type
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`

Returns

Record<string, unknown>

Defined in

index.esm.d.ts:571 (opens new window)

setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

Parameters

Name	Type
`element`	`TElement`
`datasetIndex`	`number`
`index`	`number`

Returns

void

Defined in

index.esm.d.ts:596 (opens new window)

update

▸ update(mode): void

Parameters

Name	Type
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`

Returns

void

Defined in

index.esm.d.ts:557 (opens new window)

updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

Parameters

Name	Type
`element`	`TElement` \| `TDatasetElement`
`index`	`number`
`properties`	`Record`<`string`, `unknown`>
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`

Returns

void

Defined in

index.esm.d.ts:588 (opens new window)

updateElements

▸ updateElements(elements, start, count, mode): void

Parameters

Name	Type
`elements`	`TElement`[]
`start`	`number`
`count`	`number`
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`

Returns

void

Defined in

index.esm.d.ts:556 (opens new window)

updateIndex

▸ updateIndex(datasetIndex): void

Parameters

Name	Type
`datasetIndex`	`number`

Returns

void

Defined in

index.esm.d.ts:558 (opens new window)

updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

Parameters

Name	Type
`range`	`Object`
`range.max`	`number`
`range.min`	`number`
`scale`	`Scale`<`CoreScaleOptions`>
`parsed`	`unknown`[]
`stack`	`string` \| `boolean`

Returns

void

Defined in

index.esm.d.ts:604 (opens new window)

updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

Parameters

Name	Type
`sharedOptions`	`Record`<`string`, `unknown`>
`mode`	`“resize”` \| `“reset”` \| `“none”` \| `“hide”` \| `“show”` \| `“normal”` \| `“active”`
`newOptions`	`Record`<`string`, `unknown`>

Returns

void

Defined in

index.esm.d.ts:594 (opens new window)