Last updated

API / geotoolkit / scene / exports / FooterComponent / FooterComponent

Class: FooterComponent

exports.FooterComponent.FooterComponent

Footer Component that print the page number of the document, and any additional data

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new FooterComponent(width, height, textStyle)

new FooterComponent(width, height, textStyle?)

Parameters

Name Type
widthnumber
heightnumber
Optional textStyleType

Overrides

PageElement.constructor

Methods

getClassName

getClassName(): string

Returns

string

Inherited from

PageElement.getClassName


getDefaultSize

getDefaultSize(): Dimension

get the defaultSize of the component

Returns

Dimension

dimension

Inherited from

PageElement.getDefaultSize


getMaximumSize

getMaximumSize(): Dimension

get the maximum size of the component

Returns

Dimension

dimension

Inherited from

PageElement.getMaximumSize


isElementVisible

isElementVisible(): isVisiblePageElementCallback

Get function to check element visibility. The default implementation returns null and standard rule is used

Returns

isVisiblePageElementCallback

function to check

Inherited from

PageElement.isElementVisible


render

render(context, pageInfo?): void

render the footer

Parameters

Name Type Description
contextDocumentRenderingContextPdfRenderingContext
Optional pageInfoPageInfoJSON Object

Returns

void

Overrides

PageElement.render


getClassName

Static getClassName(): string

Returns

string

Inherited from

PageElement.getClassName