Class: AbstractFeatureLayer

• [new AbstractFeatureLayer(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.layers.abstractfeaturelayer.abstractfeaturelayer.md#new abstractfeaturelayer(options))

• Protected new AbstractFeatureLayer(options?)

Creates feature layer

AbstractLayer.constructor

▸ addCssClass(cssclass): AbstractFeatureLayer

Adds new css class to node

AbstractFeatureLayer

this

AbstractLayer.addCssClass

▸ addInvalidateHandler(handler): AbstractFeatureLayer

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AbstractFeatureLayer

this

AbstractLayer.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

Returns default model limits (based on the map coordinate system)

Rect

AbstractLayer.calculateDefaultModelLimits

▸ checkCollision(context): boolean

Check if this node is within the area being rendered by the context

boolean

true if object is inside of renderable area

AbstractLayer.checkCollision

▸ clearCache(): AbstractFeatureLayer

Clear cache

AbstractFeatureLayer

this

AbstractLayer.clearCache

▸ clone(): Node

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

Node

clone

AbstractLayer.clone

▸ connectStyle(style, type, callback): AbstractFeatureLayer

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

AbstractFeatureLayer

this

AbstractLayer.connectStyle

▸ Protected copyConstructor(src, deepCopy?): AbstractFeatureLayer

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

AbstractFeatureLayer

this

AbstractLayer.copyConstructor

▸ disconnectStyle(style, type, callback): AbstractFeatureLayer

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

AbstractFeatureLayer

this

AbstractLayer.disconnectStyle

▸ dispose(): void

Disposes this layer, once disposed it should not be used anymore.<br>

void

AbstractLayer.dispose

▸ enableEventPropagation(enable): AbstractFeatureLayer

Enable event propagation from the node hierarchy from bottom to top <p> 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. </p>

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

AbstractFeatureLayer

this

AbstractLayer.enableEventPropagation

▸ execute(delegate): AbstractFeatureLayer

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> 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");
});

AbstractFeatureLayer

The result if any or this

AbstractLayer.execute

▸ execute<T&gt;(delegate): T

T

AbstractLayer.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

AbstractLayer.getCache

▸ getClassName(): string

string

AbstractLayer.getClassName

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

AbstractLayer.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractLayer.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractLayer.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

AbstractLayer.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

AbstractLayer.getDefaultModelLimits

▸ getFeatureById(id): AbstractFeature

Gets feature by feature id.

AbstractFeature

feature if found; null otherwise

▸ getFeatures(filter?): Iterator<AbstractFeature&gt;

Gets features iterator

Iterator<AbstractFeature&gt;

feature iterator (over all features if filter is null)

▸ Abstract getGeometryToText(feature?): IGeometryToText

Gets feature_geometry-to-text_anchor_position adapter

IGeometryToText

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AbstractLayer.getId

▸ getLayerAlpha(): number

Return a the alpha of the layer between 0.0 (fully transparent) and 1.0 (fully opaque). The default value is 1.0.

number

alpha alpha

AbstractLayer.getLayerAlpha

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

AbstractLayer.getMapCoordinateSystem

▸ getMaxZoom(): number

Get maximum zoom level for layer to visualize layer data based on map zoom level

number

layer maximum zoom level.

AbstractLayer.getMaxZoom

▸ getMinZoom(): number

Get minimum zoom level for layer to visualize layer data based on map zoom level

number

layer minimum zoom level.

AbstractLayer.getMinZoom

▸ getModelLimits(): Rect

Gets user defined model limits if set; calculated model limits otherwise

Rect

limits user defined or calculated model limits

AbstractLayer.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

AbstractLayer.getName

▸ getOptions(): Options

Gets options

Options

options options

AbstractLayer.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

AbstractLayer.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

object containing the properties

AbstractLayer.getProperties

▸ getProperty(name): any

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

any

AbstractLayer.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractLayer.getPropertyKeys

▸ getRoot(): Node

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

Node

the root node

AbstractLayer.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractLayer.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

AbstractLayer.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractLayer.getTag

▸ getTooltipFormatter(): Formatter

Returns the format function to use for the tooltip info (null if tooltips are not visible)

Formatter

AbstractLayer.getTooltipFormatter

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AbstractLayer.getVisible

▸ Protected getVisibleByZoom(): boolean

