Interface ISheetHeaderRange<U>

interface ISheetHeaderRange<U> {
    isSheetHeaderRange: true;
    autoFit(options?): void;
    bounds(): RunCoords;
    forEach(visitor, options?): void;
    toString(): string;
    update(values, options?): void;
}

Type Parameters

Hierarchy (view full)

Properties

isSheetHeaderRange

Methods

autoFit bounds forEach toString update

Properties

Readonly isSheetHeaderRange

isSheetHeaderRange: true

Used for runtime reflection.

Methods

autoFit

bounds

forEach

  • forEach(visitor, options?): void

  • Advanced and performant way to iteratively values. This allows for visiting only values that are not empty. Important note If no options for filtering are passed this will not return any values

    Parameters

    Returns void

    Remarks

    • Visitors can return a 'break' value to stop the visit.
    • skipEmpty will ensure that only non-empty cells are visited.
    • getContext().getCell() requires additional work over getCoord or reading value.

toString

update

  • update(values, options?): void

  • Provides a convenient method for setting values with a range of calls.

    Parameters

    Returns void

    Remarks

    If an array is passed the values will be in row-major order and will repeat if the range is larger than the array

Settings

Member Visibility

Theme

On This Page

isSheetHeaderRangeautoFitboundsforEachtoStringupdate