Chart.js

# Interface: DoughnutController

# Hierarchy

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DatasetController._cachedMeta

# Defined in

types/index.d.ts:602 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

DatasetController.chart

# Defined in

types/index.d.ts:600 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Inherited from

DatasetController.enableOptionSharing

# Defined in

types/index.d.ts:603 (opens new window)

# index

• Readonly index: number

# Inherited from

DatasetController.index

# Defined in

types/index.d.ts:601 (opens new window)

# innerRadius

• Readonly innerRadius: number

# Defined in

types/index.d.ts:341 (opens new window)

# offsetX

• Readonly offsetX: number

# Defined in

types/index.d.ts:343 (opens new window)

# offsetY

• Readonly offsetY: number

# Defined in

types/index.d.ts:344 (opens new window)

# outerRadius

• Readonly outerRadius: number

# Defined in

types/index.d.ts:342 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Inherited from

DatasetController.supportsDecimation

# Defined in

types/index.d.ts:607 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Inherited from

DatasetController.addElements

# Defined in

types/index.d.ts:623 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Inherited from

DatasetController.applyStack

# Defined in

types/index.d.ts:659 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Inherited from

DatasetController.buildOrUpdateElements

# Defined in

types/index.d.ts:624 (opens new window)

# calculateCircumference

▸ calculateCircumference(value): number

# Parameters

Name Type
value number

# Returns

number

# Defined in

types/index.d.ts:347 (opens new window)

# calculateTotal

▸ calculateTotal(): number

# Returns

number

# Defined in

types/index.d.ts:346 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

DatasetController.configure

# Defined in

types/index.d.ts:621 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Inherited from

DatasetController.draw

# Defined in

types/index.d.ts:616 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Inherited from

DatasetController.getAllParsedValues

# Defined in

types/index.d.ts:610 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Inherited from

DatasetController.getDataset

# Defined in

types/index.d.ts:618 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Inherited from

DatasetController.getLabelAndValue

# Defined in

types/index.d.ts:611 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Inherited from

DatasetController.getMaxOverflow

# Defined in

types/index.d.ts:615 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DatasetController.getMeta

# Defined in

types/index.d.ts:619 (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

# Inherited from

DatasetController.getMinMax

# Defined in

types/index.d.ts:666 (opens new window)

# getParsed

▸ Protected getParsed(index): number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Parameters

Name Type
index number

# Returns

number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Inherited from

DatasetController.getParsed

# Defined in

types/index.d.ts:658 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Inherited from

DatasetController.getScaleForId

# Defined in

types/index.d.ts:620 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

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

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Inherited from

DatasetController.getSharedOptions

# Defined in

types/index.d.ts:633 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Inherited from

DatasetController.getStyle

# Defined in

types/index.d.ts:626 (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 "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Inherited from

DatasetController.includeOptions

# Defined in

types/index.d.ts:638 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Inherited from

DatasetController.initialize

# Defined in

types/index.d.ts:622 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Inherited from

DatasetController.linkScales

# Defined in

types/index.d.ts:609 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Inherited from

DatasetController.parse

# Defined in

types/index.d.ts:654 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parseArrayData

# Defined in

types/index.d.ts:656 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parseObjectData

# Defined in

types/index.d.ts:657 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parsePrimitiveData

# Defined in

types/index.d.ts:655 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DatasetController.removeHoverStyle

# Defined in

types/index.d.ts:651 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Inherited from

DatasetController.reset

# Defined in

types/index.d.ts:617 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DatasetController.resolveDataElementOptions

# Defined in

types/index.d.ts:628 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DatasetController.resolveDatasetElementOptions

# Defined in

types/index.d.ts:627 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DatasetController.setHoverStyle

# Defined in

types/index.d.ts:652 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.update

# Defined in

types/index.d.ts:613 (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 default<AnyObject, AnyObject>
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.updateElement

# Defined in

types/index.d.ts:644 (opens new window)

# updateElements

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

# Parameters

Name Type
elements default<AnyObject, AnyObject>[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.updateElements

# Defined in

types/index.d.ts:612 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Inherited from

DatasetController.updateIndex

# Defined in

types/index.d.ts:614 (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

# Inherited from

DatasetController.updateRangeFromParsed

# Defined in

types/index.d.ts:660 (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 AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Inherited from

DatasetController.updateSharedOptions

# Defined in

types/index.d.ts:650 (opens new window)

← DoughnutControllerChartOptions →