diff --git a/Data-model.md b/Data-model.md index 6a90fa8..27ee8ec 100644 --- a/Data-model.md +++ b/Data-model.md @@ -262,7 +262,14 @@ Markers data is stored as an unordered array of objects (so element id is _not_ * `lock`: `boolean` - `true` if marker is locked (not affected by regeneration). Optional ## Routes -Routes data is not in data model, but can be retrieved directly from svg `routes` element and `pack.cells.roads` array. +Routes data is stored as an ordered array of objects (so element id is the array index). Object structure: +* `i`: `number` - route id. Please note the element with id `0` is a fully valid route, not a placeholder +* `points`: `number[]` - array of control points in format `[x, y, cellId]` +* `feature`: `number` - feature id of the route. Auto-generated routes cannot be place on multiple features +* `group`: `string` - route group. Default groups are: 'roads', 'trails', 'searoutes' +* `length`: `number` - route length in km. Optional +* `name`: `string` - route name. Optional +* `lock`: `boolean` - `true` if route is locked (not affected by regeneration). Optional # Secondary global data Secondary data exposed to global space.