Class which controls the way frozen panes are arranged and used for a worksheet.

Note: Frozen and unfrozen panes cannot be used simultaneously, so depending whether the panes are frozen or unfrozen, these settings may not be used or saved.

See

  • [[DisplayOptions.panesAreFrozen]]
  • [[UnfrozenPaneSettings]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get firstColumnInRightPane(): number
  • Gets or sets the first visible column in the right pane(s) of the worksheet.

    This affects the scroll position for the right pane(s) of the worksheet and is only used if the worksheet is split vertically.

    The zero-based index of the first visible column in the right pane(s).

    Throws

    [[ArgumentOutOfRangeException]] The assigned value is outside the valid column range (0 to one less than [[Workbook.maxExcelColumnCount]] or [[Workbook.maxExcel2007ColumnCount]], depending on the workbook's [[Workbook.currentFormat]]).

    Returns number

  • set firstColumnInRightPane(a): void
  • Parameters

    • a: number

    Returns void

  • get firstRowInBottomPane(): number
  • Gets or sets the first visible row in the bottom pane(s) of the worksheet.

    This affects the scroll position for the bottom pane(s) of the worksheet and is only used if the worksheet is split horizontally.

    The zero-based index of the first visible row in the bottom pane(s).

    Throws

    [[ArgumentOutOfRangeException]] The assigned value is outside the valid row range (0 to one less than [[Workbook.maxExcelRowCount]] or [[Workbook.maxExcel2007RowCount]], depending on the workbook's [[Workbook.currentFormat]]).

    Returns number

  • set firstRowInBottomPane(a): void
  • Parameters

    • a: number

    Returns void

  • get frozenColumns(): number
  • Gets or sets the number of columns frozen at the left of the worksheet.

    The frozen columns will always remain in view, regardless of the horizontal scroll position of the worksheet.

    Note: If the number of frozen columns specified is more than the amount of visible columns in the worksheet, the worksheet may not scroll correctly.

    The number of columns frozen at the left of the worksheet.

    Throws

    [[ArgumentOutOfRangeException]] The assigned value is not a valid column count (0 to [[Workbook.maxExcelColumnCount]] or [[Workbook.maxExcel2007ColumnCount]], depending on the workbook's [[Workbook.currentFormat]]).

    Returns number

  • set frozenColumns(a): void
  • Parameters

    • a: number

    Returns void

  • get frozenRows(): number
  • Gets or sets the number of rows frozen at the top of the worksheet.

    The frozen rows will always remain in view, regardless of the vertical scroll position of the worksheet.

    Note: If the number of frozen rows specified is more than the amount of visible rows in the worksheet, the worksheet may not scroll correctly.

    The number of rows frozen at the top of the worksheet.

    Throws

    [[ArgumentOutOfRangeException]] The assigned value is not a valid row count (0 to [[Workbook.maxExcelRowCount]] or [[Workbook.maxExcel2007RowCount]], depending on the workbook's [[Workbook.currentFormat]]).

    Returns number

  • set frozenRows(a): void
  • Parameters

    • a: number

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Resets the pane settings to their defaults.

    The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet.

    Returns void

  • Resets the frozen pane settings to their defaults.

    The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean