PrintDocument Class

File
wijmo.js
Module
wijmo

Class that enables the creation of custom documents for printing.

The PrintDocument class makes it easy to create documents for printing or exporting to PDF. Most browsers allow you to select the paper size, orientation, margins, and whether to include page headers and footers.

To use, instantiate a PrintDocument, add content using the append method, and finish by calling the print method.

For example:

// create the document
var doc = new wijmo.PrintDocument({
  title: 'PrintDocument Test'
});

// add some simple text
doc.append('<h1>Printing Example</h1>');
doc.append('<p>This document was created using the <b>PrintDocument</b> class.</p>');

// add some existing elements
doc.append(document.getElementById('gaugeControl'));

// print the document (or export it to PDF)
doc.print();

Constructor

Properties

Methods

Constructor

constructor

constructor(options?: any): PrintDocument

Initializes a new instance of the PrintDocument class.

Parameters
Returns
PrintDocument

Properties

copyCss

Gets or sets a value that determines whether the PrintDocument should include the CSS style sheets defined in the main document.

Type
boolean

title

Gets or sets the document title.

Type
string

Methods

addCSS

addCSS(href: string): void

Adds a CSS style sheet to the document.

Parameters
Returns
void

append

append(child: any): void

Appends an HTML element or string to the document.

Parameters
Returns
void

print

print(): void

Prints the document.

Returns
void