API / geotoolkit / scene / exports / PageElement / PageElement
exports.PageElement.PageElement
Utility class used to create page component such as header and footer in a document. Used in PDF output.
PageElement
Constructors
- [new PageElement(width, height)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.pageelement.pageelement.md#new pageelement(width, height))
Constructors
• Protected new PageElement(width, height)
| Name | Type | Description |
|---|---|---|
width | number | width of the component |
height | number | height of the component |
Methods
▸ getClassName(): string
string
▸ getDefaultSize(): Dimension
get the defaultSize of the component
dimension
▸ getMaximumSize(): Dimension
get the maximum size of the component
dimension
▸ isElementVisible(): isVisiblePageElementCallback
Get function to check element visibility. The default implementation returns null and standard rule is used
function to check
▸ Abstract render(context, pageInfo?, pageContext?): void
draw component
| Name | Type | Description |
|---|---|---|
context | RenderingContext | RenderingContext |
Optional pageInfo | Record<string, any> | contains all data about the pdf page |
Optional pageContext | PageContext |
void
▸ Static getClassName(): string
string