Skip to content
Last updated

API / geotoolkit / scene / exports / PageContext / PageContext

Class: PageContext

exports.PageContext.PageContext

Define context to be pass to check if page header or footer should be drawn

Table of contents

Constructors
  • [new PageContext(root, pageInfo, pageTransformation, position)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.pagecontext.pagecontext.md#new pagecontext(root, pageinfo, pagetransformation, position))
Methods

Contents

Constructors

new PageContext(root, pageInfo, pageTransformation, position)

• new PageContext(root, pageInfo, pageTransformation, position)

Parameters

Name Type Description
rootCompositeDocumentElement | DocumentElementRoot document
pageInfoPageInfopage info
pageTransformationTransformationpage transformation
positionPointposition of the current page relative to the parent document
Methods

containsElement

▸ containsElement(element): boolean

Checks if the provided exported element in this page

Parameters

Name Type Description
elementNodeexported element

Returns

boolean


getClassName

▸ getClassName(): string

Returns

string


getElementBounds

▸ getElementBounds(element): Rect

Return page element bounds

Parameters

Name Type Description
elementNodeexported element

Returns

Rect

bounds


getPageElement

▸ getPageElement(element): AbstractDocumentElement

Return page element

Parameters

Name Type Description
elementNodeexported element

Returns

AbstractDocumentElement

page element


getPageInfo

▸ getPageInfo(): PageInfo

Returns page info

Returns

PageInfo

page info


getPageModelRect

▸ getPageModelRect(): Rect

Return model page area

Returns

Rect


getPageTransformation

▸ getPageTransformation(): Transformation

Returns page transformation

Returns

Transformation

page transformation


getPosition

▸ getPosition(): Point

Return position of the current page relative to the parent document

Returns

Point


getPositionTransform

▸ getPositionTransform(): Transformation

Returns position transformation

Returns

Transformation

position transformation


getRoot

▸ getRoot(): CompositeDocumentElement | DocumentElement

Get root document

Returns

CompositeDocumentElement | DocumentElement

root


getClassName

▸ Static getClassName(): string

Returns

string