- Interface: DoughnutController
- Hierarchy
- Properties
- Methods
- addElements
- applyStack
- buildOrUpdateElements
- calculateCircumference
- calculateTotal
- configure
- draw
- getAllParsedValues
- getDataset
- getLabelAndValue
- getMaxOverflow
- getMeta
- getMinMax
- getParsed
- getScaleForId
- getSharedOptions
- getStyle
- includeOptions
- initialize
- linkScales
- parse
- parseArrayData
- parseObjectData
- parsePrimitiveData
- removeHoverStyle
- reset
- resolveDataElementOptions
- resolveDatasetElementOptions
- setHoverStyle
- update
- updateElement
- updateElements
- updateIndex
- updateRangeFromParsed
- updateSharedOptions
Interface: DoughnutController
Hierarchy
-
↳
DoughnutController
Properties
_cachedMeta
• Readonly
_cachedMeta: ChartMeta
<Element
<AnyObject
, AnyObject
>, Element
<AnyObject
, AnyObject
>, keyof ChartTypeRegistry
>
Inherited from
Defined in
index.esm.d.ts:566 (opens new window)
chart
• Readonly
chart: Chart
<keyof ChartTypeRegistry
, (number
| ScatterDataPoint
| BubbleDataPoint
)[], unknown
>
Inherited from
Defined in
index.esm.d.ts:564 (opens new window)
enableOptionSharing
• enableOptionSharing: boolean
Inherited from
DatasetController.enableOptionSharing
Defined in
index.esm.d.ts:567 (opens new window)
index
• Readonly
index: number
Inherited from
Defined in
index.esm.d.ts:565 (opens new window)
innerRadius
• Readonly
innerRadius: number
Defined in
index.esm.d.ts:319 (opens new window)
offsetX
• Readonly
offsetX: number
Defined in
index.esm.d.ts:321 (opens new window)
offsetY
• Readonly
offsetY: number
Defined in
index.esm.d.ts:322 (opens new window)
outerRadius
• Readonly
outerRadius: number
Defined in
index.esm.d.ts:320 (opens new window)
Methods
addElements
▸ addElements(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:583 (opens new window)
applyStack
▸ Protected
applyStack(scale
, parsed
): number
Parameters
Name | Type |
---|---|
scale | Scale <CoreScaleOptions > |
parsed | unknown [] |
Returns
number
Inherited from
Defined in
index.esm.d.ts:619 (opens new window)
buildOrUpdateElements
▸ buildOrUpdateElements(resetNewElements?
): void
Parameters
Name | Type |
---|---|
resetNewElements? | boolean |
Returns
void
Inherited from
DatasetController.buildOrUpdateElements
Defined in
index.esm.d.ts:584 (opens new window)
calculateCircumference
▸ calculateCircumference(value
): number
Parameters
Name | Type |
---|---|
value | number |
Returns
number
Defined in
index.esm.d.ts:325 (opens new window)
calculateTotal
▸ calculateTotal(): number
Returns
number
Defined in
index.esm.d.ts:324 (opens new window)
configure
▸ configure(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:581 (opens new window)
draw
▸ draw(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:576 (opens new window)
getAllParsedValues
▸ getAllParsedValues(scale
): number
[]
Parameters
Name | Type |
---|---|
scale | Scale <CoreScaleOptions > |
Returns
number
[]
Inherited from
DatasetController.getAllParsedValues
Defined in
index.esm.d.ts:570 (opens new window)
getDataset
▸ getDataset(): ChartDataset
<keyof ChartTypeRegistry
, (number
| ScatterDataPoint
| BubbleDataPoint
)[]>
Returns
ChartDataset
<keyof ChartTypeRegistry
, (number
| ScatterDataPoint
| BubbleDataPoint
)[]>
Inherited from
Defined in
index.esm.d.ts:578 (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
index.esm.d.ts:571 (opens new window)
getMaxOverflow
▸ Protected
getMaxOverflow(): number
| boolean
Returns
number
| boolean
Inherited from
DatasetController.getMaxOverflow
Defined in
index.esm.d.ts:575 (opens new window)
getMeta
▸ getMeta(): ChartMeta
<Element
<AnyObject
, AnyObject
>, Element
<AnyObject
, AnyObject
>, keyof ChartTypeRegistry
>
Returns
ChartMeta
<Element
<AnyObject
, AnyObject
>, Element
<AnyObject
, AnyObject
>, keyof ChartTypeRegistry
>
Inherited from
Defined in
index.esm.d.ts:579 (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
Defined in
index.esm.d.ts:626 (opens new window)
getParsed
▸ Protected
getParsed(index
): number
| BarParsedData
| CartesianParsedData
| BubbleParsedData
| RadialParsedData
Parameters
Name | Type |
---|---|
index | number |
Returns
number
| BarParsedData
| CartesianParsedData
| BubbleParsedData
| RadialParsedData
Inherited from
Defined in
index.esm.d.ts:618 (opens new window)
getScaleForId
▸ getScaleForId(scaleID
): Scale
<CoreScaleOptions
>
Parameters
Name | Type |
---|---|
scaleID | string |
Returns
Inherited from
DatasetController.getScaleForId
Defined in
index.esm.d.ts:580 (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
index.esm.d.ts:593 (opens new window)
getStyle
▸ getStyle(index
, active
): AnyObject
Parameters
Name | Type |
---|---|
index | number |
active | boolean |
Returns
AnyObject
Inherited from
Defined in
index.esm.d.ts:586 (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” | “hide” | “show” | “none” | “normal” | “active” |
sharedOptions | AnyObject |
Returns
boolean
Inherited from
DatasetController.includeOptions
Defined in
index.esm.d.ts:598 (opens new window)
initialize
▸ initialize(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:582 (opens new window)
linkScales
▸ linkScales(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:569 (opens new window)
parse
▸ parse(start
, count
): void
Parameters
Name | Type |
---|---|
start | number |
count | number |
Returns
void
Inherited from
Defined in
index.esm.d.ts:614 (opens new window)
parseArrayData
▸ Protected
parseArrayData(meta
, data
, start
, count
): AnyObject
[]
Parameters
Name | Type |
---|---|
meta | ChartMeta <Element <AnyObject , AnyObject >, Element <AnyObject , AnyObject >, keyof ChartTypeRegistry > |
data | AnyObject [] |
start | number |
count | number |
Returns
AnyObject
[]
Inherited from
DatasetController.parseArrayData
Defined in
index.esm.d.ts:616 (opens new window)
parseObjectData
▸ Protected
parseObjectData(meta
, data
, start
, count
): AnyObject
[]
Parameters
Name | Type |
---|---|
meta | ChartMeta <Element <AnyObject , AnyObject >, Element <AnyObject , AnyObject >, keyof ChartTypeRegistry > |
data | AnyObject [] |
start | number |
count | number |
Returns
AnyObject
[]
Inherited from
DatasetController.parseObjectData
Defined in
index.esm.d.ts:617 (opens new window)
parsePrimitiveData
▸ Protected
parsePrimitiveData(meta
, data
, start
, count
): AnyObject
[]
Parameters
Name | Type |
---|---|
meta | ChartMeta <Element <AnyObject , AnyObject >, Element <AnyObject , AnyObject >, keyof ChartTypeRegistry > |
data | AnyObject [] |
start | number |
count | number |
Returns
AnyObject
[]
Inherited from
DatasetController.parsePrimitiveData
Defined in
index.esm.d.ts:615 (opens new window)
removeHoverStyle
▸ removeHoverStyle(element
, datasetIndex
, index
): void
Parameters
Name | Type |
---|---|
element | Element <AnyObject , AnyObject > |
datasetIndex | number |
index | number |
Returns
void
Inherited from
DatasetController.removeHoverStyle
Defined in
index.esm.d.ts:611 (opens new window)
reset
▸ reset(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:577 (opens new window)
resolveDataElementOptions
▸ Protected
resolveDataElementOptions(index
, mode
): AnyObject
Parameters
Name | Type |
---|---|
index | number |
mode | “resize” | “reset” | “hide” | “show” | “none” | “normal” | “active” |
Returns
AnyObject
Inherited from
DatasetController.resolveDataElementOptions
Defined in
index.esm.d.ts:588 (opens new window)
resolveDatasetElementOptions
▸ Protected
resolveDatasetElementOptions(mode
): AnyObject
Parameters
Name | Type |
---|---|
mode | “resize” | “reset” | “hide” | “show” | “none” | “normal” | “active” |
Returns
AnyObject
Inherited from
DatasetController.resolveDatasetElementOptions
Defined in
index.esm.d.ts:587 (opens new window)
setHoverStyle
▸ setHoverStyle(element
, datasetIndex
, index
): void
Parameters
Name | Type |
---|---|
element | Element <AnyObject , AnyObject > |
datasetIndex | number |
index | number |
Returns
void
Inherited from
DatasetController.setHoverStyle
Defined in
index.esm.d.ts:612 (opens new window)
update
▸ update(mode
): void
Parameters
Name | Type |
---|---|
mode | “resize” | “reset” | “hide” | “show” | “none” | “normal” | “active” |
Returns
void
Inherited from
Defined in
index.esm.d.ts:573 (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 | Element <AnyObject , AnyObject > |
index | number |
properties | AnyObject |
mode | “resize” | “reset” | “hide” | “show” | “none” | “normal” | “active” |
Returns
void
Inherited from
DatasetController.updateElement
Defined in
index.esm.d.ts:604 (opens new window)
updateElements
▸ updateElements(elements
, start
, count
, mode
): void
Parameters
Name | Type |
---|---|
elements | Element <AnyObject , AnyObject >[] |
start | number |
count | number |
mode | “resize” | “reset” | “hide” | “show” | “none” | “normal” | “active” |
Returns
void
Inherited from
DatasetController.updateElements
Defined in
index.esm.d.ts:572 (opens new window)
updateIndex
▸ updateIndex(datasetIndex
): void
Parameters
Name | Type |
---|---|
datasetIndex | number |
Returns
void
Inherited from
Defined in
index.esm.d.ts:574 (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
index.esm.d.ts:620 (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 | “resize” | “reset” | “hide” | “show” | “none” | “normal” | “active” |
newOptions | AnyObject |
Returns
void
Inherited from
DatasetController.updateSharedOptions