Class: Marker

Members

onClick{function}

onDoubleClick{function}

onMouseOut{function}

onMouseOver Function, if specified

onMouseOver{function}

onRightClick{function}

Methods

addExtraIcon(icon)

cercalia.marker.js, line 809

Add extra icon with a plus zIndex. You can add multiple icons to a marker.

Name	Type	Description
icon	cercalia.Icon	Icon

addPopup(popup)

cercalia.marker.js, line 593

Name	Type	Description
popup	cercalia.Popup

destroy()

cercalia.marker.js, line 687

Destroy popup

getClass(){string}

cercalia.marker.js, line 792

Returns:

ClassName: cercalia.Marker

getExtraIcons(){Array.<cercalia.Icon>}

cercalia.marker.js, line 842

Returns:

Return extra icons

getFeature(){ol.Feature}

cercalia.marker.js, line 253

Returns:

Object ol.Feature

getIcon(){cercalia.Icon}

cercalia.marker.js, line 565

Returns:

Icon.

getId(){string}

cercalia.marker.js, line 261

Returns:

Marker ID. If specified, if not returns null.

getLabel(){cercalia.Label}

cercalia.marker.js, line 764

Returns:

label Label assigned to th marker.

getMap(){cercalia.Map}

cercalia.marker.js, line 617

Returns:

The map where it's painted, if not returns null.

getPopup(){cercalia.Popup}

cercalia.marker.js, line 624

Returns:

Popup, if don't have returns null.

getPosition(){cercalia.LonLat}

cercalia.marker.js, line 278

Returns:

position The marker Array position [lat, lon].

getSimpleLabel(){cercalia.SimpleLabel}

cercalia.marker.js, line 585

Returns:

Returns cercalia.SimpleLabel if created. If not, returns null.

getZIndex(){number}

cercalia.marker.js, line 434

Returns:

CSS marker zIndex

hasExtraIcons(){boolean}

cercalia.marker.js, line 835

Returns:

true if extra icons.

hideLabel()

cercalia.marker.js, line 755

Hide marker label

isDraggable(){boolean}

cercalia.marker.js, line 513

Returns:

Boolean showing if marker it's draggable.

isDragging()

cercalia.marker.js, line 783

Returns:

true if marker is dragging, otherwise false.

isVisible(){boolean}

cercalia.marker.js, line 800

Returns:

true if visible, else false.

movePosition(position, duration, callbackFn, centerMapDuringMovement, numSteps)

cercalia.marker.js, line 350

Move the parker position with an animation movement from a starting to ending position, in a specified time (duration). Optionally it's possible to call a function specified via parameter.

Name	Type	Description
position	cercalia.LonLat	Coordinate.
duration	number | undefined	optional Movement duration, in milliseconds (default value 2000ms)
callbackFn	function | undefined	optional Callback function, when movement ends
centerMapDuringMovement	boolean | undefined	optional Center map during movement. Default false.
numSteps	number | undefined	optional Number of steps to animate. Default 100.

onDragEnd()

cercalia.marker.js, line 153

onDragMove()

cercalia.marker.js, line 141

onDragStart()

cercalia.marker.js, line 127

redraw()

cercalia.marker.js, line 849

Force to draw feature.

refreshPositionFromGeometry()

cercalia.marker.js, line 287

Updates the marker position through its geometry. This function is usefull on marker dragging, where its position (obtained through its geometry) has been updated, but not its popup or label.

removeLabel()

cercalia.marker.js, line 772

Destroy the label object

setDraggable(draggable)

cercalia.marker.js, line 441

Name	Type	Description
draggable	boolean

setIcon(icon)

cercalia.marker.js, line 555

Change the marker icon

Name	Type	Description
icon	cercalia.Icon

setId(id)

cercalia.marker.js, line 269

Assign ID to marker

Name	Type	Description
id	string

setLabel(label)

cercalia.marker.js, line 726

Assign/change marker label text

Name	Type	Description
label	cercalia.Label	Label content

setMap(map)

cercalia.marker.js, line 632

Name	Type	Description
map	cercalia.Map

setPosition(position)

cercalia.marker.js, line 309

Move the marker position to the specified via parameter

Name	Type	Description
position	cercalia.LonLat

setSimpleLabel(simpleLabel)

cercalia.marker.js, line 574

SimpleLabel to add/modify related with the marker

Name	Type	Description
simpleLabel	cercalia.SimpleLabel

setVisible(visible)

cercalia.marker.js, line 522

Show or hide the marker, including its SimpleLabel, Label or Popup.

Name	Type	Description
visible	boolean

setZIndex(zIndex)

cercalia.marker.js, line 425

Change the zIndex value

Name	Type	Description
zIndex	number

showLabel()

cercalia.marker.js, line 746

Show marker label