Last updated

API / geotoolkit / scene / exports / HeaderComponent / HeaderComponent

Class: HeaderComponent

exports.HeaderComponent.HeaderComponent

Header Component that print the title and the date of the pdf document

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new HeaderComponent(width, height, title, date, textStyle)

new HeaderComponent(width, height, title?, date?, textStyle?)

Parameters

Name Type
widthnumber
heightnumber
Optional titlestring
Optional dateDate
Optional textStyleType

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


getTextStyle

getTextStyle(): TextStyle

get date

Returns

TextStyle

date


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

print title and date in the context

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