Last updated

API / geotoolkit / scene / exports / PageElement / PageElement

Class: PageElement

exports.PageElement.PageElement

Utility class used to create page component such as header and footer in a document. Used in PDF output.

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new PageElement(width, height)

Protected new PageElement(width, height)

Parameters

Name Type Description
widthnumberwidth of the component
heightnumberheight of the component
Methods

getClassName

getClassName(): string

Returns

string


getDefaultSize

getDefaultSize(): Dimension

get the defaultSize of the component

Returns

Dimension

dimension


getMaximumSize

getMaximumSize(): Dimension

get the maximum size of the component

Returns

Dimension

dimension


isElementVisible

isElementVisible(): isVisiblePageElementCallback

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

Returns

isVisiblePageElementCallback

function to check


render

Abstract render(context, pageInfo?, pageContext?): void

draw component

Parameters

Name Type Description
contextRenderingContextRenderingContext
Optional pageInfoRecord<string, any>contains all data about the pdf page
Optional pageContextPageContext

Returns

void


getClassName

Static getClassName(): string

Returns

string