geopf-extensions-openlayers
    Preparing search index...

    Class SourceWMS

    Hierarchy

    • TileWMS
      • SourceWMS
    Index
    constructor
    _description _legends _metadata _originators _producer _quicklookUrl _thumbnail _title canRotate crossOrigin disposed loading name on once projection referrerPolicy service tileClass tileGrid tileGridForProjection tileLoadFunction tileOptions tmpSize un urls viewRejector viewResolver zDirection
    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 ready refresh removeChangeListener removeEventListener set setAttributions setKey setParams setProperties setRenderReprojectionEdges setState setTileGridForProjection setTileLoadFunction setTileUrlFunction setUrl setUrls tileUrlFunction unInternal unset updateParams

    • Parameters

      • options: {
            apiKey?: string;
            configuration?: any;
            description?: string;
            layer: string;
            legends?: any[];
            metadata?: any[];
            olParams?: any;
            producer?: string;
            quicklookUrl?: string;
            ssl?: boolean;
            thumbnail?: string;
            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)

        • Optionalproducer?: string

          producer of the layer

        • OptionalquicklookUrl?: string

          quicklookUrl of the layer

        • Optionalssl?: boolean

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

        • Optionalthumbnail?: string

          thumbnail of the layer

        • Optionaltitle?: string

          title of the layer

      Returns SourceWMS

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

    _description

    _description: any

    _legends

    _legends: any

    _metadata

    _metadata: any

    _originators

    _originators: any

    _producer

    _producer: any

    _quicklookUrl

    _quicklookUrl: any

    _thumbnail

    _thumbnail: any

    _title

    _title: any
    canRotate: boolean

    Rotation can be requested from the source.

    crossOrigin: string | null
    disposed: boolean

    The object has already been disposed.

    loading: number | boolean

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

    name: string
    on: TileSourceOnSignature<EventsKey>
    once: TileSourceOnSignature<EventsKey>
    projection: Projection | null
    referrerPolicy: ReferrerPolicy | undefined
    service: string
    tileClass: typeof ImageTile
    tileGrid: TileGrid | null
    tileGridForProjection: { [x: string]: TileGrid }
    tileLoadFunction: LoadFunction
    tileOptions: Options
    tmpSize: Size
    un: TileSourceOnSignature<void>
    urls: string[] | null
    viewRejector: ((arg0: Error) => void) | null
    viewResolver: ((arg0: ViewOptions) => void) | null
    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.

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Protected

      Apply any properties from another object without triggering events.

      Parameters

      • source: BaseObject

        The source object.

      Returns void

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

      Returns void

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

      Returns 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

      • event: string | BaseEvent

        Event object.

      Returns boolean | undefined

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

    • Clean up.

      Returns void

    • Protected

      Extension point for disposable objects.

      Returns void

    • Gets a value.

      Parameters

      • key: string

        Key name.

      Returns any

      Value.

    • Get the attribution function for the source.

      Returns Attribution | null

      Attribution function.

    • Returns boolean

      Attributions are collapsible.

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

      GetFeatureInfo URL.

    • Returns number

      Gutter.

    • Parameters

      • projection: Projection

        Projection.

      Returns number

      Gutter.

    • Returns boolean

      Use linear interpolation when resampling.

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

      Returns string

      The key for all tiles.

    • Get a list of object property names.

      Returns string[]

      List of property names.

    • 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: { [x: string]: 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 string | undefined

      GetLegendGraphic URL.

    • 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 Listener[] | undefined

      Listeners.

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

    • Get the projection of the source.

      Returns Projection | null

      Projection.

    • Get an object of all property names and values.

      Returns NoInfer<{ [x: string]: any }>

      Object.

    • Get an object of all property names and values.

      Returns Partial<NoInfer<{ [x: string]: any }>> | null

      Object.

    • Parameters

      • Optionalprojection: Projection

        Projection.

      Returns number[] | null

      Resolutions.

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

      Returns number

      Revision.

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

      Returns State

      State.

    • Parameters

      • z: number

        Tile coordinate z.

      • x: number

        Tile coordinate x.

      • y: number

        Tile coordinate y.

      • pixelRatio: number

        Pixel ratio.

      • projection: Projection

        Projection.

      • OptionaltileCache: LRUCache<Tile>

        Tile cache.

      Returns ImageTile | ReprojTile

      Tile.

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

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

    • Return the tile grid of the tile source.

      Returns TileGrid | null

      Tile grid.

    • Parameters

      • projection: Projection

        Projection.

      Returns TileGrid

      Tile grid.

    • Protected

      Parameters

      • z: number

        Tile coordinate z.

      • x: number

        Tile coordinate x.

      • y: number

        Tile coordinate y.

      • pixelRatio: number

        Pixel ratio.

      • projection: Projection

        Projection.

      • OptionaltileCache: LRUCache<Tile>

        Tile cache.

      Returns ImageTile

      Tile.

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

      Returns LoadFunction

      TileLoadFunction

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

    • Parameters

      • z: number

        Z.

      • pixelRatio: number

        Pixel ratio.

      • projection: Projection

        Projection.

      Returns Size

      Tile size.

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

      Returns UrlFunction

      TileUrlFunction

    • 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 string[] | null

      URLs.

    • Returns Promise<ViewOptions>

      A promise for view-related properties.

    • Returns boolean | undefined

      Wrap X.

    • Protected

      Handle tile change events.

      Parameters

      • event: BaseEvent

        Event.

      Returns void

    • Parameters

      • Optionaltype: string

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

      Returns boolean

      Has listeners.

    • Returns boolean

      The object has properties.

    • Parameters

      • key: string

        Key name.

      • oldValue: any

        Old value.

      Returns void

    • Protected

      Parameters

      • type: string | string[]

        Type.

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

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Protected

      Parameters

      • type: string | string[]

        Type.

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

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Protected

      Resolve once the source is ready to be used (its state is ready), or reject if it fails to load (its state is error). Sources that configure asynchronously can use this to expose data (e.g. dimensions) through a promise instead of the change event.

      Returns Promise<void>

      Resolves when the source is ready.

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

      Returns void

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Sets a value.

      Parameters

      • key: string

        Key name.

      • value: any

        Value.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns void

    • Set the attributions of the source.

      Parameters

      • attributions: AttributionLike | undefined

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

      Returns 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

    • Set the URL parameters passed to the WMS source.

      Parameters

      • params: { [x: string]: any }

        New URL paremeters.

      Returns 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: Partial<NoInfer<Properties>>

        Values.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns void

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

      Parameters

      • render: boolean

        Render the edges.

      Returns void

    • Set the state of the source.

      Parameters

      • state: State

        State.

      Returns 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

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

      Parameters

      • tileLoadFunction: LoadFunction

        Tile load function.

      Returns 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

    • Set the URL to use for requests.

      Parameters

      • url: string

        URL.

      Returns void

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

      Parameters

      • urls: string[]

        URLs.

      Returns void

    • Parameters

      • tileCoord: TileCoord

        Tile coordinate.

      • pixelRatio: number

        Pixel ratio.

      • projection: Projection

        Projection.

      Returns string | undefined

      Tile URL.

    • Protected

      Unlisten for a certain type of event.

      Parameters

      • type: string | string[]

        Type.

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

        Listener.

      Returns void

    • Unsets a property.

      Parameters

      • key: string

        Key name.

      • Optionalsilent: boolean

        Unset without triggering an event.

      Returns 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: { [x: string]: any }

        Updated URL parameters.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods
    addChangeListeneraddEventListenerapplyPropertieschangedcleardispatchEventdisposedisposeInternalgetgetAttributionsgetAttributionsCollapsiblegetFeatureInfoUrlgetGuttergetGutterForProjectiongetInterpolategetKeygetKeysgetLegendUrlgetListenersgetParamsgetProjectiongetPropertiesgetPropertiesInternalgetResolutionsgetRevisiongetStategetTilegetTileCoordForTileUrlFunctiongetTileGridgetTileGridForProjectiongetTileInternalgetTileLoadFunctiongetTilePixelRatiogetTilePixelSizegetTileUrlFunctiongetUrlsgetViewgetWrapXhandleTileChangehasListenerhasPropertiesnotifyonceInternalonInternalreadyrefreshremoveChangeListenerremoveEventListenersetsetAttributionssetKeysetParamssetPropertiessetRenderReprojectionEdgessetStatesetTileGridForProjectionsetTileLoadFunctionsetTileUrlFunctionsetUrlsetUrlstileUrlFunctionunInternalunsetupdateParams