Class: CompositeDocumentElement

• [new CompositeDocumentElement(list, layout)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.compositedocumentelement.compositedocumentelement.md#new compositedocumentelement(list, layout))

• new CompositeDocumentElement(list, layout?)

AbstractDocumentElement.constructor

▸ addChild(child): any

Add DocumentElement as child

any

▸ beginExport(): void

Used to prepare object before exporting

void

AbstractDocumentElement.beginExport

▸ clearChild(): void

Clear all children

void

▸ endExport(): void

Used to restore object's state after exporting

void

AbstractDocumentElement.endExport

▸ getBounds(): Rect

Return bounds

Rect

▸ getChild(index): any

Get child at index.

any

child DocumentElement at index.

▸ getChildrenCount(): number

Get the number of children in the composite document element.

number

count

▸ getClassName(): string

string

AbstractDocumentElement.getClassName

▸ getIndex(element): number

Get index of a specified element.

number

index

▸ getLayoutStyle(): LayoutStyle<string | number&gt;

Return desired layout style

LayoutStyle<string | number&gt;

▸ getLayoutedDimension(): LayoutedDimension

Compute dimensions in the layout, this dimension is described by a fixed dimension and a scaled dimension.

LayoutedDimension

layoutedDimension object contains fixed and scaled dimensions

AbstractDocumentElement.getLayoutedDimension

▸ getList(): any[]

Gets the list of children.

any[]

list

▸ getPreferredSize(rect?): Rect

Return preferred size to layout children

Rect

▸ insertChildAtIndex(index, child): void

Add child at specific index

void

▸ render(context, position?): void

Render the document in the context.

void

AbstractDocumentElement.render

▸ renderAsync(context, position, callback): void

Render document in asynchronous mode. Default implementation creates call method "render" inside

void

AbstractDocumentElement.renderAsync

▸ setBounds(bounds): CompositeDocumentElement

Sets bounds of the document if it is a part of layout

CompositeDocumentElement

this

▸ setChild(index, child): CompositeDocumentElement

Set child at specific index

CompositeDocumentElement

this

▸ setLayout(layout): CompositeDocumentElement

set the layout

CompositeDocumentElement

this

▸ setLayoutStyle(layoutStyle): CompositeDocumentElement

Specify desired layout style

CompositeDocumentElement

▸ setScale(sx, sy): CompositeDocumentElement

set the document scale depending on the parameters isScaledVertically and isScaledHorizontally

CompositeDocumentElement

this

AbstractDocumentElement.setScale

▸ setTranslation(x, y): CompositeDocumentElement

set the document translation

CompositeDocumentElement

this

AbstractDocumentElement.setTranslation

▸ updateLayout(rect?): void

update the layout of the document

void

AbstractDocumentElement.updateLayout

▸ updatePageLayout(pageInfo): Rect

Return Layouted bounds

Rect

IExportLayoutable.updatePageLayout

▸ Static getClassName(): string

string

AbstractDocumentElement.getClassName