Class: LimbMarkerFactory

lucid.maps.limbs. LimbMarkerFactory

Manages {lucid.maps.limbs.Limb}s for a set of markers.This class will create the google.maps.Marker instance on the map as well as the associated LIMB.An info-box can optionally be associated with the factory, which displays information about the marker.

new LimbMarkerFactory(options)

Parameters:
Name Type Description
options lucid.maps.limbs.LimbMarkerFactoryOptions The factory options.
Source:

Methods

add(position, title) → {lucid.maps.limbs.Limb}

Add a new marker and a LIMB to the map.The map instance and label styling are set in the options passed into the manager's constructor.
Parameters:
Name Type Description
position google.maps.LatLng The location to be marked.
title string The name/title of the location. Used as the title of the marker created on the map.
Source:
Returns:
The limb that has been created.
Type
lucid.maps.limbs.Limb

addCustomised(customisedMarkerOptions, customisedLimbOptions) → {lucid.maps.limbs.Limb}

Add a new marker and a LIMB to the map.NB: The map and label styling are set in the options passed into the manager's constructor.
Parameters:
Name Type Description
customisedMarkerOptions google.maps.MarkerOptions Selected settings of the marker to be overriden from the options passed into the constructor.
customisedLimbOptions lucid.maps.limbs.LimbOptions Selected settings of the LIMB to be overriden from the options passed into the constructor.
Source:
Returns:
The limb that has been created.
Type
lucid.maps.limbs.Limb

destroy()

Destroy this instance and any associated resources.This method should be called when the instance is no longer required.
Source:

getNumberOfMarkers() → {number}

Source:
Returns:
The total number of places being labelled (includes any labels currently being hidden).
Type
number

hide()

Temporarily hide the labels.This does not remove the LIMBs and markers, it just takes them off display.Call this if you hide the map element.
Source:

removeAll()

Remove all markers and LIMBs created by this manager.
Source:

show()

Re-display the labels after being hidden with a call to 'hide'.
Source:

zoomToAll(zoomOptions)

Zoom and pan the map so that all markers are in view.You can optionally specify additional locations to be included in the map view by setting LatLng in the options parameter.
Parameters:
Name Type Description
zoomOptions object
Properties
Name Type Argument Description
additionalLocations google.maps.LatLng[] <optional>
Locations, in addition to the markers, which should be kept in view when the map view is changed.
Source: