Class which controls the way unfrozen 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]]
  • [[FrozenPaneSettings]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

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

    This affects the scroll position for the left pane(s) of the worksheet and is used regardless of whether or not the worksheet is split vertically.

    The zero-based index of the first visible column in the left 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 firstColumnInLeftPane(a): void
  • Parameters

    • a: number

    Returns void

  • 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 firstRowInTopPane(): number
  • Gets or sets the first visible row in the top pane(s) of the worksheet.

    This affects the scroll position for the top pane(s) of the worksheet and is used regardless of whether or not the worksheet is split horizontally.

    The zero-based index of the first visible row in the top 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 firstRowInTopPane(a): void
  • Parameters

    • a: number

    Returns void

  • get leftPaneWidth(): number
  • Gets or sets the width of the left pane in twips (1/20th of a point).

    If this value is zero, the left pane occupies the entire visible area of the worksheet. Otherwise, the left pane occupies the specified width and the right pane occupies the remaining area of the worksheet.

    The width of the left pane, or zero if there is no horizontal pane split.

    Throws

    [[ArgumentOutOfRangeException]] Thrown when the width specified is outside the valid width range (0 to 65535).

    Returns number

  • set leftPaneWidth(a): void
  • Parameters

    • a: number

    Returns void

  • get topPaneHeight(): number
  • Gets or sets the height of the top pane in twips (1/20th of a point).

    If this value is zero, the top pane occupies the entire visible area of the worksheet. Otherwise, the top pane occupies the specified height and the bottom pane occupies the remaining area of the worksheet.

    The height of the top pane, or zero if there is no vertical pane split.

    Throws

    [[ArgumentOutOfRangeException]] Thrown when the height specified is outside the valid height range (0 to 65535).

    Returns number

  • set topPaneHeight(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 unfrozen 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