Class ImageWMS

Classdesc

Source for WMS servers providing single, untiled images.

Fires

module:ol/source/Image.ImageSourceEvent

Api

Hierarchy (view full)

Constructors

constructor

Properties

disposed image loader loading on once projection un viewRejector viewResolver

Methods

addChangeListener addEventListener applyProperties changed dispatchEvent dispose disposeInternal findNearestResolution get getAttributions getAttributionsCollapsible getFeatureInfoUrl getImage getImageInternal getImageLoadFunction getInterpolate getKeys getLegendUrl getListeners getParams getProjection getProperties getPropertiesInternal getResolutions getRevision getState getUrl getView getWrapX handleImageChange hasListener hasProperties notify onInternal onceInternal refresh removeChangeListener removeEventListener set setAttributions setImageLoadFunction setProperties setResolutions setState setUrl unInternal unset updateParams

Constructors

constructor

  • new ImageWMS(options?): ImageWMS

  • Parameters

    • Optional options: Options

      ImageWMS options.

    Returns ImageWMS

Properties

Protected disposed

disposed: boolean

The object has already been disposed.

Protected image

image: external.ol.Image

Protected loader

loader: Loader

loading

loading: boolean

This source is currently loading data. Sources that defer loading to the map's tile queue never set this to true.

on

on: ImageSourceOnSignature<EventsKey>

once

once: ImageSourceOnSignature<EventsKey>

Protected projection

projection: null | Projection

un

un: ImageSourceOnSignature<void>

Protected viewRejector

viewRejector: ((arg0) => void)

Type declaration

    • (arg0): void

    • Parameters

      • arg0: Error

      Returns void

Protected viewResolver

viewResolver: ((arg0) => void)

Type declaration

    • (arg0): void

    • Parameters

      • arg0: ViewOptions

      Returns void

Methods

addChangeListener

  • addChangeListener(key, listener): void

  • Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

addEventListener

  • addEventListener(type, listener): void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

Protected applyProperties

  • applyProperties(source): void
  • Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: Object

      The source object.

    Returns void

changed

  • changed(): void

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

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event): undefined | boolean

  • 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

    • event: string | BaseEvent

      Event object.

    Returns undefined | boolean

    false if anyone called preventDefault on the event object or if any of the listeners returned false.

    Api

dispose

  • dispose(): void

  • Clean up.

    Returns void

Protected disposeInternal

  • disposeInternal(): void
  • Protected

    Extension point for disposable objects.

    Returns void

Protected findNearestResolution

  • findNearestResolution(resolution): number
  • Protected

    Parameters

    • resolution: number

      Resolution.

    Returns number

    Resolution.

get

  • get(key): any

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

getAttributions

  • getAttributions(): null | Attribution

  • Get the attribution function for the source.

    Returns null | Attribution

    Attribution function.

    Api

getAttributionsCollapsible

  • getAttributionsCollapsible(): boolean

  • Returns boolean

    Attributions are collapsible.

    Api

getFeatureInfoUrl

  • getFeatureInfoUrl(coordinate, resolution, projection, params): undefined | 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: any

      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 undefined | string

    GetFeatureInfo URL.

    Api

getImage

  • getImage(extent, resolution, pixelRatio, projection): external.ol.Image

  • Parameters

    • extent: Extent

      Extent.

    • resolution: number

      Resolution.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns external.ol.Image

    Single image.

Protected getImageInternal

  • getImageInternal(extent, resolution, pixelRatio, projection): external.ol.Image
  • Protected

    Parameters

    • extent: Extent

      Extent.

    • resolution: number

      Resolution.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns external.ol.Image

    Single image.

    Abstract

getImageLoadFunction

  • getImageLoadFunction(): LoadFunction

  • Return the image load function of the source.

    Returns LoadFunction

    The image load function.

    Api

getInterpolate

  • getInterpolate(): boolean

  • Returns boolean

    Use linear interpolation when resampling.

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getLegendUrl

  • getLegendUrl(resolution?, params?): undefined | string

  • Return the GetLegendGraphic URL, optionally optimized for the passed resolution and possibly including any passed specific parameters. Returns undefined if the GetLegendGraphic URL cannot be constructed.

    Parameters

    • Optional resolution: number

      Resolution. If set to undefined, SCALE will not be calculated and included in URL.

    • Optional params: any

      GetLegendGraphic params. If LAYER is set, the request is generated for this wms layer, else it will try to use the configured wms layer. Default FORMAT is image/png. VERSION should not be specified here.

    Returns undefined | string

    GetLegendGraphic URL.

    Api

getListeners

  • getListeners(type): undefined | Listener[]

  • Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

    Parameters

    • type: string

      Type.

    Returns undefined | Listener[]

    Listeners.

