Interface ICellHeaderRanges

ReadonlyisICellHeaderRanges

at

• at(index: number): ICellHeaderRange

  Returns the header range at a location relative to the range.

  Parameters

  • index: number

  Returns ICellHeaderRange

clear

• clear(): this

  Clear the header format. Specially this will clear the sizes.

  Returns this

doBatch

• doBatch<R>(
      callback: (commit: ICommit) => R | Promise<R>,
      options?: string | UpdateHeadersOptions,
  ): R | Promise<R>

  Perform operation on all ranges.

  Type Parameters

  • R

  Parameters

  • callback: (commit: ICommit) => R | Promise<R>
  • Optionaloptions: string | UpdateHeadersOptions

  Returns R | Promise<R>

getAddress

• getAddress(r1c1?: boolean): string

  Returns the coords as a string address (e.g., 'A1' or 'A1:E5').

  Parameters

  • Optionalr1c1: boolean

    If unspecified returns the environment's default.

  Returns string

getAxis

• getAxis(): Axis

  Returns the header axis.

  Returns Axis

getCoords

• getCoords(): readonly RunCoords[]

  The RunCoords for the range.

  Returns readonly RunCoords[]

getCount

• getCount(): number

  Returns the number of headers ranges.

  Returns number

getHeaderCount

• getHeaderCount(): number

  Returns the number of headers.

  Returns number

  Remarks

  This will remove overlaps.

getSheetHeader

• getSheetHeader<S>(): S

  Returns the SheetHeader.

  Type Parameters

  • S

  Returns S

getVisibleCount

• getVisibleCount(): number

  Returns the number of visible headers in the range.

  Returns number

isEntireHeaders

• isEntireHeaders(): boolean

  Returns true if all of the ranges cover the entire headers.

  Returns boolean

isEntireHeadersAny

• isEntireHeadersAny(): boolean

  Returns true if any of the ranges cover entire headers.

  Returns boolean

setHidden

• setHidden(hidden: boolean, options?: UpdateHeadersOptions): this

  Hides or show the columns for the given range.

  Parameters

  • hidden: boolean
  • Optionaloptions: UpdateHeadersOptions

  Returns this

setSize

• setSize(size: string | number, options?: SetSizeOptions): this

  Set the size of the headers.

  Parameters

  • size: string | number

    This can be a number of a string with units

  • Optionaloptions: SetSizeOptions

    ICellHeaderRange.SetSizeOptions

  Returns this

toString

• toString(): string

  Returns the address as a string.

  Returns string

updateHeaders

• updateHeaders(values: ICellHeader.Update, options?: UpdateHeadersOptions): this

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

  Parameters

  • values: ICellHeader.Update
  • Optionaloptions: UpdateHeadersOptions

  Returns this

  Remarks

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