GridPrintExportOptions API

The options to apply on the Print export.

Demos

For examples and details on the usage, check the following pages:

Print export

Import

import { GridPrintExportOptions } from '@mui/x-data-grid-premium'
// or
import { GridPrintExportOptions } from '@mui/x-data-grid-pro'
// or
import { GridPrintExportOptions } from '@mui/x-data-grid'

Properties

allColumnsOptional

If true, the hidden columns will also be exported.

Type:boolean

Default:false

bodyClassNameOptional

One or more classes passed to the print window.

Type:string

copyStylesOptional

If false, all <style> and <link type="stylesheet" /> tags from the <head> will not be copied
to the print window.

Type:boolean

Default:true

fieldsOptional

The columns exported.
This should only be used if you want to restrict the columns exports.

Type:string[]

fileNameOptional

The value to be used as the print window title.

Type:string

Default:The title of the page.

getRowsToExportOptional

Function that returns the list of row ids to export in the order they should be exported.

Type:(params: GridPrintGetRowsToExportParams) => GridRowId[]

hideFooterOptional

If true, the footer is removed for when printing.

Type:boolean

Default:false

hideToolbarOptional

If true, the toolbar is removed for when printing.

Type:boolean

Default:false

includeCheckboxesOptional

If true, the selection checkboxes will be included when printing.

Type:boolean

Default:false

pageStyleOptional

Provide Print specific styles to the print window.

Type:string | Function