Class: ArcGISImage

• new ArcGISImage(options)

• new ArcGISImage(options?)

Image.constructor

▸ abortGeometryQueries(): ArcGISImage

Aborts all the geometry data queried

ArcGISImage

this

▸ clear(): ArcGISImage

Notifies source to remove all data added.

ArcGISImage

this

Image.clear

▸ dispose(): void

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

void

Image.dispose

▸ getClassName(): string

string

Image.getClassName

▸ getCopyright(): string

Returns copyright information.

string

Image.getCopyright

▸ Protected getDataLoader(): AbstractLoader

Returns server data loader (if exists)

AbstractLoader

Image.getDataLoader

▸ getInflateRatio(): number

Returns current inflate ratio

number

Image.getInflateRatio

▸ getInitialCoordinateSystem(): AbstractSystem

Gets current data initial coordinate system.

AbstractSystem

Image.getInitialCoordinateSystem

▸ getInitialModelLimits(): Rect

Returns layer initial extent rectangle. Is supported in ArcGIS version 9.3 and higher.

Rect

▸ getLayers(): LayerServerData[]

Returns layers JSON data loaded from the server Should be used asynchronically after loadServerData() method is called

LayerServerData[]

Image.getLayers

▸ getMapCoordinateSystem(): AbstractSystem

Gets current map coordinate system.

AbstractSystem

Image.getMapCoordinateSystem

▸ getModelLimits(): Rect

Returns the current data model limits (presumably loaded from the server if it's settled)

Rect

Image.getModelLimits

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties

Image.getProperties

▸ getServerData(): JSONObject | XMLDocument

Returns server data loaded from the server Should be used asynchronically after loadServerData() method is called

JSONObject | XMLDocument

Image.getServerData

▸ getServerURL(): string | string[]

Gets the server url that is currently used for requests

string | string[]

server url

Image.getServerURL

▸ getSourceTimeout(): number

Returns timeout

number

Image.getSourceTimeout

▸ getToken(): string

Returns the authorization token (if set, null otherwise)

string

▸ getTransformerFromMap(): Transformer

Gets transformer to transform data from map coordinate system

Transformer

Image.getTransformerFromMap

▸ getTransformerToMap(): Transformer

Gets transformer to transform data to map coordinate system

Transformer

Image.getTransformerToMap

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

Returns the server layer ids that are requested.

(string | number)[]

layers

Image.getVisibleLayers

▸ 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

this

Image.hideLayers

▸ identify(geometry, layer): AbstractFeature[]

Queries data by the geometry provided. Is supported in ArcGIS version 9.3 and higher.

AbstractFeature[]

▸ Protected initLoader(loader?): ArcGISImage

Initializes the loader provided

ArcGISImage

this

Image.initLoader

▸ isDataLoaded(): boolean

Returns true if server data is already loaded (or no loader provided)

boolean

Image.isDataLoaded

▸ isDataReady(): boolean

Checks if source (current visible) data is loaded and ready to be rendered

boolean

Image.isDataReady

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Image.isDisposed

▸ isLoading(): boolean

Checks if some of the requests haven't been finished yet. Returns true if some data is loading, false otherwise.

boolean

Image.isLoading

▸ isSilent(): boolean

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

boolean

Image.isSilent

▸ loadServerData(): Promise<ArcGISImage>

Returns promise that is loaded when server settings are ready to process

Promise<ArcGISImage>

Image.loadServerData

▸ loadSourceData(): Promise<AbstractSource>

Returns promise that is resolving when data are ready to process

Promise<AbstractSource>

Image.loadSourceData

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

Notify listeners

ArcGISImage

this

Image.notify

▸ off<E>(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>(type, callback): ArcGISImage

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.

ArcGISImage

this

Image.on

▸ queryGeometry(geometry): AbstractFeature[]

Queries data by the geometry provided. Is supported in ArcGIS version 9.3 and higher.

AbstractFeature[]

▸ queryLegend(callback): void

Queries server legend (short info about each layer, such as layer name, type and icon). WARNING! Only ArcGIS version 10.0 and higher supports this operation.

void

▸ Protected resetLastQueryParams(): ArcGISImage

Resets saved last queried limits and layer

ArcGISImage

this

Image.resetLastQueryParams

▸ setDPI(dpi): ArcGISImage

Sets device resolution of the exported image (dots per inch)

ArcGISImage

this

▸ Protected setDataReady(isReady, err?): ArcGISImage

Sets source (current visible) data ready/not ready, changes the corresponding promise

ArcGISImage

this

Image.setDataReady

▸ setDynamicLayers(layers): ArcGISImage

Sets parameter to modify the layer drawing order, change layer drawing info, and change layer data source version for this server (if supported). See https://developers.arcgis.com/rest/services-reference/export-map.htm for more info

ArcGISImage

this

▸ setInflateRatio(ratio): ArcGISImage

Sets image inflate ratio to use

ArcGISImage

this

Image.setInflateRatio

▸ setInitialCoordinateSystem(system): ArcGISImage

Sets the data initial coordinate system.

ArcGISImage

this

Image.setInitialCoordinateSystem

▸ setMapCoordinateSystem(system): ArcGISImage

Sets map coordinate system.

ArcGISImage

this

Image.setMapCoordinateSystem

▸ setProperties(properties?): ArcGISImage

Sets properties

ArcGISImage

this

Image.setProperties

▸ setQueryParameter(param, value?): ArcGISImage

Sets custom query parameter to add to the data requests

ArcGISImage

this

Image.setQueryParameter

▸ setServerURL(url): ArcGISImage

Sets the server url to use for requesting

ArcGISImage

this

Image.setServerURL

▸ setSilent(bool): ArcGISImage

Set silent mode

ArcGISImage

this

Image.setSilent

▸ setSourceTimeout(timeout): ArcGISImage

Sets timeout

ArcGISImage

this

Image.setSourceTimeout

▸ setTime(time): ArcGISImage

Sets time instant or time extent of the exported map image

ArcGISImage

this

▸ setToken(token): ArcGISImage

Sets the authorization token for ArcGIS data server (if needed, null otherwise)

ArcGISImage

this

▸ setTooltipLayers(layers): ArcGISImage

Sets layers to show as the tooltip info (in .queryGeometry and .identify methods)

ArcGISImage

this

▸ setTransparent(transparent): ArcGISImage

Sets exported image (layer) transparency

ArcGISImage

this

▸ showLayers(layers): ArcGISImage

Sets the server layer name(s) to be shown on the layer

ArcGISImage

this

Image.showLayers

▸ update(): ArcGISImage

Aborts all the sent requests, resends the last one

ArcGISImage

this

Image.update

▸ Static getClassName(): string

string

Image.getClassName