Class: Base

Subclasses

• ol.layer.Group
• ol.layer.Layer

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.Object.Event type	Description
extent	ol.Extent | undefined	yes	change:extent	The layer extent.
maxResolution	number	yes	change:maxresolution	The maximum resolution of the layer.
minResolution	number	yes	change:minresolution	The minimum resolution of the layer.
opacity	number	yes	change:opacity	The opacity of the layer.
visible	boolean	yes	change:visible	The visibility of the layer.
zIndex	number	yes	change:zindex	The Z-index of the layer.

Methods

changed() inherited

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited

src/ol/observable.js, line 75

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 101

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getExtent(){ol.Extent|undefined}

src/ol/layer/base.js, line 115

Return the extent of the layer or undefined if it will be visible regardless of extent.

Returns:

The layer extent.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:

List of property names.

getMaxResolution(){number}

src/ol/layer/base.js, line 127

Return the maximum resolution of the layer.

Returns:

The maximum resolution of the layer.

getMinResolution(){number}

src/ol/layer/base.js, line 139

Return the minimum resolution of the layer.

Returns:

The minimum resolution of the layer.

getOpacity(){number}

src/ol/layer/base.js, line 151

Return the opacity of the layer (between 0 and 1).

Returns:

The opacity of the layer.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getVisible(){boolean}

src/ol/layer/base.js, line 169

Return the visibility of the layer (true or false).

Returns:

The visibility of the layer.

getZIndex(){number}

src/ol/layer/base.js, line 181

Return the Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Returns:

The Z-index of the layer.

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

src/ol/observable.js, line 124

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.

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setExtent(extent)

src/ol/layer/base.js, line 193

Set the extent at which the layer is visible. If undefined, the layer will be visible at all extents.

Name	Type	Description
extent	ol.Extent | undefined	The extent of the layer.

setMaxResolution(maxResolution)

src/ol/layer/base.js, line 204

Set the maximum resolution at which the layer is visible.

Name	Type	Description
maxResolution	number	The maximum resolution of the layer.

setMinResolution(minResolution)

src/ol/layer/base.js, line 215

Set the minimum resolution at which the layer is visible.

Name	Type	Description
minResolution	number	The minimum resolution of the layer.

setOpacity(opacity)

src/ol/layer/base.js, line 226

Set the opacity of the layer, allowed values range from 0 to 1.

Name	Type	Description
opacity	number	The opacity of the layer.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

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.

setVisible(visible)

src/ol/layer/base.js, line 237

Set the visibility of the layer (true or false).

Name	Type	Description
visible	boolean	The visibility of the layer.

setZIndex(zindex)

src/ol/layer/base.js, line 249

Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Name	Type	Description
zindex	number	The z-index of the layer.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

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.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

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