Class SourceWMS

Hierarchy

  • TileWMS
    • SourceWMS

Constructors

constructor

Properties

_description _legends _metadata _originators _quicklookUrl _title crossOrigin disposed loading name on once projection service tileClass tileGrid tileGridForProjection tileLoadFunction tileOptions tmpSize un urls viewRejector viewResolver zDirection

Methods

addChangeListener addEventListener applyProperties changed clear dispatchEvent dispose disposeInternal get getAttributions getAttributionsCollapsible getFeatureInfoUrl getGutter getGutterForProjection getInterpolate getKey getKeys getLegendUrl getListeners getParams getProjection getProperties getPropertiesInternal getResolutions getRevision getState getTile getTileCoordForTileUrlFunction getTileGrid getTileGridForProjection getTileInternal getTileLoadFunction getTilePixelRatio getTilePixelSize getTileUrlFunction getUrls getView getWrapX handleTileChange hasListener hasProperties notify onceInternal onInternal refresh removeChangeListener removeEventListener set setAttributions setKey setParams setProperties setRenderReprojectionEdges setState setTileGridForProjection setTileLoadFunction setTileUrlFunction setUrl setUrls tileUrlFunction unInternal unset updateParams

Constructors

constructor

  • new SourceWMS(
        options: {
            apiKey?: string;
            configuration?: any;
            description?: string;
            layer: string;
            legends?: any[];
            metadata?: any[];
            olParams?: any;
            quicklookUrl?: string;
            ssl?: boolean;
            title?: string;
        },
    ): SourceWMS

    Parameters

    • options: {
          apiKey?: string;
          configuration?: any;
          description?: string;
          layer: string;
          legends?: any[];
          metadata?: any[];
          olParams?: any;
          quicklookUrl?: string;
          ssl?: boolean;
          title?: string;
      }

      options for function call.

      • OptionalapiKey?: string

        Access key to Geoportal platform

      • Optionalconfiguration?: any

        configuration (cf. example)

      • Optionaldescription?: string

        description of the layer

      • layer: string

        Layer name (e.g. "ORTHOIMAGERY.ORTHOPHOTOS")

      • Optionallegends?: any[]

        Legends objects associated to the layer

      • Optionalmetadata?: any[]

        Metadata objects associated to the layer

      • OptionalolParams?: any

        other options for ol.source.TileWMS function (see ol.source.TileWMS)

      • OptionalquicklookUrl?: string

        quicklookUrl of the layer

      • Optionalssl?: boolean

        if set true, enforce protocol https (only for nodejs)

      • Optionaltitle?: string

        title of the layer

    Returns SourceWMS

    Example

    var sourceWMS = new ol.source.GeoportalWMS({
         layer  : "ORTHOIMAGERY.ORTHOPHOTOS"
    });

Properties

_description

_description: any

_legends

_legends: any

_metadata

_metadata: any

_originators

_originators: any

_quicklookUrl

_quicklookUrl: any

_title

_title: any

ProtectedcrossOrigin

crossOrigin: null | string

Protecteddisposed

disposed: boolean

The object has already been disposed.

loading

loading: boolean

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

name

name: string

on

on: TileSourceOnSignature<EventsKey>

once

once: TileSourceOnSignature<EventsKey>

Protectedprojection

projection: null | Projection

service

service: string

ProtectedtileClass

tileClass: typeof ImageTile

ProtectedtileGrid

tileGrid: null | TileGrid

ProtectedtileGridForProjection

tileGridForProjection: { [x: string]: TileGrid }

ProtectedtileLoadFunction

tileLoadFunction: LoadFunction

ProtectedtileOptions

tileOptions: Options

ProtectedtmpSize

tmpSize: Size

un

un: TileSourceOnSignature<void>

Protectedurls

urls: null | string[]

ProtectedviewRejector

viewRejector: (arg0: Error) => void

ProtectedviewResolver

viewResolver: (arg0: ViewOptions) => void

zDirection

zDirection: number | NearestDirectionFunction

zDirection hint, read by the renderer. Indicates which resolution should be used by a renderer if the views resolution does not match any resolution of the tile source. If 0, the nearest resolution will be used. If 1, the nearest lower resolution will be used. If -1, the nearest higher resolution will be used.

Methods

addChangeListener

  • addChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

addEventListener

  • addEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

ProtectedapplyProperties

  • applyProperties(source: BaseObject): void
    Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: BaseObject

      The source object.

    Returns void

changed

  • changed(): void

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

    Returns void

    Api

clear

  • clear(): void

    Remove all cached reprojected tiles from the source. The next render cycle will create new tiles.

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event: string | BaseEvent): 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

