Interface: PieChartOptions
Hierarchy
Omit<Options,"axisX"|"axisY">↳
PieChartOptions
Properties
classNames
• Optional classNames: Object
Override the class names that are used to generate the SVG structure of the chart
Type declaration
| Name | Type |
|---|---|
chartPie? | string |
chartDonut? | string |
series? | string |
slicePie? | string |
sliceDonut? | string |
label? | string |
Overrides
Omit.classNames
Defined in
charts/PieChart/PieChart.types.ts:31
startAngle
• Optional startAngle: number
The start angle of the pie chart in degrees where 0 points north. A higher value offsets the start angle clockwise.
Defined in
charts/PieChart/PieChart.types.ts:42
total
• Optional total: number
An optional total you can specify. By specifying a total value, the sum of the values in the series must be this total in order to draw a full pie. You can use this parameter to draw only parts of a pie or gauge charts.
Defined in
charts/PieChart/PieChart.types.ts:46
donut
• Optional donut: boolean
If specified the donut CSS classes will be used and strokes will be drawn instead of pie slices.
Defined in
charts/PieChart/PieChart.types.ts:50
donutWidth
• Optional donutWidth: string | number
Specify the donut stroke width, currently done in javascript for convenience. May move to CSS styles in the future. This option can be set as number or string to specify a relative width (i.e. 100 or '30%').
Defined in
charts/PieChart/PieChart.types.ts:55
showLabel
• Optional showLabel: boolean
If a label should be shown or not
Defined in
charts/PieChart/PieChart.types.ts:59
labelOffset
• Optional labelOffset: number
Label position offset from the standard position which is half distance of the radius. This value can be either positive or negative. Positive values will position the label away from the center.
Defined in
charts/PieChart/PieChart.types.ts:63
labelPosition
• Optional labelPosition: RadialLabelPosition
This option can be set to 'inside', 'outside' or 'center'. Positioned with 'inside' the labels will be placed on half the distance of the radius to the border of the Pie by respecting the 'labelOffset'. The 'outside' option will place the labels at the border of the pie and 'center' will place the labels in the absolute center point of the chart. The 'center' option only makes sense in conjunction with the 'labelOffset' option.
Defined in
charts/PieChart/PieChart.types.ts:70
labelDirection
• Optional labelDirection: LabelDirection
Label direction can be 'neutral', 'explode' or 'implode'. The labels anchor will be positioned based on those settings as well as the fact if the labels are on the right or left side of the center of the chart. Usually explode is useful when labels are positioned far away from the center.
Defined in
charts/PieChart/PieChart.types.ts:80
ignoreEmptyValues
• Optional ignoreEmptyValues: boolean
If true empty values will be ignored to avoid drawing unnecessary slices and labels
Defined in
charts/PieChart/PieChart.types.ts:84
preventOverlappingLabelOffset
• Optional preventOverlappingLabelOffset: number
If nonzero labels will not overlap.
Defined in
charts/PieChart/PieChart.types.ts:88
width
• Optional width: string | number
Specify a fixed width for the chart as a string (i.e. '100px' or '50%')
Inherited from
Omit.width
Defined in
height
• Optional height: string | number
Specify a fixed height for the chart as a string (i.e. '100px' or '50%')
Inherited from
Omit.height
Defined in
low
• Optional low: number
Overriding the natural low of the chart allows you to zoom in or limit the charts lowest displayed value
Inherited from
Omit.low
Defined in
high
• Optional high: number
Overriding the natural high of the chart allows you to zoom in or limit the charts highest displayed value
Inherited from
Omit.high
Defined in
referenceValue
• Optional referenceValue: number
Unless low/high are explicitly set, bar chart will be centered at zero by default. Set referenceValue to null to auto scale.
Inherited from
Omit.referenceValue
Defined in
chartPadding
• Optional chartPadding: number | Partial<ChartPadding>
Padding of the chart drawing area to the container element and labels as a number or padding object.
Inherited from
Omit.chartPadding
Defined in
plugins
• Optional plugins: (Plugin | [Plugin, any])[]
Inherited from
Omit.plugins
Defined in
viewBox
• Optional viewBox: ViewBox
Define the ViewBox for an SVG, this is optional and only required if you need a scalable chart. This should be used together with responsive options to ensure a proper text size.
Inherited from
Omit.viewBox
Defined in
Methods
labelInterpolationFnc
▸ Optional labelInterpolationFnc(value, index): undefined | null | Label
An interpolation function for the label value
Parameters
| Name | Type |
|---|---|
value | Label |
index | number |
Returns
undefined | null | Label