Class: WMSTileLayer

WMSTileLayer

Used to display [WMS]{https://en.wikipedia.org/wiki/Web_Map_Service} services as tile layers on the map. Extends TileLayer. Implemented based on Leaflet's TileLayer.WMS.

new WMSTileLayer(id, optionsopt) [source] 

var layer = new maptalks.WMSTileLayer('wms', {
    'urlTemplate' : 'https://demo.boundlessgeo.com/geoserver/ows',
    'crs' : 'EPSG:3857',
    'layers' : 'ne:ne',
    'styles' : '',
    'version' : '1.3.0',
    'format': 'image/png',
    'transparent' : true,
    'uppercase' : true
});
Parameter Type Default Description
id String | Number tile layer's id
options opt Object null options defined in WMSTileLayer
Extends:
Fires:

Members

  • (constant) options

    • Properties:
    Name Type Description
    options Object TileLayer's options
    Properties
    Name Type Default Description
    service opt String WMS WMS Service
    layers String Comma-separated list of WMS layers to show.
    styles opt String '' Comma-separated list of WMS styles.
    format opt String image/jpeg WMS image format (use `'image/png'` for layers with transparency).
    transparent opt String false Version of the WMS service to use
    version opt String 1.1.1 size of the tile image
    crs opt String null Coordinate Reference System to use for the WMS requests, defaults to map CRS. Don't change this if you're not sure what it means.
    uppercase opt Boolean false If `true`, WMS request parameter keys will be uppercase.
    detectRetina opt Boolean false If `true` and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
    urlTemplate String | function url templates
    subdomains opt Array.<String> | Array.<Number> null subdomains to replace '{s}' in urlTemplate
    spatialReference opt Object null TileLayer's spatial reference
    tileSize opt Array.<Number> [256, 256] size of the tile image, [width, height]
    offset opt Array.<Number> | function [0, 0] overall tile offset, [dx, dy], useful for tile sources from difference coordinate systems, e.g. (wgs84 and gcj02)
    tileSystem opt Array.<Number> null tile system number arrays
    maxAvailableZoom opt Number null Maximum zoom level for which tiles are available. Data from tiles at the maxAvailableZoom are used when displaying the map at higher zoom levels.
    repeatWorld opt Boolean true tiles will be loaded repeatedly outside the world.
    background opt Boolean true whether to draw a background during or after interacting, true by default
    backgroundZoomDiff opt Number 6 the zoom diff to find parent tile as background
    placeholder opt Boolean | function false a placeholder image to replace loading tile, can be a function with a parameter of the tile canvas
    fragmentShader opt String null custom fragment shader, replace the default fragment shader
    crossOrigin opt String null tile image's corssOrigin
    fadeAnimation opt Boolean true fade animation when loading tiles
    debug opt Boolean false if set to true, tiles will have borders and a title of its coordinates.
    renderer opt String gl TileLayer's renderer, canvas or gl. gl tiles requires image CORS that canvas doesn't. canvas tiles can't pitch.
    maxCacheSize opt Number 256 maximum number of tiles to cache
    cascadeTiles opt Boolean true draw cascaded tiles of different zooms to reduce tiles
    zoomOffset opt Number 0 offset from map's zoom to tile's zoom
    tileRetryCount opt Number 0 retry count of tiles
    attribution opt String null the attribution of this layer, you can specify company or other information of this layer.
    minZoom opt Number -1 the minimum zoom to display the layer, set to -1 to unlimit it.
    maxZoom opt Number -1 the maximum zoom to display the layer, set to -1 to unlimit it.
    visible opt Boolean true whether to display the layer.
    opacity opt Number 1 opacity of the layer, from 0 to 1.
    zIndex opt Number z index of the layer
    hitDetect opt Boolean true Whether to enable hit detection for layers for cursor styles on this map, disable it to improve performance.
    globalCompositeOperation opt String null (Only for layer rendered with CanvasRenderer) globalCompositeOperation of layer's canvas 2d context.
    debugOutline opt String '#0f0' debug outline's color.
    cssFilter opt String null css filter apply to canvas context's filter
    forceRenderOnMoving opt Boolean false force to render layer when map is moving
    forceRenderOnZooming opt Boolean false force to render layer when map is zooming
    forceRenderOnRotating opt Boolean false force to render layer when map is Rotating
    Overrides:
    Source:

    Methods

  • toJSON() [source]

    • Export the WMSTileLayer's json.
    It can be used to reproduce the instance by fromJSON method
    Returns:
    Object: layer's JSON

  • (inherited) getTileSize() [source]

    • Get tile size of the tile layer
    Inherited From:
    Returns:
    Size:

  • (inherited) getTiles(z) [source]

    • Get tiles at zoom z (or current zoom)
    Parameter Type Description
    z Number zoom
    Inherited From:
    Returns:
    Array.<Object>: tile descriptors

  • (inherited) getTileUrl(x, y, z) [source]

    • Get tile's url
    Parameter Type Description
    x Number
    y Number
    z Number
    Returns:
    String: url

  • (inherited) clear() [source]

    • Clear the layer
    Inherited From:
    Returns:
    TileLayer: this

  • (inherited) getSpatialReference() [source]

    • Get tilelayer's spatial reference.
    Inherited From:
    Returns:
    SpatialReference: spatial reference

  • (inherited) load() [source]

    • load the tile layer, can't be overrided by sub-classes
    Inherited From:

  • (inherited) getId() [source]

    • Get the layer id
    Inherited From:
    Returns:
    String: id

  • (inherited) setId(id) [source]

    • Set a new id to the layer
    Parameter Type Description
    id String new layer id
    Inherited From:
    Fires:
    Returns:
    Layer: this

  • (inherited) addTo(map) [source]

    • Adds itself to a map.
    Parameter Type Description
    map Map map added to
    Inherited From:
    Returns:
    Layer: this

  • (inherited) setZIndex(zIndex) [source]

    • Set a z-index to the layer
    Parameter Type Description
    zIndex Number layer's z-index
    Inherited From:
    Returns:
    Layer: this

  • (inherited) getZIndex() [source]

    • Get the layer's z-index
    Inherited From:
    Returns:
    Number:

  • (inherited) getMinZoom() [source]

    • Get Layer's minZoom to display
    Inherited From:
    Returns:
    Number:

  • (inherited) getMaxZoom() [source]

    • Get Layer's maxZoom to display
    Inherited From:
    Returns:
    Number:

  • (inherited) getOpacity() [source]

    • Get layer's opacity
    Inherited From:
    Returns:
    Number:

  • (inherited) setOpacity(opacity) [source]

    • Set opacity to the layer
    Parameter Type Description
    opacity Number layer's opacity
    Inherited From:
    Returns:
    Layer: this

  • (protected) (inherited) isCanvasRender() [source]

    • If the layer is rendered by HTML5 Canvas.
    Inherited From:
    Returns:
    Boolean:

  • (inherited) getMap() [source]

    • Get the map that the layer added to
    Inherited From:
    Returns:
    Map:

  • (inherited) getProjection() [source]

    • Get projection of layer's map
    Inherited From:
    Returns:
    Object:

  • (inherited) bringToFront() [source]

    • Brings the layer to the top of all the layers
    Inherited From:
    Returns:
    Layer: this

  • (inherited) bringToBack() [source]

    • Brings the layer under the bottom of all the layers
    Inherited From:
    Returns:
    Layer: this

  • (inherited) show() [source]

    • Show the layer
    Inherited From:
    Returns:
    Layer: this

  • (inherited) hide() [source]

    • Hide the layer
    Inherited From:
    Returns:
    Layer: this

  • (inherited) isVisible() [source]

    • Whether the layer is visible now.
    Inherited From:
    Returns:
    Boolean:

  • (inherited) remove() [source]

    • Remove itself from the map added to.
    Inherited From:
    Returns:
    Layer: this

  • (inherited) getMask() [source]

    • Get the mask geometry of the layer
    Inherited From:
    Returns:
    Geometry:

  • (inherited) setMask(mask) [source]

    • Set a mask geometry on the layer, only the area in the mask will be displayed.
    Parameter Type Description
    mask Geometry mask geometry, can only be a Marker with vector symbol, a Polygon or a MultiPolygon
    Inherited From:
    Returns:
    Layer: this

  • (inherited) removeMask() [source]

    • Remove the mask
    Inherited From:
    Returns:
    Layer: this

  • (protected) (inherited) onLoad() [source]

    • Prepare Layer's loading, this is a method intended to be overrided by subclasses.
    Inherited From:
    Returns:
    Boolean: true to continue loading, false to cease.

  • (inherited) isLoaded() [source]

    • Whether the layer is loaded
    Inherited From:
    Returns:
    Boolean:

  • (inherited) on(eventsOn, handler, contextopt) [source]

    • Register a handler function to be called whenever this event is fired. 
    foo.on('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOn String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Inherited From:
    Returns:
    Any: this

  • (inherited) addEventListener(eventTypes, handler, contextopt) [source]

    • Alias for on
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Inherited From:
    Returns:
    : this

  • (inherited) once(eventTypes, handler, contextopt) [source]

    • Same as on, except the listener will only get fired once and then removed. 
    foo.once('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Inherited From:
    Returns:
    : this

  • (inherited) off(eventsOff, handler, contextopt) [source]

    • Unregister the event handler for the specified event types. 
    foo.off('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOff String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Inherited From:
    Returns:
    : this

  • (inherited) removeEventListener(eventTypes, handler, contextopt) [source]

    • Alias for off
    Parameter Type Default Description
    eventTypes String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Inherited From:
    Returns:
    : this

  • (inherited) listens(eventType, hanlderopt, contextopt) [source]

    • Returns listener's count registered for the event type.
    Parameter Type Default Description
    eventType String an event type
    hanlder opt function null listener function
    context opt Object null the context of the handler
    Mixes From:
    Inherited From:
    Returns:
    Number:

  • (inherited) copyEventListeners(target) [source]

    • Copy all the event listener to the target object
    Parameter Type Description
    target Object target object to copy to.
    Mixes From:
    Inherited From:
    Returns:
    : this

  • (inherited) fire(eventType, param) [source]

    • Fire an event, causing all handlers for that event name to run.
    Parameter Type Description
    eventType String an event type to fire
    param Object parameters for the listener function.
    Mixes From:
    Inherited From:
    Returns:
    : this

  • (inherited) registerJSONType(type) [source]

    • It is a static method.
    Register layer for JSON serialization and assign a JSON type.
    Parameter Type Description
    type String JSON type
    Mixes From:
    Inherited From:

  • (inherited) getJSONClass(type) [source]

    • It is a static method.
    Get class of input JSON type
    Parameter Type Description
    type String JSON type
    Mixes From:
    Inherited From:
    Returns:
    Class: Class

  • (inherited) getJSONType() [source]

    • Get object's JSON Type
    Mixes From:
    Inherited From:
    Returns:
    String:

  • (inherited) registerRenderer(name, clazz) [source]

    • Register a renderer class with the given name.
    Parameter Type Description
    name String renderer's register key
    clazz function renderer's class, a function (not necessarily a Class).
    Mixes From:
    Inherited From:
    Returns:
    *: this

  • (inherited) getRendererClass(name) [source]

    • Get the registered renderer class by the given name
    Parameter Type Description
    name String renderer's register key
    Mixes From:
    Inherited From:
    Returns:
    function: renderer's class

  • (inherited) callInitHooks() [source]

    • Visit and call all the init hooks defined on Class and its parents.
    Inherited From:
    Returns:
    Class: this

  • (inherited) setOptions(options) [source]

    • Merges options with the default options of the object.
    Parameter Type Description
    options Object options to set
    Inherited From:
    Returns:
    Class: this

  • (inherited) config(conf) [source]

    • 1. Return object's options if no parameter is provided.
    2. update an option and enable/disable the handler if a handler with the same name existed. 
    // Get marker's options;
var options = marker.config();
// Set map's option "draggable" to false and disable map's draggable handler.
map.config('draggable', false);
// You can update more than one options like this:
map.config({
    'scrollWheelZoom' : false,
    'doubleClickZoom' : false
});
    Parameter Type Description
    conf Object config to update
    Inherited From:
    Returns:
    Class: this

  • (inherited) onConfig() [source]

    • Default callback when config is called
    Inherited From:

    Events

  • (inherited) clear [source]

    • clear event, fired when tile layer is cleared.
    Inherited From:
    Properties:
    Name Type Description
    type String clear
    target TileLayer tile layer
    Inherited From:
    Source:

  • (inherited) idchange [source]

    • idchange event.
    Inherited From:
    Properties:
    Name Type Description
    type String idchange
    target Layer the layer fires the event
    old String value of the old id
    new String value of the new id
    Inherited From:
    Source:

  • (inherited) renderercreate [source]

    • renderercreate event, fired when renderer is created.
    Inherited From:
    Properties:
    Name Type Description
    type String renderercreate
    target Layer the layer fires the event
    renderer Any renderer of the layer
    Inherited From:
    Source:

  • (inherited) resourceload [source]

    • resourceload event, fired when external resources of the layer complete loading.
    Inherited From:
    Properties:
    Name Type Description
    type String resourceload
    target Layer layer
    Inherited From:
    Source:

  • (inherited) canvascreate [source]

    • canvascreate event, fired when canvas created.
    Inherited From:
    Properties:
    Name Type Description
    type String canvascreate
    target Layer layer
    context CanvasRenderingContext2D canvas's context
    gl WebGLRenderingContext2D canvas's webgl context
    Inherited From:
    Source:

  • (inherited) renderstart [source]

    • renderstart event, fired when layer starts to render.
    Inherited From:
    Properties:
    Name Type Description
    type String renderstart
    target Layer layer
    context CanvasRenderingContext2D canvas's context
    Inherited From:
    Source:

  • (inherited) renderend [source]

    • renderend event, fired when layer ends rendering.
    Inherited From:
    Properties:
    Name Type Description
    type String renderend
    target Layer layer
    context CanvasRenderingContext2D canvas's context
    Inherited From:
    Source: