Toolbar
When toolbar
is configured a toolbar will be displayed at the disired position (top or bottom) of the viewer. The toolbar will contain buttons for the following actions:
- Download
- Download Excel
- Configure Grid
- Filter
- Grid mode
- Restore
Properties
export interface ToolBarButton {
enabled: boolean;
active: boolean;
}
export interface ToolBar {
download: Partial<ToolBarButton> | boolean;
downloadExcel: Partial<ToolBarButton> | boolean;
grid: Partial<ToolBarButton> | boolean;
pivot: Partial<ToolBarButton> | boolean;
filter: Partial<ToolBarButton> | boolean;
mode: Partial<ToolBarButton> | boolean;
restore: Partial<ToolBarButton> | boolean;
custom: ReactNode;
}
By default active
property is true, if this property is false the button will be shown as disabled
Download
Property | Type | Default | Description |
---|---|---|---|
download | ToolBarButton or boolean | true | Enable download button in the toolbar. |
This option enables download with CSV format.
Download Excel
Property | Type | Default | Description |
---|---|---|---|
downloadExcel | ToolBarButton or boolean | true | Enable download Excel button in the toolbar. |
This option enables download with Excel format.
Configure Grid
Property | Type | Default | Description |
---|---|---|---|
grid | ToolBarButton or boolean | true | Enable configure grid button in the toolbar. |
This option enables the configuration of the grid.
Filter
Property | Type | Default | Description |
---|---|---|---|
filter | ToolBarButton or boolean | true | Enable filter button in the toolbar. |
This option enables the filter.
Grid Mode
Property | Type | Default | Description |
---|---|---|---|
mode | ToolBarButton or boolean | true | Enable grid mode button in the toolbar. |
This option enables the grid mode change.
Restore
Property | Type | Default | Description |
---|---|---|---|
restore | ToolBarButton or boolean | true | Enable restore button in the toolbar. |
This option enables the restore button.