Class: Heatmap

• new Heatmap(options)

• new Heatmap(options?)

AbstractFeatureLayer.constructor

▸ addCssClass(cssclass): Heatmap

Adds new css class to node

Heatmap

this

AbstractFeatureLayer.addCssClass

▸ addInvalidateHandler(handler): Heatmap

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Heatmap

this

AbstractFeatureLayer.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

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

Rect

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

AbstractFeatureLayer.checkCollision

▸ clearCache(): Heatmap

Clear cache

Heatmap

this

AbstractFeatureLayer.clearCache

▸ clone(): Node

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

Node

clone

AbstractFeatureLayer.clone

▸ connectStyle(style, type, callback): Heatmap

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

Heatmap

this

AbstractFeatureLayer.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Heatmap

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

Heatmap

this

AbstractFeatureLayer.copyConstructor

▸ disconnectStyle(style, type, callback): Heatmap

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

Heatmap

this

AbstractFeatureLayer.disconnectStyle

▸ dispose(): void

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

void

AbstractFeatureLayer.dispose

▸ enableEventPropagation(enable): Heatmap

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

Heatmap

this

AbstractFeatureLayer.enableEventPropagation

▸ execute(delegate): Heatmap

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

Heatmap

The result if any or this

AbstractFeatureLayer.execute

▸ execute<T>(delegate): T

T

AbstractFeatureLayer.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

AbstractFeatureLayer.getCache

▸ getClassName(): string

string

AbstractFeatureLayer.getClassName

▸ getColorProvider(): ColorProvider

Returns current heatmap color provider

ColorProvider

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

AbstractFeatureLayer.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractFeatureLayer.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractFeatureLayer.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

AbstractFeatureLayer.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

AbstractFeatureLayer.getDefaultModelLimits

▸ getFeatureById(id): AbstractFeature

Gets feature by feature id.

AbstractFeature

feature if found; null otherwise

AbstractFeatureLayer.getFeatureById

▸ getFeatures(filter?): Iterator<AbstractFeature>

Gets features iterator

Iterator<AbstractFeature>

feature iterator (over all features if filter is null)

AbstractFeatureLayer.getFeatures

▸ getGeometryToText(feature): IGeometryToText

Gets feature_geometry-to-text_anchor_position adapter

IGeometryToText

AbstractFeatureLayer.getGeometryToText

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

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

AbstractFeatureLayer.getLayerAlpha

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

AbstractFeatureLayer.getMapCoordinateSystem

▸ getMaxIntensity(): number | IntensityCallback

Returns maximum intensity value (or a callback for it). If not set, returns calculated value

number | IntensityCallback

▸ getMode(): Mode

Returns heatmap calculation mode

Mode

▸ getModelLimits(): Rect

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

Rect

limits user defined or calculated model limits

AbstractFeatureLayer.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

AbstractFeatureLayer.getName

▸ getOptions(): Options

Gets options

Options

options options

AbstractFeatureLayer.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

AbstractFeatureLayer.getParent

▸ getProperties(): OptionsOut

Returns all the properties pertaining to this object

OptionsOut

the properties to set

AbstractFeatureLayer.getProperties

▸ getProperty(name): any

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

any

AbstractFeatureLayer.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractFeatureLayer.getPropertyKeys

▸ getRadius(): number | RadiusCallback

Returns heatmap radius (or a callback for it)

number | RadiusCallback

▸ getRoot(): Node

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

Node

the root node

AbstractFeatureLayer.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractFeatureLayer.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

AbstractFeatureLayer.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractFeatureLayer.getTag

▸ getTooltipFormatter(): Formatter

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

Formatter

AbstractFeatureLayer.getTooltipFormatter

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AbstractFeatureLayer.getVisible

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

AbstractFeatureLayer.getVisibleModelLimits

▸ getWeightField(): string | WeightCallback

Returns current weight field name or a callback for it (if exists, null otherwise)

string | WeightCallback

▸ getWorldTransform(): Transformation

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

Transformation

the world transform.

AbstractFeatureLayer.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractFeatureLayer.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractFeatureLayer.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

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

AbstractFeatureLayer.hitTest

▸ invalidate(bounds?, force?): Heatmap

Invalidate layer

Heatmap

this

AbstractFeatureLayer.invalidate

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

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

Fires

Events.Invalidate

Heatmap

this

AbstractFeatureLayer.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractFeatureLayer.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractFeatureLayer.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

AbstractFeatureLayer.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractFeatureLayer.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractFeatureLayer.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractFeatureLayer.isSilent

▸ load(): Promise<Heatmap>

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

Promise<Heatmap>

AbstractFeatureLayer.load

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

Notify listeners of the Node

Heatmap

this

AbstractFeatureLayer.notify

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

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.

Heatmap

this

AbstractFeatureLayer.off

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

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.

Heatmap

this

AbstractFeatureLayer.on

▸ Protected onParentChanged(node): Heatmap

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

Heatmap

this

AbstractFeatureLayer.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AbstractFeatureLayer.onVisibilityChanged

