Widget Creation — Overview
In Cartography, KPI widgets are created via a multi-step wizard. The wizard's steps are enforced by the CartographyInsertGuard route middleware; depending on the chart group and chart type you choose, different sub-flows run.
Each sub-flow has its own numbered step page set. Go to a sub-flow's index.md to see the step sequence for that flow.
Prerequisite
For all widgets except Static Text, at least one saved record must exist in the Compass module. If there is no Compass record: → Compass
1. Sub-Flow Selection Table
For each chart type, follow the link to the sub-flow and its numbered step pages.
| Chart Type (Group) | Sub-Flow | Active Steps | Sub-Flow Page |
|---|---|---|---|
| Line / Area / Spline / Column / Bar / Step Line (Cartesian) | Standart | 1-9 (all) | Standart Cartesian |
| Stacked* (8 charts) (Cartesian) | Stacked | 1-5, 7-9 (06 skipped) | Stacked Cartesian |
| Range Column (Cartesian) | Range Column | 1-4, 7-9 (05, 06 skipped) | Range Column |
| Waterfall (Cartesian) | Waterfall | 1-5, 7-9 (06 skipped) | Waterfall |
| Pie / Doughnut / Radial Bar (Circular) | Circular | 1-5, 7-9 (06 skipped) | Circular Steps |
| Radial Gauge (Gauge) | Radial Gauge | 1-4, 8-9 (05, 06, 07 skipped) | Radial Gauge |
| Linear Gauge (Gauge) | Linear Gauge | 1-4, 8-9 (05, 06, 07 skipped) | Linear Gauge |
| Static Text (Text) | Static Text | 1-2, 7-9 (03, 04, 05, 06 skipped) | Static Text |
| Dynamic Text (Text) | Dynamic Text | 1-4, 7-9 (05, 06 skipped) | Dynamic Text |
| Table (DataGrid) | DataGrid | 1-3, 7-9 (04, 05, 06 skipped) | DataGrid Steps |
| Two-Column List (Other) | Other | 1-4, 7-9 (05, 06 skipped) | Two-Column List Steps |
Funnel & Pyramid
Funnel and Pyramid groups appear in the UI but are not yet active. If selected, a "This chart type is not available yet" warning appears.
2. Sub-Flow vs Individual Chart Pages
You can access information from two places:
| Goal | Page Type | What You Find |
|---|---|---|
| I am creating a new widget | Sub-flow's index.md and numbered step pages |
End-to-end walkthrough of the 1-9 wizard steps |
| I am looking for a specific chart's detail | Individual chart page (e.g., Line, Pie) | Use cases, data structure, chart-specific settings + chart-specific 9-step summary |
Individual chart pages contain a chart-specific 9-step summary table linking to the relevant sub-flow step pages.
3. Wizard Behavior
- Step skipping: If you try to navigate to a later route without completing a step, the wizard redirects you to the nearest missing step.
- Back button: Located in the top-left of each step; returns to the previous step. Going back does not erase the fields you filled in.
- Reset: If you exit the wizard and re-enter,
CartographyInsertFlowStateis reset and you start over. - Saving: The widget is only persisted by the Save button in Step 9 Display Information. Until then no step auto-saves.
Speeding Up the Wizard
Using meaningful tags and descriptive record names in Compass lets you find the right record much faster in step 3. Also, if you need to produce different charts from the same record, after finishing the first widget it is faster to use Edit to clone the same template and make small changes.
4. Next Step
Decide which chart you want to build, then start from the corresponding sub-flow's Step 1. If you cannot decide, look at the "Supported Chart Groups" table on the Cartography Overview page first.