getParams

  • getParams(): any

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

    Returns any

    Params.

    Api

getProjection

  • getProjection(): null | Projection

  • Get the projection of the source.

    Returns null | Projection

    Projection.

    Api

getProperties

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

  • Get an object of all property names and values.

    Returns {
        [x: string]: any;
    }

    Object.

    • [x: string]: any

    Api

getPropertiesInternal

  • getPropertiesInternal(): null | {
        [x: string]: any;
    }

  • Get an object of all property names and values.

    Returns null | {
        [x: string]: any;
    }

    Object.

getResolutions

  • getResolutions(): null | number[]

  • Returns null | number[]

    Resolutions.

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

  • getState(): State

  • Get the state of the source, see import("./Source.js").State for possible states.

    Returns State

    State.

    Api

getUrl

  • getUrl(): undefined | string

  • Return the URL used for this WMS source.

    Returns undefined | string

    URL.

    Api

getView

  • getView(): Promise<ViewOptions>

  • Returns Promise<ViewOptions>

    A promise for view-related properties.

getWrapX

  • getWrapX(): undefined | boolean

  • Returns undefined | boolean

    Wrap X.

Protected handleImageChange

  • handleImageChange(event): void
  • Protected

    Handle image change events.

    Parameters

    • event: BaseEvent

      Event.

    Returns void

hasListener

  • hasListener(type?): boolean

  • Parameters

    • Optional type: string

      Type. If not provided, true will be returned if this event target has any listeners.

    Returns boolean

    Has listeners.

hasProperties

  • hasProperties(): boolean

  • Returns boolean

    The object has properties.

notify

  • notify(key, oldValue): void

  • Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

Protected onInternal

  • onInternal(type, listener): EventsKey | EventsKey[]
  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown

        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns EventsKey | EventsKey[]

    Event key.

Protected onceInternal

  • onceInternal(type, listener): EventsKey | EventsKey[]
  • Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown

        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns EventsKey | EventsKey[]

    Event key.

refresh

  • refresh(): void

  • Refreshes the source. The source will be cleared, and data from the server will be reloaded.

    Returns void

    Api

removeChangeListener

  • removeChangeListener(key, listener): void

  • Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

removeEventListener

  • removeEventListener(type, listener): void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

set

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

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional silent: boolean

      Update without triggering an event.

    Returns void

    Api

setAttributions

  • setAttributions(attributions): void

  • Set the attributions of the source.

    Parameters

    • attributions: undefined | AttributionLike

      Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

    Returns void

    Api

setImageLoadFunction

  • setImageLoadFunction(imageLoadFunction): void

  • Set the image load function of the source.

    Parameters

    • imageLoadFunction: LoadFunction

      Image load function.

    Returns void

    Api

setProperties

  • setProperties(values, 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: {
          [x: string]: any;
      }

      Values.

      • [x: string]: any
    • Optional silent: boolean

      Update without triggering an event.

    Returns void

    Api

setResolutions

  • setResolutions(resolutions): void

  • Parameters

    • resolutions: null | number[]

      Resolutions.

    Returns void

setState

  • setState(state): void

  • Set the state of the source.

    Parameters

    • state: State

      State.

    Returns void

setUrl

  • setUrl(url): void

  • Set the URL to use for requests.

    Parameters

    • url: undefined | string

      URL.

    Returns void

    Api

Protected unInternal

  • unInternal(type, listener): void
  • Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: ((arg0) => unknown)

      Listener.

        • (arg0): unknown

        • Parameters

          • arg0: Event | BaseEvent

          Returns unknown

    Returns void

unset

  • unset(key, silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional silent: boolean

      Unset without triggering an event.

    Returns void

    Api

updateParams

  • updateParams(params): void

  • Update the user-provided params.

    Parameters

    • params: any

      Params.

    Returns void

    Api

Settings

Member Visibility

On This Page

constructordisposedimageloaderloadingononceprojectionunviewRejectorviewResolveraddChangeListeneraddEventListenerapplyPropertieschangeddispatchEventdisposedisposeInternalfindNearestResolutiongetgetAttributionsgetAttributionsCollapsiblegetFeatureInfoUrlgetImagegetImageInternalgetImageLoadFunctiongetInterpolategetKeysgetLegendUrlgetListenersgetParamsgetProjectiongetPropertiesgetPropertiesInternalgetResolutionsgetRevisiongetStategetUrlgetViewgetWrapXhandleImageChangehasListenerhasPropertiesnotifyonInternalonceInternalrefreshremoveChangeListenerremoveEventListenersetsetAttributionssetImageLoadFunctionsetPropertiessetResolutionssetStatesetUrlunInternalunsetupdateParams