▸ queryFeatures(query): AbstractFeature[]

queries layer for items that match the search

AbstractFeature[]

features selected features

AbstractFeatureLayer.queryFeatures

▸ removeCssClass(cssclass): Heatmap

Removes css class from node

Heatmap

this

AbstractFeatureLayer.removeCssClass

▸ removeInvalidateHandler(handler): Heatmap

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Heatmap

this

AbstractFeatureLayer.removeInvalidateHandler

▸ render(context): void

Renders node

void

AbstractFeatureLayer.render

▸ renderAnnotations(featuresIt, context): void

Renders annotations (to filtered features only)

void

AbstractFeatureLayer.renderAnnotations

▸ renderAsync(context, callback): void

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

void

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

AbstractFeatureLayer.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

AbstractFeatureLayer.renderContentAsync

▸ renderFeatures(featuresIt, context): void

Calculates features influence into 2d pixel array for the later rendering

void

AbstractFeatureLayer.renderFeatures

▸ setCache(cache): Heatmap

Sets cache to be used to cache

Heatmap

this

AbstractFeatureLayer.setCache

▸ setColorProvider(provider): Heatmap

Sets color provider for heatmap colors interpolation

Heatmap

this

▸ setCssClass(name): Heatmap

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

Heatmap

this

AbstractFeatureLayer.setCssClass

▸ setId(id): Heatmap

Allows the user to associate any identifier

Heatmap

this

AbstractFeatureLayer.setId

▸ setLayerAlpha(alpha): Heatmap

Set the alpha of the layer

Heatmap

this

AbstractFeatureLayer.setLayerAlpha

▸ setMapCoordinateSystem(system): Heatmap

Sets a map coordinate system

Heatmap

this

AbstractFeatureLayer.setMapCoordinateSystem

▸ setMaxIntensity(intensity): Heatmap

Sets maximum intensity value

Heatmap

this

▸ setMode(mode): Heatmap

Sets heatmap calculation mode

Heatmap

this

▸ setModelLimits(limits): Heatmap

Sets model limits

Heatmap

this

AbstractFeatureLayer.setModelLimits

▸ setName(name): Heatmap

Sets name of the node

Heatmap

this

AbstractFeatureLayer.setName

▸ setNotification(notify, force?): Heatmap

set notification state

Heatmap

this

AbstractFeatureLayer.setNotification

▸ setOptions(options?): Heatmap

Sets options

Heatmap

this

AbstractFeatureLayer.setOptions

▸ setProperties(properties?): Heatmap

Sets all the properties pertaining to this object

Heatmap

this

AbstractFeatureLayer.setProperties

▸ setProperty(name, value): Heatmap

Sets dynamic property by name

Heatmap

this

AbstractFeatureLayer.setProperty

▸ setRadius(radius): Heatmap

Sets heatmap radius

Heatmap

this

▸ setSelectable(selectable): Heatmap

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

Heatmap

this

AbstractFeatureLayer.setSelectable

▸ setServerURL(url): Heatmap

Sets the url to the layer source

Heatmap

AbstractFeatureLayer.setServerURL

▸ setSilent(bool): Heatmap

Set silent mode

Heatmap

this

AbstractFeatureLayer.setSilent

▸ setTag(tag): Heatmap

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

Heatmap

this

AbstractFeatureLayer.setTag

▸ setVisible(value): Heatmap

Sets visibility of the node. Send event Events.VisibilityChanged

Heatmap

this

AbstractFeatureLayer.setVisible

▸ setWeightField(field): Heatmap

Sets features' field name to use as the weight value (or a callback for it)

Heatmap

this

▸ setZIndex(value): Heatmap

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

Heatmap

this

AbstractFeatureLayer.setZIndex

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

Converts layer features into CSV formatted object

string[][]

geoJson geoJson object

AbstractFeatureLayer.toCSV

▸ toGeoJSON(): Feature

Converts layer features into GeoJSON format

Feature

geoJson geoJson object

AbstractFeatureLayer.toGeoJSON

▸ toString(): string

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

string

A string representation

AbstractFeatureLayer.toString

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

Transform a point from map coordinate system to layer coordinate system

Point

AbstractFeatureLayer.transformFromMap

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

Transform point

Point

AbstractFeatureLayer.transformPoint

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

Transform a point from layer coordinate system to map coordinate system

Point

AbstractFeatureLayer.transformToMap

▸ updateSceneTransformation(): Heatmap

Update scene transformation

Heatmap

this

AbstractFeatureLayer.updateSceneTransformation

▸ updateState(regions?, changes?): Heatmap

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

Heatmap

this

AbstractFeatureLayer.updateState

▸ Protected updateTimeStamp(): Heatmap

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

Heatmap

this

AbstractFeatureLayer.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

AbstractFeatureLayer.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

AbstractFeatureLayer.findParent

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

Find root of the node with specified type

Node

AbstractFeatureLayer.findParent

▸ Static getClassName(): string

string

AbstractFeatureLayer.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

AbstractFeatureLayer.isSceneGraphNotificationEnabled