ChartsToolbarRangeButtonTrigger API
API reference docs for the React ChartsToolbarRangeButtonTrigger component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import { ChartsToolbarRangeButtonTrigger } from '@mui/x-charts-pro/ChartsToolbarPro';
// or
import { ChartsToolbarRangeButtonTrigger } from '@mui/x-charts-pro';
Learn about the difference by reading this guide on minimizing bundle size.
A button that sets the chart zoom to a
predefined range. It renders the
baseToggleButton slot.
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| label* | string | - |
The label used to identify the button for active-state tracking. |
| value* |
Array<Date> | Array<string> | func | { step?: number, unit: 'day' | 'hour' | 'microsecond' | 'millisecond' | 'minute' | 'month' | 'second' | 'week' | 'year' } |
- |
The range value. Specifies how far back from the end of the data to zoom.
|
| axisId |
number | string |
- |
The axis ID to apply the range to. Defaults to the first x-axis with zoom enabled. |
| render |
element | func |
- |
A function to customize the rendering of the component. |
| size |
'large' | 'medium' | 'small' |
'small' |
The size of the button. |
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.