Skip to content

ChartImageExportOptions API

Extended documentation for the ChartImageExportOptions interface with detailed information on the module's properties and available APIs.

Demos

Import

import { ChartImageExportOptions } from '@mui/x-charts-pro'


The options to apply on the image export.

Properties

Optional

If true, the styles of the page the chart belongs to will be copied to the export iframe.
Copying styles is useful to ensure that the exported chart looks the same as it does on the page.

Type:boolean

Default:true


Optional

The name of the file without the extension.

Type:string

Default:The title of the document the chart belongs to


Optional

Callback function that is called before the export is triggered.
It can be used to modify the iframe or perform any other actions before the export, such as updating styles,
removing elements, etc.

Type:(iframe: HTMLIFrameElement) => Promise<void> | void


Optional

The quality of the image to be exported between 0 and 1. This is only applicable for lossy formats, such as
'image/jpeg' and 'image/webp'. 'image/png' does not support this option.

Type:number

Default:0.9


Optional

The format of the image to be exported.
Browsers are required to support 'image/png'. Some browsers also support 'image/jpeg' and 'image/webp'.
If the provided type is not supported by the browser, it will default to 'image/png'.

Type:'image/png' | string

Default:'image/png'