new ol.source.ImageWMS(opt_options)
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
change
experimental - Triggered when the revision counter is increased. -
imageloadend
(ol.source.ImageEvent) experimental - Triggered when an image finishes loading. -
imageloaderror
(ol.source.ImageEvent) experimental - Triggered if image loading results in an error. -
imageloadstart
(ol.source.ImageEvent) experimental - Triggered when an image starts loading. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
Methods
-
changed() inherited experimental
src/ol/observable.js, line 50 -
Increases the revision counter and dispatches a 'change' event.
-
dispatchEvent(event) inherited experimental
src/ol/observable.js, line 72 -
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
type
property.Name Type Description event
goog.events.EventLike Event object.
-
get(key){*} inherited
src/ol/object.js, line 147 -
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/imagewmssource.js, line 138 -
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.
-
getImageLoadFunction(){ol.ImageLoadFunctionType} experimental
src/ol/source/imagewmssource.js, line 257 -
Return the image load function of the source.
Returns:
The image load function.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 161 -
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/imagewmssource.js, line 178 -
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 171 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 81 -
Get the version number for this object. Each time the object is modified, its version number will be incremented.
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.
-
getUrl(){string|undefined}
src/ol/source/imagewmssource.js, line 325 -
Return the URL used for this WMS source.
Returns:
URL.
-
on(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 94 -
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 107 -
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, opt_silent) inherited
src/ol/object.js, line 201 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
setAttributions(attributions) inherited experimental
src/ol/source/source.js, line 158 -
Set the attributions of the source.
Name Type Description attributions
Array.<ol.Attribution> Attributions.
-
setImageLoadFunction(imageLoadFunction) experimental
src/ol/source/imagewmssource.js, line 335 -
Set the image load function of the source.
Name Type Description imageLoadFunction
ol.ImageLoadFunctionType Image load function.
-
setProperties(values, opt_silent) inherited
src/ol/object.js, line 221 -
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.
silent
boolean Update without triggering an event.
-
setUrl(url)
src/ol/source/imagewmssource.js, line 348 -
Set the URL to use for requests.
Name Type Description url
string | undefined URL.
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 120 -
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 133 -
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, opt_silent) inherited
src/ol/object.js, line 235 -
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.
-
updateParams(params)
src/ol/source/imagewmssource.js, line 362 -
Update the user-provided params.
Name Type Description params
Object Params.