Class: Marker

cercaliagl.layer/Marker


Layer for markers. This layer has the possibility to cluster markers with different values such radius and max zoom. This class manages events and its callbacks methods. All methods such as addMarker, removeMarker must be used from cercaliagl.Map methods. Don't use methods not published in this document page to avoid possibles strange map behaviours.

new Marker(options)

layer/Marker.js, line 121
Name Type Description
options
Name Type Description
id string

Layer id
map module:cercaliagl/Map~Map

Mapbox Map
type string

Type
onClusterClick function

Callback function when mouse click cluster feature.
onClusterMouseOver function

Callback function when mouse over cluster feature.
onClusterMouseOut function

Callback function when mouse out cluster feature.
clusteringEnabled Boolean

Enable/Disable clustering. Default true.
minTimeToDrag number

Minimum time to start dragging a marker. Default 200.
layerOpacityFactor number

Layer opacity. Default 1.

Extends

Methods

clear()

layer/Marker.js, line 939

disableClustering()

layer/Marker.js, line 281

Disable clustering markers.

disableHeatmap()

layer/Marker.js, line 1009

enableClustering(maxZoom, clusterRadius)

layer/Marker.js, line 269

Enable clustering. Clustering agroup markers in circle features showing total features clustered over this circular feature. Callback events for cluster feature events is possible using module:cercaliagl/Map~Map#enableClustering method

Name Type Description
maxZoom number

Max zoom. Default 16
clusterRadius number

Radius in pixels for every cluster. Default 40.

enableHeatmap(styleZones, stylePoints)

layer/Marker.js, line 983

Converts layer into heatmap. There are two layers: Zone layer for heat, and points layer. Points layers is useful to show markers in the nearest zooms. Read MapboxGL documentation to styling both layers: https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#heatmap.

Name Type Description
styleZones Object.<string, (string|boolean|number|array)>

Zones styles.
stylePoints Object.<string, (string|boolean|number|array)>

Points styles.

getId(){string} inherited

layer/Base.js, line 199

Obtain layer id.

Returns:
Layer id.

getLayerOpacityFactor(){number}

layer/Marker.js, line 1115
Returns:
Layer opacity factor

getMinTimeToDrag(){number}

layer/Marker.js, line 1140
Returns:
Return min time to start dragging in milliseconds

getOverlappedMarkers(currentExtentView, tolerance){Array.<Array.<module:cercaliagl/layer/Marker~Marker>>}

layer/Marker.js, line 1025

Get Overlapped markers

Name Type Description
currentExtentView boolean | undefined

If true returns only visible markers at the moment, if not null or false it returns all markers
tolerance number (defaults to 5)

Tolerance in meters.
Returns:
Array of group (array) of features.

separateOverlapMarkers(separation)

layer/Marker.js, line 1078

Overlap markers if some markers coincides in the same exact coordinate. This function must be called after add or remove markers.

Name Type Description
separation number (defaults to 3)

Separation from anchor. Default 3.

setLayerOpacityFactor(factor)

layer/Marker.js, line 1123
Name Type Description
factor number

Layer opacity factor

setMinTimeToDrag(minTimeToDrag)

layer/Marker.js, line 1148
Name Type Description
minTimeToDrag number

Min time to start dragging in milliseconds

toggleLayers(visible)

layer/Marker.js, line 962
Name Type Description
visible boolean

Visible