Class ImageWMS

Classdesc

Source for WMS servers providing single, untiled images.

Fires

ol.source.ImageEvent

Param: opt_options

Options.

Api

stable

Hierarchy

Constructors

constructor

Methods

changed dispatchEvent get getAttributions getGetFeatureInfoUrl getImageLoadFunction getKeys getLogo getParams getProjection getProperties getRevision getState getUrl on once refresh set setAttributions setImageLoadFunction setProperties setUrl un unByKey unByKey unset updateParams

Constructors

constructor

  • new ImageWMS(opt_options?): ImageWMS

  • Parameters

    Returns ImageWMS

    Classdesc

    Source for WMS servers providing single, untiled images.

    Fires

    ol.source.ImageEvent

    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

getAttributions

getGetFeatureInfoUrl

  • getGetFeatureInfoUrl(coordinate, resolution, projection, params): string

  • Return the GetFeatureInfo URL for the passed coordinate, resolution, and projection. Return undefined if the GetFeatureInfo URL cannot be constructed.

    Parameters

    • coordinate: Coordinate

      Coordinate.

    • resolution: number

      Resolution.

    • projection: ProjectionLike

      Projection.

    • params: Object

      GetFeatureInfo params. INFO_FORMAT at least should be provided. If QUERY_LAYERS is not provided then the layers specified in the LAYERS parameter will be used. VERSION should not be specified here.

    Returns string

    GetFeatureInfo URL.

    Api

    stable

getImageLoadFunction

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getLogo

getParams

  • getParams(): Object

  • Get the user-provided params, i.e. those passed to the constructor through the "params" option, and possibly updated using the updateParams method.

    Returns Object

    Params.

    Api

    stable

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

getState

getUrl

  • getUrl(): string

  • Return the URL used for this WMS source.

    Returns string

    URL.

    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

setImageLoadFunction

  • setImageLoadFunction(imageLoadFunction): void

  • Set the image load function of the source.

    Parameters

    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

setUrl

  • setUrl(url): void

  • Set the URL to use for requests.

    Parameters

    • url: string

      URL.

    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

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

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

updateParams

  • updateParams(params): void

  • Update the user-provided params.

    Parameters

    • params: Object

      Params.

    Returns void

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc