Class which exposes the display options which can only be controlled through the worksheet.

Constructors

Section titled "Constructors"

WorksheetDisplayOptions 

new WorksheetDisplayOptions(a: Worksheet, b: boolean): WorksheetDisplayOptions

Returns WorksheetDisplayOptions

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

frozenPaneSettings

Section titled "frozenPaneSettings"

Inherited from: DisplayOptions

Gets the settings which control the frozen panes in the worksheet.

 
get frozenPaneSettings(): FrozenPaneSettings

Returns FrozenPaneSettings

gridlineColor

Section titled "gridlineColor"

Inherited from: DisplayOptions

Gets or sets the color of the gridlines on the worksheet.

 
get gridlineColor(): any

Returns any 

set gridlineColor(a: any): void

Parameters

  • a: any

Returns void

magnificationInNormalView

Section titled "magnificationInNormalView"

Gets or sets the magnification level of the worksheet when it is displayed in normal view.

 
get magnificationInNormalView(): number

Returns number 

set magnificationInNormalView(a: number): void

Parameters

  • a: number

Returns void

magnificationInPageBreakView

Section titled "magnificationInPageBreakView"

Gets or sets the magnification level of the worksheet when it is displayed in the page break preview.

 
get magnificationInPageBreakView(): number

Returns number 

set magnificationInPageBreakView(a: number): void

Parameters

  • a: number

Returns void

magnificationInPageLayoutView

Section titled "magnificationInPageLayoutView"

Gets or sets the magnification level of the worksheet when it is displayed in page layout view.

 
get magnificationInPageLayoutView(): number

Returns number 

set magnificationInPageLayoutView(a: number): void

Parameters

  • a: number

Returns void

orderColumnsRightToLeft

Section titled "orderColumnsRightToLeft"

Gets or sets the value indicating whether the columns are ordered right to left.

 
get orderColumnsRightToLeft(): boolean

Returns boolean 

set orderColumnsRightToLeft(a: boolean): void

Parameters

  • a: boolean

Returns void

panesAreFrozen

Section titled "panesAreFrozen"

Inherited from: DisplayOptions

Gets or sets the value which indicates if the panes in the worksheet are frozen.

 
get panesAreFrozen(): boolean

Returns boolean 

set panesAreFrozen(a: boolean): void

Parameters

  • a: boolean

Returns void

showExpansionIndicatorBelowGroupedRows

Section titled "showExpansionIndicatorBelowGroupedRows"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether the expansion indicators should be shown below grouped, or indented rows.

 
get showExpansionIndicatorBelowGroupedRows(): boolean | null

Returns boolean | null 

set showExpansionIndicatorBelowGroupedRows(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showExpansionIndicatorToRightOfGroupedColumns

Section titled "showExpansionIndicatorToRightOfGroupedColumns"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether the expansion indicators should be shown to the right of grouped, or indented rows.

 
get showExpansionIndicatorToRightOfGroupedColumns(): boolean | null

Returns boolean | null 

set showExpansionIndicatorToRightOfGroupedColumns(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showFormulasInCells

Section titled "showFormulasInCells"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether formulas are shown in cells.

 
get showFormulasInCells(): boolean

Returns boolean 

set showFormulasInCells(a: boolean): void

Parameters

  • a: boolean

Returns void

showGridlines

Section titled "showGridlines"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether gridlines are shown between cells. The value which indicates whether gridlines are shown between cells.

 
get showGridlines(): boolean

Returns boolean 

set showGridlines(a: boolean): void

Parameters

  • a: boolean

Returns void

showOutlineSymbols

Section titled "showOutlineSymbols"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether outline symbols are shown for outlined columns and rows.

 
get showOutlineSymbols(): boolean

Returns boolean 

set showOutlineSymbols(a: boolean): void

Parameters

  • a: boolean

Returns void

showRowAndColumnHeaders

Section titled "showRowAndColumnHeaders"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether to display row and column headers.

 
get showRowAndColumnHeaders(): boolean

Returns boolean 

set showRowAndColumnHeaders(a: boolean): void

Parameters

  • a: boolean

Returns void

showRulerInPageLayoutView

Section titled "showRulerInPageLayoutView"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether to show rulers in the page layout view.

 
get showRulerInPageLayoutView(): boolean

Returns boolean 

set showRulerInPageLayoutView(a: boolean): void

Parameters

  • a: boolean

Returns void

showWhitespaceInPageLayoutView

Section titled "showWhitespaceInPageLayoutView"

Gets or sets the value which indicates whether to show whitespace between worksheet pages in page layout view.

 
get showWhitespaceInPageLayoutView(): boolean

Returns boolean 

set showWhitespaceInPageLayoutView(a: boolean): void

Parameters

  • a: boolean

Returns void

showZeroValues

Section titled "showZeroValues"

Inherited from: DisplayOptions

Gets or sets the value which indicates whether zero values are shown in cells.

 
get showZeroValues(): boolean

Returns boolean 

set showZeroValues(a: boolean): void

Parameters

  • a: boolean

Returns void

tabColorInfo

Section titled "tabColorInfo"

Gets or sets the [[WorkbookColorInfo]] to use for the associated worksheet's tab in the tab bar of Microsoft Excel.

 
get tabColorInfo(): WorkbookColorInfo

Returns WorkbookColorInfo 

set tabColorInfo(a: WorkbookColorInfo): void

Parameters

Returns void

unfrozenPaneSettings

Section titled "unfrozenPaneSettings"

Inherited from: DisplayOptions

Gets the settings which control the unfrozen panes in the worksheet.

 
get unfrozenPaneSettings(): UnfrozenPaneSettings

Returns UnfrozenPaneSettings

view

Section titled "view"

Inherited from: DisplayOptions

Gets or sets the current view of the worksheet.

 
get view(): WorksheetView

Returns WorksheetView 

set view(a: WorksheetView): void

Parameters

Returns void

visibility

Section titled "visibility"

Inherited from: DisplayOptions

Gets or sets the visibility of the sheet.

 
get visibility(): WorksheetVisibility

Returns WorksheetVisibility 

set visibility(a: WorksheetVisibility): void

Parameters

Returns void

Methods

Section titled "Methods"

clearSelection

Section titled "clearSelection"

Inherited from: DisplayOptions

Removes any saved selection information.

 
clearSelection(): void

Returns void

reset

Section titled "reset"

Inherited from: DisplayOptions

Resets the display options to their default settings.

 
reset(): void

Returns void