React Data GridExcel Export - Data Protection

Excel Export allows you to protect the exported worksheet so that users can only edit specific cells.

Data Protection Copy Link

Excel has two layers of protection:

1. Cell Protection controls whether a cell is locked and whether a formula is hidden (ExcelStyle.protection).
2. Worksheet Protection enables enforcement of the locked/unlocked cell states (ExcelExportParams.protectSheet).

Enable worksheet protection by setting protectSheet in the Excel Export Params (or in defaultExcelExportParams):

const defaultExcelExportParams = useMemo(() => { 
	return {
        protectSheet: true
    };
}, []);

<AgGridReact defaultExcelExportParams={defaultExcelExportParams} />

Worksheet Custom Protection Copy Link

To allow specific actions, or to require a password to unprotect the sheet, provide an ExcelSheetProtection config object:

const defaultExcelExportParams = useMemo(() => { 
	return {
        protectSheet: {
            password: 'secret',
            autoFilter: true,
            formatCells: true
        }
    };
}, []);

<AgGridReact defaultExcelExportParams={defaultExcelExportParams} />

Unlocking Cells Copy Link

When worksheet protection is enabled, all exported cells are locked by default. To unlock specific cells or columns, configure an Excel style with protection.protected = false and apply that style via cellClass / cellClassRules:

const [columnDefs, setColumnDefs] = useState([
    { field: 'athlete', cellClass: 'unlocked' },
    { field: 'country', cellClass: 'unlocked' }
]);
const excelStyles = useMemo(() => { 
	return [
        {
            id: 'unlocked',
            protection: { protected: false, hideFormula: false }
        }
    ];
}, []);
const defaultExcelExportParams = useMemo(() => { 
	return {
        protectSheet: true
    };
}, []);

<AgGridReact
    columnDefs={columnDefs}
    excelStyles={excelStyles}
    defaultExcelExportParams={defaultExcelExportParams}
/>

Interfaces Copy Link

ExcelExportParams Copy Link

interface ExcelExportParams {
    // ...
    protectSheet?: boolean | ExcelSheetProtection;
}

ExcelSheetProtection Copy Link

ExcelStyle Copy Link

interface ExcelStyle {
    // ...
    protection?: ExcelProtection;
}

ExcelProtection Copy Link

Next Up Copy Link

Continue to the next section: API Reference.