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 74

Name Type Description

options

Options

Name	Type	Description
`id`	string	Id
`icon`	module:cercaliagl/Icon~Icon	Icon
`position`	maplibregl.LngLat	Position
`encodedGooglePosition`	string	Position encoded on google polyline format.
`draggable`	boolean	Draggable. Default `false`.
`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.
`onDragStart`	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 {}.

Extends

module:cercaliagl/BaseFeature~BaseFeature

Methods

addPopup(popup) Marker.js, line 388

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

closePopup() Marker.js, line 419

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 646

Get extra properties

Returns:

Extra properties

getGeoJSON(){GeoJSON} inherited BaseFeature.js, line 184

Returns:

GeoJSON

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

Returns:

GeoJSON

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

Get marker icon

Returns:

Icon

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

Returns:

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

Get label

Returns:

label Label assigned to th marker.

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

Returns:

Layer

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

Returns:

Map

getPopup(){maplibregl.Popup} Marker.js, line 310

Returns:

Popup

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

Returns:

visible Visible

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

Get zIndex

Returns:

zIndex zIndex

hideLabel() Marker.js, line 457

Hide marker label

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

Returns:

draggable Draggable

openPopup() Marker.js, line 409

Open popup

removeLabel() Marker.js, line 476

Remove label

set(key, value, silent) inherited BaseObject.js, line 45

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean	Update without triggering an event.

setDraggable(draggable) Marker.js, line 511

Set marker as draggable

Name	Type	Description
`draggable`	boolean	Draggable

setExtraProperties(properties) Marker.js, line 655

Set extra properties

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

setIcon(icon) Marker.js, line 293

Set marker icon.

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

setLabel(label) Marker.js, line 431

Assign/change marker label text

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

setMap(map) inherited Marker.js, line 358

Name	Type	Description
`map`	module:cercaliagl/Map~Map	Map

setOnDragEnd(onDragEnd) Marker.js, line 547

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 556

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 529

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 538

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 318

Name	Type	Description
`popup`	maplibregl.Popup	Popup

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

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 573

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 335

Hide or show marker.

Name	Type	Description
`visible`	boolean	Visible

setZIndex(zIndex) Marker.js, line 599

Set zIndex and update it.

Name	Type	Description
`zIndex`	number	zIndex

showLabel() Marker.js, line 447

Show marker label