Route Map
Who it’s for
Anyone reviewing where something went, without needing to replay it — a completed delivery route on a report, yesterday’s service round, an asset’s movement shown alongside other widgets. The path is the answer, and a playback control would only be in the way.
What it does
The Route Map draws an entity’s path over the dashboard’s time window as a static line, colored by a key along its length. The default configuration colors the route by Speed, so a slow section and a fast one are different colors on the same line, with a marker image at the end position.
- The whole journey at once — a static picture that can be read, screenshotted and put in a report.
- The path color follows a key by default, which draws a second dimension into the route without a chart beside it.
- A marker at the position, rotated to its heading, shows where the entity ended up.
- Direction decorators can be repeated along the line, so the direction of travel is readable from the path alone.
- Individual reported points can be shown with tooltips, for reading actual positions rather than the interpolated line.
- The same layer types as the other maps — polygons, circles and additional markers — so a route can be drawn against its zones.
- The Route Map has no playback: reviewing a journey moment by moment belongs on the Trip Map, which is the same widget with the timeline control turned on.
How to set up
Data keys
The Route Map takes a position series per entity from the keys named in the route layer.
| Key | Role | Type | Description |
|---|---|---|---|
latitude | The route’s north-south coordinate over time | Timeseries | Timeseries only — the widget plots history. The key name is configured on the layer. |
longitude | The route’s east-west coordinate over time | Timeseries | As above. |
Speed | Colors the path along its length | Timeseries | Any additional key can be used; the default configuration colors by speed through a color function. |
The route covers the dashboard’s time window, so set the window to the journey being reviewed. A rolling window produces a route that begins and ends nowhere in particular.
Route
| Setting | Default | Effect |
|---|---|---|
| Path stroke color | A function over Speed | A constant color, or a function coloring the line by a key |
| Path stroke weight | 4 | Line thickness |
| Show points | Off | Draws the individual reported positions |
| Rotate marker | On | Turns the end marker to face its direction of travel |
| Marker type | image | An image marker rather than a shape |
| Show timeline control | Off | Left off; turning it on makes this behave as the Trip Map |
How to customize
- To color by something else — edit the path stroke color function to read whichever additional key matters, such as load, temperature or signal.
- To use a flat line — set the path stroke color to a constant where the route alone is the point.
- To show direction — turn on the path decorator and set its symbol and repeat spacing.
- To show the reported positions — turn on Show points with their size, color and tooltip.
- To change the vehicle marker — set the marker image, keeping Rotate marker on so it faces the right way.
- To draw the route against its zones — add a Polygons layer for the areas it should or should not enter.
- To frame the whole route — leave Fit map bounds on.
Tips
- Color the route by the key that explains the journey rather than by speed out of habit. On a cold-chain run the interesting line is colored by temperature, and the route then answers the question the reader actually had.
- Choose the Route Map for reports and dashboards, and the Trip Map for investigations. A static route is readable in a screenshot and beside other widgets; a playback control on a dashboard nobody is actively driving is a control that never gets used.
Share Your Widget with the Community
Built a custom widget? Export it as a JSON from ThingsBoard and publish it to the IoT Hub through a simple 4-step wizard (Upload, Listing, Readme, Review & Submit). Share it with thousands of ThingsBoard developers worldwide and get featured in the catalog.