Last updated

API / geotoolkit / report / view / exports / PageComponent / PageComponent

Class: PageComponent

exports.PageComponent.PageComponent

Header/Footer Component that print the title, date or page information

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new PageComponent(documentElement, options)

new PageComponent(documentElement, options?)

Parameters

Name Type Description
documentElementElementdocument element
Optional optionsPageInfooptional object

Overrides

PageElement.constructor

Methods

getClassName

getClassName(): string

Returns

string

Inherited from

PageElement.getClassName


getDate

getDate(): Date

get date

Returns

Date

date


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


getTitle

getTitle(): string

Get title

Returns

string

title


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?, pageContext?): void

Parameters

Name Type Description
contextDocumentRenderingContextPdfRenderingContext
Optional pageInfoPageInfoJSON Object
Optional pageContextPageContextpage context

Returns

void

Overrides

PageElement.render


getClassName

Static getClassName(): string

Returns

string

Inherited from

PageElement.getClassName