Class: Image

• [new Image(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.sources.image.image.md#new image(options))

• new Image(options?)

Creates image source

AbstractSource.constructor

▸ clear(): Image

Notifies source to remove all data added.

Image

this

AbstractSource.clear

▸ dispose(): void

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

void

AbstractSource.dispose

▸ getClassName(): string

string

AbstractSource.getClassName

▸ getCopyright(): string

Returns copyright information.

string

AbstractSource.getCopyright

▸ Protected getDataLoader(): AbstractLoader

Returns server data loader (if exists)

AbstractLoader

AbstractSource.getDataLoader

▸ getInflateRatio(): number

Returns current inflate ratio

number

▸ getInitialCoordinateSystem(): AbstractSystem

Gets current data initial coordinate system.

AbstractSystem

AbstractSource.getInitialCoordinateSystem

▸ getLayers(): LayerServerData[]

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

LayerServerData[]

▸ getMapCoordinateSystem(): AbstractSystem

Gets current map coordinate system.

AbstractSystem

AbstractSource.getMapCoordinateSystem

▸ getModelLimits(): Rect

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

Rect

AbstractSource.getModelLimits

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties

AbstractSource.getProperties

▸ getServerData(): JSONObject | XMLDocument

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

JSONObject | XMLDocument

AbstractSource.getServerData

▸ getServerURL(): string | string[]

Gets the server url that is currently used for requests

string | string[]

server url

AbstractSource.getServerURL

▸ getSourceTimeout(): number

Returns timeout

number

▸ getTransformerFromMap(): Transformer

Gets transformer to transform data from map coordinate system

Transformer

AbstractSource.getTransformerFromMap

▸ getTransformerToMap(): Transformer

Gets transformer to transform data to map coordinate system

Transformer

AbstractSource.getTransformerToMap

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

Returns the server layer ids that are requested.

(string | number)[]

layers

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractSource.hasEventListener

▸ hideLayers(id?): Image

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

Image

this

▸ Protected initLoader(loader?): Image

Initializes the loader provided

Image

this

AbstractSource.initLoader

▸ isDataLoaded(): boolean

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

boolean

AbstractSource.isDataLoaded

▸ isDataReady(): boolean

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

boolean

AbstractSource.isDataReady

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractSource.isDisposed

▸ isLoading(): boolean

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

boolean

AbstractSource.isLoading

▸ isSilent(): boolean

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

boolean

AbstractSource.isSilent

▸ loadServerData(): Promise<Image&gt;

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

Promise<Image&gt;

AbstractSource.loadServerData

▸ loadSourceData(): Promise<AbstractSource&gt;

Returns promise that is resolving when data are ready to process

Promise<AbstractSource&gt;

AbstractSource.loadSourceData

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

Notify listeners

Image

this

AbstractSource.notify

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

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.

Image

this

AbstractSource.off

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

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>

Image

this

AbstractSource.on

▸ Protected resetLastQueryParams(): Image

Resets saved last queried limits and layer

Image

this

AbstractSource.resetLastQueryParams

▸ Protected setDataReady(isReady, err?): Image

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

Image

this

AbstractSource.setDataReady

▸ setInflateRatio(ratio): Image

Sets image inflate ratio to use

Image

this

▸ setInitialCoordinateSystem(system): Image

Sets the data initial coordinate system.

Image

this

AbstractSource.setInitialCoordinateSystem

▸ setMapCoordinateSystem(system): Image

Sets map coordinate system.

Image

this

AbstractSource.setMapCoordinateSystem

▸ setProperties(properties?): Image

Sets properties

Image

this

AbstractSource.setProperties

▸ setQueryParameter(param, value?): Image

Sets custom query parameter to add to the data requests

Image

this

AbstractSource.setQueryParameter

▸ setServerURL(url): Image

Sets the server url to use for requesting

Image

this

AbstractSource.setServerURL

▸ setSilent(bool): Image

Set silent mode

Image

this

AbstractSource.setSilent

▸ setSourceTimeout(timeout): Image

Sets timeout

Image

this

▸ showLayers(layers): Image

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

Image

this

▸ update(): Image

Aborts all the sent requests, resends the last one

Image

this

AbstractSource.update

▸ Static getClassName(): string

string

AbstractSource.getClassName