Class: ArcGISImage

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

• new ArcGISImage(options?)

Creates layer

Image.constructor

▸ addCssClass(cssclass): ArcGISImage

Adds new css class to node

ArcGISImage

this

Image.addCssClass

▸ addInvalidateHandler(handler): ArcGISImage

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

ArcGISImage

this

Image.addInvalidateHandler

▸ Protected calculateDefaultModelLimits(data?): Rect

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

Rect

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

Image.checkCollision

▸ clearCache(): ArcGISImage

Clear cache

ArcGISImage

this

Image.clearCache

▸ clone(): Node

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

Node

clone

Image.clone

▸ connectStyle(style, type, callback): ArcGISImage

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

ArcGISImage

this

Image.connectStyle

▸ Protected copyConstructor(src, deepCopy?): ArcGISImage

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

ArcGISImage

this

Image.copyConstructor

▸ disconnectStyle(style, type, callback): ArcGISImage

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

ArcGISImage

this

Image.disconnectStyle

▸ dispose(): void

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

void

Image.dispose

▸ enableEventPropagation(enable): ArcGISImage

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

ArcGISImage

this

Image.enableEventPropagation

▸ execute(delegate): ArcGISImage

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

ArcGISImage

The result if any or this

Image.execute

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

T

Image.execute

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache cache strategy

Image.getCache

▸ getClassName(): string

string

Image.getClassName

▸ getCoordinateSystem(): AbstractSystem

Return coordinate system for this layer

AbstractSystem

Image.getCoordinateSystem

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Image.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Image.getCssClasses

▸ getDataSource(): AbstractSource

Returns current data source

AbstractSource

source

Image.getDataSource

▸ getDefaultModelLimits(): Rect

Gets calculated model limits

Rect

limits calculated model limits

Image.getDefaultModelLimits

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

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

Image.getLayerAlpha

▸ getLayers(): LayerServerData[]

Gets the JSON data of the available layers for the server

LayerServerData[]

Image.getLayers

▸ getMapCoordinateSystem(): AbstractSystem

Return a map coordinate system

AbstractSystem

Image.getMapCoordinateSystem

▸ getMaxZoom(): number

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

number

layer maximum zoom level.

Image.getMaxZoom

▸ getMinZoom(): number

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

number

layer minimum zoom level.

Image.getMinZoom

▸ getModelLimits(): Rect

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

Rect

limits user defined or calculated model limits

Image.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Image.getName

▸ getOptions(): Options

Gets options

Options

options options

Image.getOptions

▸ getParent(): Node

Return parent node

Node

parent node

Image.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

object containing the properties

Image.getProperties

▸ getProperty(name): any

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

any

Image.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Image.getPropertyKeys

▸ getRoot(): Node

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

Node

the root node

Image.getRoot

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Image.getSceneTransform

▸ getServerURL(): string | string[]

Gets the server url from the layer source

string | string[]

Image.getServerURL

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Image.getTag

▸ getTooltipFormatter(): Formatter

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

Formatter

Image.getTooltipFormatter

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

Image.getVisibleByZoom

▸ getVisibleLayers(): (string | number)[]

Returns the server layer names that are requested.

(string | number)[]

layers

Image.getVisibleLayers

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Image.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

the world transform.

Image.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Image.getZIndex

▸ getZoomLayerVisibility(): boolean

Get layer zoom layer visibility status

boolean

true if layer is visible.

Image.getZoomLayerVisibility

▸ getZoomLevel(): number

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

number

Image.getZoomLevel

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Image.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Image.hasEventListener

▸ hideLayers(id?): ArcGISImage

Adds the passed in ID's to the list of layers to hide

ArcGISImage

Image.hideLayers

▸ hitTest(pt, radius?): 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).

AbstractFeature[]

data data selected

Image.hitTest

▸ invalidate(bounds?, force?): ArcGISImage

Invalidate layer

ArcGISImage

this

Image.invalidate

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

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

Fires

Events.Invalidate

ArcGISImage

this

Image.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Image.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Image.isEventPropagationEnabled

▸ isLoading(): boolean

Checks if layer data is still loading and not ready

boolean

Image.isLoading

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Image.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Image.isSelectable

▸ isSilent(): boolean

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

boolean

Image.isSilent

▸ load(): Promise<ArcGISImage&gt;

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

Promise<ArcGISImage&gt;

