Interface: PolarAreaController
-
↳
PolarAreaController
• Readonly
_cachedMeta: ChartMeta
<<Object
, Object
>, Element
<Object
, Object
>>
Inherited from
DoughnutController._cachedMeta
Defined in
chart
• Readonly
chart: <"bar"
| "line"
| "scatter"
| "bubble"
| "pie"
| "doughnut"
| "polarArea"
| "radar"
, (number
| ScatterDataPoint
| )[], unknown
>
Inherited from
DoughnutController.chart
Defined in
index.esm.d.ts:548 (opens new window)
enableOptionSharing
• enableOptionSharing: boolean
Inherited from
DoughnutController.enableOptionSharing
Defined in
index.esm.d.ts:551 (opens new window)
index
• Readonly
index: number
Inherited from
DoughnutController.index
Defined in
index.esm.d.ts:549 (opens new window)
innerRadius
• Readonly
innerRadius: number
Inherited from
DoughnutController.innerRadius
Defined in
index.esm.d.ts:316 (opens new window)
offsetX
• Readonly
offsetX: number
Inherited from
DoughnutController.offsetX
Defined in
index.esm.d.ts:318 (opens new window)
offsetY
• Readonly
offsetY: number
Inherited from
DoughnutController.offsetY
Defined in
index.esm.d.ts:319 (opens new window)
outerRadius
• Readonly
outerRadius: number
Inherited from
DoughnutController.outerRadius
Defined in
index.esm.d.ts:317 (opens new window)
addElements
▸ addElements(): void
Returns
void
Inherited from
DoughnutController.addElements
Defined in
applyStack
▸ Protected
applyStack(scale
, parsed
): number
Parameters
Returns
number
Inherited from
DoughnutController.applyStack
Defined in
buildOrUpdateElements
▸ buildOrUpdateElements(resetNewElements?
): void
Parameters
Name | Type |
---|---|
resetNewElements? | boolean |
Returns
void
Inherited from
DoughnutController.buildOrUpdateElements
Defined in
calculateCircumference
▸ calculateCircumference(value
): number
Parameters
Name | Type |
---|---|
value | number |
Returns
number
Inherited from
DoughnutController.calculateCircumference
Defined in
calculateTotal
▸ calculateTotal(): number
Returns
number
Inherited from
DoughnutController.calculateTotal
Defined in
index.esm.d.ts:321 (opens new window)
configure
▸ configure(): void
Returns
void
Inherited from
DoughnutController.configure
Defined in
▸ countVisibleElements(): number
Returns
number
Defined in
index.esm.d.ts:363 (opens new window)
draw
▸ draw(): void
Returns
void
Inherited from
DoughnutController.draw
Defined in
getAllParsedValues
Parameters
Name | Type |
---|---|
scale | Scale <> |
Returns
number
[]
Inherited from
DoughnutController.getAllParsedValues
Defined in
getDataset
▸ getDataset(): <"bar"
| "line"
| "scatter"
| "bubble"
| "pie"
| "doughnut"
| "polarArea"
| "radar"
, (number
| ScatterDataPoint
| )[]>
Returns
<"bar"
| "line"
| "scatter"
| "bubble"
| "pie"
| "doughnut"
| "polarArea"
| "radar"
, (number
| ScatterDataPoint
| )[]>
Inherited from
DoughnutController.getDataset
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 |
Inherited from
DoughnutController.getLabelAndValue
Defined in
index.esm.d.ts:555 (opens new window)
getMaxOverflow
▸ Protected
getMaxOverflow(): number
| boolean
Returns
number
| boolean
Inherited from
DoughnutController.getMaxOverflow
Defined in
getMeta
▸ getMeta(): <Element
<Object
, Object
>, <Object
, Object
>>
Returns
<Element
<Object
, Object
>, <Object
, Object
>>
Inherited from
DoughnutController.getMeta
Defined in
index.esm.d.ts:563 (opens new window)
getMinMax
▸ Protected
getMinMax(scale
, canStack?
): Object
Parameters
Name | Type |
---|---|
scale | <CoreScaleOptions > |
canStack? | boolean |
Returns
Object
Name | Type |
---|---|
max | number |
min | number |
Inherited from
DoughnutController.getMinMax
Defined in
index.esm.d.ts:610 (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
DoughnutController.getParsed
Defined in
index.esm.d.ts:602 (opens new window)
getScaleForId
▸ getScaleForId(scaleID
): Scale
<>
Parameters
Returns
Scale
<>
Inherited from
DoughnutController.getScaleForId
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
>
Inherited from
DoughnutController.getSharedOptions
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
>
Inherited from
DoughnutController.getStyle
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
Inherited from
DoughnutController.includeOptions
Defined in
index.esm.d.ts:582 (opens new window)
initialize
▸ initialize(): void
Returns
void
Inherited from
DoughnutController.initialize
Defined in
▸ linkScales(): void
Returns
void
Inherited from
DoughnutController.linkScales
Defined in
parse
▸ parse(start
, count
): void
Parameters
Name | Type |
---|---|
start | number |
count | number |
Returns
void
Inherited from
DoughnutController.parse
Defined in
parseArrayData
▸ Protected
parseArrayData(meta
, data
, start
, count
): Record
<string
, unknown
>[]
Parameters
Name | Type |
---|---|
meta | <Element <Object , Object >, <Object , Object >> |
data | Record <string , unknown >[] |
start | number |
count | number |
Returns
Record
<string
, unknown
>[]
Inherited from
DoughnutController.parseArrayData
Defined in
parseObjectData
▸ Protected
parseObjectData(meta
, data
, start
, count
): Record
<string
, unknown
>[]
Parameters
Name | Type |
---|---|
meta | ChartMeta <<Object , Object >, Element <Object , Object >> |
data | Record <string , unknown >[] |
start | number |
count | number |
Returns
Record
<string
, unknown
>[]
Inherited from
DoughnutController.parseObjectData
Defined in
index.esm.d.ts:601 (opens new window)
parsePrimitiveData
▸ Protected
parsePrimitiveData(meta
, data
, start
, count
): Record
<string
, unknown
>[]
Parameters
Name | Type |
---|---|
meta | <Element <Object , Object >, <Object , Object >> |
data | Record <string , unknown >[] |
start | number |
count | number |
Returns
Record
<string
, unknown
>[]
Inherited from
DoughnutController.parsePrimitiveData
Defined in
removeHoverStyle
▸ removeHoverStyle(element
, datasetIndex
, index
): void
Parameters
Name | Type |
---|---|
element | Element <Object , Object > |
datasetIndex | number |
index | number |
Returns
void
Inherited from
DoughnutController.removeHoverStyle
Defined in
index.esm.d.ts:595 (opens new window)
reset
▸ reset(): void
Returns
Inherited from
DoughnutController.reset
Defined in
resolveDataElementOptions
▸ Protected
resolveDataElementOptions(index
, mode
): Record
<string
, unknown
>
Parameters
Returns
Record
<string
, unknown
>
Inherited from
DoughnutController.resolveDataElementOptions
Defined in
resolveDatasetElementOptions
▸ Protected
resolveDatasetElementOptions(mode
): Record
<string
, unknown
>
Parameters
Name | Type |
---|---|
mode | “resize” | “reset” | “none” | “hide” | “show” | “normal” | “active” |
Returns
Record
<string
, unknown
>
Inherited from
DoughnutController.resolveDatasetElementOptions
Defined in
setHoverStyle
▸ setHoverStyle(element
, datasetIndex
, index
): void
Parameters
Name | Type |
---|---|
element | Element <Object , Object > |
datasetIndex | number |
index | number |
Returns
void
Inherited from
DoughnutController.setHoverStyle
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
Inherited from
DoughnutController.update
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 | <Object , Object > |
index | number |
properties | Record <string , unknown > |
mode | “resize” | “reset” | “none” | “hide” | “show” | “normal” | “active” |
Returns
void
Inherited from
DoughnutController.updateElement
Defined in
updateElements
▸ updateElements(elements
, start
, count
, mode
): void
Parameters
Name | Type |
---|---|
elements | Element <Object , Object >[] |
start | number |
count | number |
mode | “resize” | “reset” | “none” | “hide” | “show” | “normal” | “active” |
Returns
void
Inherited from
DoughnutController.updateElements
Defined in
index.esm.d.ts:556 (opens new window)
updateIndex
▸ updateIndex(datasetIndex
): void
Parameters
Name | Type |
---|---|
datasetIndex | number |
Returns
void
Inherited from
DoughnutController.updateIndex
Defined in
index.esm.d.ts:558 (opens new window)
▸ Protected
updateRangeFromParsed(range
, scale
, parsed
, stack
): void
Parameters
Name | Type |
---|---|
range | Object |
range.max | number |
range.min | number |
scale | Scale <> |
parsed | unknown [] |
stack | string | boolean |
Returns
void
Inherited from
DoughnutController.updateRangeFromParsed
Defined in
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 > |