new ol.layer.Base(options)
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Layer options.
|
Fires:
-
change:brightness
(ol.ObjectEvent) -
change:contrast
(ol.ObjectEvent) -
change:extent
(ol.ObjectEvent) -
change:hue
(ol.ObjectEvent) -
change:maxResolution
(ol.ObjectEvent) -
change:minResolution
(ol.ObjectEvent) -
change:opacity
(ol.ObjectEvent) -
change:saturation
(ol.ObjectEvent) -
change:visible
(ol.ObjectEvent)
Subclasses
Extends
Observable Properties
Name | Type | Settable | ol.ObjectEvent 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. |
Methods
-
getExtent(){ol.Extent|undefined}
src/ol/layer/layerbase.js, line 182 -
Returns:
The layer extent.
-
getMaxResolution(){number}
src/ol/layer/layerbase.js, line 197 -
Returns:
The maximum resolution of the layer.
-
getMinResolution(){number}
src/ol/layer/layerbase.js, line 212 -
Returns:
The minimum resolution of the layer.
-
getOpacity(){number}
src/ol/layer/layerbase.js, line 227 -
Returns:
The opacity of the layer.
-
getVisible(){boolean}
src/ol/layer/layerbase.js, line 261 -
Returns:
The visibility of the layer.
-
on(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 75 -
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 88 -
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.
-
setExtent(extent)
src/ol/layer/layerbase.js, line 342 -
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/layerbase.js, line 356 -
Name Type Description maxResolution
number The maximum resolution of the layer.
-
setMinResolution(minResolution)
src/ol/layer/layerbase.js, line 370 -
Name Type Description minResolution
number The minimum resolution of the layer.
-
setOpacity(opacity)
src/ol/layer/layerbase.js, line 384 -
Name Type Description opacity
number The opacity of the layer.
-
setVisible(visible)
src/ol/layer/layerbase.js, line 417 -
Name Type Description visible
boolean The visibility of the layer.
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 101 -
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 114 -
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()
.