Add Listeners.
Optionaloptions: IListener.OptionsReturns the header at a given offset. Will only return null for invalid header offset. To get a list of headers use getRange.
0-based absolute index.
Batches all 'transactional' changes until they have all be committed or rolled back.
Optionaloptions: string | ITransaction.OperationOptions
Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.
Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.
Close the record and cleans resources. Can't be undone.
Provides a mechanism to perform a set of operations in a batch.
A callback that performs multiple operations all within the same transaction.
Optionaloptions: string | ITransaction.OperationOptions
Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
The axis the headers manage.
The default header size in native units.
The entire range for the header.
Optionaloptions: ICellHeaderRange.GetRangeOptionsReturns the ranges of headers a filter holds a condition over: on the row axis, the data rows of the AutoTable and of every table whose ITable.getActiveFilters is not empty; on the column axis none, as nothing filters columns.
Optionalcoords: Readonly<RunCoords>
Only the ranges that meet this run, when given (a viewport).
A sheet with any is "filtered", as Excel has it: SUBTOTAL 1-11 leave out every hidden row
of a filtered sheet, hand-hidden ones included, and count them all on an unfiltered one; the
visible headers of these ranges are the ones drawn as filtered. A condition counts whether
or not it hides a row.
A row hidden by hand and a row hidden by a filter are the same hidden row; nothing records which, and clearing a filter shows both (ITable.deleteFilters).
A unique identifier for the record. This will never change.
This enables the record to be identified across transactions and users in a collaborative environment. The id is store-issued (IStore.create); the store keys all state by it.
The maximum size of the header in native units.
Returns the header's measurements: pixel sizes, offsets and hidden headers, as they are now.
The returned object does not change. The header returns the same object until a measurement changes, then a new one, announced by ISheetHeader.Events.onMetricsChange. Hold on to it to keep measuring against one consistent layout; compare identities to tell whether anything moved. Calling this repeatedly is cheap.
The minimum size of the header in native units.
Returns a range of cells for the specified range.
The address or addresses of the header range to retrieve.
Optionaloptions: ICellHeaderRange.GetRangeOptions
Options for retrieving the header ranges.
Returns a collection of header ranges for the specified ranges.
The address or addresses of the header ranges to retrieve.
Optionaloptions: ICellHeaderRange.GetRangeOptions
Options for retrieving the header ranges.
Returns the active header range that is used in the selection.
Optionaloptions: ICellHeaderRange.GetRangeOptionsReturns the active header ranges that are used in the selection.
Optionaloptions: ICellHeaderRange.GetRangeOptionsReturns the selected headers as contiguous runs; each run's value is isSelectedAll (whether
that span is an entire-row/column selection).
IRangeSelection.getSelectedRuns — the projection this reflects for the primary selection.
Returns the sheet model used for the header.
Returns a displayable title for the given index.
0-based absolute index.
Returns the data ranges for headers that contain information.
Optionaloptions: ICellHeaderRange.GetRangeOptionsEvery committed update gives the record a new, strictly increasing version id.
Used with getId to uniquely identify a version of the record.
The id is an identity, not a per-record count: ids are drawn from a single store-wide sequence bumped once per commit, so all records written in the same commit share an id and a given record's ids increase but are not sequential.
Records are immutable so a restore/revert doesn't change them — it repoints, and the version id reported is the one for the snapshot the store is currently at. Version ids are never reused: a write after an undo receives an id higher than any previously issued, so a stale reader can always detect the change.
Returns true if no more operations are allowed.
Returns a flag indicating if the headers are protected by the sheet.
Returns true if header has a selection at the given index.
Returns true if header has a max selection at the given index.
Save the header state to a JSON object.
Sets the headers. This supports setting values as a batch.
Optionaloptions: UpdateHeadersOptions
Provides a programmatic interface for interacting with and modifying entire rows or columns in a spreadsheet, allowing for actions such as inserting, deleting, resizing, and applying formatting changes.