Freeze rows

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

Documentation

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

setFreezeRows

Set the value of the freezeRows property.

Parameter	Description
`row`	new value.

POST /api/:guid/:worksheetIndex/freeze/rows

Examples

Update the freeze rows 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 rows
await fetch(`${baseUrl}/${guid}/0/freeze/rows`, {
    method: 'POST',
    headers,
    body: new URLSearchParams({
        'row[0]': '1',
        'row[1]': '2',
    }),
});