Abstract base class which exposes the various display options available for a worksheet which can be saved with both a worksheet and a custom view.

Constructors

Section titled "Constructors"

DisplayOptions 

new DisplayOptions(a: Worksheet): DisplayOptions

Returns DisplayOptions

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

frozenPaneSettings

Section titled "frozenPaneSettings"

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

 
get frozenPaneSettings(): FrozenPaneSettings

Returns FrozenPaneSettings

gridlineColor

Section titled "gridlineColor"

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

panesAreFrozen

Section titled "panesAreFrozen"

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"

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"

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"

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"

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"

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"

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"

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

showZeroValues

Section titled "showZeroValues"

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

unfrozenPaneSettings

Section titled "unfrozenPaneSettings"

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

 
get unfrozenPaneSettings(): UnfrozenPaneSettings

Returns UnfrozenPaneSettings

view

Section titled "view"

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: DisplayOptionsBase

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"

Removes any saved selection information.

 
clearSelection(): void

Returns void

reset

Section titled "reset"

Inherited from: DisplayOptionsBase

Resets the display options to their default settings.

 
reset(): void

Returns void