Skip to content

Commit b003d07

Browse files
committed
Update some docs pre-RVR
1 parent f3a06c3 commit b003d07

3 files changed

Lines changed: 43 additions & 8 deletions

File tree

docs/guide-dashboards.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,17 @@ A dashboard config requires a top-level `header` containing _tab_ and _title_ an
2424
header:
2525
tab: 'Summary'
2626
title: 'Top-Level Summary Statistics'
27-
description: 'At-a-glance figures we usually look at' #optional
28-
triggerPattern: "*.drt.csv" #optional
27+
description: 'At-a-glance figures we usually look at' # optional
28+
fullscreen: true # optional
29+
triggerPattern: "*.drt.csv" # optional
2930
```
3031
3132
|**Field**|**Description**|**Default**|
3233
|---------|---------------|-----------|
3334
|title|Header title displayed at top of dashboard|--|
3435
|tab|Name shown on the tab|Same as title|
3536
|description|Longer text shown below dashboard title|--|
37+
|fullscreen|Fill the height of the window instead of assigning specific heights to each row|false|
3638
|triggerPattern|If specified, the dashboard defined in this YAML will only be generated when a filename matching the given triggerPattern exists in the current folder. For example, if it is set to `triggerPattern: "*.drt.csv"` and the file `output_mode.drt.csv` exists in the current folder, then this dashboard will be created. If no file matches the given pattern, then this dashboard will be skipped. If triggerPattern is not specified, then the dashboard will always be generated.|--|
3739

3840
## Dashboard Layout

docs/matsim-transit-supply.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,20 @@ This viz shows transit route details.
1212

1313
No YAML is required. If the run folder contains a `*output_transitSchedule.xml.gz` file, then this view will be available and the transit route supply can be explored.
1414

15-
If the run folder also contains `*pt_stop2stop_departures.csv.gz` then the transit ridership (demand) will also be loaded. This may take a few seconds.
15+
**Stop-to-stop ridership:** If the run folder also contains `*pt_stop2stop_departures.csv.gz` then the transit ridership (demand) will also be loaded. This may take a few seconds.
16+
17+
## Dashboard
18+
19+
The following configuration options are available when embedding the transit viewer in a dashboard. Use `type: transit` for this plugin.
20+
```yaml
21+
layout:
22+
row1:
23+
- type: transit
24+
title: Transit Explorer
25+
network: "*output_network.xml.gz"
26+
transitSchedule: "*output_transitSchedule.xml.gz"
27+
projection: EPSG:25832 # Use your EPSG coordinate system here
28+
```
1629
1730
### Exploring transit
1831

docs/ref-xy-hexagons.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,35 @@ In addition, the presence of the MATSim regular output file `output-trips.xml.gz
1717

1818
## Dashboards
1919

20-
XY Hexagon plots can be embedded in dashboards using `type: hexagons` and specifying the config details in the props as follows:
20+
XY Hexagon plots can be embedded in dashboards using `type: hexagons` and specifying the config details in the YAML as follows:
2121

2222
```yaml
23-
row:
24-
- title: My Hexagon Plot
25-
type: hexagons
26-
# ...
23+
layout:
24+
row1:
25+
- title: My Hexagon Plot
26+
type: hexagons
27+
# ...etc
2728
```
2829

30+
To load the standard MATSim `output_trips` origins/destinations plot, the following code should do the trick:
31+
32+
```yaml
33+
layout:
34+
row1:
35+
- type: hexagons
36+
file: "*output_trips.csv.gz"
37+
title: Output Trips
38+
projection: EPSG:25832 # Set your coordinate projection here
39+
aggregations:
40+
Trips:
41+
- title: Origins
42+
x: start_x
43+
y: start_y
44+
- title: Destinations
45+
x: end_x
46+
y: end_y
47+
48+
```
2949

3050
## YAML fields explained
3151

0 commit comments

Comments
 (0)