Class: AbstractSource

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

• Protected new AbstractSource(options?)

Creates source

EventDispatcher.constructor

▸ clear(): AbstractSource

Clears all the data.

AbstractSource

this

▸ dispose(): void

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

void

EventDispatcher.dispose

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ getCopyright(): string

Returns copyright information.

string

▸ Protected getDataLoader(): AbstractLoader

Returns server data loader (if exists)

AbstractLoader

▸ getInitialCoordinateSystem(): AbstractSystem

Gets current data initial coordinate system.

AbstractSystem

▸ getMapCoordinateSystem(): AbstractSystem

Gets current map coordinate system.

AbstractSystem

▸ getModelLimits(): Rect

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

Rect

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties

▸ getServerData(): JSONObject | XMLDocument

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

JSONObject | XMLDocument

▸ getServerURL(): string | string[]

Gets the server url that is currently used for requests

string | string[]

server url

▸ getTransformerFromMap(): Transformer

Gets transformer to transform data from map coordinate system

Transformer

▸ getTransformerToMap(): Transformer

Gets transformer to transform data to map coordinate system

Transformer

▸ hasEventListener(type, callback?): boolean

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

boolean

EventDispatcher.hasEventListener

▸ Protected initLoader(loader?): AbstractSource

Initializes the loader provided

AbstractSource

this

▸ isDataLoaded(): boolean

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

boolean

▸ isDataReady(): boolean

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

boolean

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ isLoading(): boolean

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

boolean

▸ isSilent(): boolean

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

boolean

EventDispatcher.isSilent

▸ loadServerData(): Promise<AbstractSource&gt;

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

Promise<AbstractSource&gt;

▸ loadSourceData(): Promise<AbstractSource&gt;

Returns promise that is resolving when data are ready to process

Promise<AbstractSource&gt;

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

Notify listeners

AbstractSource

this

EventDispatcher.notify

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

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.

AbstractSource

this

EventDispatcher.off

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

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>

AbstractSource

this

EventDispatcher.on

▸ Protected resetLastQueryParams(): AbstractSource

Resets saved last queried limits and layer

AbstractSource

this

▸ Protected setDataReady(isReady, err?): AbstractSource

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

AbstractSource

this

▸ setInitialCoordinateSystem(system): AbstractSource

Sets the data initial coordinate system.

AbstractSource

this

▸ setMapCoordinateSystem(system): AbstractSource

Sets map coordinate system.

AbstractSource

this

▸ setProperties(properties?): AbstractSource

Sets properties

AbstractSource

this

▸ setQueryParameter(param, value?): AbstractSource

Sets custom query parameter to add to the data requests

AbstractSource

this

▸ setServerURL(url): AbstractSource

Sets the server url to use for requesting

AbstractSource

this

▸ setSilent(bool): AbstractSource

Set silent mode

AbstractSource

this

EventDispatcher.setSilent

▸ update(): AbstractSource

Aborts all the sent requests, resends the last one

AbstractSource

this

▸ Static getClassName(): string

string

EventDispatcher.getClassName