Class: Limb

lucid.maps.limbs. Limb

Displays a label on the border of a Google Map.If multiple labels are to be displayed you are recommended to use a LimbFactory.

new Limb(optionsOrMarker)

Parameters:
Name Type Description
optionsOrMarker lucid.maps.limbs.LimbOptions | google.maps.Marker Settings for the LIMB to be rendered or the Marker to be tracked.
Source:

Methods

destroy()

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

getMap() → {google.maps.Map}

Source:
Returns:
The map this LIMB is associated with.
Type
google.maps.Map

getTarget() → {google.maps.Marker|google.maps.Polyline|google.maps.Polygon|google.maps.Rectangle|google.maps.Circle}

Source:
Returns:
The target this LIMB is associated with.
Type
google.maps.Marker | google.maps.Polyline | google.maps.Polygon | google.maps.Rectangle | google.maps.Circle

hide()

Temporarily hide the label.This does not remove the LIMB, it just takes it off display.Call this if you hide the map element.
Source:

refresh()

Refresh the display of the LIMB on the page.
Source:

setSyncClickWithTarget(synchonised)

Set whether the click event on the LIMB should cause an effective click on the associated target.
Parameters:
Name Type Description
synchonised boolean Whether the click events should be synchonised.
Source:

show()

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

Events

click

Indicates when the LIMB is clicked.
Type:
  • object
Source: