Back to Devexpress

DashboardConfigurator.ConfigureItemDataCalculation Event

dashboard-devexpress-dot-dashboardweb-dot-dashboardconfigurator-5138e334.md

latest5.1 KB
Original Source

DashboardConfigurator.ConfigureItemDataCalculation Event

Allows you to configure how the dashboard item’s client data is calculated.

Namespace : DevExpress.DashboardWeb

Assembly : DevExpress.Dashboard.v25.2.Web.dll

NuGet Package : DevExpress.Web.Dashboard.Common

Declaration

csharp
public event ConfigureItemDataCalculationWebEventHandler ConfigureItemDataCalculation
vb
Public Event ConfigureItemDataCalculation As ConfigureItemDataCalculationWebEventHandler

Event Data

The ConfigureItemDataCalculation event's data class is ConfigureItemDataCalculationWebEventArgs. The following properties provide information specific to this event:

PropertyDescription
CalculateAllTotalsInherited from ConfigureItemDataCalculationEventArgs.
DashboardIdGets a dashboard identifier.
ItemComponentNameInherited from ConfigureItemDataCalculationEventArgs.

Remarks

Tip

For information on how to use the DashboardConfigurator‘s API, see the following topic: Server-Side API Overview.

The ConfigureItemDataCalculation event is raised for the data-aware dashboard items. For example, you can specify whether to calculate totals that are not displayed in the dashboard item. For this, use the ConfigureItemDataCalculationEventArgs.CalculateAllTotals property.

The ConfigureItemDataCalculationWebEventArgs.DashboardId property allows you to get a dashboard identifier, and the ConfigureItemDataCalculationEventArgs.ItemComponentName property is used to get the component name of the dashboard item.

For displayed values, you can obtain hidden measures values regardless of the ConfigureItemDataCalculationEventArgs.CalculateAllTotals property’s value.

The following code snippets (auto-collected from DevExpress Examples) contain references to the ConfigureItemDataCalculation event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

dashboard-constant-lines/CS/ConstantLineExtension.Web/ConstantLineModule.cs#L27

csharp
targetConfigurator = configurator;
targetConfigurator.ConfigureItemDataCalculation += Web_ConfigureItemDataCalculation;
targetConfigurator.CustomExport += CustomExport;

asp-net-mvc-dashboard-custom-properties-sample/CS/AspMvcDashboardCustomPropertiesSample/App_Start/DashboardConfig.cs#L28

csharp
DashboardConfigurator.Default.ConfigureItemDataCalculation += (s, e) => {
    e.CalculateAllTotals = true;

asp-net-core-dashboard-custom-properties-sample/CS/AspNetCoreDashboard/Startup.cs#L54

csharp
configurator.ConfigureItemDataCalculation += (s, e) => {
    e.CalculateAllTotals = true;

See Also

DashboardConfigurator Class

DashboardConfigurator Members

DevExpress.DashboardWeb Namespace