Class Base

Classdesc

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.

Param: options

Layer options.

Api

stable

Hierarchy

Constructors

constructor

Methods

changed dispatchEvent get getExtent getKeys getMaxResolution getMinResolution getOpacity getProperties getRevision getVisible getZIndex on once set setExtent setMaxResolution setMinResolution setOpacity setProperties setVisible setZIndex un unByKey unset unByKey

Constructors

constructor

  • new Base(options): Base

  • Parameters

    Returns Base

    Classdesc

    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.

    Api

    stable

Methods

changed

  • changed(): void

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

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event): void

  • 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.

    Parameters

    Returns void

    Function

    Api

get

  • get(key): any

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

    stable

getExtent

  • getExtent(): Extent

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

    Returns Extent

    The layer extent.

    Observable

    Api

    stable

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getMaxResolution

  • getMaxResolution(): number

  • Return the maximum resolution of the layer.

    Returns number

    The maximum resolution of the layer.

    Observable

    Api

    stable

getMinResolution

  • getMinResolution(): number

  • Return the minimum resolution of the layer.

    Returns number

    The minimum resolution of the layer.

    Observable

    Api

    stable

getOpacity

  • getOpacity(): number

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

    Returns number

    The opacity of the layer.

    Observable

    Api

    stable

getProperties

  • getProperties(): {
        [k: string]: any;
    }

  • Get an object of all property names and values.

    Returns {
        [k: string]: any;
    }

    Object.

    • [k: string]: any

    Api

    stable

getRevision

  • getRevision(): number

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

    Returns number

    Revision.

    Api

getVisible

  • getVisible(): boolean

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

    Returns boolean

    The visibility of the layer.

    Observable

    Api

    stable

getZIndex

  • getZIndex(): number

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

    Returns number

    The Z-index of the layer.

    Observable

    Api

on

  • on(type, listener, opt_this?): Object | Object[]

  • Listen for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

once

  • once(type, listener, opt_this?): Object | Object[]

  • Listen once for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

set

  • set(key, value, opt_silent?): void

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setExtent

  • setExtent(extent): void

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

    Parameters

    • extent: Extent

      The extent of the layer.

    Returns void

    Observable

    Api

    stable

setMaxResolution

  • setMaxResolution(maxResolution): void

  • Set the maximum resolution at which the layer is visible.

    Parameters

    • maxResolution: number

      The maximum resolution of the layer.

    Returns void

    Observable

    Api

    stable

setMinResolution

  • setMinResolution(minResolution): void

  • Set the minimum resolution at which the layer is visible.

    Parameters

    • minResolution: number

      The minimum resolution of the layer.

    Returns void

    Observable

    Api

    stable

setOpacity

  • setOpacity(opacity): void

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

    Parameters

    • opacity: number

      The opacity of the layer.

    Returns void

    Observable

    Api

    stable

setProperties

  • setProperties(values, opt_silent?): void

  • 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).

    Parameters

    • values: {
          [k: string]: any;
      }

      Values.

      • [k: string]: any
    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setVisible

  • setVisible(visible): void

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

    Parameters

    • visible: boolean

      The visibility of the layer.

    Returns void

    Observable

    Api

    stable

setZIndex

  • setZIndex(zindex): void

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

    Parameters

    • zindex: number

      The z-index of the layer.

    Returns void

    Observable

    Api

un

  • un(type, listener, opt_this?): void

  • Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object which was used as this by the listener.

    Returns void

    Api

    stable

unByKey

  • unByKey(key): void

  • 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.

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Function

    Api

    stable

unset

  • unset(key, opt_silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional opt_silent: boolean

      Unset without triggering an event.

    Returns void

    Api

    stable

Static unByKey

  • unByKey(key): void

  • Removes an event listener using the key returned by on() or once().

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc