Class: ImageMapGuide

Extends

• ol.source.Image

Methods

changed() inherited experimental

src/ol/observable.js, line 57

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 81

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	Object | ol.events.Event | string	Event object.

get(key){*} inherited

src/ol/object.js, line 148

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 134

Get the attributions of the source.

Returns:

Attributions.

getImageLoadFunction(){ol.ImageLoadFunctionType} experimental

src/ol/source/imagemapguidesource.js, line 163

Return the image load function of the source.

Returns:

The image load function.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 162

Get a list of object property names.

Returns:

List of property names.

getLogo(){string|olx.LogoOptions|undefined} inherited

src/ol/source/source.js, line 144

Get the logo of the source.

Returns:

Logo.

getParams(){Object}

src/ol/source/imagemapguidesource.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.

getProjection(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 154

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 90

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 170

Get the state of the source, see ol.source.State for possible states.

Returns:

State.

on(type, listener, opt_this){ol.events.Key|Array.<ol.events.Key>} inherited

src/ol/observable.js, line 105

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 in listener.

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.events.Key|Array.<ol.events.Key>} inherited

src/ol/observable.js, line 130

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 in listener.

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.

refresh() inherited experimental

src/ol/source/source.js, line 187

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

src/ol/object.js, line 197

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 199

Set the attributions of the source.

Name	Type	Description
attributions	Attributions. Can be passed as string, Array<string>, ol.Attribution, Array<ol.Attribution> or undefined. Type Description

setImageLoadFunction(imageLoadFunction) experimental

src/ol/source/imagemapguidesource.js, line 235

Set the image load function of the MapGuide source.

Name	Type	Description
imageLoadFunction	ol.ImageLoadFunctionType	Image load function.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 217

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.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 153

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 the listener.

unByKey(key) inherited

src/ol/observable.js, line 174

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	ol.events.Key | Array.<ol.events.Key>	The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.

updateParams(params)

src/ol/source/imagemapguidesource.js, line 194

Update the user-provided params.

Name	Type	Description
params	Object	Params.