ProtecteddisposeInternal

  • disposeInternal(): void
    Protected

    Extension point for disposable objects.

    Returns void

get

  • get(key: string): 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: Coordinate,
        resolution: number,
        projection: ProjectionLike,
        params: any,
    ): 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

getGutter

  • getGutter(): number

    Returns number

    Gutter.

getGutterForProjection

  • getGutterForProjection(projection: Projection): number

    Parameters

    • projection: Projection

      Projection.

    Returns number

    Gutter.

getInterpolate

  • getInterpolate(): boolean

    Returns boolean

    Use linear interpolation when resampling.

getKey

  • getKey(): string

    Return the key to be used for all tiles in the source.

    Returns string

    The key for all tiles.

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getLegendUrl

  • getLegendUrl(resolution?: number, params?: any): 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

    • Optionalresolution: number

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

    • Optionalparams: 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: string): 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.

    Api

getPropertiesInternal

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

    Get an object of all property names and values.

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

    Object.

getResolutions

  • getResolutions(projection?: Projection): null | number[]

    Parameters

    • Optionalprojection: Projection

      Projection.

    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

getTile

  • getTile(
        z: number,
        x: number,
        y: number,
        pixelRatio: number,
        projection: Projection,
    ): ImageTile | ReprojTile

    Parameters

    • z: number

      Tile coordinate z.

    • x: number

      Tile coordinate x.

    • y: number

      Tile coordinate y.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns ImageTile | ReprojTile

    Tile.

getTileCoordForTileUrlFunction

  • getTileCoordForTileUrlFunction(
        tileCoord: TileCoord,
        projection?: Projection,
    ): TileCoord

    Returns a tile coordinate wrapped around the x-axis. When the tile coordinate is outside the resolution and extent range of the tile grid, null will be returned.

    Parameters

    • tileCoord: TileCoord

      Tile coordinate.

    • Optionalprojection: Projection

      Projection.

    Returns TileCoord

    Tile coordinate to be passed to the tileUrlFunction or null if no tile URL should be created for the passed tileCoord.

getTileGrid

  • getTileGrid(): null | TileGrid

    Return the tile grid of the tile source.

    Returns null | TileGrid

    Tile grid.

    Api

getTileGridForProjection

  • getTileGridForProjection(projection: Projection): TileGrid

    Parameters

    • projection: Projection

      Projection.

    Returns TileGrid

    Tile grid.

ProtectedgetTileInternal

  • getTileInternal(
        z: number,
        x: number,
        y: number,
        pixelRatio: number,
        projection: Projection,
    ): ImageTile
    Protected

    Parameters

    • z: number

      Tile coordinate z.

    • x: number

      Tile coordinate x.

    • y: number

      Tile coordinate y.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns ImageTile

    Tile.

getTileLoadFunction

  • getTileLoadFunction(): LoadFunction

    Deprecated. Use an ImageTile source instead. Return the tile load function of the source.

    Returns LoadFunction

    TileLoadFunction

    Api

getTilePixelRatio

  • getTilePixelRatio(pixelRatio: number): number

    Get the tile pixel ratio for this source. Subclasses may override this method, which is meant to return a supported pixel ratio that matches the provided pixelRatio as close as possible.

    Parameters

    • pixelRatio: number

      Pixel ratio.

    Returns number

    Tile pixel ratio.

getTilePixelSize

  • getTilePixelSize(z: number, pixelRatio: number, projection: Projection): Size

    Parameters

    • z: number

      Z.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns Size

    Tile size.

getTileUrlFunction

  • getTileUrlFunction(): UrlFunction

    Deprecated. Use an ImageTile source instead. Return the tile URL function of the source.

    Returns UrlFunction

    TileUrlFunction

    Api

getUrls

  • getUrls(): null | string[]

    Deprecated. Use an ImageTile source instead. Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

    Returns null | string[]

    URLs.

    Api

getView

  • getView(): Promise<ViewOptions>

    Returns Promise<ViewOptions>

    A promise for view-related properties.

getWrapX

  • getWrapX(): undefined | boolean

    Returns undefined | boolean

    Wrap X.

ProtectedhandleTileChange

  • handleTileChange(event: BaseEvent): void
    Protected

    Handle tile change events.

    Parameters

    • event: BaseEvent

      Event.

    Returns void

hasListener

  • hasListener(type?: string): boolean

    Parameters

    • Optionaltype: 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: string, oldValue: any): void

    Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

ProtectedonceInternal

  • onceInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
    Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns EventsKey | EventsKey[]

    Event key.

