Calls related to setting up new printer configurations.
- Source:
Methods
(static) create(printer, optionsopt) → {Config}
Creates new printer config to be used in printing.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
printer |
string | object | Name of printer. Use object type to specify printing to file or host.
Properties
|
|||||||||||||||||||||
options |
Object |
<optional> |
Override any of the default options for this config only. |
- Source:
- See:
-
- configs.setDefaults
Returns:
The new config.
- Type
- Config
(static) setDefaults(options)
Default options used by new configs if not overridden.
Setting a value to NULL will use the printer's default options.
Updating these will not update the options on any created config.
Parameters:
| Name | Type | Attributes | Default | Description | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Default options used by printer configs if not overridden. | |||||||||||||||||||||||||||
option.bounds |
Object |
<optional> |
null | Bounding box rectangle. | |||||||||||||||||||||||||
options.bounds.x |
number |
<optional> |
0 | Distance from left for bounding box starting corner | |||||||||||||||||||||||||
options.bounds.y |
number |
<optional> |
0 | Distance from top for bounding box starting corner | |||||||||||||||||||||||||
options.bounds.width |
number |
<optional> |
0 | Width of bounding box | |||||||||||||||||||||||||
options.bounds.height |
number |
<optional> |
0 | Height of bounding box | |||||||||||||||||||||||||
options.colorType |
string |
<optional> |
'color' | Valid values [color | grayscale | blackwhite] |
|||||||||||||||||||||||||
options.copies |
number |
<optional> |
1 | Number of copies to be printed. | |||||||||||||||||||||||||
options.density |
number | Array.<number> | Object | Array.<Object> | string |
<optional> |
0 | Pixel density (DPI, DPMM, or DPCM depending on [options.units]).
If provided as an array, uses the first supported density found (or the first entry if none found).
If provided as a string, valid values are [best | draft], corresponding to highest or lowest reported density respectively.
Properties
|
|||||||||||||||||||||||||
options.duplex |
boolean | string |
<optional> |
false | Double sided printing, Can specify duplex style by passing a string value: [one-sided | duplex | long-edge | tumble | short-edge] |
|||||||||||||||||||||||||
options.fallbackDensity |
number |
<optional> |
null | Value used when default density value cannot be read, or in cases where reported as "Normal" by the driver, (in DPI, DPMM, or DPCM depending on [options.units]). |
|||||||||||||||||||||||||
options.interpolation |
string |
<optional> |
'bicubic' | Valid values [bicubic | bilinear | nearest-neighbor]. Controls how images are handled when resized. |
|||||||||||||||||||||||||
options.jobName |
string |
<optional> |
null | Name to display in print queue. | |||||||||||||||||||||||||
options.legacy |
boolean |
<optional> |
false | If legacy style printing should be used. | |||||||||||||||||||||||||
options.margins |
Object | number |
<optional> |
0 | If just a number is provided, it is used as the margin for all sides.
Properties
|
|||||||||||||||||||||||||
options.orientation |
string |
<optional> |
null | Valid values [portrait | landscape | reverse-landscape] |
|||||||||||||||||||||||||
options.paperThickness |
number |
<optional> |
null | ||||||||||||||||||||||||||
options.printerTray |
string | number |
<optional> |
null | Printer tray to pull from. The number N assumes string equivalent of 'Tray N'. Uses printer default if NULL. | |||||||||||||||||||||||||
options.rasterize |
boolean |
<optional> |
false | Whether documents should be rasterized before printing.
Specifying [options.density] for PDF print formats will set this to true. |
|||||||||||||||||||||||||
options.rotation |
number |
<optional> |
0 | Image rotation in degrees. | |||||||||||||||||||||||||
options.scaleContent |
boolean |
<optional> |
true | Scales print content to page size, keeping ratio. | |||||||||||||||||||||||||
options.size |
Object |
<optional> |
null | Paper size.
Properties
|
|||||||||||||||||||||||||
options.units |
string |
<optional> |
'in' | Page units, applies to paper size, margins, and density. Valid value [in | cm | mm] |
|||||||||||||||||||||||||
options.altPrinting |
boolean |
<optional> |
false | Print the specified file using CUPS command line arguments. Has no effect on Windows. | |||||||||||||||||||||||||
options.encoding |
string |
<optional> |
null | Character set | |||||||||||||||||||||||||
options.endOfDoc |
string |
<optional> |
null | ||||||||||||||||||||||||||
options.perSpool |
number |
<optional> |
1 | Number of pages per spool. |
- Source: