Chart API Reference

This page documents every public class, interface, and enum in the PowerPortalsPro charting library.

Components

The Blazor components that render charts.

FluentUIChart

A theme-aware wrapper around the base Chart component. Reads colors from the active Fluent UI design tokens, auto-fills dataset colors from a Fluent-derived palette, and re-themes the chart when the user toggles between light and dark mode.

DataverseChart

A convenience component that wraps FluentUIChart and owns the data-loading lifecycle. Accepts a DataverseChartDataSource, handles loading state, error display, and provides an optional refresh button.

Chart Types & Enums

Enumerations for chart type selection and date bucketing.

ChartType

The set of chart types supported by the underlying Chart.js library: Bar, Line, Pie, Doughnut, PolarArea, Radar, Bubble, and Scatter.

ChartDateGrouping

Date bucketing intervals for grouping datetime columns in aggregate queries. Includes simple values (Day, Month, Year) and combined values (MonthAndYear, QuarterAndYear, etc.) that produce formatted labels like "Jan 2024".

Data Model

The classes and interfaces that represent chart data, data points, theming, and click event payloads.

ChartData

Bundles the fully-shaped data needed to render a chart: a list of category labels (X axis) and one or more datasets. Returned by data source LoadAsync methods.

ChartDataset

Represents a single dataset (series) in a chart. Contains data points, a legend label, and optional color overrides for background and border.

IDataPoint

IDataPoint is an interface representing a single data point in a chart dataset. Implementations may carry additional context (record id, category, etc.) that is preserved on the C# side and made available to click handlers via ChartClickEventArgs.DataPoint.

DataPoint

Default implementation of IDataPoint. Subclass to attach caller-defined context (record id, region, etc.) that will be available to click handlers.

DataverseDataPoint

An IDataPoint implementation that retains the underlying Dataverse TableRecord it was projected from. Click handlers can pattern-match on this type to access the row's id, table name, and column values.

ChartTheme

Theme and formatting overrides applied to a chart instance — text color, gridline color, Y-axis value formatting (prefix/suffix), chart title, stacked mode, and legend position.

ChartClickEventArgs

Payload describing a click on a single chart element (bar, slice, point, etc.). Contains the dataset index, data index, label, value, dataset label, and the original IDataPoint instance for pattern matching.

Data Sources

Data source classes that load chart data from Dataverse via FetchXML queries.

DataverseChartDataSource

Base data source class that accepts raw FetchXML and column mappings. Executes the query via IPowerPortalsProService, handles RelatedRecordValue unwrapping for aggregate results, and shapes rows into single- or multi-series ChartData.

AggregateDataverseChartDataSource

A subclass that builds an aggregate FetchXML query from simple properties (TableName, GroupByColumn, AggregateColumn, Aggregate) instead of requiring raw FetchXML. Supports date bucketing, multi-series, view-based filtering, inline filter fragments, and linked entity joins.

ViewDataverseChartDataSource

A subclass that resolves its FetchXML from a Dataverse saved view (saved query). The caller still sets LabelColumn and ValueColumn to indicate which columns map to labels and values.

ChartLinkedEntity

Describes a linked entity (join) used by AggregateDataverseChartDataSource to place a groupby or series attribute on a related table. Supports unlimited nesting via the LinkedEntity property for multi-hop joins (e.g. opportunity → account → business unit).

Linking charts to a grid

A DataverseChart can mirror the current filter state of a MainGrid. When the user switches the grid's view or types in its search box, the chart re-aggregates against the matching records — and when the grid's Refresh button is pressed, the chart reloads alongside it. Any number of charts can link to the same grid.

Pass the grid reference through a lambda rather than directly. The lambda is resolved after the parent's render completes, so the grid's @@ref has already been captured — a direct LinkedGrid="_grid" would be evaluated as null during that same render pass.

<MainGrid @ref="_grid" TableName="opportunity" ViewIds="_viewIds" />

<DataverseChart Source="_pipelineSource" LinkedGrid="() => _grid" />
<DataverseChart Source="_ratingSource"   LinkedGrid="() => _grid" />

@code {
    private MainGrid _grid = default!;
    // ... data sources ...
}

Under the hood, GridBase exposes two events that charts subscribe to: FetchXmlChanged carries the exact FetchXml the grid just executed (late subscribers receive the most recent value immediately, so the chart still picks up the grid's starting filters if it links up after the initial load), and OnRefresh fires when the user presses Refresh so linked charts always reload even if the filter portion hasn't changed. The chart dedupes FetchXmlChanged on the filter portion so a grid sort doesn't trigger a redundant chart query.