Class: OverlayLayer

OverlayLayer

Base class of all the layers that can add/remove geometries.
It is abstract and not intended to be instantiated.

Members

  • (constant) options

  • Properties:
    Name Type Default Description
    options.drawImmediate opt Boolean false (Only for layer rendered with CanvasRenderer)
    In default, for performance reason, layer will be drawn in a frame requested by RAF(RequestAnimationFrame).
    Set drawImmediate to true to draw immediately.
    This is necessary when layer's drawing is wrapped with another frame requested by RAF.
    options opt Object null base options of layer.
    Properties
    Name Type Default Description
    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
    renderer opt String canvas renderer type, "canvas" in default.
    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
    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
    renderer opt String canvas renderer type, "canvas" in default.
    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

  • getGeometryById(id) [source]

  • Get a geometry by its id
    Parameter Type Description
    id String | Number id of the geometry
    Returns:
    Geometry:
  • getGeometries(filteropt, contextopt) [source]

  • Get all the geometries or the ones filtered if a filter function is provided.
    Parameter Type Description
    filter opt function a function to filter the geometries
    context opt Object context of the filter function, value to use as this when executing filter.
    Returns:
    Array.<Geometry>:
  • getFirstGeometry() [source]

  • Get the first geometry, the geometry at the bottom.
    Returns:
    Geometry: first geometry
  • getLastGeometry() [source]

  • Get the last geometry, the geometry on the top
    Returns:
    Geometry: last geometry
  • getCount() [source]

  • Get count of the geometries
    Returns:
    Number: count
  • getExtent() [source]

  • Get extent of all the geometries in the layer, return null if the layer is empty.
    Returns:
    Extent: - extent of the layer
  • forEach(fn, contextopt) [source]

  • Executes the provided callback once for each geometry present in the layer in order.
    Parameter Type Description
    fn function a callback function
    context opt * callback's context, value to use as this when executing callback.
    Returns:
    OverlayLayer: this
  • filter(fn, contextopt) [source]

  • Creates a GeometryCollection with all the geometries that pass the test implemented by the provided function.
    Parameter Type Description
    fn function Function to test each geometry
    context opt * Function's context, value to use as this when executing function.
    Returns:
    GeometryCollection: A GeometryCollection with all the geometries that pass the test
  • isEmpty() [source]

  • Whether the layer is empty.
    Returns:
    Boolean:
  • addGeometry(geometries, fitViewopt) [source]

  • Adds one or more geometries to the layer
    Parameter Type Default Description
    geometries Geometry | Array.<Geometry> one or more geometries
    fitView opt Boolean false automatically set the map to a fit center and zoom for the geometries
    Returns:
    OverlayLayer: this
  • getGeoMinZIndex() [source]

  • Get minimum zindex of geometries

  • getGeoMaxZIndex() [source]

  • Get maximum zindex of geometries

  • removeGeometry(geometries) [source]

  • Removes one or more geometries from the layer
    Parameter Type Description
    geometries String | Array.<String> | Geometry | Array.<Geometry> geometry ids or geometries to remove
    Returns:
    OverlayLayer: this
  • clear() [source]

  • Clear all geometries in this layer
    Returns:
    OverlayLayer: this
  • (protected) onRemoveGeometry(geometry) [source]

  • Called when geometry is being removed to clear the context concerned.
    Parameter Type Description
    geometry Geometry the geometry instance to remove

  • identify(coordinate, optionsopt) [source]

  • Identify the geometries on the given coordinate
    Parameter Type Default Description
    coordinate maptalks.Coordinate coordinate to identify
    options opt Object null options
    Properties
    Parameter Type Default Description
    tolerance opt Object 0 identify tolerance in pixel
    count opt Object null result count
    Returns:
    Array.<Geometry>: geometries identified
  • (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
    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

  • addgeo [source]

  • addgeo event.
    Properties:
    Name Type Description
    type String addgeo
    target OverlayLayer layer
    geometries Array.<Geometry> the geometries to add
    Source:

  • removegeo [source]

  • removegeo event.
    Properties:
    Name Type Description
    type String removegeo
    target OverlayLayer layer
    geometries Array.<Geometry> the geometries to remove
    Source:

  • clear [source]

  • clear event.
    Properties:
    Name Type Description
    type String clear
    target OverlayLayer layer
    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: