API / geotoolkit / map / sources / WMSTile / WMSTile
Tile source that allows user to get map data as a bunch of tiles using the WMS (Web Map Service) server
↳
WMSTile
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
imagepool | number | The amount of cache for the tile images |
maxlod | number | The maximum level of details for the tiles |
minlod | number | The minimum level of details for the tiles |
system | string | Initial data coordinate system |
tileheight | number | Height for the tiles to use (in px) |
tilewidth | number | Width for the tiles to use (in px) |
token | string | Authorization token (for ArcGIS tile servers if needed) |
url | string | Data server url |
Constructors
• new WMSTile(options?)
| Name | Type | Description |
|---|---|---|
Optional options | Options | options |
Tile.constructor
Methods
▸ clear(): WMSTile
Clears all the data.
this
▸ dispose(): void
Disposes this source, once disposed it should not be used anymore.
void
▸ getClassName(): string
string
▸ getCopyright(): string
Returns copyright information.
string
▸ Protected getDataLoader(): AbstractLoader
Returns server data loader (if exists)
▸ getImageFormat(): string
Returns the image format currently used for tiles
string
▸ getInitialCoordinateSystem(): AbstractSystem
Gets current data initial coordinate system.
Tile.getInitialCoordinateSystem
▸ getLayers(): LayerServerData[]
Returns layers JSON data loaded from the server Should be used asynchronically after loadServerData() method is called
▸ getMapCoordinateSystem(): AbstractSystem
Gets current map coordinate system.
▸ getModelLimits(): Rect
Returns the current data model limits (presumably loaded from the server if it's settled)
▸ getProperties(): OptionsOut
Returns properties
options
▸ 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
▸ getTransformerToMap(): Transformer
Gets transformer to transform data to map coordinate system
▸ getTransparent(): boolean
Returns the tiles current transparency
boolean
▸ getVersion(): string
Returns WMS version currently used
string
▸ 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
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ hideLayers(id?): WMSTile
Adds the passed in ID's to the list of layers to hide
| Name | Type | Description |
|---|---|---|
Optional id | string | number | (string | number)[] | ID(s) for the layers to show |
this
▸ Protected initLoader(loader?): WMSTile
Initializes the loader provided
| Name | Type | Description |
|---|---|---|
Optional loader | AbstractLoader | loader to use |
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
▸ 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
▸ loadServerData(): Promise<WMSTile>
Returns promise that is loaded when server settings are ready to process
Promise<WMSTile>
▸ loadSourceData(): Promise<AbstractSource>
Returns promise that is resolving when data are ready to process
Promise<AbstractSource>
▸ notify<E>(type, source, args?): WMSTile
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Tile | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): WMSTile
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: WMSTile, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): WMSTile
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: WMSTile, args: EventMap[E]) => void | to be called |
this
▸ Protected resetLastQueryParams(): WMSTile
Resets saved last queried limits and layer
this
▸ Protected setDataReady(isReady, err?): WMSTile
Sets source (current visible) data ready/not ready, changes the corresponding promise
| Name | Type | Description |
|---|---|---|
isReady | boolean | true if source data was loaded, false if it needs to be reset |
Optional err | Error | data loading error (if exists) |
this
▸ setImageFormat(format): WMSTile
Sets the image format to be used for tiles
| Name | Type | Description |
|---|---|---|
format | string | image format to use (e.g. 'png') |
this
▸ setInitialCoordinateSystem(system): WMSTile
Sets the data initial coordinate system.
| Name | Type | Description |
|---|---|---|
system | string | AbstractSystem | initial coordinate system |
this
Tile.setInitialCoordinateSystem
▸ setMapCoordinateSystem(system): WMSTile
Sets map coordinate system.
| Name | Type | Description |
|---|---|---|
system | string | AbstractSystem | map coordinate system |
this
▸ setProperties(properties?): WMSTile
Sets properties (default properties listed are for construction time only)
| Name | Type | Description |
|---|---|---|
Optional properties | Options | options |
this
▸ setQueryParameter(param, value?): WMSTile
Sets custom query parameter to add to the data requests
| Name | Type | Description |
|---|---|---|
param | string | Record<string, string | number> | parameter name or custom parameters object (in name -> value format) |
Optional value | string | number | parameter value |
this
▸ setServerURL(url): WMSTile
Sets the server url to use for requesting
| Name | Type | Description |
|---|---|---|
url | string | string[] | server url |
this
▸ setSilent(bool): WMSTile
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTransparent(transparent): WMSTile
Sets the tiles transparency
| Name | Type | Description |
|---|---|---|
transparent | boolean | tiles transparency |
this
▸ setVersion(version): WMSTile
Sets WMS version to use
| Name | Type | Description |
|---|---|---|
version | string | version to use (in '1.3.0' format) |
this
▸ showLayers(layers): WMSTile
Sets the server layer name(s) to be shown on the layer
| Name | Type | Description |
|---|---|---|
layers | string | number | (string | number)[] | layer id(s) to be shown |
this
▸ update(): WMSTile
Aborts all the sent requests, resends the last one
this
▸ Static getClassName(): string
string