_leaflet_.trackdrawer.md

Leaflet.TrackDrawer

Globals / "leaflet" / TrackDrawer

Namespace: TrackDrawer

TrackDrawer

Usage sample:

var track = L.TrackDrawer.track({
routingCallback: function(markerStart, markerEnd, done) {
// Do stuff
var latlngs = [markerStart.getLatLng(), markerEnd.getLatLng()];
done(null, latlngs, {my: 'metadata'});
},
}).addTo(map);

// With Leaflet Routing Machine
var track = L.TrackDrawer.track({
router: L.Routing.osrmv1(),
}).addTo(map);

Index

Namespaces

• colors

Enumerations

• NodeType

Classes

• Edge
• LayerContainer
• Node
• ToolBar
• TraceModeBar
• Track

Interfaces

• EdgeOptions
• EdgesList
• NodeOptions
• NodesList
• RouteInfo
• ToolBarMode
• ToolBarOptions
• TraceMode
• TraceModeBarOptions
• TrackOptions

Type aliases

• LayerId
• NodeCreationCallback
• RoutingCallback
• State
• TrackLayer

Functions

• edge
• node
• toolBar
• traceModeBar
• track

Type aliases

LayerId

Ƭ LayerId: Number

Leaflet's internal layer ID

---

NodeCreationCallback

Ƭ NodeCreationCallback: (latlng: LatLngExpression) => Node

Function that can be implemented to create a custom node.

Color of the node will be (re)set by this plugin.

Example:

function(latlng) {
var marker = L.TrackDrawer.node(latlng, { metadata: { hello: 'world' } });
ctrl._bindMarkerEvents(marker);
return marker;
}

---

RoutingCallback

Ƭ RoutingCallback: (previousMarker: Node, marker: Node, done: (err: null | Routing.IError, result: LatLng[], metadata?: Object) => void) => void

Function to implement to compute the route between two markers. Once computation is done, must call done(null, <result>, <object>) if successful, or done(<error>) if failure.

Example:

function(previousMarker, marker, done) {
done(null, [previousMarker.getLatLng(), marker.getLatLng()], {hello: 'world'});
}

---

State

Ƭ State: object

---

TrackLayer

Ƭ TrackLayer: Node | Edge

Layers handled by this plugin

Functions

edge

▸ edge(latlngs: LatLngExpression[], options?: PolylineOptions): Edge

Parameters:

Name	Type
latlngs	LatLngExpression[]
options?	PolylineOptions

Returns: Edge

---

node

▸ node(latlng: LatLngExpression, options?: NodeOptions): Node

Parameters:

Name	Type
latlng	LatLngExpression
options?	NodeOptions

Returns: Node

---

toolBar

▸ toolBar(track: Track, options?: ToolBarOptions): ToolBar

Parameters:

Name	Type
track	Track
options?	ToolBarOptions

Returns: ToolBar

---

traceModeBar

▸ traceModeBar(track: Track, modes: TraceMode[], options?: TraceModeBarOptions): TraceModeBar

Parameters:

Name	Type
track	Track
modes	TraceMode[]
options?	TraceModeBarOptions

Returns: TraceModeBar

---

track

▸ track(options?: TrackOptions): Track

Parameters:

Name	Type
options?	TrackOptions

Returns: Track