Class: Base

ol.layer.Base

Abstract base class; normally only used for creating subclasses and not instantiated in apps. Note that with ol.layer.Base and all its subclasses, any property set in the options is set as a ol.Object property on the layer object, so is observable, and has get/set accessors.

new ol.layer.Base(options)

src/ol/layer/layerbase.js, line 59
Name Type Description
options

Layer options.

Name Type Description
opacity number | undefined

Opacity (0, 1). Default is 1.

visible boolean | undefined

Visibility. Default is true.

extent ol.Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

minResolution number | undefined

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution number | undefined

The maximum resolution (exclusive) below which this layer will be visible.

Fires:

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

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

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

unByKey(key) inherited

src/ol/observable.js, line 114

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 goog.events.Key

The key returned by on() or once().