Validate layer zoom base visibility based on minimum and maximum zoom level configuration. Update layer visibility status to true or false based on zoom level configuration. Notify ZoomVisibilityChanged event.

boolean

true if layer is visible.

AbstractLayer.getVisibleByZoom

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

AbstractLayer.getVisibleModelLimits

▸ getWorldTransform(): Transformation

<code>getWorldTransform</code> retrieves the local transformation of the inner node coordinates to parent coordinates.

Transformation

the world transform.

AbstractLayer.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractLayer.getZIndex

▸ getZoomLayerVisibility(): boolean

Get layer zoom layer visibility status

boolean

true if layer is visible.

AbstractLayer.getZoomLayerVisibility

▸ getZoomLevel(): number

Calculates current zoom level (float) for the default tile size

number

AbstractLayer.getZoomLevel

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractLayer.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractLayer.hasEventListener

▸ hitTest(pt, radius?): (AbstractNode | AbstractFeature)[]

Performs selection of the data with its device coordinates. Returns null, if no data available but will be loaded asynchronously later (fires Events.InfoUpdated).

(AbstractNode | AbstractFeature)[]

data data selected

AbstractLayer.hitTest

▸ invalidate(bounds?, force?): AbstractFeatureLayer

Invalidate layer

AbstractFeatureLayer

this

AbstractLayer.invalidate

▸ Protected invalidateParent(bounds?, force?): AbstractFeatureLayer

Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed

Fires

Events.Invalidate

AbstractFeatureLayer

this

AbstractLayer.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractLayer.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractLayer.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

AbstractLayer.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractLayer.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractLayer.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractLayer.isSilent

▸ load(): Promise<AbstractFeatureLayer&gt;

Returns promise that is resolved when all layer data is loaded and ready to be rendered

Promise<AbstractFeatureLayer&gt;

AbstractLayer.load

▸ notify<E&gt;(type, source, args?): AbstractFeatureLayer

Notify listeners of the Node

AbstractFeatureLayer

this

AbstractLayer.notify

▸ off<E&gt;(type?, callback?): AbstractFeatureLayer

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.

AbstractFeatureLayer

this

AbstractLayer.off

▸ on<E&gt;(type, callback): AbstractFeatureLayer

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

AbstractFeatureLayer

this

AbstractLayer.on

▸ Protected onParentChanged(node): AbstractFeatureLayer

This method is called when parent changes. Do not call it directly.

AbstractFeatureLayer

this

AbstractLayer.onParentChanged

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

AbstractLayer.onVisibilityChanged

▸ queryFeatures(query): AbstractFeature[]

queries layer for items that match the search

AbstractFeature[]

features selected features

▸ removeCssClass(cssclass): AbstractFeatureLayer

Removes css class from node

AbstractFeatureLayer

this

AbstractLayer.removeCssClass

▸ removeInvalidateHandler(handler): AbstractFeatureLayer

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AbstractFeatureLayer

this

AbstractLayer.removeInvalidateHandler

▸ render(context): void

Renders node

void

AbstractLayer.render

▸ renderAnnotations(featuresIt, context): void

Renders annotations (to filtered features only)

void

▸ renderAsync(context, callback): void

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

void

AbstractLayer.renderAsync

▸ renderContent(context): void

Renders content. The implementation:

1. Applies features filter(s) if set;
2. Execute "renderFeatures"; If annotations visible then:
3. Applies annotations filter(s) if set;
4. Execute "renderAnnotations"

void

AbstractLayer.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

AbstractLayer.renderContentAsync

▸ renderFeatures(featuresIt, context): void

Renders features. The basic implementations iterates over the features provided and renders them if derived from Node.

void

▸ setCache(cache): AbstractFeatureLayer

Sets cache to be used to cache

AbstractFeatureLayer

this

AbstractLayer.setCache

▸ setCssClass(name): AbstractFeatureLayer

Sets css class name of the node to be used to apply CSS style

AbstractFeatureLayer

this

AbstractLayer.setCssClass

▸ setId(id): AbstractFeatureLayer

Allows the user to associate any identifier

AbstractFeatureLayer

this

AbstractLayer.setId

▸ setLayerAlpha(alpha): AbstractFeatureLayer

Set the alpha of the layer

AbstractFeatureLayer

this

AbstractLayer.setLayerAlpha

