Interface ISheetHeader

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.

interface ISheetHeader {
    addListeners(listeners: IListeners, options?: IListener.Options): Remove;
    at(index: number): ICellHeader;
    beginCommit(options?: string | OperationOptions): ITransaction;
    close(): void;
    doBatch<R = any>(
        callback: (commit: ICommit) => R | Promise<R>,
        options?: string | OperationOptions,
    ): R | Promise<R>;
    findIndex(offset: number): number;
    findOffset(index: number): number;
    findVisibleIndex(index: number): Readonly<RunCoords>;
    fromJSON(json: ISheetHeader.JSON): void;
    getDefaultSize(): number;
    getEntireRange(options?: GetRangeOptions): ICellHeaderRange;
    getMaxSize(): number;
    getMinSize(): number;
    getOrientation(): IRange.Orientation;
    getRange(
        address: ICellHeaderRange.Address,
        options?: GetRangeOptions,
    ): ICellHeaderRange;
    getScaleFactor(): number;
    getSelectedRange(options?: GetRangeOptions): ICellHeaderRange;
    getSelectedRuns(): readonly RunCoordValue<SelectedRun>[];
    getSheet(): ISheet;
    getSpanSize(indexFrom: number, indexTo?: number): number;
    getTextAt(index: number): string;
    getUsedRange(options?: GetRangeOptions): ICellHeaderRange;
    getUUID(): string;
    getVisibleCount(indexFrom: number, indexTo: number): number;
    hasHidden(): boolean;
    hiddenHeadersAt(index: number, reverse?: boolean): number;
    isClosed(): boolean;
    isProtected(): boolean;
    isSelected(index: number): boolean;
    isSelectedAll(index: number): boolean;
    setHidden(
        address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[],
        hidden?: boolean,
    ): this;
    setSize(
        address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[],
        size?: string | number,
        options?: SetSizeOptions,
    ): this;
    toJSON(): ISheetHeader.JSON;
    update(
        address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[],
        update: ICellHeader.Update,
        options?: UpdateHeadersOptions,
    ): this;
    updateHeaderPairs(
        pairs: AddressUpdatePair[],
        options?: UpdateHeadersOptions,
    ): RunCoords[];
}

Hierarchy (View Summary)

ITransactional
- ISheetHeader

Methods

addListeners

addListeners(listeners: IListeners, options?: IListener.Options): Remove
Add Listeners.
Parameters
- listeners: IListeners
- Optionaloptions: IListener.Options
Returns Remove
See
IListener.ISource.addListeners

Overrides IListener.ISource.addListeners

at

at(index: number): ICellHeader
Returns the header at a given offset. Will only return null for invalid header offset. To get a list of headers use getRange.
Parameters
- index: number
  0-based absolute index.
Returns ICellHeader

beginCommit

beginCommit(options?: string | OperationOptions): ITransaction
Batches all 'transactional' changes until they have all be committed or rolled back.
Parameters
- Optionaloptions: string | OperationOptions
  Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns ITransaction
Remarks
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.

Inherited from ITransactional.beginCommit

close

close(): void
Close the record and cleans resources. Can't be undone.

Returns void
Overrides ITransactional.close

doBatch

doBatch<R = any>(
callback: (commit: ICommit) => R | Promise<R>,
options?: string | OperationOptions,
): R | Promise<R>
Provides a mechanism to perform a set of operations in a batch.
Type Parameters
- R = any
Parameters
- callback: (commit: ICommit) => R | Promise<R>
  A callback that performs multiple operations all within the same transaction.
- Optionaloptions: string | OperationOptions
  Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns R | Promise<R>
Inherited from ITransactional.doBatch

findIndex

findIndex(offset: number): number
Finds the index for the given header offset in pixels.
Parameters
- offset: number
  0-based pixels.
Returns number

findOffset

findOffset(index: number): number
Finds the offset in pixels for the given header index
Parameters
- index: number
  0-based absolute index.
