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

Type parameters

Hierarchy

• DatasetController

  ↳ DoughnutController

Constructors

constructor

+ new DatasetController<TType, TElement, TDatasetElement, TParsedData>(chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>, datasetIndex: number): DatasetController<TType, TElement, TDatasetElement, TParsedData>

Type parameters:

Parameters:

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

Defined in: index.esm.d.ts:526 (opens new window)

Properties

_cachedMeta

• Readonly _cachedMeta: ChartMeta<TElement, TDatasetElement>

Defined in: index.esm.d.ts:531 (opens new window)

chart

• Readonly chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>

Defined in: index.esm.d.ts:529 (opens new window)

enableOptionSharing

• enableOptionSharing: boolean

Defined in: index.esm.d.ts:532 (opens new window)

index

• Readonly index: number

Defined in: index.esm.d.ts:530 (opens new window)

Methods

addElements

▸ addElements(): void

Returns: void

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

applyStack

▸ ProtectedapplyStack(scale: Scale<CoreScaleOptions>, parsed: unknown[]): number

Parameters:

Returns: number

Defined in: index.esm.d.ts:584 (opens new window)

buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?: boolean): void

Parameters:

Returns: void

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

configure

▸ configure(): void

Returns: void

Defined in: index.esm.d.ts:546 (opens new window)

draw

▸ draw(): void

Returns: void

Defined in: index.esm.d.ts:541 (opens new window)

getAllParsedValues

▸ getAllParsedValues(scale: Scale<CoreScaleOptions>): number[]

Parameters:

Returns: number[]

Defined in: index.esm.d.ts:535 (opens new window)

getDataset

▸ getDataset(): ChartDataset<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[]>

Returns: ChartDataset<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[]>

Defined in: index.esm.d.ts:543 (opens new window)

getLabelAndValue

▸ ProtectedgetLabelAndValue(index: number): object

Parameters:

Returns: object

Defined in: index.esm.d.ts:536 (opens new window)

getMaxOverflow

▸ ProtectedgetMaxOverflow(): number | boolean

Returns: number | boolean

Defined in: index.esm.d.ts:540 (opens new window)

getMeta

▸ getMeta(): ChartMeta<TElement, TDatasetElement>

Returns: ChartMeta<TElement, TDatasetElement>

Defined in: index.esm.d.ts:544 (opens new window)

getMinMax

▸ ProtectedgetMinMax(scale: Scale<CoreScaleOptions>, canStack?: boolean): object

Parameters:

Returns: object

Defined in: index.esm.d.ts:591 (opens new window)

getParsed

▸ ProtectedgetParsed(index: number): TParsedData

Parameters:

Returns: TParsedData

Defined in: index.esm.d.ts:583 (opens new window)

getScaleForId

▸ getScaleForId(scaleID: string): Scale<CoreScaleOptions>

Parameters:

Returns: Scale<CoreScaleOptions>

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

getSharedOptions

▸ ProtectedgetSharedOptions(options: Record<string, unknown>): Record<string, unknown>

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

Parameters:

Returns: Record<string, unknown>

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

getStyle

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

Parameters:

Returns: Record<string, unknown>

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

includeOptions

▸ ProtectedincludeOptions(mode: resize | reset | none | hide | show | normal | active, sharedOptions: Record<string, unknown>): boolean

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

Parameters:

Returns: boolean

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

initialize

▸ initialize(): void

Returns: void

Defined in: index.esm.d.ts:547 (opens new window)

linkScales

▸ linkScales(): void

Returns: void

Defined in: index.esm.d.ts:534 (opens new window)

parse

▸ parse(start: number, count: number): void

Parameters:

Returns: void

Defined in: index.esm.d.ts:579 (opens new window)

parseArrayData

▸ ProtectedparseArrayData(meta: ChartMeta<TElement, TDatasetElement>, data: Record<string, unknown>[], start: number, count: number): Record<string, unknown>[]

Parameters:

Returns: Record<string, unknown>[]

Defined in: index.esm.d.ts:581 (opens new window)

parseObjectData

▸ ProtectedparseObjectData(meta: ChartMeta<TElement, TDatasetElement>, data: Record<string, unknown>[], start: number, count: number): Record<string, unknown>[]

Parameters:

Returns: Record<string, unknown>[]

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

parsePrimitiveData

▸ ProtectedparsePrimitiveData(meta: ChartMeta<TElement, TDatasetElement>, data: Record<string, unknown>[], start: number, count: number): Record<string, unknown>[]

Parameters:

Returns: Record<string, unknown>[]

Defined in: index.esm.d.ts:580 (opens new window)

removeHoverStyle

▸ removeHoverStyle(element: TElement, datasetIndex: number, index: number): void

Parameters:

Returns: void

Defined in: index.esm.d.ts:576 (opens new window)

reset

▸ reset(): void

Returns: void

Defined in: index.esm.d.ts:542 (opens new window)

resolveDataElementOptions

▸ ProtectedresolveDataElementOptions(index: number, mode: resize | reset | none | hide | show | normal | active): Record<string, unknown>

Parameters:

Returns: Record<string, unknown>

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

resolveDatasetElementOptions

▸ ProtectedresolveDatasetElementOptions(mode: resize | reset | none | hide | show | normal | active): Record<string, unknown>

Parameters:

Returns: Record<string, unknown>

Defined in: index.esm.d.ts:552 (opens new window)

setHoverStyle

▸ setHoverStyle(element: TElement, datasetIndex: number, index: number): void

Parameters:

Returns: void

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

update

▸ update(mode: resize | reset | none | hide | show | normal | active): void

Parameters:

Returns: void

Defined in: index.esm.d.ts:538 (opens new window)

updateElement

▸ ProtectedupdateElement(element: TElement | TDatasetElement, index: number, properties: Record<string, unknown>, mode: resize | reset | none | hide | show | normal | active): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:569 (opens new window)

updateElements

▸ updateElements(elements: TElement[], start: number, count: number, mode: resize | reset | none | hide | show | normal | active): void

Parameters:

Returns: void

Defined in: index.esm.d.ts:537 (opens new window)

updateIndex

▸ updateIndex(datasetIndex: number): void

Parameters:

Returns: void

Defined in: index.esm.d.ts:539 (opens new window)

updateRangeFromParsed

▸ ProtectedupdateRangeFromParsed(range: { max: number ; min: number }, scale: Scale<CoreScaleOptions>, parsed: unknown[], stack: string | boolean): void

Parameters:

Returns: void

Defined in: index.esm.d.ts:585 (opens new window)

updateSharedOptions

▸ ProtectedupdateSharedOptions(sharedOptions: Record<string, unknown>, mode: resize | reset | none | hide | show | normal | active, newOptions: Record<string, unknown>): void

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

Parameters:

Returns: void

Defined in: index.esm.d.ts:575 (opens new window)