Namespace: limbs

lucid.maps. limbs

Source:

Classes

DirectionsController
Limb
LimbFactory
LimbMarkerFactory
LimbMarkerPlacesFactory

Namespaces

layout
location
tooltip

Members

<static> DirectionsControllerOptions :object

Properties:
Name Type Description
map google.maps.Map The map that will show the travel points and directions.
Source:

<static> LimbMarkerFactoryOptions :object

Properties:
Name Type Argument Description
map google.maps.Map The map the markers and LIMBs are to be associated with.
markerOptions google.maps.MarkerOptions The settings for the marker shown on the map for these labels. The LimbMarkerFactory will ignore the position property. This will be set when the places are added with a call to addPlaces.
limbOptions lucid.maps.limbs.LimbOptions <optional>
 The settings for the LIMB shown on the map for these labels. The LimbMarkerFactory will ignore the marker property. This will be set to the place's marker. The LimbMarkerFactory will ignore the independent property. This will always be false. If undefined the LIMB will take its styling from the marker.
infoBox lucid.maps.limbs.InfoBox <optional>
 The class that displays an info box when the user clicks on the label. Leave undefined if no info box should appear.
Source:

<static> LimbMarkerPlacesFactoryOptions :object

Properties:
Name Type Argument Description
zoomLevelWhenSelected number <optional>
 The zoom level to be used when a marker is clicked. Set this to null if you do not want the zoom to change. Defaults to 16 if not defined.
Source:

<static> LimbOptions :object

Properties:
Name Type Argument Description
hidden boolean <optional>
 Whether the LIMB is initially hidden. If so, it can be made visible with a call to show(). If not defined, the LIMB is shown by default.
independent boolean <optional>
 Whether this LIMB is independent of a lucid.maps.limbs.LimbFactory. It is more efficient for a group of LIMBs to be managed by a manager, but if a single LIMB is being displayed then the Limb will manage itself if you set this property to true. The default is true.
target google.maps.Marker | google.maps.Polyline | google.maps.Polygon | google.maps.Rectangle | google.maps.Circle The target on the map which is to be displayed in the map border when the target is outside the map's viewport.
title string <optional>
 Title describing the target location. If not defined and the target is a Marker, then the LIMB will use the title of the Marker. This property must be defined if the target is not a Marker.
icon google.maps.Icon <optional>
 Icon specification which must contain the URL and size of the icon image to display. If not defined and the target is a Marker, then the LIMB will use the icon of the Marker. This property must be defined if the target is not a Marker.
clickable boolean <optional>
 Whether the icon in the map border is clickable. If not defined, the clickable setting is taken from the target. NOTE: While it is possible to change the clickable setting of google.maps.Marker objects, all other targets default to being clickable.
syncClick boolean <optional>
 Whether to synchronise the click on the LIMB with the same action performed when clicking on the target itself. The effect is to trigger a click event on the target when the LIMB is clicked. NOTE: This will not bring the target into view. You will need to assign another click handler to pan the map. If left undefined, this property defaults to false.
layout lucid.maps.limbs.layout.LayoutStrategy <optional>
 A strategy for positioning the LIMB. If not defined, a DefaultLayoutStrategy will be used.
location lucid.maps.limbs.location.LocationStrategy <optional>
 A strategy for computing the location of the target. If not defined, a BoundsEdgeLocationStrategy will be used.
tooltipFactory function <optional>
 A strategy for generating the tooltip shown when the user mouses-over the LIMB. If not defined, the lucid.maps.limbs.tooltip.standardTooltip tooltip factory will be used. NOTE: A tooltip is only shown if the LIMB is clickable.
Source:

<static> TransportLinkOptions :object

Properties:
Name Type Argument Description
markerOptions google.maps.MarkerOptions <optional>
 Settings for the travel-point marker.
limbOptions lucid.maps.limbs.LimbOptions <optional>
 Settings for the travel-point LIMB.
directionOptions google.maps.DirectionsRequest <optional>
 Settings for the directions/route from this travel-point to the destination.
Source:

Methods

<static> applyDirectionsOptions(options, optionsToApply)

Copy google.maps.DirectionsRequest from one instance to another.Only the settings defined in the 'optionsToApply' object will be copied onto the 'options' object.
Parameters:
Name Type Description
options google.maps.DirectionsRequest The target instance.
optionsToApply google.maps.DirectionsRequest Options that take precedence and should be copied into the target object.
Source:

<static> applyLimbOptions(options, optionsToApply)

Copy lucid.maps.limbs.LimbOptions from one instance to another.Only the settings defined in the 'optionsToApply' object will be copied onto the 'options' object.
Parameters:
Name Type Description
options lucid.maps.limbs.LimbOptions The target instance.
optionsToApply lucid.maps.limbs.LimbOptions Options that take precedence and should be copied into the target object.
Source:

<static> applyMarkerOptions(options, optionsToApply)

Copy google.maps.MarkerOptions from one instance to another.Only the settings defined in the 'optionsToApply' object will be copied onto the 'options' object.
Parameters:
Name Type Description
options google.maps.MarkerOptions The target instance.
optionsToApply google.maps.MarkerOptions Options that take precedence and should be copied into the target object.
Source: