Class: GeoTile

• new GeoTile(options)

• new GeoTile(options)

Projection.constructor

▸ addCssClass(cssclass): GeoTile

Adds new css class to node

GeoTile

this

Projection.addCssClass

▸ addInvalidateHandler(handler): GeoTile

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

GeoTile

this

Projection.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

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

Rect

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

Projection.checkCollision

▸ clearCache(): GeoTile

Clear cache

GeoTile

this

Projection.clearCache

▸ clone(): GeoTile

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

GeoTile

clone

Projection.clone

▸ connectStyle(style, type, callback): GeoTile

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

GeoTile

this

Projection.connectStyle

▸ Protected copyConstructor(src, deepCopy?): GeoTile

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

GeoTile

this

Projection.copyConstructor

▸ disconnectStyle(style, type, callback): GeoTile

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

GeoTile

this

Projection.disconnectStyle

▸ dispose(): void

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

void

Projection.dispose

▸ enableEventPropagation(enable): GeoTile

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

GeoTile

this

Projection.enableEventPropagation

▸ execute(delegate): GeoTile

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

GeoTile

The result if any or this

Projection.execute

▸ execute<T>(delegate): T

T

Projection.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

Projection.getCache

▸ getClassName(): string

string

Projection.getClassName

▸ getContentNode(): Node

Returns current projected content node

Node

Projection.getContentNode

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

Projection.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Projection.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Projection.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

Projection.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

Projection.getDefaultModelLimits

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

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

Projection.getLayerAlpha

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

Projection.getMapCoordinateSystem

▸ getModelLimits(): Rect

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

Rect

limits user defined or calculated model limits

Projection.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Projection.getName

▸ getOptions(): Options

Gets options

Options

options options

Projection.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

Projection.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

options

Projection.getProperties

▸ getProperty(name): any

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

any

Projection.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Projection.getPropertyKeys

▸ getResourceManager(): TileResourceManager

Returns resource manager used to create projection intermediate results

TileResourceManager

Projection.getResourceManager

▸ getRoot(): Node

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

Node

the root node

Projection.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Projection.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

Projection.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Projection.getTag

▸ getTooltipFormatter(): Formatter

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

Formatter

Projection.getTooltipFormatter

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Projection.getVisible

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Projection.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

the world transform.

Projection.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Projection.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Projection.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

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

Projection.hitTest

▸ invalidate(bounds?, force?): GeoTile

Invalidate layer

GeoTile

this

Projection.invalidate

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

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

Fires

Events.Invalidate

GeoTile

this

Projection.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Projection.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Projection.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

Projection.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Projection.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Projection.isSelectable

▸ isSilent(): boolean

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

boolean

Projection.isSilent

▸ load(): Promise<GeoTile>

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

Promise<GeoTile>

Projection.load

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

Notify listeners of the Node

GeoTile

this

Projection.notify

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

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.

GeoTile

this

Projection.off

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

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.

GeoTile

this

Projection.on

▸ Protected onParentChanged(node): GeoTile

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

GeoTile

this

Projection.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Projection.onVisibilityChanged

▸ removeCssClass(cssclass): GeoTile

Removes css class from node

GeoTile

this

Projection.removeCssClass

▸ removeInvalidateHandler(handler): GeoTile

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

GeoTile

this

Projection.removeInvalidateHandler

▸ render(context): void

Renders node

void

Projection.render

▸ renderAsync(context, callback): void

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

void

Projection.renderAsync

▸ renderContent(context): void

Renders layer content

void

Projection.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

Projection.renderContentAsync

▸ setCache(cache): GeoTile

Sets cache to be used to cache

GeoTile

this

Projection.setCache

▸ setContentNode(node): GeoTile

Sets content node to be projected

GeoTile

this

Projection.setContentNode

▸ setCssClass(name): GeoTile

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

GeoTile

this

Projection.setCssClass

▸ setId(id): GeoTile

Allows the user to associate any identifier

GeoTile

this

Projection.setId

▸ setLayerAlpha(alpha): GeoTile

Set the alpha of the layer

GeoTile

this

Projection.setLayerAlpha

▸ setMapCoordinateSystem(system?): GeoTile

Sets a map coordinate system

GeoTile

Projection.setMapCoordinateSystem

▸ setModelLimits(limits): GeoTile

Sets model limits

GeoTile

this

Projection.setModelLimits

▸ setName(name): GeoTile

Sets name of the node

GeoTile

this

Projection.setName

▸ setNotification(notify, force?): GeoTile

set notification state

GeoTile

this

Projection.setNotification

▸ setOptions(options?): GeoTile

Sets options (default options listed are for construction time only)

GeoTile

Projection.setOptions

▸ setProperties(properties?): GeoTile

Sets all the properties pertaining to this object

GeoTile

this

Projection.setProperties

▸ setProperty(name, value): GeoTile

Sets dynamic property by name

GeoTile

this

Projection.setProperty

▸ setSelectable(selectable): GeoTile

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

GeoTile

this

Projection.setSelectable

▸ setServerURL(url): GeoTile

Sets the url to the layer source

GeoTile

Projection.setServerURL

▸ setSilent(bool): GeoTile

Set silent mode

GeoTile

this

Projection.setSilent

▸ setTag(tag): GeoTile

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

GeoTile

this

Projection.setTag

▸ setVisible(value): GeoTile

Sets visibility of the node. Send event Events.VisibilityChanged

GeoTile

this

Projection.setVisible

▸ setZIndex(value): GeoTile

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

GeoTile

this

Projection.setZIndex

▸ toString(): string

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

string

A string representation

Projection.toString

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

Transform a point from map coordinate system to layer coordinate system

Point

Projection.transformFromMap

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

Transform point

Point

Projection.transformPoint

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

Transform a point from layer coordinate system to map coordinate system

Point

Projection.transformToMap

▸ updateSceneTransformation(): GeoTile

Update scene transformation

GeoTile

this

Projection.updateSceneTransformation

▸ updateState(regions?, changes?): GeoTile

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

GeoTile

this

Projection.updateState

▸ Protected updateTimeStamp(): GeoTile

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

GeoTile

this

Projection.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Projection.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

Projection.findParent

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

Find root of the node with specified type

Node

Projection.findParent

▸ Static getClassName(): string

string

Projection.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Projection.isSceneGraphNotificationEnabled