API / geotoolkit / scene / exports / FooterComponent / FooterComponent
exports.FooterComponent.FooterComponent
Footer Component that print the page number of the document, and any additional data
↳
FooterComponent
Constructors
- [new FooterComponent(width, height, textStyle)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.footercomponent.footercomponent.md#new footercomponent(width, height, textstyle))
Constructors
• new FooterComponent(width, height, textStyle?)
| Name | Type |
|---|---|
width | number |
height | number |
Optional textStyle | Type |
PageElement.constructor
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
▸ render(context, pageInfo?): void
render the footer
| Name | Type | Description |
|---|---|---|
context | DocumentRenderingContext | PdfRenderingContext |
Optional pageInfo | PageInfo | JSON Object |
void
▸ Static getClassName(): string
string