Class which exposes the various print options available for a worksheet which can be saved with both a worksheet and a custom view.

Constructors

Section titled "Constructors"

PrintOptions

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

Returns PrintOptions

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

alignHeadersAndFootersWithMargins

Section titled "alignHeadersAndFootersWithMargins"

Inherited from: PrintOptionsBase 

alignHeadersAndFootersWithMargins: boolean

bottomMargin

Section titled "bottomMargin"

Inherited from: PrintOptionsBase 

bottomMargin: number

centerHorizontally

Section titled "centerHorizontally" 
centerHorizontally: boolean

centerVertically

Section titled "centerVertically" 
centerVertically: boolean

columnsToRepeatAtLeft

Section titled "columnsToRepeatAtLeft" 
columnsToRepeatAtLeft: RepeatTitleRange

draftQuality

Section titled "draftQuality"

Inherited from: PrintOptionsBase 

draftQuality: boolean
Section titled "footer"

Inherited from: PrintOptionsBase 

footer: string

footerMargin

Section titled "footerMargin"

Inherited from: PrintOptionsBase 

footerMargin: number
Section titled "header"

Inherited from: PrintOptionsBase 

header: string

headerMargin

Section titled "headerMargin"

Inherited from: PrintOptionsBase 

headerMargin: number

leftMargin

Section titled "leftMargin"

Inherited from: PrintOptionsBase 

leftMargin: number

maxPagesHorizontally

Section titled "maxPagesHorizontally" 
maxPagesHorizontally: number

maxPagesVertically

Section titled "maxPagesVertically" 
maxPagesVertically: number

numberOfCopies

Section titled "numberOfCopies"

Inherited from: PrintOptionsBase 

numberOfCopies: number

orientation

Section titled "orientation"

Inherited from: PrintOptionsBase 

orientation: Orientation

pageNumbering

Section titled "pageNumbering"

Inherited from: PrintOptionsBase 

pageNumbering: PageNumbering

pageOrder

Section titled "pageOrder" 
pageOrder: PageOrder

paperSize

Section titled "paperSize"

Inherited from: PrintOptionsBase 

paperSize: PaperSize

printErrors

Section titled "printErrors"

Inherited from: PrintOptionsBase 

printErrors: PrintErrors

printGridlines

Section titled "printGridlines" 
printGridlines: boolean

printInBlackAndWhite

Section titled "printInBlackAndWhite"

Inherited from: PrintOptionsBase 

printInBlackAndWhite: boolean

printNotes

Section titled "printNotes"

Inherited from: PrintOptionsBase 

printNotes: PrintNotes

printRowAndColumnHeaders

Section titled "printRowAndColumnHeaders" 
printRowAndColumnHeaders: boolean

resolution

Section titled "resolution"

Inherited from: PrintOptionsBase 

resolution: number

rightMargin

Section titled "rightMargin"

Inherited from: PrintOptionsBase 

rightMargin: number

rowsToRepeatAtTop

Section titled "rowsToRepeatAtTop" 
rowsToRepeatAtTop: RepeatTitleRange

scaleHeadersAndFootersWithDocument

Section titled "scaleHeadersAndFootersWithDocument"

Inherited from: PrintOptionsBase 

scaleHeadersAndFootersWithDocument: boolean

scalingFactor

Section titled "scalingFactor" 
scalingFactor: number

scalingType

Section titled "scalingType" 
scalingType: ScalingType

startPageNumber

Section titled "startPageNumber"

Inherited from: PrintOptionsBase 

startPageNumber: number

topMargin

Section titled "topMargin"

Inherited from: PrintOptionsBase 

topMargin: number

verticalResolution

Section titled "verticalResolution"

Inherited from: PrintOptionsBase 

verticalResolution: number

Accessors

Section titled "Accessors"

orientationResolved

Section titled "orientationResolved"

Inherited from: PrintOptionsBase

Returns the resolved orientation for each page of the printed worksheet.

get orientationResolved(): Orientation

Returns Orientation

Methods

Section titled "Methods"

clearPageBreaks

Section titled "clearPageBreaks"

Clears all page breaks from the [[PrintOptions]].

clearPageBreaks(): void

Returns void

horizontalPageBreaks

Section titled "horizontalPageBreaks"

Gets the page break at the specified index.

horizontalPageBreaks(index: number): HorizontalPageBreak

Parameters

  • index: number

    The index of the page break to get.

Returns HorizontalPageBreak

insertPageBreak

Section titled "insertPageBreak"

Inserts a horizontal and/or vertical page break before the specified cell.

insertPageBreak(cell: WorksheetCell): void

Parameters

  • cell: WorksheetCell

    The cell at which to insert the page break(s).

Returns void

printAreas

Section titled "printAreas"

Gets the print area at the specified index.

printAreas(index: number): WorksheetRegion

Parameters

  • index: number

    The index of the print area to get.

Returns WorksheetRegion

reset

Section titled "reset"

Resets the print options to their default settings.

reset(): void

Returns void

verticalPageBreaks

Section titled "verticalPageBreaks"

Gets the page break at the specified index.

verticalPageBreaks(index: number): VerticalPageBreak

Parameters

  • index: number

    The index of the page break to get.

Returns VerticalPageBreak