Image.load

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

Notify listeners of the Node

ArcGISImage

this

Image.notify

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

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.

ArcGISImage

this

Image.off

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

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>

ArcGISImage

this

Image.on

▸ Protected onParentChanged(node): ArcGISImage

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

ArcGISImage

this

Image.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Image.onVisibilityChanged

▸ queryLegend(callback?): ArcGISImage

Queries layer legend data. WARNING! Only ArcGIS version 10.0 and higher supports this operation.

ArcGISImage

this

▸ removeCssClass(cssclass): ArcGISImage

Removes css class from node

ArcGISImage

this

Image.removeCssClass

▸ removeInvalidateHandler(handler): ArcGISImage

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

ArcGISImage

this

Image.removeInvalidateHandler

▸ render(context): void

Renders node

void

Image.render

▸ renderAsync(context, callback): void

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

void

Image.renderAsync

▸ renderContent(context): void

Renders layer content

void

Image.renderContent

▸ renderContentAsync(context, callback): void

Renders async layer content

void

Image.renderContentAsync

▸ setCache(cache): ArcGISImage

Sets cache to be used to cache

ArcGISImage

this

Image.setCache

▸ setCssClass(name): ArcGISImage

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

ArcGISImage

this

Image.setCssClass

▸ setId(id): ArcGISImage

Allows the user to associate any identifier

ArcGISImage

this

Image.setId

▸ setLayerAlpha(alpha): ArcGISImage

Set the alpha of the layer

ArcGISImage

this

Image.setLayerAlpha

▸ setMapCoordinateSystem(system?): ArcGISImage

Sets a map coordinate system

ArcGISImage

Image.setMapCoordinateSystem

▸ setMaxZoom(zoom): ArcGISImage

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

ArcGISImage

this

Image.setMaxZoom

▸ setMinZoom(zoom): ArcGISImage

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

ArcGISImage

this

Image.setMinZoom

▸ setModelLimits(limits): ArcGISImage

Sets model limits

ArcGISImage

this

Image.setModelLimits

▸ setName(name): ArcGISImage

Sets name of the node

ArcGISImage

this

Image.setName

▸ setNotification(notify, force?): ArcGISImage

set notification state

ArcGISImage

this

Image.setNotification

▸ setOptions(options?): ArcGISImage

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

ArcGISImage

Image.setOptions

▸ setParent(parent): ArcGISImage

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

ArcGISImage

this

Image.setParent

▸ setProperties(properties?): ArcGISImage

Sets all the properties pertaining to this object

ArcGISImage

this

Image.setProperties

▸ setProperty(name, value): ArcGISImage

Sets dynamic property by name

ArcGISImage

this

Image.setProperty

▸ setSelectable(selectable): ArcGISImage

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

ArcGISImage

this

Image.setSelectable

▸ setServerURL(url): ArcGISImage

Sets the url to the layer source

ArcGISImage

Image.setServerURL

▸ setSilent(bool): ArcGISImage

Set silent mode

ArcGISImage

this

Image.setSilent

▸ setTag(tag): ArcGISImage

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

ArcGISImage

this

Image.setTag

▸ setVisible(value): ArcGISImage

Sets visibility of the node. Send event Events.VisibilityChanged

ArcGISImage

this

Image.setVisible

▸ setZIndex(value): ArcGISImage

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

ArcGISImage

this

Image.setZIndex

▸ showLayers(id): ArcGISImage

Adds the passed in ID's to the list of layers to show

ArcGISImage

Image.showLayers

▸ toString(): string

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

string

A string representation

Image.toString

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

Transform a point from map coordinate system to layer coordinate system

Point

Image.transformFromMap

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

Transform point

Point

Image.transformPoint

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

Transform a point from layer coordinate system to map coordinate system

Point

Image.transformToMap

▸ updateSceneTransformation(): ArcGISImage

Update scene transformation

ArcGISImage

this

Image.updateSceneTransformation

▸ updateState(regions?, changes?): ArcGISImage

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

ArcGISImage

this

Image.updateState

▸ Protected updateTimeStamp(): ArcGISImage

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

ArcGISImage

this

Image.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Image.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T&gt;

Image.findParent

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

Find root of the node with specified type

Node

Image.findParent

▸ Static getClassName(): string

string

Image.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Image.isSceneGraphNotificationEnabled