API / geotoolkit / scene / exports / Document / Document
Document class represents a pdf document this class can contains a :
- root element CompositeDocumentElement || DocumentElement
- header : pdf header component PageElement
- footer : pdf footer component PageElement
Constructors
- [new Document(root, pageHeader, pageFooter, trueScale, options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.document.document.md#new document(root, pageheader, pagefooter, truescale, options))
Methods
Constructors
• new Document(root, pageHeader?, pageFooter?, trueScale?, options?)
| Name | Type |
|---|---|
root | CompositeDocumentElement | DocumentElement | Options |
Optional pageHeader | PageElement |
Optional pageFooter | PageElement |
Optional trueScale | boolean |
Optional options | OptionsType |
Methods
▸ beginExport(): void
Used to prepare object before exporting
void
▸ endExport(): void
Used to restore object's state after exporting
void
▸ getClassName(): string
string
▸ getDocumentFooter(): PageElement
Get PDF Document Footer Component
Document Footer
▸ getDocumentHeader(): PageElement
Get PDF Document Header component
Document Header
▸ getOptions(): OptionsType
Returns options
options
▸ getPageFooter(): PageElement
Get PDF Page Footer Component
Page Footer
▸ getPageHeader(): PageElement
Get PDF Page Header component
Page Header
▸ getRoot(): CompositeDocumentElement | DocumentElement
Get root document
CompositeDocumentElement | DocumentElement
root
▸ getTrueScale(): boolean
Get true if true scale mode is enabled
boolean
true scale
▸ isFooterVisible(): () => boolean
Get function to check PDF Page Footer visibility
fn
Page Config
▸ (): boolean
Get function to check PDF Page Footer visibility
boolean
Page Config
▸ isHeaderVisible(): () => boolean
Get function to check PDF Page Header visibility
fn
Header Config
▸ (): boolean
Get function to check PDF Page Header visibility
boolean
Header Config
▸ setDocumentFooter(docFooter): Document
Set PDF Document Footer Component
| Name | Type | Description |
|---|---|---|
docFooter | PageElement | Document Footer |
this
▸ setDocumentHeader(docHeader): Document
Set PDF Document Header component.
| Name | Type | Description |
|---|---|---|
docHeader | PageElement | Document Header |
this
▸ setPageFooter(pageFooter): Document
Set PDF Page Footer Component
| Name | Type | Description |
|---|---|---|
pageFooter | PageElement | Page Footer |
this
▸ setPageHeader(pageHeader): Document
Set PDF Page Header component.
| Name | Type | Description |
|---|---|---|
pageHeader | PageElement | Page Header |
this
▸ setRoot(root): Document
Set Root document
| Name | Type | Description |
|---|---|---|
root | CompositeDocumentElement | DocumentElement | Root document |
this
▸ Static getClassName(): string
string