Class: MultiMarker

bemap.MultiMarker(coordinates, options)

Base class for multimarker.

Constructor

new MultiMarker(coordinates, options)

Parameters:
Name Type Description
coordinates bemap.Coordinate Array of bemap.Coordinate.
options Object See below the available values.
Properties
Name Type Description
icon bemap.Icon Style of marker used by the renderer.
name String Name of multimarker.
properties Object custom object.
Source:

Members

(protected) callback :function

Type:
  • function
Source:

(protected) coords

Source:

(protected) events :Array

Type:
  • Array
Source:

(protected) icon :bemap.Icon

Type:
Source:

(protected) id :String

Type:
  • String
Source:

(protected) layer :Object

Type:
  • Object
Source:

(protected) map :Object

Type:
  • Object
Source:

(protected) name :String

Type:
  • String
Source:

(protected) native :Object

Type:
  • Object
Source:

(protected) properties :Object

Type:
  • Object
Source:

(protected) textStyle :String

Type:
  • String
Source:

Methods

addCoordinate(coordinate)

Add a coordinate.
Parameters:
Name Type Description
coordinate bemap.Coordinate bemap.Coordinate.
Source:

addLonLat(lon, lat)

Add a coordinate.
Parameters:
Name Type Description
lon double Longitude in degres deciaml (WGS84).
lat double Latitude in degres deciaml (WGS84).
Source:

getCoordinate(index) → {bemap.Coordinate}

Return the coordinate. See bemap.Coordinate.
Parameters:
Name Type Description
index int Index of coordinate in multimarker.
Source:
Returns:
Return the coordinate. See bemap.Coordinate.
Type
bemap.Coordinate

getCoordinates() → {bemap.Coordinate}

Return the coordinates. See bemap.Coordinate.
Source:
Returns:
Return the coordinates. See bemap.Coordinate.
Type
bemap.Coordinate

getIcon() → {bemap.Icon}

Return the bemap.Icon that define the style of the multimarker.
Source:
Returns:
Return the bemap.Icon that define the style of the multimarker.
Type
bemap.Icon

getId() → {String}

Return the id of the multimarker.
Source:
Returns:
Return the id of the multimarker.
Type
String

getLatLonArray(index) → {array}

Return an array with latitude and longitude in degres decimal (WGS94).
Parameters:
Name Type Description
index int Index of coordinate in polyline.
Source:
Returns:
Return an array with latitude and longitude in degres decimal (WGS94).
Type
array

getLonLatArray(index) → {array}

Return an array with longitude and latitude in degres decimal (WGS94).
Parameters:
Name Type Description
index int Index of the coordinates in multimarker.
Source:
Returns:
Return an array with longitude and latitude in degres decimal (WGS94).
Type
array

getLonLatArrays() → {array}

Return an array with longitude and latitude in degres decimal (WGS94). Example: [ [lon, lat], [lon, lat], ... ]
Source:
Returns:
Return an array with longitude and latitude in degres decimal (WGS94).
Type
array

getName() → {String}

Return the name of the multimarker.
Source:
Returns:
Return the name of the multimarker.
Type
String

remove()

Remove the MultiMarker from the layer.
Source:

setCoordinate(index, coords) → {bemap.MultiMarker}

Define the coordinate.
Parameters:
Name Type Description
index int index of coordinates in multimarker.
coords bemap.Coordinate new coordinates to set.
Source:
Returns:
Return this.
Type
bemap.MultiMarker

setCoordinates(coords) → {bemap.MultiMarker}

Define the coordinates.
Parameters:
Name Type Description
coords bemap.Coordinate new coordinates to set.
Source:
Returns:
Return this.
Type
bemap.MultiMarker

setIcon(icon) → {bemap.MultiMarker}

Set the icon style of the multimarker.
Parameters:
Name Type Description
icon bemap.Icon the new icon style to set.
Source:
Returns:
Return this.
Type
bemap.MultiMarker

setId(id) → {bemap.MultiMarker}

Define the id of multimarker
Parameters:
Name Type Description
id String the new id to set.
Source:
Returns:
this
Type
bemap.MultiMarker

setName(name) → {bemap.MultiMarker}

Define the name of multimarker.
Parameters:
Name Type Description
name String the new name to set.
Source:
Returns:
Return this.
Type
bemap.MultiMarker