@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/sheetHeader/ISheetHeader.d.ts

@@ -0,0 +1,217 @@
+import { IRange } from '@sheetxl/primitives';
+import { RunCoords } from '@sheetxl/utils';
+import { ITypes } from '../type';
+import { ITransaction } from '../transaction';
+import { IListener } from '../listener';
+import { ICellHeader } from '../cell';
+import { ICellHeaderRange, ICellHeaderRanges } from '../cellRange';
+import { ISheet } from '../sheet';
+/**
+ * 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.
+ */
+export interface ISheetHeader extends ITransaction.ITransactional, IListener.ISource<ISheetHeader> {
+    /**
+     * Returns the header at a given offset. Will only return null for invalid header offset. To get a list of headers use {@link getRange}.
+     *
+     * @param index 0-based absolute index.
+     */
+    at(index: number): ICellHeader;
+    /**
+     * Returns a displayable title for the given index.
+     *
+     * @param index 0-based absolute index.
+     */
+    getTextAt(index: number): string;
+    /**
+     * Returns a range of cells for the specified range.
+     *
+     * @param address The address or addresses of the header range to retrieve.
+     * @param options Options for retrieving the header ranges.
+     * @see
+     * {@link ICellHeaderRange}
+     */
+    getRange(address: ICellHeaderRange.Address, options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /**
+     * Returns a collection of header ranges for the specified ranges.
+     *
+     * @param address The address or addresses of the header ranges to retrieve.
+     * @param options Options for retrieving the header ranges.
+     */
+    getRanges(address: ICellHeaderRanges.Address, options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRanges;
+    /**
+     * Returns the active header range that is used in the selection.
+     */
+    getSelectedRange(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /**
+     * Returns the active header ranges that are used in the selection.
+     */
+    getSelectedRanges(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRanges;
+    /**
+     * Returns the data ranges for headers that contain information.
+     *
+     * @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
+     * {@link ICellRange.getUsedRange}
+     */
+    getUsedRange(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /**
+     * The entire range for the header.
+     */
+    getEntireRange(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /**
+     * The axis the headers manage.
+     */
+    getAxis(): IRange.Axis;
+    /**
+     * Returns a flag indicating if the headers are protected by the sheet.
+     */
+    isProtected(): boolean;
+    /**
+     * All header sizes are returned in pixels. This is done
+     * by multiplying the scaleFactor by the size on the cellHeader.
+     */
+    getScaleFactor(): number;
+    /**
+     * Returns the offset in pixels for the given header index.
+     * @param index 0-based absolute index.
+     */
+    getOffset(index: number): number;
+    /**
+     * Returns the index for the given header offset in pixels.
+     * @param offset 0-based pixels.
+     */
+    getIndex(offset: number): number;
+    /**
+     * Returns 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.
+     *
+     * @param index 0-based absolute index.
+     * @returns A {@link 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.
+     */
+    getVisibleIndex(index: number): Readonly<RunCoords>;
+    /**
+     * Returns the number of indices visible. Between to indices.
+     * @param indexFrom
+     * @param indexTo
+     */
+    getVisibleCount(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
+     */
+    getSpanSize(indexFrom: number, indexTo?: number): number;
+    /**
+     * The default header size if not adjusted.
+     */
+    getDefaultSize(): number;
+    /**
+     * The default header size in native units.
+     */
+    getDefaultSizeNative(): number;
+    /**
+     * The maximum size of the header in native units.
+     */
+    getMaxSize(): number;
+    /**
+     * The minimum size of the header in native units.
+     */
+    getMinSize(): 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.
+     *
+     * @param index The location to start the search.
+     * @param reverse Indicates if search should scan in reverse. defaults to `false`.
+     * @returns The number of headers following the index.
+     */
+    hiddenHeadersAt(index: number, reverse?: boolean): number;
+    /**
+     * Returns true if any of the headers have the isHidden flag set to true or if any sizes are 0.
+     */
+    hasHidden(): boolean;
+    /**
+     * Returns true if header has a max selection at the given index.
+     */
+    isSelectedAll(index: number): boolean;
+    /**
+     * Returns true if header has a selection at the given index.
+     */
+    isSelected(index: number): boolean;
+    /**
+     * Returns the selected headers as contiguous runs; each run's `value` is `isSelectedAll` (whether
+     * that span is an entire-row/column selection).
+     *
+     * @see {@link IRangeSelection.getSelectedRuns} — the projection this reflects for the primary selection.
+     */
+    getSelectedRuns(): readonly ITypes.RunCoordValue<boolean>[];
+    /**
+     * Sets the headers. This supports setting values as a batch.
+     *
+     * @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.
+     */
+    updateHeaderPairs(pairs: ICellHeaderRange.AddressUpdatePair[], options?: ICellHeaderRange.UpdateHeadersOptions): RunCoords[] | null;
+    /**
+     * Returns the sheet model used for the header.
+     */
+    getSheet(): ISheet;
+    /**
+     * Save the header state to a JSON object.
+     *
+     * @remarks
+     * Returns `null` if there is nothing to persist.
+     */
+    toJSON(): ISheetHeader.JSON | null;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: ISheetHeader.IListeners, options?: IListener.Options): IListener.Remove;
+    close(): void;
+}
+/**
+ * {@inheritDoc ISheetHeader}
+ * @see
+ * ### **Interface**
+ *
+ * {@link ISheetHeader}
+ */
+export declare namespace ISheetHeader {
+    /**
+     * Headers as runs, each addressed as an entire column or row (`'E:H'`, `'5:12'`).
+     *
+     * @remarks
+     * The address carries the orientation, so a row address is read by a column header collection
+     * and the reverse.
+     */
+    interface JSON {
+        headers: IRange.JSONReference<ICellHeader.JSON>[];
+        defaultSize?: number;
+    }
+    interface Events {
+        /**
+         * Called when headers sizes have changed.
+         */
+        onSizesChange?(source: ISheetHeader): void;
+        /**
+         * Called when headers visibility (hidden) has changed.
+         */
+        onHiddenChange?(source: ISheetHeader): void;
+    }
+    interface IListeners extends IListener.Callbacks<ISheetHeader, ISheetHeader.Events> {
+    }
+}
+//# sourceMappingURL=ISheetHeader.d.ts.map

package/types/src/sheetHeader/ISheetHeader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISheetHeader.d.ts","sourceRoot":"","sources":["../../../../src/sheetHeader/ISheetHeader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY,CAAC,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC;IAChG;;;;OAIG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC;IAC/B;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,gBAAgB,CAAC;IAC1G;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,iBAAiB,CAAC;IAC7G;;OAEG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,gBAAgB,CAAC;IAC/E;;OAEG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,iBAAiB,CAAC;IACjF;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,gBAAgB,CAAC;IAC3E;;OAEG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,gBAAgB,CAAC;IAC7E;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC;IACvB;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC;IACvB;;;OAGG;IACH,cAAc,IAAI,MAAM,CAAC;IACzB;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACpD;;;;OAIG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5D;;;;OAIG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzD;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;IACzB;;OAEG;IACH,oBAAoB,IAAI,MAAM,CAAC;IAC/B;;OAEG;IACH,UAAU,IAAI,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,IAAI,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC1D;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACnC;;;;;OAKG;IACH,eAAe,IAAI,SAAS,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5D;;;;;;OAMG;IAEH,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,oBAAoB,GAAG,SAAS,EAAE,GAAG,IAAI,CAAC;IACpI;;OAEG;IACH,QAAQ,IAAI,MAAM,CAAC;IACnB;;;;;OAKG;IACH,MAAM,IAAI,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;IACnC;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;IAEhG,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;;;;GAMG;AACH,yBAAiB,YAAY,CAAC;IAC5B;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB,OAAO,EAAE,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAClD,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,aAAa,CAAC,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;QAC3C;;WAEG;QACH,cAAc,CAAC,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;KAC7C;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC;KAAG;CAC9F"}

package/types/src/sheetHeader/SheetCellHeader.d.ts

@@ -0,0 +1,61 @@
+import { IRange } from '@sheetxl/primitives';
+import { IStyleCollection } from '../style';
+import { ITable } from '../table';
+import { ICell, ICellHeader } from '../cell';
+import { ISheetHeader } from './ISheetHeader';
+import type * as _Utils from './_HeaderUtils';
+export declare class SheetCellHeader implements ICellHeader {
+    protected _sheetHeader: ISheetHeader;
+    protected _index: number;
+    protected _headerState: _Utils.CellHeaderState | null | undefined;
+    protected _template: ICell.Modifiers | null | undefined;
+    private _cellTemplate;
+    private _getColumnAt;
+    constructor(index: number, sheetHeader: ISheetHeader, headerState: _Utils.CellHeaderState | null | undefined, template: ICell.Modifiers | null | undefined, getColumnAt: ((index: number) => ITable.IColumn | null) | undefined);
+    /** {@inheritDoc ICellHeader.getSize} */
+    getSize(): number;
+    /** {@inheritDoc ICellHeader.getText} */
+    getText(): string;
+    /** {@inheritDoc ICellHeader.getAxis} */
+    getAxis(): IRange.Axis;
+    /** {@inheritDoc ICellHeader.isHidden} */
+    isHidden(): boolean;
+    /** {@inheritDoc ICellHeader.isCustomSize} */
+    isCustomSize(): boolean;
+    /** {@inheritDoc ICellHeader.getSheetHeader} */
+    getSheetHeader(): ISheetHeader;
+    /** {@inheritDoc ICell.getColumn} */
+    getColumn(): ITable.IColumn | null;
+    /** {@inheritDoc ICellHeader.asCell} */
+    asCell(): ICell;
+    /** {@inheritDoc ICellHeader.getSizeRelative} */
+    getSizeRelative(): number;
+    /** {@inheritDoc ICellHeader.createCellHeader} */
+    createCellHeader(update: ICellHeader.Modifiers): ICellHeader;
+    /** {@inheritDoc ICellHeader.isEqual} */
+    isEqual(other: ICellHeader): boolean;
+    /** {@inheritDoc ICellHeader.isEmpty} */
+    isEmpty(): boolean;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+    /** {@inheritDoc ICellHeader.isICellHeader} */
+    get isICellHeader(): true;
+}
+/**
+ * Callback for creating custom headers.
+ * Note - Not currently used. Formalize and make public or remove.
+ * @internal
+ */
+export interface CreateCellHeaderCallback {
+    (index: number, headers: ISheetHeader, hs: _Utils.CellHeaderState | null | undefined, template?: ICell.Modifiers | null): ICellHeader;
+}
+/**
+ * Note - Unlike SheetCell.resolveCellModifiers this does not return a ICellHeader.Modifiers.
+ *
+ * It returns a partial State with only the changed values (or null for clear).
+ * This is due to refactoring. Rationalize later.
+ *
+ * @internal
+ */
+export declare function resolveCellHeaderModifiers(sheetHeader: ISheetHeader, styles: IStyleCollection, prevHs: _Utils.CellHeaderState | null | undefined, update: ICellHeader.Update | undefined): _Utils.CellHeaderState | null | undefined;
+//# sourceMappingURL=SheetCellHeader.d.ts.map

package/types/src/sheetHeader/SheetCellHeader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SheetCellHeader.d.ts","sourceRoot":"","sources":["../../../../src/sheetHeader/SheetCellHeader.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAKvD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,KAAK,KAAK,MAAM,MAAM,gBAAgB,CAAC;AAE9C,qBAAa,eAAgB,YAAW,WAAW;IACjD,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC;IACrC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAGzB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAAC;IAClE,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,GAAG,SAAS,CAAC;IAExD,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,YAAY,CAAqE;gBAGvF,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,EACtD,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,GAAG,SAAS,EAC5C,WAAW,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,SAAS;IAWrE,wCAAwC;IACxC,OAAO,IAAI,MAAM;IAKjB,wCAAwC;IACxC,OAAO,IAAI,MAAM;IAIjB,wCAAwC;IACxC,OAAO,IAAI,MAAM,CAAC,IAAI;IAItB,yCAAyC;IACzC,QAAQ,IAAI,OAAO;IAKnB,6CAA6C;IAC7C,YAAY,IAAI,OAAO;IAmBvB,+CAA+C;IAC/C,cAAc,IAAI,YAAY;IAI9B,oCAAoC;IACpC,SAAS,IAAI,MAAM,CAAC,OAAO,GAAG,IAAI;IAIlC,uCAAuC;IACvC,MAAM,IAAI,KAAK;IAYf,gDAAgD;IAChD,eAAe,IAAI,MAAM;IAIzB,iDAAiD;IACjD,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW;IAU5D,wCAAwC;IACxC,OAAO,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAoBpC,wCAAwC;IACxC,OAAO,IAAI,OAAO;IAalB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,QAAQ,IAAI,MAAM;IAIlB,8CAA8C;IAC9C,IAAI,aAAa,IAAI,IAAI,CAExB;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,CACE,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,YAAY,EACrB,EAAE,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,EAC7C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,GAChC,WAAW,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,EACzB,MAAM,EAAE,gBAAgB,EACxB,MAAM,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,EACjD,MAAM,EAAE,WAAW,CAAC,MAAM,GAAG,SAAS,GACrC,MAAM,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAoG3C"}

package/types/src/sheetHeader/SheetCellHeaderRange.d.ts

@@ -0,0 +1,54 @@
+import { IRange } from '@sheetxl/primitives';
+import { RunCoords } from '@sheetxl/utils';
+import { ITransaction } from '../transaction';
+import { ICellHeader } from '../cell';
+import { ICellHeaderRange } from '../cellRange';
+import { CreateCellHeaderCallback } from './SheetCellHeader';
+import { SheetHeader } from './SheetHeader';
+export declare class SheetCellHeaderRange implements ICellHeaderRange {
+    protected _header: any;
+    protected _coords: RunCoords;
+    constructor(header: SheetHeader, coords: RunCoords);
+    protected _forEachSpan<T = any>(callback: ICellHeaderRange.ForEachSpanCallback<T>, optionsVisitor?: ICellHeaderRange.IteratorOptions, createCellHeader?: CreateCellHeaderCallback): T | void;
+    /** {@inheritDoc ICellHeaderRange.forEachSpan} */
+    forEachSpan<T = any>(callback: ICellHeaderRange.ForEachSpanCallback<T>, options?: ICellHeaderRange.IteratorOptions): T | void;
+    /** {@inheritDoc ICellHeaderRange.forEach} */
+    forEach<T>(callback: ICellHeaderRange.ForEachCallback<T>, options?: ICellHeaderRange.IteratorOptions): T | void;
+    /** {@inheritDoc ICellHeaderRange.updateHeaders} */
+    updateHeaders(update: ICellHeader.Update, options?: ICellHeaderRange.UpdateHeadersOptions): this;
+    /** {@inheritDoc ICellHeaderRange.getCoords} */
+    getCoords(): RunCoords;
+    /** {@inheritDoc ICellHeaderRange.getUsedRange} */
+    getUsedRange(options?: ICellHeaderRange.GetRangeOptions): this;
+    /** {@inheritDoc ICellHeaderRange.getCount} */
+    getCount(): number;
+    /** {@inheritDoc ICellHeaderRange.getHeaderCount} */
+    getHeaderCount(): number;
+    /** {@inheritDoc ICellHeaderRange.getVisibleCount} */
+    getVisibleCount(): number;
+    /** {@inheritDoc ICellHeaderRange.isEntireHeaders} */
+    isEntireHeaders(): boolean;
+    /** {@inheritDoc ICellHeaderRange.getSnapshot} */
+    getSnapshot(options?: ICellHeaderRange.CopyOptions): ICellHeaderRange.ISnapshot;
+    /** {@inheritDoc ICellHeaderRange.setSize} */
+    setSize(size?: number | string, options?: ICellHeaderRange.SetSizeOptions): this;
+    /** {@inheritDoc ICellHeaderRange.setHidden} */
+    setHidden(hidden?: boolean, options?: ICellHeaderRange.UpdateHeadersOptions): this;
+    /** {@inheritDoc ICellHeaderRange.clear} */
+    clear(): this;
+    /** {@inheritDoc ICellHeaderRange.at} */
+    at(index: number): ICellHeader;
+    /** {@inheritDoc ICellHeaderRange.getAxis} */
+    getAxis(): IRange.Axis;
+    /** {@inheritDoc ICellHeaderRange.doBatch} */
+    doBatch<R>(callback: (commit: ITransaction.ICommit) => R | Promise<R>, options?: string | ICellHeaderRange.UpdateHeadersOptions): R | Promise<R>;
+    /** {@inheritDoc ICellHeaderRange.getSheetHeader} */
+    getSheetHeader<S>(): S;
+    /** {@inheritDoc ICellHeaderRange.getAddress} */
+    getAddress(r1c1?: boolean): string;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+    /** {@inheritDoc ICellHeaderRange.isICellHeaderRange} */
+    get isICellHeaderRange(): true;
+}
+//# sourceMappingURL=SheetCellHeaderRange.d.ts.map

package/types/src/sheetHeader/SheetCellHeaderRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SheetCellHeaderRange.d.ts","sourceRoot":"","sources":["../../../../src/sheetHeader/SheetCellHeaderRange.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,KAAK,SAAS,EAAK,MAAM,gBAAgB,CAAC;AAGnD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAC;AASrD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAGlE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,qBAAa,oBAAqB,YAAW,gBAAgB;IAC3D,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC;gBACjB,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS;IAKlD,SAAS,CAAC,YAAY,CAAC,CAAC,GAAC,GAAG,EAC1B,QAAQ,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC,EACjD,cAAc,CAAC,EAAE,gBAAgB,CAAC,eAAe,EACjD,gBAAgB,CAAC,EAAE,wBAAwB,GAC1C,CAAC,GAAG,IAAI;IA6BX,iDAAiD;IACjD,WAAW,CAAC,CAAC,GAAC,GAAG,EACf,QAAQ,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC,EACjD,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GACzC,CAAC,GAAG,IAAI;IAIX,6CAA6C;IAC7C,OAAO,CAAC,CAAC,EACP,QAAQ,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,EAC7C,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GACzC,CAAC,GAAG,IAAI;IAyCX,mDAAmD;IACnD,aAAa,CACX,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,OAAO,CAAC,EAAE,gBAAgB,CAAC,oBAAoB,GAC9C,IAAI;IAaP,+CAA+C;IAC/C,SAAS,IAAI,SAAS;IAItB,kDAAkD;IAClD,YAAY,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,eAAe,GAAG,IAAI;IAU9D,8CAA8C;IAC9C,QAAQ,IAAI,MAAM;IAKlB,oDAAoD;IACpD,cAAc,IAAI,MAAM;IAKxB,qDAAqD;IACrD,eAAe,IAAI,MAAM;IAKzB,qDAAqD;IACrD,eAAe,IAAI,OAAO;IAQ1B,iDAAiD;IACjD,WAAW,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,WAAW,GAAG,gBAAgB,CAAC,SAAS;IAI/E,6CAA6C;IAC7C,OAAO,CACL,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE,gBAAgB,CAAC,cAAc,GACxC,IAAI;IAKP,+CAA+C;IAC/C,SAAS,CACP,MAAM,CAAC,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,gBAAgB,CAAC,oBAAoB,GAC9C,IAAI;IAKP,2CAA2C;IAC3C,KAAK,IAAI,IAAI;IAKb,wCAAwC;IACxC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAI9B,6CAA6C;IAC7C,OAAO,IAAI,MAAM,CAAC,IAAI;IAItB,6CAA6C;IAC7C,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC,oBAAoB,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAMhJ,oDAAoD;IACpD,cAAc,CAAC,CAAC,KAAK,CAAC;IAItB,gDAAgD;IAChD,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM;IAWlC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,QAAQ,IAAI,MAAM;IAIlB,wDAAwD;IACxD,IAAI,kBAAkB,IAAI,IAAI,CAE7B;CACF"}

package/types/src/sheetHeader/SheetCellHeaderRanges.d.ts

@@ -0,0 +1,46 @@
+import { IRange } from '@sheetxl/primitives';
+import { RunCoords } from '@sheetxl/utils';
+import { ITransaction } from '../transaction';
+import { ICellHeader } from '../cell';
+import { ICellHeaderRange, ICellHeaderRanges } from '../cellRange';
+import { SheetHeader } from './SheetHeader';
+export declare class SheetCellHeaderRanges implements ICellHeaderRanges {
+    protected _header: any;
+    protected _coords: RunCoords[];
+    constructor(header: SheetHeader, coords: RunCoords[]);
+    /** {@inheritDoc ICellHeaderRanges.updateHeaders} */
+    updateHeaders(update: ICellHeader.Update, options?: ICellHeaderRange.UpdateHeadersOptions): this;
+    /** {@inheritDoc ICellHeaderRanges.getCoords} */
+    getCoords(): RunCoords[];
+    /** {@inheritDoc ICellHeaderRanges.setHidden} */
+    setHidden(hidden: boolean, options?: ICellHeaderRange.UpdateHeadersOptions): this;
+    /** {@inheritDoc ICellHeaderRanges.setSize} */
+    setSize(size: number | string, options?: ICellHeaderRange.SetSizeOptions): this;
+    /** {@inheritDoc ICellHeaderRanges.getCount} */
+    getCount(): number;
+    /** {@inheritDoc ICellHeaderRanges.getHeaderCount} */
+    getHeaderCount(): number;
+    /** {@inheritDoc ICellHeaderRanges.getVisibleCount} */
+    getVisibleCount(): number;
+    /** {@inheritDoc ICellHeaderRanges.isEntireHeaders} */
+    isEntireHeaders(): boolean;
+    /** {@inheritDoc ICellHeaderRanges.isEntireHeaders} */
+    isEntireHeadersAny(): boolean;
+    /** {@inheritDoc ICellHeaderRanges.clear} */
+    clear(): this;
+    /** {@inheritDoc ICellHeaderRanges.at} */
+    at(index: number): ICellHeaderRange;
+    /** {@inheritDoc ICellHeaderRanges.getAxis} */
+    getAxis(): IRange.Axis;
+    /** {@inheritDoc ICellHeaderRanges.doBatch} */
+    doBatch<R>(callback: (commit: ITransaction.ICommit) => R | Promise<R>, options?: string | ICellHeaderRange.UpdateHeadersOptions): R | Promise<R>;
+    /** {@inheritDoc ICellHeaderRanges.getSheetHeader} */
+    getSheetHeader<S>(): S;
+    /** {@inheritDoc ICellHeaderRanges.getAddress} */
+    getAddress(r1c1?: boolean): string;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+    /** {@inheritDoc ICellHeaderRanges.isICellHeaderRanges} */
+    get isICellHeaderRanges(): true;
+}
+//# sourceMappingURL=SheetCellHeaderRanges.d.ts.map

package/types/src/sheetHeader/SheetCellHeaderRanges.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SheetCellHeaderRanges.d.ts","sourceRoot":"","sources":["../../../../src/sheetHeader/SheetCellHeaderRanges.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,KAAK,SAAS,EAAK,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAW7E,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,qBAAa,qBAAsB,YAAW,iBAAiB;IAC7D,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;gBACnB,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE;IAKpD,oDAAoD;IACpD,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,oBAAoB,GAAG,IAAI;IAahG,gDAAgD;IAChD,SAAS,IAAI,SAAS,EAAE;IAIxB,gDAAgD;IAChD,SAAS,CACP,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,gBAAgB,CAAC,oBAAoB,GAC9C,IAAI;IAKP,8CAA8C;IAC9C,OAAO,CACL,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,CAAC,EAAE,gBAAgB,CAAC,cAAc,GACxC,IAAI;IAKP,+CAA+C;IAC/C,QAAQ,IAAI,MAAM;IAIlB,qDAAqD;IACrD,cAAc,IAAI,MAAM;IAWxB,sDAAsD;IACtD,eAAe,IAAI,MAAM;IAYzB,sDAAsD;IACtD,eAAe,IAAI,OAAO;IAc1B,sDAAsD;IACtD,kBAAkB,IAAI,OAAO;IAc7B,4CAA4C;IAC5C,KAAK,IAAI,IAAI;IAKb,yCAAyC;IACzC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB;IAOnC,8CAA8C;IAC9C,OAAO,IAAI,MAAM,CAAC,IAAI;IAItB,8CAA8C;IAC9C,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,OAAO,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC,oBAAoB,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAMhJ,qDAAqD;IACrD,cAAc,CAAC,CAAC,KAAK,CAAC;IAItB,iDAAiD;IACjD,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM;IAOlC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,QAAQ,IAAI,MAAM;IAIlB,0DAA0D;IAC1D,IAAI,mBAAmB,IAAI,IAAI,CAE9B;CACF"}

package/types/src/sheetHeader/SheetHeader.d.ts

@@ -0,0 +1,257 @@
+import { IRange } from '@sheetxl/primitives';
+import { RunCoords } from '@sheetxl/utils';
+import { ITypes } from '../type';
+import { ITransaction } from '../transaction';
+import { IListener } from '../listener';
+import { ICellHeader } from '../cell';
+import { ITable } from '../table';
+import { ICellHeaderRange, ICellHeaderRanges } from '../cellRange';
+import { IRangeSelection } from '../selection';
+import { ISheet } from '../sheet';
+import { ISheetHeader } from './ISheetHeader';
+import { ListenerEmitter } from '../listener/ListenerEmitter';
+import { CreateCellHeaderCallback } from './SheetCellHeader';
+import * as RunUtils from '../collections/_RunUtils';
+import * as _Utils from './_HeaderUtils';
+/**
+ * For updating and working with headers (rows/columns).
+ */
+export declare class SheetHeader implements ISheetHeader {
+    protected _emitter: ListenerEmitter<ISheetHeader, ISheetHeader.IListeners>;
+    protected _options: ResolvedConstructorOptions;
+    protected _sheetRemoveListener: IListener.Remove;
+    protected _transactions: ITransaction.IStore;
+    protected _transactionsRemoveListener: IListener.Remove;
+    protected _id: string;
+    protected _closed: boolean;
+    protected _emptyHeader: ICellHeader;
+    protected _scaleFactor: number;
+    protected _defaultSize: number;
+    protected _defaultCustomSize: number;
+    protected _defaultPxSize: number;
+    protected _isColumn: boolean;
+    protected _indexedSizes: readonly _Utils.RunningHeaderSize[];
+    protected _indexedHidden: _Utils.IndexedRun[];
+    protected _headerRunCoords: RunCoords | null;
+    protected _hasHidden: boolean;
+    protected _hiddenSignature: number;
+    protected _lastHeaderRead: {
+        offset: number;
+        header: ICellHeader;
+    } | null;
+    protected _readCache: RunUtils.CacheSearchRunData<_Utils.CellHeaderState> | null;
+    protected _lastHeaders: ITypes.RunCoordValue<_Utils.CellHeaderState>[] | null;
+    protected _lastVisibleRunsRead: number | null;
+    protected _lastVisibleRunCoords: RunCoords | null;
+    protected _entireRunMax: number;
+    protected _entireHeaderRange: ICellHeaderRange;
+    protected _entireRunCoords: RunCoords;
+    protected _entireRangeCoords: IRange.Coords;
+    protected _entireSheetCoords: IRange.Coords;
+    protected _selectionRuns: readonly ITypes.RunCoordValue<boolean>[] | null;
+    protected _selection: IRangeSelection.Coords;
+    constructor(options: SheetHeader.ConstructorOptions);
+    /** {@inheritDoc IListener.ISource.addListeners} */
+    addListeners(listeners: ISheetHeader.IListeners, options?: IListener.Options): IListener.Remove;
+    protected _invalidateMaxIndex(): void;
+    protected _invalidSizes(force?: boolean): void;
+    /**
+     * Force the header to re-read configurations.
+     *
+     * @remarks
+     * This exists to support loading after the sheet view.
+     *
+     * @internal
+     */
+    invalidate(): void;
+    protected _onHeaderChange(sizeUpdate: boolean): void;
+    /** {@inheritDoc ISheetHeader.getSheet} */
+    getSheet(): ISheet;
+    /** {@inheritDoc ISheetHeader.getAxis} */
+    getAxis(): IRange.Axis;
+    /** {@inheritDoc ISheetHeader.getTextAt} */
+    getTextAt(index: number): string;
+    protected _scanHeaders<T = any>(callback: ICellHeaderRange.ForEachSpanCallback<T>, headerState: State, createCellHeader: CreateCellHeaderCallback, optionsRange: ICellHeaderRange.GetRangeOptions | null, asRun: RunCoords, options: ICellHeaderRange.IteratorOptions): {
+        break: T;
+    } | void;
+    /** {@inheritDoc ISheetHeader.getRange} */
+    getRange(address: ICellHeaderRange.Address, options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /** {@inheritDoc ISheetHeader.getRanges} */
+    getRanges(address: ICellHeaderRanges.Address, options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRanges;
+    /** {@inheritDoc ISheetHeader.getSelectedRange} */
+    getSelectedRange(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /** {@inheritDoc ISheetHeader.getSelectedRanges} */
+    getSelectedRanges(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRanges;
+    /** {@inheritDoc ISheetHeader.getUsedRange} */
+    getUsedRange(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /** {@inheritDoc ISheetHeader.getEntireRange} */
+    getEntireRange(options?: ICellHeaderRange.GetRangeOptions): ICellHeaderRange;
+    /** {@inheritDoc ISheetHeader.at} */
+    at(index: number): ICellHeader;
+    /** {@inheritDoc ISheetHeader.updateHeaderPairs} */
+    updateHeaderPairs(pairs: ICellHeaderRange.AddressUpdatePair[], options?: ICellHeaderRange.UpdateHeadersOptions): RunCoords[] | null;
+    protected _parseHeaderRangeAddress(address: ICellHeaderRange.Address | undefined, r1c1?: boolean): RunCoords;
+    protected _update(addresses: ICellHeaderRange.Address | ICellHeaderRange.Address[], update: ICellHeader.Update, options?: ICellHeaderRange.UpdateHeadersOptions): this | undefined;
+    protected _setSize(address: ICellHeaderRange.Address | ICellHeaderRange.Address[], size?: number | string | null, options?: ICellHeaderRange.SetSizeOptions): this;
+    protected _setHidden(address: ICellHeaderRange.Address | ICellHeaderRange.Address[], hidden?: boolean | null, options?: ICellHeaderRange.UpdateHeadersOptions): this;
+    protected _clear(coords: RunCoords, options?: ICellHeaderRange.UpdateHeadersOptions): void;
+    protected _getSnapshot(coordsFrom: RunCoords, optionsMark?: ICellHeaderRange.CopyOptions): ICellHeaderRange.ISnapshot;
+    /** {@inheritDoc ISheetHeader.isProtected} */
+    isProtected(): boolean;
+    /** {@inheritDoc ISheetHeader.getScaleFactor} */
+    getScaleFactor(): number;
+    protected get _headers(): ITypes.RunCoordValue<_Utils.CellHeaderState>[];
+    protected _updatePairsInternal(setters: ICellHeaderRange.AddressUpdatePair[], options?: ICellHeaderRange.UpdateHeadersOptions): RunCoords[] | null;
+    /** {@inheritDoc ISheetHeader.hasHidden} */
+    hasHidden(): boolean;
+    /** {@inheritDoc ISheetHeader.getDefaultSize} */
+    getDefaultSize(): number;
+    /** {@inheritDoc ISheetHeader.getDefaultSizeNative} */
+    getDefaultSizeNative(): number;
+    /** {@inheritDoc ISheetHeader.getMaxSize} */
+    getMaxSize(): number;
+    /** {@inheritDoc ISheetHeader.getMinSize} */
+    getMinSize(): number;
+    /** {@inheritDoc ISheetHeader.getOffset} */
+    getOffset(index: number): number;
+    /** {@inheritDoc ISheetHeader.getIndex} */
+    getIndex(offset: number): number;
+    /** {@inheritDoc ISheetHeader.getVisibleIndex} */
+    getVisibleIndex(index: number): RunCoords;
+    /** {@inheritDoc ISheetHeader.getSpanSize} */
+    getSpanSize(indexFrom: number, indexTo?: number): number;
+    /** {@inheritDoc ISheetHeader.getVisibleCount} */
+    getVisibleCount(indexFrom: number, indexTo: number): number;
+    /** {@inheritDoc ISheetHeader.isSelectedAll} */
+    isSelectedAll(index: number): boolean;
+    /** {@inheritDoc ISheetHeader.isSelected} */
+    isSelected(index: number): boolean;
+    /** {@inheritDoc ISheetHeader.getSelectedRuns} */
+    getSelectedRuns(): readonly ITypes.RunCoordValue<boolean>[];
+    /** {@inheritDoc ISheetHeader.hiddenHeadersAt} */
+    hiddenHeadersAt(index: number, reverse?: boolean): number;
+    protected _insertHeaders(index: number, amount: number): void;
+    protected _deleteHeaders(index: number, amount: number): void;
+    /** {@inheritDoc ITransaction.ITransactional.beginCommit} */
+    beginCommit(options?: string | ITransaction.OperationOptions): ITransaction;
+    /** {@inheritDoc ITransaction.ITransactional.doBatch} */
+    doBatch<R>(callback: (commit: ITransaction.ICommit) => R | Promise<R>, options?: string | ITransaction.OperationOptions): R | Promise<R>;
+    /** {@inheritDoc ITransaction.ITransactional.getId} */
+    getId(): string;
+    /** {@inheritDoc ITransaction.ITransactional.getVersionId} */
+    getVersionId(): number;
+    /** {@inheritDoc ITransaction.ITransactional.isClosed} */
+    isClosed(): boolean;
+    /** {@inheritDoc ISheetHeader.close} */
+    close(): void;
+    protected _getState(): State;
+    protected _beginCommit(options?: ITransaction.StoreOperationOptions): ITransaction;
+    protected _updateState(updateState: Partial<State>, sizeUpdate?: boolean): void;
+    /** {@inheritDoc ISheetHeader.fromJSON} */
+    fromJSON(json?: ISheetHeader.JSON): void;
+    /** {@inheritDoc ISheetHeader.toJSON} */
+    toJSON(): ISheetHeader.JSON | null;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+/**
+ * {@inheritDoc SheetHeader}
+ * @see
+ * ### **Interface**
+ *
+ * {@link SheetHeader}
+ */
+export declare namespace SheetHeader {
+    /**
+     * Constructor Options for Sheet Header.
+     *
+     * @remarks
+     * Used by `Sheet`.
+     */
+    interface ConstructorOptions {
+        /**
+         * The {@link ISheet} containing the Headers.
+         */
+        sheet: ISheet;
+        /**
+         * The axis of the data.
+         *
+         * @defaultValue IRange.Axis.Column
+         *
+         * @remarks
+         * This is the opposite of the axis of the layout. For examples a header that manages
+         * columns will be visibility orientated as a row.
+         */
+        axis?: IRange.Axis;
+        createCellHeader?: CreateCellHeaderCallback;
+        transactions?: ITransaction.IStore;
+        /**
+         * If true the Header will error if any updates are attempted.
+         */
+        isProtected?: () => boolean;
+        /**
+         * Return the display text at the given index.
+         */
+        getTextAt?: (index: number) => string;
+        /**
+         * The size of the header without any customizations.
+         *
+         * @defaultValue 100
+         *
+         * @remarks
+         * Must be great than 0.
+         */
+        defaultSize?: () => number;
+        /**
+         * The minimum size of the header.
+         *
+         * @defaultValue 0
+         *
+         * @remarks
+         * Must be great than or equal 0.
+         */
+        minSize?: () => number;
+        maxSize?: () => number;
+        /**
+         * A callback to return the maximum index of the header.
+         */
+        getEntireSheetCoords?: () => IRange.Coords | null;
+        /**
+         * A number that represents a scaling factor.
+         */
+        scaleFactor?: () => number;
+        /**
+         * A callback to return the column filter at a given index.
+         */
+        getColumnAt?: (index: number) => ITable.IColumn | null;
+        /**
+         * A callback to tell the headers to shift.
+         *
+         * @param index
+         * @param amount
+         */
+        setContainerShiftedCallback?: (callback: ShiftCallback) => void;
+        /**
+         * JSON state to load.
+         */
+        json?: ISheetHeader.JSON;
+    }
+    /**
+     * `Sheet`s manage the insertion and deletion of headers. To notify that this
+     * should occur the ShiftCallback is used.
+     */
+    interface ShiftCallback {
+        (index: number, amount: number): void;
+    }
+}
+/**
+ * {@link SheetHeader.ConstructorOptions} with the keys that are defaulted in the
+ * constructor guaranteed to be present.
+ */
+type ResolvedConstructorOptions = SheetHeader.ConstructorOptions & Required<Pick<SheetHeader.ConstructorOptions, 'isProtected' | 'scaleFactor' | 'defaultSize' | 'minSize' | 'maxSize' | 'getEntireSheetCoords' | 'axis' | 'createCellHeader'>>;
+interface State {
+    headers: ITypes.RunCoordValue<_Utils.CellHeaderState>[];
+    defaultCustomSize: number;
+}
+export {};
+//# sourceMappingURL=SheetHeader.d.ts.map