Interface ICellHeader

interface ICellHeader {
    hidden: boolean;
    isCustomFormat: boolean;
    isCustomSize: boolean;
    size: number;
    style: ICellStyle;
    cellTemplate(): ICellModel;
    cloneWithUpdate(update): ICellHeader;
    isEmpty(): boolean;
    isEqual(other): boolean;
    toJSON(): CellHeaderJSON;
}

Hierarchy (view full)

Properties

hidden isCustomFormat isCustomSize size style

Methods

cellTemplate cloneWithUpdate isEmpty isEqual toJSON

Properties

Readonly hidden

hidden: 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

Readonly isCustomFormat

isCustomFormat: boolean

isCustomFormat is a special flag that allows for rows to have normal style and not be cleared.

Readonly 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)

Readonly size

size: number

The size in pixels

Readonly style

style: ICellStyle

The style for the header. Note - This is actually not reflected in the header but rather in all of the cells in this header. For example setting font to bold will bold all of the cell within this span but not the header itself.

Methods

cellTemplate

cloneWithUpdate

isEmpty

  • isEmpty(): boolean

  • If a cell has no value or formatting

    Returns boolean

isEqual

  • isEqual(other): boolean

  • Returns true if the headers are logically equal

    Parameters

    Returns boolean

toJSON

Settings

Member Visibility

Theme

On This Page

hiddenisCustomFormatisCustomSizesizestylecellTemplatecloneWithUpdateisEmptyisEqualtoJSON