Dashboard¶

A dashboard shows several visuals that users arrange themselves: they drag fields onto it to make visuals, move and resize them, filter them all at once, and click a chart to filter the others.

Show it¶

<DockPanel bi:VisualView.FilterContext="{Binding Filters}"> <!-- (1)! -->
    <bi:FilterBar DockPanel.Dock="Top" Context="{Binding Context}" />
    <bi:FieldList DockPanel.Dock="Left" Width="210" Context="{Binding Context}" />
    <bi:DashboardView Context="{Binding Context}" Document="{Binding Dashboard}" /> <!-- (2)! -->
</DockPanel>

1. Shared by the filter bar and every visual: global filters and cross-filtering.
2. Two-way: every change users make comes back into Dashboard, a DashboardDocument.

Each part is optional: a dashboard without a field list is arranged with its "+" buttons, one without a filter context does not cross-filter.

Save and open¶

A DashboardDocument is the report (easybi/v1: visuals, filters, calculated measures) and its layout. It is saved as JSON, with the schema easybi-dashboard/v1:

public DashboardDocument Dashboard { get; set; } = new();   // bound to Document

File.WriteAllText(path, DashboardSerializer.Serialize(Dashboard));
Dashboard = DashboardSerializer.Deserialize(File.ReadAllText(path));

File.WriteAllText(path, DashboardSerializer.Serialize(dashboard.Capture()));
dashboard.Load(DashboardSerializer.Deserialize(File.ReadAllText(path)));   // (1)!

Read-only¶

<bi:DashboardView Context="{Binding Context}" Document="{Binding Dashboard}" IsReadOnly="True" />

No editing chrome, no editing command, no selection. Clicks keep cross-filtering. IsReadOnly is inherited, so item templates can use it.

Performance¶

Only the visuals in or near the visible part of the dashboard query their data; the others query when they scroll into view. A change of filters or data costs them one query then.

Next¶