ProtectedonInternal

  • onInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): EventsKey | EventsKey[]
    Protected

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    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: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

removeEventListener

  • removeEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

set

  • set(key: string, value: any, silent?: boolean): void

    Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optionalsilent: boolean

      Update without triggering an event.

    Returns void

    Api

setAttributions

  • setAttributions(attributions: undefined | AttributionLike): 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

ProtectedsetKey

  • setKey(key: string): void
    Protected

    Set the value to be used as the key for all tiles in the source.

    Parameters

    • key: string

      The key for tiles.

    Returns void

setParams

  • setParams(params: any): void

    Set the URL parameters passed to the WMS source.

    Parameters

    • params: any

      New URL paremeters.

    Returns void

    Api

setProperties

  • setProperties(values: { [x: string]: any }, silent?: boolean): 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.

    • Optionalsilent: boolean

      Update without triggering an event.

    Returns void

    Api

setRenderReprojectionEdges

  • setRenderReprojectionEdges(render: boolean): void

    Sets whether to render reprojection edges or not (usually for debugging).

    Parameters

    • render: boolean

      Render the edges.

    Returns void

    Api

setState

  • setState(state: State): void

    Set the state of the source.

    Parameters

    • state: State

      State.

    Returns void

setTileGridForProjection

  • setTileGridForProjection(projection: ProjectionLike, tilegrid: TileGrid): void

    Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

    This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

    Parameters

    • projection: ProjectionLike

      Projection.

    • tilegrid: TileGrid

      Tile grid to use for the projection.

    Returns void

    Api

setTileLoadFunction

  • setTileLoadFunction(tileLoadFunction: LoadFunction): void

    Deprecated. Use an ImageTile source instead. Set the tile load function of the source.

    Parameters

    • tileLoadFunction: LoadFunction

      Tile load function.

    Returns void

    Api

setTileUrlFunction

  • setTileUrlFunction(tileUrlFunction: UrlFunction, key?: string): void

    Deprecated. Use an ImageTile source instead. Set the tile URL function of the source.

    Parameters

    • tileUrlFunction: UrlFunction

      Tile URL function.

    • Optionalkey: string

      Optional new tile key for the source.

    Returns void

    Api

setUrl

  • setUrl(url: string): void

    Set the URL to use for requests.

    Parameters

    • url: string

      URL.

    Returns void

    Api

setUrls

  • setUrls(urls: string[]): void

    Deprecated. Use an ImageTile source instead. Set the URLs to use for requests.

    Parameters

    • urls: string[]

      URLs.

    Returns void

    Api

tileUrlFunction

  • tileUrlFunction(
        tileCoord: TileCoord,
        pixelRatio: number,
        projection: Projection,
    ): undefined | string

    Parameters

    • tileCoord: TileCoord

      Tile coordinate.

    • pixelRatio: number

      Pixel ratio.

    • projection: Projection

      Projection.

    Returns undefined | string

    Tile URL.

ProtectedunInternal

  • unInternal(
        type: string | string[],
        listener: (arg0: Event | BaseEvent) => unknown,
    ): void
    Protected

    Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      Type.

    • listener: (arg0: Event | BaseEvent) => unknown

      Listener.

    Returns void

unset

  • unset(key: string, silent?: boolean): void

    Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optionalsilent: boolean

      Unset without triggering an event.

    Returns void

    Api

updateParams

  • updateParams(params: any): void

    Update the URL parameters. This method can be used to update a subset of the WMS parameters. Call setParams to set all of the parameters.

    Parameters

    • params: any

      Updated URL parameters.

    Returns void

    Api

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addChangeListeneraddEventListenerapplyPropertieschangedcleardispatchEventdisposedisposeInternalgetgetAttributionsgetAttributionsCollapsiblegetFeatureInfoUrlgetGuttergetGutterForProjectiongetInterpolategetKeygetKeysgetLegendUrlgetListenersgetParamsgetProjectiongetPropertiesgetPropertiesInternalgetResolutionsgetRevisiongetStategetTilegetTileCoordForTileUrlFunctiongetTileGridgetTileGridForProjectiongetTileInternalgetTileLoadFunctiongetTilePixelRatiogetTilePixelSizegetTileUrlFunctiongetUrlsgetViewgetWrapXhandleTileChangehasListenerhasPropertiesnotifyonceInternalonInternalrefreshremoveChangeListenerremoveEventListenersetsetAttributionssetKeysetParamssetPropertiessetRenderReprojectionEdgessetStatesetTileGridForProjectionsetTileLoadFunctionsetTileUrlFunctionsetUrlsetUrlstileUrlFunctionunInternalunsetupdateParams