Class: SymbolLegendItem

• new SymbolLegendItem(object, options)

• new SymbolLegendItem(object?, options?)

Create SymbolLegendItem

LegendItem.constructor

▸ addBaseLayer(baseLayer): SymbolLegendItem

Add baseLayer to container

SymbolLegendItem

this

LegendItem.addBaseLayer

▸ addChild(node): SymbolLegendItem

Add a child node

SymbolLegendItem

this

LegendItem.addChild

▸ addCssClass(cssclass): SymbolLegendItem

Adds new css class to node

SymbolLegendItem

this

LegendItem.addCssClass

▸ addInvalidateHandler(handler): SymbolLegendItem

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

SymbolLegendItem

this

LegendItem.addInvalidateHandler

▸ addOverlay(overlay): SymbolLegendItem

Add overlay to container

SymbolLegendItem

this

LegendItem.addOverlay

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

Adjust position of node to specified area

SymbolLegendItem

this

LegendItem.adjustPosition

▸ Protected applyOpacity(context): SymbolLegendItem

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

SymbolLegendItem

this

LegendItem.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

LegendItem.applyResponsiveStyle

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

Changes the z-order of the baseLayer.

SymbolLegendItem

this

LegendItem.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

SymbolLegendItem

this

LegendItem.changeChildOrder

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

Changes the z-order of the overlay.

SymbolLegendItem

this

LegendItem.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

LegendItem.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): SymbolLegendItem

Remove all child baseLayers from group

SymbolLegendItem

this

LegendItem.clearBaseLayers

▸ clearCache(): SymbolLegendItem

Clear cache

SymbolLegendItem

this

LegendItem.clearCache

▸ clearChildren(disposeChildren?): SymbolLegendItem

Remove all child nodes from this composite group

SymbolLegendItem

this

LegendItem.clearChildren

▸ clearOverlays(disposeOverlays?): SymbolLegendItem

Remove all child overlays from group

SymbolLegendItem

this

LegendItem.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

LegendItem.clone

▸ connectStyle(style, type, callback): SymbolLegendItem

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

SymbolLegendItem

this

LegendItem.connectStyle

▸ Protected copyConstructor(src): SymbolLegendItem

copy constructor

SymbolLegendItem

LegendItem.copyConstructor

▸ disconnectStyle(style, type, callback): SymbolLegendItem

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

SymbolLegendItem

this

LegendItem.disconnectStyle

▸ dispose(): void

Disposes the object.

void

LegendItem.dispose

▸ Protected drawBorder(localContext, bounds?): SymbolLegendItem

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

SymbolLegendItem

this

LegendItem.drawBorder

▸ enableClipping(doClip): SymbolLegendItem

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

SymbolLegendItem

this

LegendItem.enableClipping

▸ enableEventPropagation(enable): SymbolLegendItem

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();

SymbolLegendItem

this

LegendItem.enableEventPropagation

▸ enablePickingChildren(enable): SymbolLegendItem

Enables or disables picking children

SymbolLegendItem

this

LegendItem.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

LegendItem.enumerateNodes

▸ execute(delegate): SymbolLegendItem

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");
});

SymbolLegendItem

The result if any or this

LegendItem.execute

▸ execute<T>(delegate): T

T

LegendItem.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

LegendItem.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

LegendItem.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

LegendItem.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

LegendItem.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

LegendItem.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

LegendItem.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.

LegendItem.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

LegendItem.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

LegendItem.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

LegendItem.getCache

▸ getChild(i): Node

Return node by index

Node

LegendItem.getChild

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

Return iterator by child nodes

Iterator<S>

LegendItem.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.

LegendItem.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

LegendItem.getChildrenCount

▸ getClassName(): string

string

LegendItem.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

LegendItem.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

LegendItem.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

LegendItem.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

LegendItem.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

LegendItem.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

LegendItem.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

LegendItem.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

LegendItem.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)

LegendItem.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)

LegendItem.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

LegendItem.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

LegendItem.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

LegendItem.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

LegendItem.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

LegendItem.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

LegendItem.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

LegendItem.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

LegendItem.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

LegendItem.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

LegendItem.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

LegendItem.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

LegendItem.getName

▸ getObject(): EventDispatcher

Gets object

EventDispatcher

object

LegendItem.getObject

▸ getOpacity(): number

Returns current node opacity

number

opacity

LegendItem.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

LegendItem.getOpacityBlendMode

▸ getOptions(): OptionsOut

Sets item's options

Deprecated

since 4.0 use getProperties instead

OptionsOut

options options

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

LegendItem.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

LegendItem.getOverlayAt

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

Return iterator by overlays nodes

Iterator<Node>

LegendItem.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.

LegendItem.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

LegendItem.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

LegendItem.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

LegendItem.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

LegendItem.getPreferredSize

▸ getProperties(): OptionsOut

Returns the current symbol legend options

OptionsOut

options

LegendItem.getProperties

▸ getProperty(name): any

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

any

LegendItem.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

LegendItem.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

LegendItem.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

LegendItem.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

LegendItem.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

LegendItem.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

LegendItem.getSceneTransform

▸ getState(): number

Returns item state

number

LegendItem.getState

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

LegendItem.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

LegendItem.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

LegendItem.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

LegendItem.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

LegendItem.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

LegendItem.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

LegendItem.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

LegendItem.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

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

number

LegendItem.indexOfBaseLayer

▸ indexOfChild(node): number

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

number

LegendItem.indexOfChild

▸ indexOfOverlay(overlay): number

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

number

LegendItem.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): SymbolLegendItem

Insert child baseLayer at specified index

SymbolLegendItem

this

LegendItem.insertBaseLayer

▸ insertChild(index, node): SymbolLegendItem

Insert child node at specified index

SymbolLegendItem

this

LegendItem.insertChild

▸ insertOverlay(index, overlay): SymbolLegendItem

Insert child overlay at specified index

SymbolLegendItem

this

LegendItem.insertOverlay

▸ invalidate(bounds?, force?): SymbolLegendItem

Invalidate node

SymbolLegendItem

this

LegendItem.invalidate

▸ invalidateLayout(propagate?): SymbolLegendItem

Notify that layout is invalidated. Send event Events.LayoutInvalidated

SymbolLegendItem

this

LegendItem.invalidateLayout

▸ invalidateParent(bounds?, force?): SymbolLegendItem

Invalidate parent area

SymbolLegendItem

this

LegendItem.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

LegendItem.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

LegendItem.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

LegendItem.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

LegendItem.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

LegendItem.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

LegendItem.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

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

boolean

pickingChildren

LegendItem.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

LegendItem.isSelectable

▸ isSilent(): boolean

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

boolean

LegendItem.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

LegendItem.isVerticalFlip

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

MoveTo position of node to specified area

SymbolLegendItem

this

LegendItem.moveTo

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

Notify listeners of the Node

SymbolLegendItem

this

LegendItem.notify

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

Notify an even to root node

Node

this

LegendItem.notifyRoot

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

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.

SymbolLegendItem

this

LegendItem.off

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

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.

SymbolLegendItem

this

LegendItem.on

▸ Protected onBoundsChanged(bounds): SymbolLegendItem

Occurs when bounds has been changed

SymbolLegendItem

this

LegendItem.onBoundsChanged