Class ImageVector

Classdesc

An image source whose images are canvas elements into which vector features read from a vector source (ol.source.Vector) are drawn. An ol.source.ImageVector object is to be used as the source of an image layer (ol.layer.Image). Image layers are rotated, scaled, and translated, as opposed to being re-rendered, during animations and interactions. So, like any other image layer, an image layer configured with an ol.source.ImageVector will exhibit this behaviour. This is in contrast to a vector layer, where vector features are re-drawn during animations and interactions.

Param: options

Options.

Api

Hierarchy

Constructors

constructor

Methods

changed dispatchEvent get getAttributions getKeys getLogo getProjection getProperties getRevision getSource getState getStyle getStyleFunction on once refresh set setAttributions setProperties setStyle un unByKey unset unByKey

Constructors

constructor

  • new ImageVector(options): ImageVector

  • Parameters

    Returns ImageVector

    Classdesc

    An image source whose images are canvas elements into which vector features read from a vector source (ol.source.Vector) are drawn. An ol.source.ImageVector object is to be used as the source of an image layer (ol.layer.Image). Image layers are rotated, scaled, and translated, as opposed to being re-rendered, during animations and interactions. So, like any other image layer, an image layer configured with an ol.source.ImageVector will exhibit this behaviour. This is in contrast to a vector layer, where vector features are re-drawn during animations and interactions.

    Api

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

getAttributions

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getLogo

getProjection

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

getSource

getState

getStyle

  • getStyle(): Style | Style[] | StyleFunction

  • Get the style for features. This returns whatever was passed to the style option at construction or to the setStyle method.

    Returns Style | Style[] | StyleFunction

    Layer style.

    Api

    stable

getStyleFunction

  • getStyleFunction(): StyleFunction

  • Get the style function.

    Returns StyleFunction

    Layer style function.

    Api

    stable

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

refresh

  • refresh(): void

  • Refreshes the source and finally dispatches a 'change' event.

    Returns void

    Api

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

setAttributions

  • setAttributions(attributions): void

  • Set the attributions of the source.

    Parameters

    • attributions: AttributionLike

      Attributions. Can be passed as string, Array<string>, {@link ol.Attribution}, Array<{@link ol.Attribution}> or undefined.

    Returns void

    Api

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

setStyle

  • setStyle(style): void

  • Set the style for features. This can be a single style object, an array of styles, or a function that takes a feature and resolution and returns an array of styles. If it is undefined the default style is used. If it is null the layer has no style (a null style), so only features that have their own styles will be rendered in the layer. See ol.style for information on the default style.

    Parameters

    Returns void

    Api

    stable

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