Last updated

API / geotoolkit / report / Document / Document

Class: Document

report.Document.Document

Define parsed document

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new Document(context)

new Document(context)

Parameters

Name Type
contextParserContext
Methods

dispose

dispose(): void

Dispose.

Returns

void

Implementation of

IDisposable.dispose


exportToPdf

exportToPdf(options?): Promise<IWritable>

Exports the widget content as a PDF file, user has option to select the scale of track in pdf.

Example

// following example shows how to use exportPdf to get stream without downloading PDF
// and create Blob based on it
document.exportPdf({
'skipoutput': true,
...
}).then((stream) => {
const content = stream.getContent();
const blob = new Blob([content], {'type': 'application/pdf'});
const url = URL.createObjectURL(blob);
...
});

Parameters

Name Type Description
Optional optionsExportToPdfOptionsexport options

Returns

Promise<IWritable>

promise with output stream


getClassName

getClassName(): string

Returns

string


getDefaultPrintSettings

getDefaultPrintSettings(): DefaultPrintSettings

Return default print settings

Returns

DefaultPrintSettings

default print settings


getDocument

getDocument(): CompositeElement

Return Document Element

Returns

CompositeElement


getDomElement

getDomElement(): Document

Returns dom document element

Returns

Document

document element


getPageFooterElement

getPageFooterElement(options?): PageElement

Returns exportable page footer element

Parameters

Name Type Description
Optional optionsPageInfoexport options

Returns

PageElement

return exportable element


getPageHeaderElement

getPageHeaderElement(options?): PageElement

Returns exportable page header element

Parameters

Name Type Description
Optional optionsPageInfoexport options

Returns

PageElement

return exportable element


getProperty

getProperty(propertyName, defaultValue?): string | number | object

Return known property value

Parameters

Name Type Description
propertyNamestringproperty name
Optional defaultValuestring | number | objectproperty default value

Returns

string | number | object

property value


getRootElement

getRootElement(width?, height?): Element

Returns root element

Parameters

Name Type Description
Optional widthnumberwidth
Optional heightnumberheight

Returns

Element

root element


hasOwnProperty

hasOwnProperty(propertyName): boolean

Returns returns a boolean indicating whether the object has the specified property as its own property.

Parameters

Name Type Description
propertyNamestringproperty name

Returns

boolean


parseDomElements

parseDomElements(xml): Promise<Node[]>

Parse DOM elements

Parameters

Name Type Description
xmlstringXML template

Returns

Promise<Node[]>


getClassName

Static getClassName(): string

Returns

string