Widget configuration

Each widget is configured through a wizard dialog, in the order type, then resource, then configuration (the resource step is skipped for dataSource: 'none' widgets):

• Type: one of the registered widget types.
• Resource: the resource to query, filtered to those supporting the type's data source.
• Configuration: depends on the widget type:
  • Table: label (link text), visible columns, sort field and direction, filters, rows per page, color.
  • Simple aggregate: function (count / min / max), field (for min / max), label, filters, color.
  • Aggregate: function (count / sum / avg / min / max), field (for everything except count), label, filters, color.
  • Bar / Line / Pie: aggregate function and field, one or two group-by dimensions (the first is required for charts), chart options, label, filters, color.
    • Bar chartOptions.orientation: vertical (default) or horizontal.
    • Pie chartOptions.variant: pie (default) or doughnut.
    • Line: the primary group-by dimension is usually a date with a trunc bucket (granularity such as day / month / year) that forms the time axis.

Persistence

The layout and every widget's configuration live under the preferences.dashboard store key, which React Admin's store scopes per user — one dashboard per person, not per browser profile.

When a service in the serviceConfigMap sets syncPreferences: true, that key is on the synced whitelist, so a dashboard built on one machine appears on the next. Without it the layout stays in localStorage.

See also

• SchemaDashboard — the dashboard these widgets sit on
• Data sources — which resources each type can use
• Backend-synced preferences — how the layout travels between devices