new ol.source.TileWMS(opt_options)
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Tile WMS options.
|
Fires:
-
change
- Triggered when the state of the source changes. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed. -
tileloadend
(ol.source.TileEvent) - Triggered when a tile finishes loading. -
tileloaderror
(ol.source.TileEvent) - Triggered if tile loading results in an error. -
tileloadstart
(ol.source.TileEvent) - Triggered when a tile starts loading.
Extends
Methods
-
changed() inherited experimental
src/ol/observable.js, line 52 -
Increases the revision counter and dispatches a 'change' event.
Fires:
-
change
experimental
-
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getAttributions(){Array.<ol.Attribution>} inherited
src/ol/source/source.js, line 104 -
Get the attributions of the source.
Returns:
Attributions.
-
getGetFeatureInfoUrl(coordinate, resolution, projection, params){string|undefined}
src/ol/source/tilewmssource.js, line 130 -
Return the GetFeatureInfo URL for the passed coordinate, resolution, and projection. Return
undefined
if the GetFeatureInfo URL cannot be constructed.Name Type Description coordinate
ol.Coordinate Coordinate.
resolution
number Resolution.
projection
ol.proj.ProjectionLike Projection.
params
Object GetFeatureInfo params.
INFO_FORMAT
at least should be provided. IfQUERY_LAYERS
is not provided then the layers specified in theLAYERS
parameter will be used.VERSION
should not be specified here.Returns:
GetFeatureInfo URL.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getLogo(){string|olx.LogoOptions|undefined} inherited
src/ol/source/source.js, line 114 -
Get the logo of the source.
Returns:
Logo.
-
getParams(){Object}
src/ol/source/tilewmssource.js, line 205 -
Get the user-provided params, i.e. those passed to the constructor through the "params" option, and possibly updated using the updateParams method.
Returns:
Params.
-
getProjection(){ol.proj.Projection} inherited experimental
src/ol/source/source.js, line 124 -
Get the projection of the source.
Returns:
Projection.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
getState(){ol.source.State} inherited experimental
src/ol/source/source.js, line 140 -
Get the state of the source, see
ol.source.State
for possible states.Returns:
State.
-
getTileGrid(){ol.tilegrid.TileGrid} inherited
src/ol/source/tilesource.js, line 187 -
Return the tile grid of the tile source.
Returns:
Tile grid.
-
getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental
src/ol/source/tileimagesource.js, line 120 -
Return the tile load function of the source.
Returns:
TileLoadFunction
-
getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental
src/ol/source/tileimagesource.js, line 130 -
Return the tile URL function of the source.
Returns:
TileUrlFunction
-
getUrls(){Array.<string>}
src/ol/source/tilewmssource.js, line 309 -
Return the URLs used for this WMS source.
Returns:
URLs.
-
on(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 75 -
Listen for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener.
-
once(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 88 -
Listen once for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description values
Object.<string, *> Values.
-
setTileLoadFunction(tileLoadFunction) inherited experimental
src/ol/source/tileimagesource.js, line 164 -
Set the tile load function of the source.
Name Type Description tileLoadFunction
ol.TileLoadFunctionType Tile load function.
-
setTileUrlFunction(tileUrlFunction) inherited experimental
src/ol/source/tileimagesource.js, line 176 -
Set the tile URL function of the source.
Name Type Description tileUrlFunction
ol.TileUrlFunctionType Tile URL function.
-
setUrl(url)
src/ol/source/tilewmssource.js, line 340 -
Set the URL to use for requests.
Name Type Description url
string | undefined URL.
-
setUrls(urls)
src/ol/source/tilewmssource.js, line 351 -
Set the URLs to use for requests.
Name Type Description urls
Array.<string> | undefined URLs.
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 101 -
Unlisten for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object which was used as
this
by thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.
-
updateParams(params)
src/ol/source/tilewmssource.js, line 416 -
Update the user-provided params.
Name Type Description params
Object Params.