Header menu logo fable-electron-docs-api

Options Type

Constructors

Constructor Description

Options(?silent, ?printBackground, ?deviceName, ?color, ?margins, ?landscape, ?scaleFactor, ?pagesPerSheet, ?collate, ?copies, ?pageRanges, ?duplexMode, ?dpi, ?header, ?footer, ?pageSize)

Full Usage: Options(?silent, ?printBackground, ?deviceName, ?color, ?margins, ?landscape, ?scaleFactor, ?pagesPerSheet, ?collate, ?copies, ?pageRanges, ?duplexMode, ?dpi, ?header, ?footer, ?pageSize)

Parameters:
    ?silent : bool - Don't ask user for print settings. Default is false.
    ?printBackground : bool - Prints the background color and image of the web page. Default is false.
    ?deviceName : string - Set the printer device name to use. Must be the system-defined name and not the 'friendly' name, e.g 'Brother_QL_820NWB' and not 'Brother QL-820NWB'.
    ?color : bool - Set whether the printed web page will be in color or grayscale. Default is true.
    ?margins : Margins -
    ?landscape : bool - Whether the web page should be printed in landscape mode. Default is false.
    ?scaleFactor : float - The scale factor of the web page.
    ?pagesPerSheet : float - The number of pages to print per page sheet.
    ?collate : bool - Whether the web page should be collated.
    ?copies : float - The number of copies of the web page to print.
    ?pageRanges : PageRanges[] - The page range to print.
    ?duplexMode : DuplexMode - Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
    ?dpi : Record<string, float> -
    ?header : string - string to be printed as page header.
    ?footer : string - string to be printed as page footer.
    ?pageSize : U2<PageSize, Size> - Specify page size of the printed document. Can be A3, A4, A5, Legal, Letter, Tabloid or an Object containing height in microns.

Returns: Options
?silent : bool

Don't ask user for print settings. Default is false.

?printBackground : bool

Prints the background color and image of the web page. Default is false.

?deviceName : string

Set the printer device name to use. Must be the system-defined name and not the 'friendly' name, e.g 'Brother_QL_820NWB' and not 'Brother QL-820NWB'.

?color : bool

Set whether the printed web page will be in color or grayscale. Default is true.

?margins : Margins

?landscape : bool

Whether the web page should be printed in landscape mode. Default is false.

?scaleFactor : float

The scale factor of the web page.

?pagesPerSheet : float

The number of pages to print per page sheet.

?collate : bool

Whether the web page should be collated.

?copies : float

The number of copies of the web page to print.

?pageRanges : PageRanges[]

The page range to print.

?duplexMode : DuplexMode

Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.

?dpi : Record<string, float>

?header : string

string to be printed as page header.

?footer : string

string to be printed as page footer.

?pageSize : U2<PageSize, Size>

Specify page size of the printed document. Can be A3, A4, A5, Legal, Letter, Tabloid or an Object containing height in microns.

Returns: Options

Instance members

Instance member Description

this.collate

Full Usage: this.collate

Whether the web page should be collated.

this.color

Full Usage: this.color

Set whether the printed web page will be in color or grayscale. Default is true.

this.copies

Full Usage: this.copies

The number of copies of the web page to print.

this.deviceName

Full Usage: this.deviceName

Set the printer device name to use. Must be the system-defined name and not the 'friendly' name, e.g 'Brother_QL_820NWB' and not 'Brother QL-820NWB'.

this.dpi

Full Usage: this.dpi

this.duplexMode

Full Usage: this.duplexMode

Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.

this.footer

Full Usage: this.footer

string to be printed as page footer.

this.header

Full Usage: this.header

string to be printed as page header.

this.landscape

Full Usage: this.landscape

Whether the web page should be printed in landscape mode. Default is false.

this.margins

Full Usage: this.margins

this.pageRanges

Full Usage: this.pageRanges

The page range to print.

this.pageSize

Full Usage: this.pageSize

Specify page size of the printed document. Can be A3, A4, A5, Legal, Letter, Tabloid or an Object containing height in microns.

this.pagesPerSheet

Full Usage: this.pagesPerSheet

The number of pages to print per page sheet.

this.printBackground

Full Usage: this.printBackground

Prints the background color and image of the web page. Default is false.

this.scaleFactor

Full Usage: this.scaleFactor

The scale factor of the web page.

this.silent

Full Usage: this.silent

Don't ask user for print settings. Default is false.

Type something to start searching.