Interface ICellHeader

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

interface ICellHeader {
    get isICellHeader(): true;
    asCell(): ICell;
    createTemporaryCellHeader(update: ICellHeader.Modifiers): ICellHeader;
    getDisplayText(): string;
    getOrientation(): IRange.Orientation;
    getSize(): number;
    getSizeRelative(): number;
    getStyle(): IStyle;
    isCustomSize(): boolean;
    isEmpty(): boolean;
    isEqual(other: ICellHeader): boolean;
    isHidden(): boolean;
}

Index

Accessors

Methods

asCell createTemporaryCellHeader getDisplayText getOrientation getSize getSizeRelative getStyle 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

createTemporaryCellHeader

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

getDisplayText

getDisplayText(): string
Returns the header display.

Returns string

getOrientation

getOrientation(): IRange.Orientation
Returns orientation for the header.

Returns IRange.Orientation

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

getStyle

getStyle(): IStyle
The style for the header.

Returns IStyle
Remarks
This represents a default style for the entire span. It generally is not used for formatting the header itself.

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