TypeScript component props¶
Generated from the TypeScript component metadata during the build.
Property |
TypeScript type |
Description |
|---|---|---|
|
|
Unique identifier for the component. Defaults to None when omitted. |
|
|
CSS class applied to the component container. Defaults to None when omitted. |
|
|
Inline styles applied to the component container. Defaults to None when omitted. |
|
|
ECharts option object. Defaults to None when omitted. |
|
|
GeoJSON or SVG map definitions registered before applying the option. Defaults to None when omitted. |
|
|
Lazily load ECharts-GL before applying 3D/WebGL options. Defaults to false. |
|
|
Optional URL override for the separately served ECharts-GL bundle. Defaults to None when omitted. |
|
|
Replace the current option instead of merging it. Defaults to false. |
|
|
Defer option updates until the next animation frame. Defaults to false. |
|
|
Rendering engine used by ECharts. Defaults to “canvas”. |
|
|
Named light/dark theme or a custom ECharts theme object. Defaults to None when omitted. |
|
|
Latest click event with seriesIndex, dataIndex, name, and value when available. Defaults to None when omitted. |
|
|
Latest double-click event with seriesIndex, dataIndex, name, and value when available. Defaults to None when omitted. |
|
|
Latest pointer-over event with seriesIndex, dataIndex, name, and value when available. Defaults to None when omitted. |
|
|
Latest selection-change event, including the selected series and data indexes. Defaults to None when omitted. |
|
|
Latest legend selection event with the legend name and selection state. Defaults to None when omitted. |
|
|
Latest data-zoom event with range and value bounds when available. Defaults to None when omitted. |
|
|
Dispatch a supported ECharts action when this payload changes. Defaults to None when omitted. |
|
|
Append a batch of data to an ECharts series without resending its full option. Defaults to None when omitted. |
|
|
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @,see,,{@link ,https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs,} |
|
|
No description provided. |