Class: VectorLayer

new VectorLayer(id, geometriesopt, optionsopt) [source]

Parameter Type Default Description

id String | Number layer's id

geometries opt Geometry | Array.<Geometry> null geometries to add

options opt

Object

null

construct options

Properties

Parameter	Type	Default	Description
`style` opt	Object	null	vectorlayer's style
`*` opt	*	null	options defined in VectorLayer

Extends:

OverlayLayer

Members

(constant) options

Properties:

Name Type Description

options

Object

VectorLayer's options

Properties

Name	Type	Default	Description
`debug`	Boolean	false	whether the geometries on the layer is in debug mode.
`enableSimplify`	Boolean	true	whether to simplify geometries before rendering.
`cursor`	String	default	the cursor style of the layer
`geometryEvents`	Boolean	true	enable/disable firing geometry events, disable it to improve performance.
`defaultIconSize`	Boolean	[20,20	default size of a marker's icon
`enableAltitude` opt	Boolean	false	whether to enable render geometry with altitude, false by default
`altitudeProperty` opt	Boolean	altitude	geometry's altitude property name, if enableAltitude is true, "altitude" by default
`drawAltitude` opt	Boolean	false	whether to draw altitude: a vertical line for marker, a vertical polygon for line
`altitude` opt	Number	0	layer altitude
`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.
`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.
`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:

OverlayLayer#options

Source:

layer/VectorLayer.js, line 28

Methods

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

toJSON(optionsopt) [source]

Export the VectorLayer's JSON.

Parameter Type Default Description

options opt

Object

null

export options

Properties

Parameter	Type	Default	Description
`geometries` opt	Object	null	If not null and the layer is a OverlayerLayer, the layer's geometries will be exported with the given "options.geometries" as a parameter of geometry's toJSON.
`clipExtent` opt	Extent	null	if set, only the geometries intersectes with the extent will be exported.

Returns:

Object: layer's JSON

(inherited) getGeometryById(id) [source]

Get a geometry by its id

Parameter	Type	Description
`id`	String \| Number	id of the geometry

Inherited From:

OverlayLayer#getGeometryById

Returns:

Geometry:

(inherited) 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.

Inherited From:

OverlayLayer#getGeometries

Returns:

Array.<Geometry>:

(inherited) getFirstGeometry() [source]

Get the first geometry, the geometry at the bottom.

Inherited From:

OverlayLayer#getFirstGeometry

Returns:

Geometry: first geometry

(inherited) getLastGeometry() [source]

Get the last geometry, the geometry on the top

Inherited From:

OverlayLayer#getLastGeometry

Returns:

Geometry: last geometry

(inherited) getCount() [source]

Get count of the geometries

Inherited From:

OverlayLayer#getCount

Returns:

Number: count

(inherited) getExtent() [source]

Get extent of all the geometries in the layer, return null if the layer is empty.

Inherited From:

OverlayLayer#getExtent

Returns:

Extent: - extent of the layer

(inherited) 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.

Inherited From:

OverlayLayer#forEach

Returns:

OverlayLayer: this

(inherited) 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.

Inherited From:

OverlayLayer#filter

Returns:

GeometryCollection: A GeometryCollection with all the geometries that pass the test

(inherited) isEmpty() [source]

Whether the layer is empty.

Inherited From:

OverlayLayer#isEmpty

Returns:

Boolean:

(inherited) 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 | Object

false

automatically set the map to a fit center and zoom for the geometries

Properties

Parameter	Type	Default	Description
`easing` opt	String	out	default animation type
`duration` opt	Number	map.options.zoomAnimationDuration	default animation time
`step` opt	function	null	step function during animation, animation frame as the parameter

Inherited From:

OverlayLayer#addGeometry

Returns:

OverlayLayer: this

(inherited) getGeoMinZIndex() [source]

Get minimum zindex of geometries

Inherited From:

OverlayLayer#getGeoMinZIndex

(inherited) getGeoMaxZIndex() [source]

Get maximum zindex of geometries

Inherited From:

OverlayLayer#getGeoMaxZIndex

(inherited) 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

Inherited From:

OverlayLayer#removeGeometry

Returns:

OverlayLayer: this

(inherited) clear() [source]

Clear all geometries in this layer

Inherited From:

OverlayLayer#clear

Returns:

OverlayLayer: this

(protected) (inherited) onRemoveGeometry(geometry) [source]

Called when geometry is being removed to clear the context concerned.

Parameter	Type	Description
`geometry`	Geometry	the geometry instance to remove

Inherited From:

OverlayLayer#onRemoveGeometry

(inherited) getStyle() [source]

Gets layer's style.

Inherited From:

OverlayLayer#getStyle

Returns:

Object|Array.<Object>: layer's style

(inherited) setStyle(style) [source]

Sets style to the layer, styling the geometries satisfying the condition with style's symbol.
Based on filter type in [mapbox-gl-js's style specification]{https://www.mapbox.com/mapbox-gl-js/style-spec/#types-filter}.

layer.setStyle([
        {
          'filter': ['==', 'count', 100],
          'symbol': {'markerFile' : 'foo1.png'}
        },
        {
          'filter': ['==', 'count', 200],
          'symbol': {'markerFile' : 'foo2.png'}
        }
      ]);

Parameter	Type	Description
`style`	Object \| Array.<Object>	layer's style

Inherited From:

OverlayLayer#setStyle

Fires:

setstyle

Returns:

VectorLayer: this

(inherited) removeStyle() [source]

Removes layers' style

Inherited From:

OverlayLayer#removeStyle

Fires:

removestyle

Returns:

VectorLayer: this

(inherited) load() [source]

load the tile layer, can't be overrided by sub-classes

Inherited From:

Layer#load

(inherited) getId() [source]

Get the layer id

Inherited From:

Layer#getId

Returns:

String: id

(inherited) setId(id) [source]

Set a new id to the layer

Parameter	Type	Description
`id`	String	new layer id

Inherited From:

Layer#setId

Fires:

idchange

Returns:

Layer: this

(inherited) addTo(map) [source]

Adds itself to a map.

Parameter	Type	Description
`map`	Map	map added to

Inherited From:

Layer#addTo

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:

Layer#setZIndex

Returns:

Layer: this

(inherited) getZIndex() [source]

Get the layer's z-index

Inherited From:

Layer#getZIndex

Returns:

Number:

(inherited) getMinZoom() [source]

Get Layer's minZoom to display

Inherited From:

Layer#getMinZoom

Returns:

Number:

(inherited) getMaxZoom() [source]

Get Layer's maxZoom to display

Inherited From:

Layer#getMaxZoom

Returns:

Number:

(inherited) getOpacity() [source]

Get layer's opacity

Inherited From:

Layer#getOpacity

Returns:

Number:

(inherited) setOpacity(opacity) [source]

Set opacity to the layer

Parameter	Type	Description
`opacity`	Number	layer's opacity

Inherited From:

Layer#setOpacity

Returns:

Layer: this

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

If the layer is rendered by HTML5 Canvas.

Inherited From:

Layer#isCanvasRender

Returns:

Boolean:

(inherited) getMap() [source]

Get the map that the layer added to

Inherited From:

Layer#getMap

Returns:

Map:

(inherited) getProjection() [source]

Get projection of layer's map

Inherited From:

Layer#getProjection

Returns:

Object:

(inherited) bringToFront() [source]

Brings the layer to the top of all the layers

Inherited From:

Layer#bringToFront

Returns:

Layer: this

(inherited) bringToBack() [source]

Brings the layer under the bottom of all the layers

Inherited From:

Layer#bringToBack

Returns:

Layer: this

(inherited) show() [source]

Show the layer

Inherited From:

Layer#show

Returns:

Layer: this

(inherited) hide() [source]

Hide the layer

Inherited From:

Layer#hide

Returns:

Layer: this

(inherited) isVisible() [source]

Whether the layer is visible now.

Inherited From:

Layer#isVisible

Returns:

Boolean:

(inherited) remove() [source]

Remove itself from the map added to.

Inherited From:

Layer#remove

Returns:

Layer: this

(inherited) getMask() [source]

Get the mask geometry of the layer

Inherited From:

Layer#getMask

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:

Layer#setMask

Returns:

Layer: this

(inherited) removeMask() [source]

Remove the mask

Inherited From:

Layer#removeMask

Returns:

Layer: this

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

Prepare Layer's loading, this is a method intended to be overrided by subclasses.

Inherited From:

Layer#onLoad

Returns:

Boolean: true to continue loading, false to cease.

(inherited) isLoaded() [source]

Whether the layer is loaded

Inherited From:

Layer#isLoaded

Returns:

Boolean:

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

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:

Eventable.on

Inherited From:

Layer#on

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:

Eventable.addEventListener

Inherited From:

Layer#addEventListener

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:

Eventable.once

Inherited From:

Layer#once

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:

Eventable.off

Inherited From:

Layer#off

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:

Eventable.removeEventListener

Inherited From:

Layer#removeEventListener

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:

Eventable.listens

Inherited From:

Layer#listens

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:

Eventable.copyEventListeners

Inherited From:

Layer#copyEventListeners

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:

Eventable.fire

Inherited From:

Layer#fire

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:

JSONAble.registerJSONType

Inherited From:

Layer#registerJSONType

(inherited) getJSONClass(type) [source]

It is a static method.
Get class of input JSON type

Parameter	Type	Description
`type`	String	JSON type

Mixes From:

JSONAble.getJSONClass

Inherited From:

Layer#getJSONClass

Returns:

Class: Class

(inherited) getJSONType() [source]

Get object's JSON Type

Mixes From:

JSONAble.getJSONType

Inherited From:

Layer#getJSONType

Returns:

String:

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

Parameter	Type	Description
`name`	String	renderer's register key
`clazz`	function	renderer's class, a function (not necessarily a Class).

Mixes From:

Renderable.registerRenderer

Inherited From:

Layer#registerRenderer

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:

Renderable.getRendererClass

Inherited From:

Layer#getRendererClass

Returns:

function: renderer's class

(inherited) callInitHooks() [source]

Visit and call all the init hooks defined on Class and its parents.

Inherited From:

Class#callInitHooks

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:

Class#setOptions

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
});