API / geotoolkit / scene / exports / AbstractDocumentElement / AbstractDocumentElement
exports.AbstractDocumentElement.AbstractDocumentElement
Abstract parent class used for PDF output.
AbstractDocumentElement
Constructors
- [new AbstractDocumentElement()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.abstractdocumentelement.abstractdocumentelement.md#new abstractdocumentelement())
Methods
Methods
▸ beginExport(): void
Used to prepare object before exporting
void
▸ endExport(): void
Used to restore object's state after exporting
void
▸ getClassName(): string
string
▸ Abstract getLayoutedDimension(): LayoutedDimension
Compute the dimension in the layout, this dimension is described by a fixed dimension and a scaled dimension
▸ Abstract render(context, position?): void
render the document in the context
| Name | Type | Description |
|---|---|---|
context | DocumentRenderingContext | rendering context |
Optional position | Point | position of current document element relative to the parent document |
void
▸ renderAsync(context, position, callback): void
Render document in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | DocumentRenderingContext | rendering context |
position | Point | position of current document element relative to the parent document |
callback | () => void | callback function |
void
▸ Abstract setScale(sx, sy): AbstractDocumentElement
set the document scale depending on the parameters isScaledVertically and isScaledHorizontally
| Name | Type | Description |
|---|---|---|
sx | number | scale factor in x direction |
sy | number | scale factor in y direction |
this
▸ Abstract setTranslation(x, y): AbstractDocumentElement
set the document translation
| Name | Type | Description |
|---|---|---|
x | number | offset x coordinate |
y | number | offset y coordinate |
this
▸ Abstract updateLayout(rect?): void
Set the document bounds
| Name | Type | Description |
|---|---|---|
Optional rect | Rect | document bounds |
void
▸ Static getClassName(): string
string