new ol.source.ImageMapGuide(options)
| Name | Type | Description | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
||||||||||||||||||||||||||||||||||
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
imageloadend(ol.source.Image.Event) - Triggered when an image finishes loading. -
imageloaderror(ol.source.Image.Event) - Triggered if image loading results in an error. -
imageloadstart(ol.source.Image.Event) - Triggered when an image starts loading. -
propertychange(ol.Object.Event) - Triggered when a property is changed.
Extends
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
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
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
Get the attributions of the source.
Returns:
Attributions.
-
Return the image load function of the source.
Returns:
The image load function.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the logo of the source.
Returns:
Logo.
-
getParams(){Object}
src/ol/source/imagemapguide.js, line 111 -
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.
-
Get the projection of the source.
Returns:
Projection.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Get the state of the source, see
ol.source.Statefor possible states.Returns:
State.
-
on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
Listen for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
Listen once for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
Refreshes the source and finally dispatches a 'change' event.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
Set the attributions of the source.
Name Type Description attributionsol.AttributionLike | undefined Attributions. Can be passed as
string,Array<string>,, orol.Attribution2undefined. -
setImageLoadFunction(imageLoadFunction)
src/ol/source/imagemapguide.js, line 235 -
Set the image load function of the MapGuide source.
Name Type Description imageLoadFunctionol.ImageLoadFunctionType Image load function.
-
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 valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
-
updateParams(params)
src/ol/source/imagemapguide.js, line 194 -
Update the user-provided params.
Name Type Description paramsObject Params.
OpenLayers