Cercalia API GL

Class: Marker

cercaliagl.Marker

Javascript ES5

const map = new cercaliagl.Marker({ ... });

Create a marker component. Marker will draw a feature on map with an icon Icon. Marker optionally can have a Label, SimpleLabel and Popup
There are many events which marker can handle.
These events can defined in constructor or in runtime modifing attribute as onClick, onMouseOver, etc.

Example usage:

const map = new cercaliagl.Map({
  target: 'map'
});

const marker = new cercaliagl.Marker({
  position: new cercaliagl.LonLat(1.241, 41.431),
  label: new cercaliagl.Label({text: 'Label text'}),
  simpleLabel: new cercaliagl.SimpleLabel({text: 'Simple label text'}),
  popup: new cercaliagl.Popup({
    title: 'Title popup',
    content: '<b>Content</b> popup',
  }),
  draggable: true,
  onClick: () => map.setCenter(marker.getPosition()),
});
map.addMarker(marker);

new Marker(options) Marker.js, line 78

Name Type Description

options

Options

Name	Type	Description
`id`	string	Id
`icon`	module:cercaliagl/Icon~Icon	Icon
`position`	module:cercaliagl/LonLat~LonLat	Position
`encodedGooglePosition`	string	Position encoded on google polyline format.
`draggable`	boolean	Draggable. Default `false`.
`popup`	module:cercaliagl/Popup~Popup \| null	marker popup.
`onClick`	function	Function to execute on marker click.
`onDoubleClick`	function	Function to execute on marker double click.
`onMouseOut`	function	Function to execute on Mouse Out.
`onMouseOver`	function	Function to execute on Mouse Over.
`onRightClick`	function	Function to execute on marker right click.
`onDragEnd`	function	Function to execute when ends marker dragging.
`onDragMove`	function	Function to execute during marker dragging.
`onDragStart`	function	Function to execute on marker dragging start.
`onVisibilityChange`	function	Function to be executed when marker visibility changes.
`onDrop`	function	Function to obtain markers on dragged marker extent when drag ends.
`simpleLabel`	module:cercaliagl/SimpleLabel~SimpleLabel	Marker Simple Label object.
`visible`	boolean	Marker visible or not. Default `true`.
`label`	module:cercaliagl/Label~Label	Label
`zIndex`	number	Z-Index. Default 0.
`extraProperties`	Object.<string, string>	Extra properties to put inside geojson. Default {}.
`encodedPrecision`	number	Precision of encoded data. Default 5.

Extends

module:cercaliagl/BaseFeature~BaseFeature

Methods

addPopup(popup) Marker.js, line 400

Name	Type	Description
`popup`	module:cercaliagl/Popup~Popup	PPopup

closePopup() Marker.js, line 431

Close popup

get(key){*} inherited BaseObject.js, line 30

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getExtraProperties(){Object.<string, string>} Marker.js, line 678

Get extra properties

Returns:

Extra properties

getGeoJSON(){module:cercaliagl/BaseFeature~CercaliaFeature} inherited BaseFeature.js, line 200

Returns:

GeoJSON

getGeometryType(){string} inherited BaseFeature.js, line 208

Returns:

GeoJSON

getIcon(){module:cercaliagl/Icon~Icon} Marker.js, line 296

Get marker icon

Returns:

Icon

getId(){String} inherited BaseFeature.js, line 177

Returns:

getLabel(){module:cercaliagl/Label~Label} Marker.js, line 480

Get label

Returns:

label Label assigned to th marker.

getLayer(){module:cercaliagl/layer/Feature~Feature} inherited BaseFeature.js, line 192

Returns:

Layer

getMap(){module:cercaliagl/Map~Map} inherited BaseFeature.js, line 216

Returns:

Map

getPopup(){module:cercaliagl/Popup~Popup} Marker.js, line 322

Returns:

Popup

getVisible(){boolean} Marker.js, line 338

Returns:

visible Visible

getZIndex(){number} Marker.js, line 607

Get zIndex

Returns:

zIndex zIndex

hideLabel() Marker.js, line 469

Hide marker label

isDraggable(){boolean} Marker.js, line 537

Returns:

draggable Draggable

openPopup() Marker.js, line 421

Open popup

removeLabel() Marker.js, line 488

Remove label

set(key, value) inherited BaseObject.js, line 44

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.

setDraggable(draggable) Marker.js, line 528

Set marker as draggable

Name	Type	Description
`draggable`	boolean	Draggable

setExtraProperties(properties) Marker.js, line 687

Set extra properties

Name	Type	Description
`properties`	Object.<string, string>	Extra properties

setIcon(icon) Marker.js, line 305

Set marker icon.

Name	Type	Description
`icon`	module:cercaliagl/Icon~Icon	Icon

setLabel(label) Marker.js, line 443

Assign/change marker label text

Name	Type	Description
`label`	module:cercaliagl/Label~Label	Label content

setOnDragEnd(onDragEnd) Marker.js, line 564

Sets the function to be called when the marker is dragged and released.

Name	Type	Description
`onDragEnd`	function	The function to be called when the marker is dragged and released.

setOnDragMove(onDragMove) Marker.js, line 573

Sets the function to be called when the marker is moved.

Name	Type	Description
`onDragMove`	function	The function to be called when the marker is moved

setOnDragStart(onDragStart) Marker.js, line 546

Sets the function to be called when the marker has started to be dragged.

Name	Type	Description
`onDragStart`	function	The function to be called when the marker has started to be dragged.

setOnVisibilityChange(onVisibilityChange) Marker.js, line 555

Sets the function to be called when the marker has changed his visibility.

Name	Type	Description
`onVisibilityChange`	function	The function to be called when the marker has changed his visibility.

setPopup(popup) Marker.js, line 330

Name	Type	Description
`popup`	module:cercaliagl/Popup~Popup	Popup

setPosition(position, avoidRefresh) Marker.js, line 503

Set position

Name	Type	Description
`position`	module:cercaliagl/LonLat~LonLat \| module:maplibre-gl~LngLat	Position
`avoidRefresh`	boolean (defaults to false)	Avoid refresh

setSimpleLabel(simpleLabel) Marker.js, line 590

Set simpel label. If null simple label will be removed

Name	Type	Description
`simpleLabel`	module:cercaliagl/SimpleLabel~SimpleLabel \| null	Simple Label

setVisible(visible) Marker.js, line 347

Hide or show marker.

Name	Type	Description
`visible`	boolean	Visible

setZIndex(zIndex) Marker.js, line 616

Set zIndex and update it.

Name	Type	Description
`zIndex`	number	zIndex

showLabel() Marker.js, line 459

Show marker label