Returns number

findVisibleIndex

findVisibleIndex(index: number): Readonly<RunCoords>
Finds the visibleIndex for a given absolute index.
- If it's hidden it will return a range of 1 with a value before the offset and after.
- If it's visible then it will return a range of 0 with the min and max that exactly match the offset.
Parameters
- index: number
  0-based absolute index.
Returns Readonly<RunCoords>
A RunCoords that can be used to determine if an index is hidden.

Remarks
If this is on the edge of the bounds this will return a +/- 1 the max bounds.

fromJSON

fromJSON(json: ISheetHeader.JSON): void
Load the ISheetHeader.JSON state into the header. The current state will be lost.
Parameters
- json: ISheetHeader.JSON
Returns void
Deprecated
- Should be added to constructor.

getDefaultSize

getDefaultSize(): number
The default header size if not adjusted.

Returns number

getEntireRange

getEntireRange(options?: GetRangeOptions): ICellHeaderRange
The entire range for the header.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellHeaderRange

getMaxSize

getMaxSize(): number
The maximum size of the header in native units.

Returns number

getMinSize

getMinSize(): number
The minimum size of the header in native units.

Returns number

getOrientation

getOrientation(): IRange.Orientation
The orientation the headers manage.

Returns IRange.Orientation

getRange

getRange(
address: ICellHeaderRange.Address,
options?: GetRangeOptions,
): ICellHeaderRange
Returns a range of cells for the specified range.
Parameters
- address: ICellHeaderRange.Address
- Optionaloptions: GetRangeOptions
Returns ICellHeaderRange
See
ICellHeaderRange

getScaleFactor

getScaleFactor(): number
All header sizes are returned in pixels. This is done by multiplying the scaleFactor by the size on the cellHeader.

Returns number

getSelectedRange

getSelectedRange(options?: GetRangeOptions): ICellHeaderRange
Returns the actives that are used in the selection.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellHeaderRange

getSelectedRuns

getSelectedRuns(): readonly RunCoordValue<SelectedRun>[]
Returns a list of SelectedRuns.

Returns readonly RunCoordValue<SelectedRun>[]

getSheet

getSheet(): ISheet
Returns the sheet model used for the header.

Returns ISheet

getSpanSize

getSpanSize(indexFrom: number, indexTo?: number): number
Returns the size of the header in pixels. If a second argument is passed it will be the size of all the headers within the range. Note - It is expected that indexFrom will always be less than or equal to indexTo
Parameters
- indexFrom: number
- OptionalindexTo: number
Returns number

getTextAt

getTextAt(index: number): string
Returns a displayable title for the given index.
Parameters
- index: number
  0-based absolute index.
Returns string

getUsedRange

getUsedRange(options?: GetRangeOptions): ICellHeaderRange
Returns the data ranges for headers that contain information.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellHeaderRange
Remarks
- This is NOT the last cell that may have data or has been resized.
- This also has nothing to do with the selection bounds.
See
ICellRange.getUsedRange

`Optional`getUUID

getUUID(): string
A unique identifier for the record. This will never change.

Returns string
Remarks
This enables the record to be identified across transactions and users in a collaborative environment.

Inherited from ITransactional.getUUID

getVisibleCount

getVisibleCount(indexFrom: number, indexTo: number): number
Returns the number of indices visible. Between to indices.
Parameters
- indexFrom: number
- indexTo: number
Returns number

hasHidden

hasHidden(): boolean
Returns true if any of the headers have the isHidden flag set to true or if any sizes are 0.

Returns boolean

hiddenHeadersAt

hiddenHeadersAt(index: number, reverse?: boolean): number
This is a very specific optimization function. When hiding many headers instead of scanning we can just skip. If 0 is returned then there are no hidden headers immediately following this one. If 1 is returned then only this header is hidden.
Parameters
- index: number
  The location to start the search.
- Optionalreverse: boolean
  Indicates if search should scan in reverse. defaults to false.
Returns number
The number of headers following the index.

isClosed

isClosed(): boolean
Returns true if no more operations are allowed.

Returns boolean
Inherited from ITransactional.isClosed

isProtected

isProtected(): boolean
Returns a flag indicating if the headers are protected by the sheet.

Returns boolean

isSelected

isSelected(index: number): boolean
Returns true if header has a selection at the given index.
Parameters
- index: number
Returns boolean

isSelectedAll

isSelectedAll(index: number): boolean
Returns true if header has a max selection at the given index.
Parameters
- index: number
Returns boolean

setHidden

setHidden(
address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[],
hidden?: boolean,
): this
Parameters
- address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[]
- Optionalhidden: boolean
Returns this
See
ICellHeaderRange.setHidden

setSize

setSize(
    address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[],
    size?: string | number,
    options?: SetSizeOptions,
): this
Parameters
- address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[]
- Optionalsize: string | number
- Optionaloptions: SetSizeOptions
Returns this
See
ICellHeaderRange.setSize

toJSON

toJSON(): ISheetHeader.JSON
Save the header state to a JSON object.

Returns ISheetHeader.JSON

update

update(
    address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[],
    update: ICellHeader.Update,
    options?: UpdateHeadersOptions,
): this
Bulk update api.
Parameters
- address: ICellHeaderRange.Address | readonly ICellHeaderRange.Address[]
- update: ICellHeader.Update
- Optionaloptions: UpdateHeadersOptions
Returns this
Remarks
This only supports one range at a time but offers a few flavors
- update(5, { size: '100px' }); // 0-based index
- update({ min: 3, max: 4 }, { size: '100px' }); // 0-based index
- update('e:f', { size: '100px' }); // 1-based a1 style
- update({ colStart: 3, colEnd: 4 }, { size: '100px' }); // 0-based index
- update('5:7', { size: '100px' }); // 1-based a1 style
- update({ rowStart: 3, rowEnd: 4 }, { size: '100px' }); // 0-based index

updateHeaderPairs

updateHeaderPairs(
pairs: AddressUpdatePair[],
options?: UpdateHeadersOptions,
): RunCoords[]
Sets the headers. This supports setting values as a batch.
Parameters
- pairs: AddressUpdatePair[]
- Optionaloptions: UpdateHeadersOptions
Returns RunCoords[]
Remarks
When setting headers the cells references by this sheet will not update. To ensure they are updated on the sheet call updateHeaderPairs with the range from the header.

Interface ISheetHeader

Hierarchy (View Summary)

Index

Methods

Methods

addListeners

Parameters

Returns Remove

See

at

Parameters

Returns ICellHeader

beginCommit

Parameters

Returns ITransaction

Remarks

close

Returns void

doBatch

Type Parameters

Parameters

Returns R | Promise<R>

findIndex

Parameters

Returns number

findOffset

Parameters

Returns number

findVisibleIndex

Parameters

Returns Readonly<RunCoords>

Remarks

fromJSON

Parameters

Returns void

Deprecated

getDefaultSize

Returns number

getEntireRange

Parameters

Returns ICellHeaderRange

getMaxSize

Returns number

getMinSize

Returns number

getOrientation

Returns IRange.Orientation

getRange

Parameters

Returns ICellHeaderRange

See

getScaleFactor

Returns number

getSelectedRange

Parameters

Returns ICellHeaderRange

getSelectedRuns

Returns readonly RunCoordValue<SelectedRun>[]

getSheet

Returns ISheet

getSpanSize

Parameters

Returns number

getTextAt

Parameters

Returns string

getUsedRange

Parameters

Returns ICellHeaderRange

Remarks

See

OptionalgetUUID

Returns string

Remarks

getVisibleCount

Parameters

Returns number

hasHidden

Returns boolean

hiddenHeadersAt

`Optional`getUUID