Skip to content

Commit d89bb34

Browse files
committed
fix(routing): added docstring to units param
1 parent b2f1987 commit d89bb34

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

doc/plugins.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -776,6 +776,7 @@ Requites `routingServiceUrl` in `config.json` pointing to a Valhalla routing ser
776776
| enabledProviders | `[string]` | List of search providers to use for routing location search. | `["coordinates", "nominatim"]` |
777777
| geometry | `{`<br />`  initialWidth: number,`<br />`  initialHeight: number,`<br />`  initialX: number,`<br />`  initialY: number,`<br />`  initiallyDocked: bool,`<br />`  side: string,`<br />`}` | Default window geometry with size, position and docking status. Positive position values (including '0') are related to top (InitialY) and left (InitialX), negative values (including '-0') to bottom (InitialY) and right (InitialX). | `{`<br />`  initialWidth: 320,`<br />`  initialHeight: 640,`<br />`  initialX: 0,`<br />`  initialY: 0,`<br />`  initiallyDocked: true,`<br />`  side: 'left'`<br />`}` |
778778
| showPinLabels | `bool` | Whether to label the routing waypoint pins with the route point number. | `true` |
779+
| units | `object` | Set of units for isochrone time/distance intervals to use. | `{`<br />`  time: {`<br />`  min: 1,`<br />`  s: 60`<br />`  },`<br />`  distance: {`<br />`  km: 1,`<br />`  m: 1000`<br />`  }`<br />`}` |
779780
| zoomAuto | `bool` | Automatically zoom to the extent of the route | `true` |
780781

781782
ScratchDrawing<a name="scratchdrawing"></a>

plugins/Routing.jsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ class Routing extends React.Component {
6969
showPinLabels: PropTypes.bool,
7070
task: PropTypes.object,
7171
theme: PropTypes.object,
72+
/** Set of units for isochrone time/distance intervals to use. */
7273
units: PropTypes.object,
7374
/** Automatically zoom to the extent of the route */
7475
zoomAuto: PropTypes.bool,

0 commit comments

Comments
 (0)