Class: LegendPanel

• new LegendPanel(options)

• new LegendPanel(options?)

ScrollablePanel.constructor

▸ addBaseLayer(baseLayer): LegendPanel

Add baseLayer to container

LegendPanel

this

ScrollablePanel.addBaseLayer

▸ addChild(node): LegendPanel

Add a child node

LegendPanel

this

ScrollablePanel.addChild

▸ addCssClass(cssclass): LegendPanel

Adds new css class to node

LegendPanel

this

ScrollablePanel.addCssClass

▸ addInvalidateHandler(handler): LegendPanel

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LegendPanel

this

ScrollablePanel.addInvalidateHandler

▸ addOverlay(overlay): LegendPanel

Add overlay to container

LegendPanel

this

ScrollablePanel.addOverlay

▸ adjustPosition(area?, vAlign?, hAlign?): LegendPanel

Adjust position of node to specified area

LegendPanel

this

ScrollablePanel.adjustPosition

▸ Protected applyOpacity(context): LegendPanel

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

LegendPanel

this

ScrollablePanel.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

ScrollablePanel.applyResponsiveStyle

▸ changeBaseLayerOrder(overlay, order, anchor?): LegendPanel

Changes the z-order of the baseLayer.

LegendPanel

this

ScrollablePanel.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): LegendPanel

changes the z-order of the nodes being rendered.

LegendPanel

this

ScrollablePanel.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): LegendPanel

Changes the z-order of the overlay.

LegendPanel

this

ScrollablePanel.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

ScrollablePanel.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): LegendPanel

Remove all child baseLayers from group

LegendPanel

this

ScrollablePanel.clearBaseLayers

▸ clearCache(): LegendPanel

Clear cache

LegendPanel

this

ScrollablePanel.clearCache

▸ clearChildren(disposeChildren?): LegendPanel

Remove all child nodes from this composite group

LegendPanel

this

ScrollablePanel.clearChildren

▸ clearOverlays(disposeOverlays?): LegendPanel

Remove all child overlays from group

LegendPanel

this

ScrollablePanel.clearOverlays

▸ clone(): Group<Node>

All subclasses should override copyConstructor or provide custom implementation for this method

Group<Node>

clone

ScrollablePanel.clone

▸ connectStyle(style, type, callback): LegendPanel

Connects style.

This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks

LegendPanel

this

ScrollablePanel.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LegendPanel

Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.

LegendPanel

this

ScrollablePanel.copyConstructor

▸ disconnectStyle(style, type, callback): LegendPanel

Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.

LegendPanel

this

ScrollablePanel.disconnectStyle

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

ScrollablePanel.dispose

▸ Protected drawBorder(localContext, bounds?): LegendPanel

Draws a rectangle at the bounding box (in parent coordinates)

LegendPanel

this

ScrollablePanel.drawBorder

▸ enableClipping(doClip): LegendPanel

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

LegendPanel

this

ScrollablePanel.enableClipping

▸ enableEventPropagation(enable): LegendPanel

Enable event propagation from the node hierarchy from bottom to top

This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance.

Example

import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

LegendPanel

this

ScrollablePanel.enableEventPropagation

▸ enablePickingChildren(enable): LegendPanel

Enables or disables picking children

LegendPanel

this

ScrollablePanel.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

ScrollablePanel.enumerateNodes

▸ execute(delegate): LegendPanel

Executes delegate and return the result. It allows us to keep all initialization calls in one place,
and we do not need to scroll up or down in IDE to find how and where it was initialized.

Example

// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});

LegendPanel

The result if any or this

ScrollablePanel.execute

▸ execute<T>(delegate): T

T

ScrollablePanel.execute

▸ Protected filter(context): boolean

Filter node

boolean

flag filter flag ("true" to render node; "false" otherwise)

ScrollablePanel.filter

▸ fitContent(): LegendPanel

Fit size to content

LegendPanel

this

ScrollablePanel.fitContent

▸ getAnchorType(): AnchorType

Returs legend anchor alignment for position updates

AnchorType

anchor type

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

ScrollablePanel.getAnimationStyle

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

ScrollablePanel.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

ScrollablePanel.getAutoModelLimitsStrategy

▸ getAutoSize(): boolean

Gets autosize

boolean

ScrollablePanel.getAutoSize

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

ScrollablePanel.getBaseLayer

▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>

Return iterator by baseLayers nodes

Iterator<Node>

ScrollablePanel.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node>

Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

ScrollablePanel.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

ScrollablePanel.getBaseLayersCount

▸ getBounds(): Rect

Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.

Rect

current bounds

ScrollablePanel.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

ScrollablePanel.getCache

▸ getChild(i): Node

Return node by index

Node

ScrollablePanel.getChild

▸ getChildren<S>(predicate, modify?): Iterator<S>

Return iterator by child nodes

Iterator<S>

ScrollablePanel.getChildren

▸ getChildren(filter?, modify?): Iterator<Node>

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<Node>

An iterator for child nodes.

ScrollablePanel.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

ScrollablePanel.getChildrenCount

▸ getClassName(): string

string

ScrollablePanel.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

ScrollablePanel.getClipStyle

▸ getContent(): Group<Node>

Returns content group

Group<Node>

content

ScrollablePanel.getContent

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

ScrollablePanel.getContentOrientation

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

ScrollablePanel.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

ScrollablePanel.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

ScrollablePanel.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

ScrollablePanel.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

ScrollablePanel.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

ScrollablePanel.getCssTransform

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

ScrollablePanel.getDesiredHeight

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

ScrollablePanel.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

ScrollablePanel.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

ScrollablePanel.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

ScrollablePanel.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

ScrollablePanel.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

ScrollablePanel.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

ScrollablePanel.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

Returs legend layout style

LayoutStyle<string | number>

layout style

ScrollablePanel.getLayoutStyle

▸ getLegend(): Legend

Returns legend shape

Legend

▸ getLineStyle(): LineStyle

Return border style

LineStyle

ScrollablePanel.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

ScrollablePanel.getLocalTransform

▸ getLocation(): AnnotationLocation

Returns desired legend panel location

AnnotationLocation

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

ScrollablePanel.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

ScrollablePanel.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

ScrollablePanel.getName

▸ getOffset(): Point

Returns legend preferred offset

Point

▸ getOpacity(): number

Returns current node opacity

number

opacity

ScrollablePanel.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

ScrollablePanel.getOpacityBlendMode

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

ScrollablePanel.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

ScrollablePanel.getOverlayAt

▸ getOverlays<S>(predicate, modify?): Iterator<Node>

Return iterator by overlays nodes

Iterator<Node>

ScrollablePanel.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node>

Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

ScrollablePanel.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

ScrollablePanel.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

ScrollablePanel.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

ScrollablePanel.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

ScrollablePanel.getPreferredSize

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

ScrollablePanel.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

ScrollablePanel.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

ScrollablePanel.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

ScrollablePanel.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

ScrollablePanel.getResponsiveStyle

▸ getRoot(): Node

Returns root node.
If node doesn't have parent then it returns itself.

Node

the root node

ScrollablePanel.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

ScrollablePanel.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

ScrollablePanel.getSceneTransform

▸ getSize(): Dimension

Returns legend preferred size

Dimension

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

ScrollablePanel.getTag

▸ getTools(): AbstractTool[]

Gets associated tools

AbstractTool[]

ScrollablePanel.getTools

▸ getType(): string

Returns associated panel type

string

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

ScrollablePanel.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

ScrollablePanel.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

ScrollablePanel.getVisibleModelLimits

▸ getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Transformation

ScrollablePanel.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

ScrollablePanel.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

ScrollablePanel.hasCssClass

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

ScrollablePanel.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

Return index of overlay ( index of the specified child or -1 if baseLayer is not found)

number

ScrollablePanel.indexOfBaseLayer

▸ indexOfChild(node): number

Return index of child ( index of the specified child or -1 if node is not found)

number

ScrollablePanel.indexOfChild

▸ indexOfOverlay(overlay): number

Return index of overlay ( index of the specified child or -1 if overlay is not found)

number

ScrollablePanel.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): LegendPanel

Insert child baseLayer at specified index

LegendPanel

this

ScrollablePanel.insertBaseLayer

▸ insertChild(index, node): LegendPanel

Insert child node at specified index

LegendPanel

this

ScrollablePanel.insertChild

▸ insertOverlay(index, overlay): LegendPanel

Insert child overlay at specified index

LegendPanel

this

ScrollablePanel.insertOverlay

▸ invalidate(bounds?, force?): LegendPanel

Invalidate node

LegendPanel

this

ScrollablePanel.invalidate

▸ invalidateLayout(propagate?): LegendPanel

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LegendPanel

this

ScrollablePanel.invalidateLayout

▸ invalidateParent(bounds?, force?): LegendPanel

Invalidate parent area

LegendPanel

this

ScrollablePanel.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

ScrollablePanel.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ScrollablePanel.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

ScrollablePanel.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

ScrollablePanel.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

ScrollablePanel.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

ScrollablePanel.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

ScrollablePanel.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

ScrollablePanel.isSelectable

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

ScrollablePanel.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

ScrollablePanel.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): LegendPanel

MoveTo position of node to specified area

LegendPanel

this

ScrollablePanel.moveTo

▸ notify<E>(type, source, args?): LegendPanel

Notify listeners of the Node

LegendPanel

this

ScrollablePanel.notify

▸ Protected notifyRoot(event, source, args?): Node

Notify an even to root node

Node

this

ScrollablePanel.notifyRoot

▸ off<E>(type?, callback?): LegendPanel

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

LegendPanel

this

ScrollablePanel.off

▸ on<E>(type, callback): LegendPanel

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

LegendPanel

this

ScrollablePanel.on

▸ Protected onBoundsChanged(bounds): LegendPanel

Occurs when bounds has been changed

LegendPanel

this

ScrollablePanel.onBoundsChanged

▸ Protected onChildAdded(child): void

This method is called it child or children are added