| className | - | string, undefined |
A string of all className you want applied to the base component. |
| customTooltips | true | boolean, undefined |
Enables custom html based tooltips instead of standard tooltips. |
| data | - | ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint | null)[], unknown>, ((canvas: HTMLCanvasElement) => ChartData<...>) |
The data object that is passed into the Chart.js chart (more info). |
| fallbackContent | - | ReactNode |
A fallback for when the canvas cannot be rendered. Can be used for accessible chart descriptions. |
| getDatasetAtEvent | - | ((dataset: InteractionItem[], event: MouseEvent<HTMLCanvasElement, MouseEvent>) => void), undefined |
Proxy for Chart.js getDatasetAtEvent. Calls with dataset and triggering event. |
| getElementAtEvent | - | ((element: InteractionItem[], event: MouseEvent<HTMLCanvasElement, MouseEvent>) => void), undefined |
Proxy for Chart.js getElementAtEvent. Calls with single element array and triggering event. |
| getElementsAtEvent | - | ((elements: InteractionItem[], event: MouseEvent<HTMLCanvasElement, MouseEvent>) => void), undefined |
Proxy for Chart.js getElementsAtEvent. Calls with element array and triggering event. |
| height | 150 | number, undefined |
Height attribute applied to the rendered canvas. |
| id | - | string, undefined |
ID attribute applied to the rendered canvas. |
| options | - | _DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<...> & DatasetChartOptions<...> & ScaleChartOptions<...>>, undefined |
The options object that is passed into the Chart.js chart. |
| plugins | [] | Plugin<keyof ChartTypeRegistry, AnyObject>[], undefined |
The plugins array that is passed into the Chart.js chart (more info) |
| redraw | - | boolean, undefined |
If true, will tear down and redraw chart on all updates. |
| type | bar | {'line' | 'bar' | 'radar' | 'doughnut' | 'polarArea' | 'bubble' | 'pie' | 'scatter'} |
Chart.js chart type. |
| width | 300 | number, undefined |
Width attribute applied to the rendered canvas. |
| wrapper | true | boolean, undefined |
Put the chart into the wrapper div element. |