▸ setMapCoordinateSystem(system): AbstractFeatureLayer

Sets a map coordinate system

AbstractFeatureLayer

this

AbstractLayer.setMapCoordinateSystem

▸ setMaxZoom(zoom): AbstractFeatureLayer

Set maximum zoom level for layer to visualize layer data based on map zoom level

AbstractFeatureLayer

this

AbstractLayer.setMaxZoom

▸ setMinZoom(zoom): AbstractFeatureLayer

Set minimum zoom level for layer to visualize layer data based on map zoom level

AbstractFeatureLayer

this

AbstractLayer.setMinZoom

▸ setModelLimits(limits): AbstractFeatureLayer

Sets model limits

AbstractFeatureLayer

this

AbstractLayer.setModelLimits

▸ setName(name): AbstractFeatureLayer

Sets name of the node

AbstractFeatureLayer

this

AbstractLayer.setName

▸ setNotification(notify, force?): AbstractFeatureLayer

set notification state

AbstractFeatureLayer

this

AbstractLayer.setNotification

▸ setOptions(options?): AbstractFeatureLayer

Sets options

AbstractFeatureLayer

this

AbstractLayer.setOptions

▸ setParent(parent): AbstractFeatureLayer

Sets parent node. Don't call this method directly. It is internal method.

AbstractFeatureLayer

this

AbstractLayer.setParent

▸ setProperties(properties?): AbstractFeatureLayer

Sets all the properties pertaining to this object

AbstractFeatureLayer

this

AbstractLayer.setProperties

▸ setProperty(name, value): AbstractFeatureLayer

Sets dynamic property by name

AbstractFeatureLayer

this

AbstractLayer.setProperty

▸ setSelectable(selectable): AbstractFeatureLayer

Allows to select node. If node is not selectable then child node is not selectable.

AbstractFeatureLayer

this

AbstractLayer.setSelectable

▸ setServerURL(url): AbstractFeatureLayer

Sets the url to the layer source

AbstractFeatureLayer

AbstractLayer.setServerURL

▸ setSilent(bool): AbstractFeatureLayer

Set silent mode

AbstractFeatureLayer

this

AbstractLayer.setSilent

▸ setTag(tag): AbstractFeatureLayer

Allows the user to associate any arbitrary object with the node.

AbstractFeatureLayer

this

AbstractLayer.setTag

▸ setVisible(value): AbstractFeatureLayer

Sets visibility of the node. Send event Events.VisibilityChanged

AbstractFeatureLayer

this

AbstractLayer.setVisible

▸ setZIndex(value): AbstractFeatureLayer

Sets z-index for node (set null for default)

AbstractFeatureLayer

this

AbstractLayer.setZIndex

▸ toCSV(base?): string[][]

Converts layer features into CSV formatted object

string[][]

geoJson geoJson object

▸ toGeoJSON(): Feature

Converts layer features into GeoJSON format

Feature

geoJson geoJson object

▸ toString(): string

Returns a string representation of this object (generally the classname)

string

A string representation

AbstractLayer.toString

▸ transformFromMap(point, dst?, clamp?): Point

Transform a point from map coordinate system to layer coordinate system

Point

AbstractLayer.transformFromMap

▸ transformPoint(point, from, to, dst?, clamp?): Point

Transform point

Point

AbstractLayer.transformPoint

▸ transformToMap(point, dst?, clamp?): Point

Transform a point from layer coordinate system to map coordinate system

Point

AbstractLayer.transformToMap

▸ updateSceneTransformation(): AbstractFeatureLayer

Update scene transformation

AbstractFeatureLayer

this

AbstractLayer.updateSceneTransformation

▸ updateState(regions?, changes?): AbstractFeatureLayer

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

AbstractFeatureLayer

this

AbstractLayer.updateState

▸ Protected updateTimeStamp(): AbstractFeatureLayer

Update time stamp to indicate that Node or Children has been changed.

AbstractFeatureLayer

this

AbstractLayer.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

AbstractLayer.enableSceneGraphNotification

▸ Static findParent<T&gt;(node, classType, filter?): InstanceType<T&gt;

Find root of the node with specified type

InstanceType<T&gt;

AbstractLayer.findParent

▸ Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Node

AbstractLayer.findParent

▸ Static getClassName(): string

string

AbstractLayer.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

AbstractLayer.isSceneGraphNotificationEnabled