Class LayerWMTS

Hierarchy

  • TileLayer
    • LayerWMTS

Constructors

constructor

Properties

config disposed name on once rendered service un

Methods

addChangeListener addEventListener applyProperties changed clearRenderer createRenderer dispatchEvent dispose disposeInternal get getAttributions getBackground getCacheSize getClassName getConfiguration getData getDeclutter getDescription getExtent getFeatures getKeys getLayersArray getLayerState getLayerStatesArray getLegends getListeners getMapInternal getMaxResolution getMaxZoom getMetadata getMinResolution getMinZoom getOpacity getOriginators getPreload getProperties getPropertiesInternal getQuicklookUrl getRenderer getRenderSource getRevision getSource getSourceState getTitle getUseInterimTilesOnError getVisible getZIndex hasListener hasProperties hasRenderer isVisible notify onceInternal onInternal removeChangeListener removeEventListener render renderDeclutter renderDeferred set setBackground setExtent setMap setMapInternal setMaxResolution setMaxZoom setMinResolution setMinZoom setOpacity setPreload setProperties setSource setUseInterimTilesOnError setVisible setZIndex unInternal unrender unset

Constructors

constructor

  • new LayerWMTS(options: LayerWMTSOptions): LayerWMTS

    Parameters

    Returns LayerWMTS

    Example

    var layerWMTS = new ol.layer.GeoportalWMTS({
         layer  : "ORTHOIMAGERY.ORTHOPHOTOS"
    });
    layerWMTS.getLegends();
    layerWMTS.getMetadata();
    layerWMTS.getTitle();
    layerWMTS.getDescription();
    layerWMTS.getQuicklookUrl();
    layerWMTS.getOriginators();

    // Ex. configuration object for WMTS Layer
    {
    "name" : "GEOGRAPHICALGRIDSYSTEMS.MAPS.OVERVIEW",
    "globalConstraint" : {
        "maxScaleDenominator" : 279541132.01435894,
        "minScaleDenominator" : 2183915.0938621787,
        "bbox" : {
            "left" : -179.5,
            "right" : 179.5,
            "top" : 75,
            "bottom" : -75
        }
    },
    "params" : {
        "url" : "https://data.geopf.fr/wmts",
        "styles" : "normal",
        "version" : "1.0.0",
        "format" : "image/jpeg",
        "projection" : "EPSG:3857",
        "minScale" : 2183915.0938621787,
        "maxScale" : 279541132.01435894,
        "extent" : {
            "left" : -179.5,
            "right" : 179.5,
            "top" : 75,
            "bottom" : -75
        },
        "legends" : [
            {
                "format" : "image/jpeg",
                "url" : "https:*data.geopf.fr/annexes/ressources/legendes/LEGEND.jpg",
                "minScaleDenominator" : "200"
            }
        ],
        "title" : "Carte Mondiale pour la mini-vue",
        "description" : "Carte Mondiale pour la mini-vue",
        "tileMatrixSetLimits" : {
            "1" : {
                "minTileRow" : "0",
                "maxTileRow" : "1",
                "minTileCol" : "0",
                "maxTileCol" : "1"
            },
            "2" : {
                "minTileRow" : "0",
                "maxTileRow" : "3",
                "minTileCol" : "0",
                "maxTileCol" : "3"
            },
            "3" : {
                "minTileRow" : "1",
                "maxTileRow" : "6",
                "minTileCol" : "0",
                "maxTileCol" : "7"
            },
            "4" : {
                "minTileRow" : "2",
                "maxTileRow" : "13",
                "minTileCol" : "0",
                "maxTileCol" : "15"
            },
            "5" : {
                "minTileRow" : "5",
                "maxTileRow" : "26",
                "minTileCol" : "0",
                "maxTileCol" : "31"
            },
            "6" : {
                "minTileRow" : "11",
                "maxTileRow" : "52",
                "minTileCol" : "0",
                "maxTileCol" : "63"
            },
            "7" : {
                "minTileRow" : "22",
                "maxTileRow" : "105",
                "minTileCol" : "0",
                "maxTileCol" : "127"
            },
            "8" : {
                "minTileRow" : "45",
                "maxTileRow" : "210",
                "minTileCol" : "0",
                "maxTileCol" : "255"
            }
        },
        "TMSLink" : "PM_1_8",
        "matrixIds" : [
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7",
            "8"
        ],
        "tileMatrices" : {
            "1" : {
                "matrixId" : "1",
                "matrixHeight" : 2,
                "matrixWidth" : 2,
                "scaleDenominator" : 279541132.01435894,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "2" : {
                "matrixId" : "2",
                "matrixHeight" : 4,
                "matrixWidth" : 4,
                "scaleDenominator" : 139770566.0071793,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "3" : {
                "matrixId" : "3",
                "matrixHeight" : 8,
                "matrixWidth" : 8,
                "scaleDenominator" : 69885283.00358965,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "4" : {
                "matrixId" : "4",
                "matrixHeight" : 16,
                "matrixWidth" : 16,
                "scaleDenominator" : 34942641.50179486,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "5" : {
                "matrixId" : "5",
                "matrixHeight" : 32,
                "matrixWidth" : 32,
                "scaleDenominator" : 17471320.75089743,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "6" : {
                "matrixId" : "6",
                "matrixHeight" : 64,
                "matrixWidth" : 64,
                "scaleDenominator" : 8735660.375448715,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "7" : {
                "matrixId" : "7",
                "matrixHeight" : 128,
                "matrixWidth" : 128,
                "scaleDenominator" : 4367830.1877243575,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            },
            "8" : {
                "matrixId" : "8",
                "matrixHeight" : 256,
                "matrixWidth" : 256,
                "scaleDenominator" : 2183915.0938621787,
                "tileHeight" : 256,
                "tileWidth" : 256,
                "topLeftCorner" : {
                    "x" : -20037508.3427892,
                    "y" : 20037508.3427892
                }
            }
        },
        "nativeResolutions" : [
            "78271.51696402048",
            "39135.75848201023",
            "19567.87924100512",
            "9783.939620502561",
            "4891.969810251280",
            "2445.984905125640",
            "1222.992452562820",
            "611.4962262814100"
        ]
    }

Properties

config

config: any

Protecteddisposed

disposed: boolean

The object has already been disposed.

name

name: string

on

on: BaseTileLayerOnSignature<EventsKey>

once

once: BaseTileLayerOnSignature<EventsKey>

Protectedrendered

rendered: boolean

service

service: string

un

un: BaseTileLayerOnSignature<void>

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

clearRenderer

  • clearRenderer(): void

    This will clear the renderer so that a new one can be created next time it is needed

    Returns void

createRenderer

  • createRenderer(): CanvasTileLayerRenderer<LayerWMTS>

    Returns CanvasTileLayerRenderer<LayerWMTS>

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(view?: View | ViewStateLayerStateExtent): string[]

    Get the attributions of the source of this layer for the given view.

    Parameters

    • Optionalview: View | ViewStateLayerStateExtent

      View or import("../Map.js").FrameState. Only required when the layer is not added to a map.

    Returns string[]

    Attributions for this layer at the given view.

    Api

getBackground

  • getBackground(): false | BackgroundColor

    Get the background for this layer.

    Returns false | BackgroundColor

    Layer background.

ProtectedgetCacheSize

  • getCacheSize(): undefined | number
    Protected

    Returns undefined | number

    The suggested cache size

getClassName

  • getClassName(): string

    Returns string

    CSS class name.

getConfiguration

getData

  • getData(
        pixel: Pixel,
    ):
        | null
        | Uint8ClampedArray<ArrayBufferLike>
        | Uint8Array<ArrayBufferLike>
        | Float32Array<ArrayBufferLike>
        | DataView<ArrayBufferLike>

    Parameters

    • pixel: Pixel

      Pixel.

    Returns
        | null
        | Uint8ClampedArray<ArrayBufferLike>
        | Uint8Array<ArrayBufferLike>
        | Float32Array<ArrayBufferLike>
        | DataView<ArrayBufferLike>

    Pixel data.

getDeclutter

  • getDeclutter(): string

    Returns string

    Declutter

getDescription

getExtent

  • getExtent(): undefined | Extent

    Return the module:ol/extent~Extent extent of the layer or undefined if it will be visible regardless of extent.

    Returns undefined | Extent

    The layer extent.

    Observable

    Api

getFeatures

  • getFeatures(pixel: Pixel): Promise<FeatureLike[]>

    Parameters

    • pixel: Pixel

      Pixel.

    Returns Promise<FeatureLike[]>

    Promise that resolves with an array of features.

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

AbstractgetLayersArray

  • getLayersArray(
        array?: Layer<Source, LayerRenderer<any>>[],
    ): Layer<Source, LayerRenderer<any>>[]

    Parameters

    • Optionalarray: Layer<Source, LayerRenderer<any>>[]

      Array of layers (to be modified in place).

    Returns Layer<Source, LayerRenderer<any>>[]

    Array of layers.

getLayerState

  • getLayerState(managed?: boolean): State

    This method is not meant to be called by layers or layer renderers because the state is incorrect if the layer is included in a layer group.

    Parameters

    • Optionalmanaged: boolean

      Layer is managed.

    Returns State

    Layer state.

AbstractgetLayerStatesArray

  • getLayerStatesArray(states?: State[]): State[]

    Parameters

    • Optionalstates: State[]

      Optional list of layer states (to be modified in place).

    Returns State[]

    List of layer states.

getLegends

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.

getMapInternal

  • getMapInternal(): null | Map

    For use inside the library only.

    Returns null | Map

    Map.

getMaxResolution

  • getMaxResolution(): number

    Return the maximum resolution of the layer. Returns Infinity if the layer has no maximum resolution set.

    Returns number

    The maximum resolution of the layer.

    Observable

    Api

getMaxZoom

  • getMaxZoom(): number

    Return the maximum zoom level of the layer. Returns Infinity if the layer has no maximum zoom set.

    Returns number

    The maximum zoom level of the layer.

    Observable

    Api

getMetadata

getMinResolution

  • getMinResolution(): number

    Return the minimum resolution of the layer. Returns 0 if the layer has no minimum resolution set.

    Returns number

    The minimum resolution of the layer.

    Observable

    Api

getMinZoom

  • getMinZoom(): number

    Return the minimum zoom level of the layer. Returns -Infinity if the layer has no minimum zoom set.

    Returns number

    The minimum zoom level of the layer.

    Observable

    Api

getOpacity

  • getOpacity(): number

    Return the opacity of the layer (between 0 and 1).

    Returns number

    The opacity of the layer.

    Observable

    Api

getOriginators

getPreload

  • getPreload(): number

    Return the level as number to which we will preload tiles up to.

    Returns number

    The level to preload tiles up to.

    Observable

    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.

getQuicklookUrl

getRenderer

  • getRenderer(): | null
    | CanvasTileLayerRenderer<
        TileLayer<TileSource<Tile>>
        | VectorTileLayer<VectorTile<any>, any>,
    >

    Get the renderer for this layer.

    Returns
        | null
        | CanvasTileLayerRenderer<
            TileLayer<TileSource<Tile>>
            | VectorTileLayer<VectorTile<any>, any>,
        >

    The layer renderer.

getRenderSource

  • getRenderSource(): null | TileSource<Tile>

    Returns null | TileSource<Tile>

    The source being rendered.

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

  • getSource(): null | TileSource<Tile>

    Get the layer source.

    Returns null | TileSource<Tile>

    The layer source (or null if not yet set).

    Observable

    Api

AbstractgetSourceState

  • getSourceState(): State

    Returns State

    Source state.

getTitle

getUseInterimTilesOnError

  • getUseInterimTilesOnError(): boolean

    Deprecated. Whether we use interim tiles on error.

    Returns boolean

    Use interim tiles on error.

    Observable

    Api

getVisible

  • getVisible(): boolean

    Return the value of this layer's visible property. To find out whether the layer is visible on a map, use isVisible() instead.

    Returns boolean

    The value of the visible property of the layer.

    Observable

    Api

getZIndex

  • getZIndex(): undefined | number

    Return the Z-index of the layer, which is used to order layers before rendering. Returns undefined if the layer is unmanaged.

    Returns undefined | number

    The Z-index of the layer.

    Observable

    Api

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.

hasRenderer

  • hasRenderer(): boolean

    Returns boolean

    The layer has a renderer.

isVisible

  • isVisible(view?: View | ViewStateLayerStateExtent): boolean

    The layer is visible on the map view, i.e. within its min/max resolution or zoom and extent, not set to visible: false, and not inside a layer group that is set to visible: false.

    Parameters

    • Optionalview: View | ViewStateLayerStateExtent

      View or import("../Map.js").FrameState. Only required when the layer is not added to a map.

    Returns boolean

    The layer is visible in the map view.

    Api

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.

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

render

  • render(frameState: null | FrameState, target: HTMLElement): null | HTMLElement

    In charge to manage the rendering of the layer. One layer type is bounded with one layer renderer.

    Parameters

    • frameState: null | FrameState

      Frame state.

    • target: HTMLElement

      Target which the renderer may (but need not) use for rendering its content.

    Returns null | HTMLElement

    The rendered element.

renderDeclutter

  • renderDeclutter(frameState: FrameState, layerState: State): void

    Parameters

    • frameState: FrameState

      Frame state.

    • layerState: State

      Layer state.

    Returns void

renderDeferred

  • renderDeferred(frameState: FrameState): void

    When the renderer follows a layout -> render approach, do the final rendering here.

    Parameters

    • frameState: FrameState

      Frame state

    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

setBackground

  • setBackground(background?: BackgroundColor): void

    Sets the background color.

    Parameters

    • Optionalbackground: BackgroundColor

      Background color.

    Returns void

setExtent

  • setExtent(extent: undefined | Extent): void

    Set the extent at which the layer is visible. If undefined, the layer will be visible at all extents.

    Parameters

    • extent: undefined | Extent

      The extent of the layer.

    Returns void

    Observable

    Api

setMap

  • setMap(map: null | Map): void

    Sets the layer to be rendered on top of other layers on a map. The map will not manage this layer in its layers collection. This is useful for temporary layers. To remove an unmanaged layer from the map, use #setMap(null).

    To add the layer to a map and have it managed by the map, use module:ol/Map~Map#addLayer instead.

    Parameters

    • map: null | Map

      Map.

    Returns void

    Api

setMapInternal

  • setMapInternal(map: null | Map): void

    For use inside the library only.

    Parameters

    • map: null | Map

      Map.

    Returns void

setMaxResolution

  • setMaxResolution(maxResolution: number): void

    Set the maximum resolution at which the layer is visible.

    Parameters

    • maxResolution: number

      The maximum resolution of the layer.

    Returns void

    Observable

    Api

setMaxZoom

  • setMaxZoom(maxZoom: number): void

    Set the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

    Parameters

    • maxZoom: number

      The maximum zoom of the layer.

    Returns void

    Observable

    Api

setMinResolution

  • setMinResolution(minResolution: number): void

    Set the minimum resolution at which the layer is visible.

    Parameters

    • minResolution: number

      The minimum resolution of the layer.

    Returns void

    Observable

    Api

setMinZoom

  • setMinZoom(minZoom: number): void

    Set the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

    Parameters

    • minZoom: number

      The minimum zoom of the layer.

    Returns void

    Observable

    Api

setOpacity

  • setOpacity(opacity: number): void

    Set the opacity of the layer, allowed values range from 0 to 1.

    Parameters

    • opacity: number

      The opacity of the layer.

    Returns void

    Observable

    Api

setPreload

  • setPreload(preload: number): void

    Set the level as number to which we will preload tiles up to.

    Parameters

    • preload: number

      The level to preload tiles up to.

    Returns void

    Observable

    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

setSource

  • setSource(source: null | TileSource<Tile>): void

    Set the layer source.

    Parameters

    • source: null | TileSource<Tile>

      The layer source.

    Returns void

    Observable

    Api

setUseInterimTilesOnError

  • setUseInterimTilesOnError(useInterimTilesOnError: boolean): void

    Deprecated. Set whether we use interim tiles on error.

    Parameters

    • useInterimTilesOnError: boolean

      Use interim tiles on error.

    Returns void

    Observable

    Api

setVisible

  • setVisible(visible: boolean): void

    Set the visibility of the layer (true or false).

    Parameters

    • visible: boolean

      The visibility of the layer.

    Returns void

    Observable

    Api

setZIndex

  • setZIndex(zindex: number): void

    Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

    Parameters

    • zindex: number

      The z-index of the layer.

    Returns void

    Observable

    Api

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

unrender

  • unrender(): void

    Called when a layer is not visible during a map render.

    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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addChangeListeneraddEventListenerapplyPropertieschangedclearRenderercreateRendererdispatchEventdisposedisposeInternalgetgetAttributionsgetBackgroundgetCacheSizegetClassNamegetConfigurationgetDatagetDecluttergetDescriptiongetExtentgetFeaturesgetKeysgetLayersArraygetLayerStategetLayerStatesArraygetLegendsgetListenersgetMapInternalgetMaxResolutiongetMaxZoomgetMetadatagetMinResolutiongetMinZoomgetOpacitygetOriginatorsgetPreloadgetPropertiesgetPropertiesInternalgetQuicklookUrlgetRenderergetRenderSourcegetRevisiongetSourcegetSourceStategetTitlegetUseInterimTilesOnErrorgetVisiblegetZIndexhasListenerhasPropertieshasRendererisVisiblenotifyonceInternalonInternalremoveChangeListenerremoveEventListenerrenderrenderDeclutterrenderDeferredsetsetBackgroundsetExtentsetMapsetMapInternalsetMaxResolutionsetMaxZoomsetMinResolutionsetMinZoomsetOpacitysetPreloadsetPropertiessetSourcesetUseInterimTilesOnErrorsetVisiblesetZIndexunInternalunrenderunset