Class: KML

• new KML(options)

• new KML(options?)

Vector.constructor

▸ addCssClass(cssclass): KML

Adds new css class to node

KML

this

Vector.addCssClass

▸ addFeature(parameter): KML

Adds feature(s)

Throws

if a feature to add is not supported

KML

Vector.addFeature

▸ addInvalidateHandler(handler): KML

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

KML

this

Vector.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(features?): Rect

The implementation builds default limits from scratch if no iterator is provided; otherwise, it extends previously calculated limits with limits calculated over new features.

Rect

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

Vector.checkCollision

▸ clearCache(): KML

Clear cache

KML

this

Vector.clearCache

▸ clearFeatures(): KML

Removes all feature(s)

KML

this

Vector.clearFeatures

▸ clone(): Node

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

Node

clone

Vector.clone

▸ connectStyle(style, type, callback): KML

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

KML

this

Vector.connectStyle

▸ Protected copyConstructor(src, deepCopy?): KML

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

KML

this

Vector.copyConstructor

▸ disconnectStyle(style, type, callback): KML

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

KML

this

Vector.disconnectStyle

▸ dispose(): void

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

void

Vector.dispose

▸ enableEventPropagation(enable): KML

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

KML

this

Vector.enableEventPropagation

▸ execute(delegate): KML

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

KML

The result if any or this

Vector.execute

▸ execute<T>(delegate): T

T

Vector.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

Vector.getCache

▸ getClassName(): string

string

Vector.getClassName

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

Vector.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Vector.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Vector.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

Vector.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

Vector.getDefaultModelLimits

▸ getFeatureById(id): AbstractFeature

Gets feature by feature id.

AbstractFeature

feature if found; null otherwise

Vector.getFeatureById

▸ getFeatures(filter?): Iterator<AbstractFeature>

Gets features iterator

Iterator<AbstractFeature>

feature iterator (over all features if filter is null)

Vector.getFeatures

▸ getGeometryToText(feature): IGeometryToText

Gets feature_geometry-to-text_anchor_position adapter

IGeometryToText

Vector.getGeometryToText

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

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

Vector.getLayerAlpha

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

Vector.getMapCoordinateSystem

▸ getModelLimits(): Rect

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

Rect

limits user defined or calculated model limits

Vector.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Vector.getName

▸ getOptions(): Options

Gets options

Options

options options

Vector.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

Vector.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

Vector.getProperties

▸ getProperty(name): any

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

any

Vector.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Vector.getPropertyKeys

▸ getRoot(): Node

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

Node

the root node

Vector.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Vector.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

Vector.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Vector.getTag

▸ getTemplate(parameter): BaseTemplate

Gets template associated with a feature or its class name

BaseTemplate

template

Vector.getTemplate

▸ getTooltipFormatter(): Formatter

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

Formatter

Vector.getTooltipFormatter

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Vector.getVisible

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Vector.getVisibleModelLimits

▸ getWorldTransform(): Transformation

getWorldTransform retrieves the local transformation of the inner node coordinates to parent coordinates.

Transformation

the world transform.

Vector.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Vector.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Vector.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Vector.hasEventListener

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

Performs selection of the features with its device coordinates

AbstractFeature[]

features features selected

Vector.hitTest

▸ invalidate(bounds?, force?): KML

Invalidate layer

KML

this

Vector.invalidate

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

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

Fires

Events.Invalidate

KML

this

Vector.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Vector.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Vector.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

Vector.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Vector.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Vector.isSelectable

▸ isSilent(): boolean

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

boolean

Vector.isSilent

▸ load(): Promise<KML>

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

Promise<KML>

Vector.load

▸ notify<E>(event, source, args?): KML

Notify listeners of the Node

KML

this

Vector.notify

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

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.

KML

this

Vector.off

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

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.

KML

this

Vector.on

▸ Protected onParentChanged(node): KML

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

KML

this

Vector.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Vector.onVisibilityChanged

▸ queryFeatures(query): AbstractFeature[]

queries layer for items that match the search

AbstractFeature[]

features selected features

Vector.queryFeatures

▸ removeCssClass(cssclass): KML

Removes css class from node

KML

this

Vector.removeCssClass

▸ removeFeature(parameter): KML

Removes feature(s)

KML

this

Vector.removeFeature

▸ removeInvalidateHandler(handler): KML

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

KML

this

Vector.removeInvalidateHandler

▸ render(context): void

Renders node

void

Vector.render

▸ renderAnnotations(featuresIt, context): void

Renders annotations (to filtered features only)

void

Vector.renderAnnotations

▸ renderAsync(context, callback): void

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

void

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

Vector.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

Vector.renderContentAsync

▸ renderFeatures(featuresIt, context): void

Renders features.
NOTE:
When picking is performed, then feature is selected if its shape gets picked.

void

Vector.renderFeatures

▸ resetFeatureTemplates(features?, suppressInvalidate?): KML

If no features provided then resets all shape templates to their initial states;
otherwise resets specific templates for the features provided

KML

Vector.resetFeatureTemplates

▸ setCache(cache): KML

Sets cache to be used to cache

KML

this

Vector.setCache

▸ setCssClass(name): KML

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

KML

this

Vector.setCssClass

▸ setId(id): KML

Allows the user to associate any identifier

KML

this

Vector.setId

▸ setLayerAlpha(alpha): KML

Set the alpha of the layer

KML

this

Vector.setLayerAlpha

▸ setMapCoordinateSystem(system): KML

Sets a map coordinate system

KML

this

Vector.setMapCoordinateSystem

▸ setModelLimits(limits): KML

Sets model limits

KML

this

Vector.setModelLimits

▸ setName(name): KML

Sets name of the node

KML

this

Vector.setName

▸ setNotification(notify, force?): KML

set notification state

KML

this

Vector.setNotification

▸ setOptions(options?): KML

Sets options

KML

this

Vector.setOptions

▸ setProperties(properties?): KML

Sets all the properties pertaining to this object see Vector.getProperties

KML

this

Vector.setProperties

▸ setProperty(name, value): KML

Sets dynamic property by name

KML

this

Vector.setProperty

▸ setSelectable(selectable): KML

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

KML

this

Vector.setSelectable

▸ setServerURL(url): KML

Sets the url to the layer source

KML

Vector.setServerURL

▸ setSilent(bool): KML

Set silent mode

KML

this

Vector.setSilent

▸ setTag(tag): KML

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

KML

this

Vector.setTag

▸ setTemplate(parameter, template, suppressInvalidate?): KML

Sets template associated with a feature or features

KML

Vector.setTemplate

▸ setUniqueField(field): KML

Sets the unique identifier for the features

KML

this

Vector.setUniqueField

▸ setVisible(value): KML

Sets visibility of the node. Send event Events.VisibilityChanged

KML

this

Vector.setVisible

▸ setZIndex(value): KML

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

KML

this

Vector.setZIndex

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

Converts layer features into CSV formatted object

string[][]

geoJson geoJson object

Vector.toCSV

▸ toGeoJSON(): Feature

Converts layer features into GeoJSON format

Feature

geoJson geoJson object

Vector.toGeoJSON

▸ toString(): string

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

string

A string representation

Vector.toString

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

Transform a point from map coordinate system to layer coordinate system

Point

Vector.transformFromMap

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

Transform point

Point

Vector.transformPoint

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

Transform a point from layer coordinate system to map coordinate system

Point

Vector.transformToMap

▸ updateGeometry(feature, geometry): KML

updates the geometry for the feature in this layer

KML

Vector.updateGeometry

▸ updateSceneTransformation(): KML

Update scene transformation

KML

this

Vector.updateSceneTransformation

▸ updateState(regions?, changes?): KML

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

KML

this

Vector.updateState

▸ Protected updateTimeStamp(): KML

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

KML

this

Vector.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Vector.enableSceneGraphNotification

▸ Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

Vector.findParent

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

Find root of the node with specified type

Node

Vector.findParent

▸ Static getClassName(): string

string

Vector.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Vector.isSceneGraphNotificationEnabled