ChartsToolbarExcelExportTrigger API

API reference docs for the React ChartsToolbarExcelExportTrigger component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Charts - Export

Import

import { ChartsToolbarExcelExportTrigger } from '@mui/x-charts-premium/ChartsToolbarPremium';
// or
import { ChartsToolbarExcelExportTrigger } from '@mui/x-charts-premium';

Learn about the difference by reading this guide on minimizing bundle size.

A button that triggers an Excel export of the chart data. It renders the baseButton slot.

Props

Name	Type	Description
disabled	bool	If `true`, the button is disabled.
id	string	The id of the button element.
onExport	func	Overrides how the export is performed. Defaults to `apiRef.current.exportAsExcel`. Signature:`function(options: ChartExcelExportOptions) => Promise<void>` `options` The options to apply on the Excel export.
options	{ escapeFormulas?: bool, fileName?: string, includeFormattedValues?: bool, includeHeaders?: bool, includeHiddenSeries?: bool }	The options to apply on the Excel export.
render	element \| func	A function to customize the rendering of the component.
size	'large' \| 'medium' \| 'small'	The size of the button.
tabIndex	number	The `tabIndex` of the button element.

The component cannot hold a ref.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.