Freeze columns

This section covers the methods to handle with the spreadsheet freeze columns.

Documentation

The following methods are available to interact with the spreadsheet freeze columns programmatically.

setFreezeColumns

Set the value of the freezeColumns property.

Parameter	Description
`column`	new value.

POST /api/:guid/:worksheetIndex/freeze/columns

Examples

Update the freeze columns configuration

const baseUrl = 'http://localhost:8009/api';
const guid = '79b45919-c751-4e2b-a49a-6c1286e2fc03';
const token = 'eyJhbGciOiJIUzUxMiIsInR5cCJ9.eyJkb21haW4iOiJsb2NhbGhvc3Q6ODAPQSJ9.Xr2Ir2-zEc_tqV5y6i';
const headers = { 'Authorization': `Bearer ${token}` };

// Freeze two columns
await fetch(`${baseUrl}/${guid}/0/freeze/columns`, {
    method: 'POST',
    headers,
    body: new URLSearchParams({
        'column[0]': '2',
        'column[1]': '3',
    }),
});