Interface ICellHeader

A logic label for an entire span of cells in either direction.

interface ICellHeader {
    get isICellHeader(): true;
    asCell(): ICell;
    createCellHeader(update: ICellHeader.Modifiers): ICellHeader;
    getAxis(): Axis;
    getColumn(): IColumn | null;
    getOutlineLevel(): number;
    getSize(): number;
    getSizeRelative(): number;
    getText(): string;
    isCustomSize(): boolean;
    isEmpty(): boolean;
    isEqual(other: ICellHeader): boolean;
    isHidden(): boolean;
}

Index

Accessors

Methods

asCell createCellHeader getAxis getColumn getOutlineLevel getSize getSizeRelative getText isCustomSize isEmpty isEqual isHidden

Accessors

isICellHeader

get isICellHeader(): true

For runtime introspection.

Returns true

Methods

asCell

asCell(): ICell

Returns the header as an ICell.

Returns ICell

createCellHeader

createCellHeader(update: ICellHeader.Modifiers): ICellHeader
Creates a new detected header from the modifiers.
Parameters
- update: ICellHeader.Modifiers
Returns ICellHeader

getAxis

getAxis(): Axis

Returns the header axis.

Returns Axis

getColumn

getColumn(): IColumn | null

Return an ITable.IColumn if the cell is the the first row of a table range.

Returns IColumn | null

getOutlineLevel

getOutlineLevel(): number

The outline level, 0 to 7. 0 is not grouped; 1 is the outermost group.

Returns number

See
IOutline

getSize

getSize(): number

The absolute size in pixels.

Returns number

getSizeRelative

getSizeRelative(): number

Rows and columns sizes are managed internally as relative size to the normal styling font size. This is done to allow for the sizes to auto adjustment when the style changes.

Returns number

See
https://support.microsoft.com/en-us/office/change-the-column-width-and-row-height-72f5e3cc-994d-43e8-ae58-9774a0905f46

getText

getText(): string

Returns the header text.

Returns string

isCustomSize

isCustomSize(): boolean

Note - size can be a function of autoFitting isCustomSize means the field has set by the user and should not be autoSize due to autoFitting (unless explicitly done so by a user gesture)

Returns boolean

isEmpty

isEmpty(): boolean

If a cell has no sizing or custom formatting.

Returns boolean

isEqual

isEqual(other: ICellHeader): boolean
Returns true if the headers are logically equal.
Parameters
- other: ICellHeader
Returns boolean

isHidden

isHidden(): boolean

Flag to indicate if column is hidden. Note - A column with a size > 0 but hidden is true is valid because when hiding a value we don't change the size so that an unhide will restore to it's previous location

Returns boolean