new ol.layer.Base(options)
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Layer options.
|
||||||||||||||||||||||
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:extent(ol.Object.Event) -
change:maxResolution(ol.Object.Event) -
change:minResolution(ol.Object.Event) -
change:opacity(ol.Object.Event) -
change:visible(ol.Object.Event) -
change:zIndex(ol.Object.Event) -
propertychange(ol.Object.Event) - Triggered when a property is changed.
Subclasses
Extends
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
-
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.
-
Return the
extentof the layer orundefinedif it will be visible regardless of extent.Returns:
The layer extent.
-
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.
-
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.
-
getVisible(){boolean}
src/ol/layer/base.js, line 169 -
Return the visibility of the layer (
trueorfalse).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 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.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean 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 extentol.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 maxResolutionnumber 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 minResolutionnumber 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 opacitynumber The opacity of the layer.
-
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.
-
setVisible(visible)
src/ol/layer/base.js, line 237 -
Set the visibility of the layer (
trueorfalse).Name Type Description visibleboolean 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 zindexnumber The z-index of the layer.
-
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.
OpenLayers