Excel Export allows you to configure the page settings for the exported Excel file.
Page Setup
You can customise the Excel export page settings such as page size, orientation, and margin, using the pageSetup
and margins
configs of the Excel Export Params. These settings are visible when printing the exported Excel file or exporting to PDF.
<ag-grid-vue
:defaultExcelExportParams="defaultExcelExportParams"
/* other grid options ... */>
</ag-grid-vue>
this.defaultExcelExportParams = {
pageSetup: {
orientation: 'Landscape',
pageSize: 'A3'
},
margins: {
top: 1,
right: 1,
bottom: 1,
left: 1,
header: 0.5,
footer: 0.5,
}
};
The value of the margins must be provided in inches
.
Note the following:
- The sample below allow you to configure the page size, orientation and margin values.
- Page size and orientation are stored in the
pageSetup
object. - Margin values are stored in the
margins
object.
Interfaces
ExcelExportParams
interface ExcelExportParams {
// ...
margins?: ExcelSheetMargin;
pageSetup?: ExcelSheetPageSetup
}
ExcelSheetMargin
Properties available on the ExcelSheetMargin
interface.
The sheet top margin. |
The sheet right margin. |
The sheet bottom margin. |
The sheet left margin. |
The sheet header margin. |
The sheet footer margin. |
ExcelSheetPageSetup
Properties available on the ExcelSheetPageSetup
interface.
Use this property to change the print orientation. |
Use this property to set the sheet size. |