Back to Devexpress

DevExpress.DashboardCommon Namespace

dashboard-devexpress-e4a8891a.md

latest114.1 KB
Original Source

DevExpress.DashboardCommon Namespace

Contains classes that implement the core DevExpress Dashboard functionality.

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

NuGet Package : DevExpress.Dashboard.Core

Classes

NameDescription
AbsoluteVariationNumericFormatContains format settings for numeric delta values expressed as absolute variations.
AppearanceSettingsContains style settings used to apply conditional formatting by changing appearance settings.
BarStyleSettingsContains style settings used to change colors of bars used in conditional formatting.
BeforeExportDocumentEventArgsProvides data for the BeforeExportDocument events.
BeforeFillExtractEventArgsProvides data for the DashboardExtractDataSource.BeforeFill event.
BoundImageDashboardItemA Bound Image dashboard item.
BubbleMapDashboardItemA Bubble Map dashboard item that allows you to place bubbles on the map using geographical coordinates.
CalculatedFieldA calculated field that allows you to apply complex expressions to data fields obtained from the data source.
CalculatedFieldCollectionA collection of CalculatedField objects.
CardA card template used to display a series of cards in the CardDashboardItem.
CardCenteredLayoutTemplateThe Centered layout template used to center card elements so that they occupy a specified width/height.
CardCollectionA collection that contains Card objects.
CardCompactLayoutTemplateThe Compact layout template used to arrange card elements so that they occupy the minimum area.
CardCustomLayoutTemplateThe Custom layout template that allows you to create a card layout manually.
CardDashboardItemA Card dashboard item that displays a series of KPI elements (cards), each illustrating the difference between two values.
CardDeltaOptionsContains options that control how the difference between actual and target values should be displayed.
CardElementCollectionA collection of CardRowElementBase descendants that are a card’s visual elements.
CardFormatRuleDimensionLayoutElementA card’s dimension layout element to which a format rule applies.
CardFormatRuleLayoutElementLists values that specify the card’s layout elements to which the format rule applies.
CardFormatRuleTextLayoutElementA card’s text layout element to which a format rule applies.
CardItemDeltaFormatRuleA format rule that is calculated by delta and used to apply conditional formatting to the Card dashboard item.
CardItemFormatRuleA format rule that is calculated by data items and used to apply conditional formatting to the Card dashboard item.
CardItemFormatRuleBaseServes as the base class for classes that are format rules for the Card item.
CardItemFormatRuleCollectionA collection of CardItemFormatRuleBase descendants that are format rules for the Card item.
CardLayoutContains settings related to the layout of cards for the CardDashboardItem.
CardLayoutTemplateServes as the base for classes that define a layout template for the CardDashboardItem.
CardLayoutTemplateDataElementA visual element within a card layout that displays bound data in text form.
CardLayoutTemplateElementA visual element within a card layout.
CardLightweightLayoutTemplateThe Lightweight layout template that displays the minimum set of elements within a card.
CardRowA row in the CardDashboardItem‘s layout.
CardRowBaseServes as the base for classes that are rows in the CardDashboardItem‘s layout.
CardRowCollectionA collection of CardRow objects that are rows in a card’s layout.
CardRowDataElementA card element that displays bound data.
CardRowElementBaseServes as the base for classes that are a card’s visual elements.
CardRowIndicatorElementA delta indicator within a card.
CardRowTextElementA card element that displays static text.
CardRowTextElementBaseServes as the base for classes that are card elements displaying text data.
CardSparklineRowA sparkline row in the CardDashboardItem‘s layout.
CardStretchedLayoutTemplateThe Stretched layout template that arranges card elements so that they occupy an entire card area.
CardWindowDefinitionA window definition used to perform calculations within the CardDashboardItem.
CellsItemFormatRuleServes as the base for classes used to apply conditional formatting to a dashboard item‘s cells.
ChartAxisServes as the base class for classes that represent chart axes.
ChartAxisXThe chart’s X-axis.
ChartAxisYThe chart’s Y-axis.
ChartContextProvides a connection between data item containers from the Values section and series from an underlying control.
ChartCustomIndicatorA custom indicator in a chart dashboard item.
ChartDashboardItemA Chart dashboard item that visualizes data in an XY-diagram.
ChartDashboardItemBaseServes as the base class for chart dashboard items, such as the ChartDashboardItem and PieDashboardItem.
ChartIndicatorBaseContains settings for Trend Indicators of the Chart dashboard item.
ChartIndicatorCollectionA collection of trend indicators.
ChartInteractivityOptionsContains options related to the specifics of Master Filtering and drill-down in the Chart and Pie dashboard items.
ChartItemFormatRuleA format rule that is used to apply conditional formatting to the Chart dashboard item.
ChartItemFormatRuleBaseServes as the base class for classes that are format rules for the Chart and ScatterChart dashboard items.
ChartItemFormatRuleCollectionA collection of ChartItemFormatRule descendants that are format rules of a Chart item.
ChartLegendA chart legend.
ChartPaneA chart pane.
ChartPaneCollectionA collection of ChartPane objects.
ChartRegressionLineA regression line in a chart dashboard item that shows data using a mathematical formula that minimizes the distance between the line itself and associated data points.
ChartSecondaryAxisYThe chart’s secondary Y-axis.
ChartSeriesServes as the base class for chart series.
ChartSeriesCollectionA collection of Chart dashboard item‘s series.
ChartSeriesCollectionBase<TSeries>Serves as the base class for classes that represent collections of chart series.
ChartTrendLineA trend line in a chart dashboard item that shows trends in the series data.
ChartWindowDefinitionA window definition used to perform calculations within the ChartDashboardItem.
ChoroplethMapServes as the base class for classes that provide values for different types of the ChoroplethMapDashboardItem.
ChoroplethMapCollectionA collection of ChoroplethMap descendants.
ChoroplethMapDashboardItemA Choropleth Map dashboard item that colors areas depending on the provided values.
ColorDefinitionA color definition.
ColorSchemeA color scheme used to color dashboard item elements.
ColorSchemeDimensionKeyA dimension key used to specify dimension values to be colored.
ColorSchemeEntryA color scheme entry used to map the dimension values/measures and the specified color.
ColorSchemeMeasureKeyA measure key used to specify measures to be colored.
ColorStyleSettingsContains color settings for conditional formatting.
ComboBoxDashboardItemA Combo Box dashboard item that allows end-users to filter other dashboard items.
ConfigureItemDataCalculationEventArgsProvides data for the ConfigureItemDataCalculation event.
ConfigureOlapConnectionEventArgsProvides data for the DashboardOlapDataSource.ConfigureOlapConnection event.
ControlContextA base class for classes that provide a connection between Dashboard items and corresponding underlying controls.
CustomDashboardItemContains base functionality for custom dashboard items. This member supports the internal infrastructure and is not intended to be used directly from your code.
CustomDashboardItem<T>A custom dashboard item.
CustomDashboardItemConfigurationExceptionThe exceptions that occur when a custom item’s metadata is not registered or a CustomControlProviderBase descendant is not assigned to the e.CustomControlProvider property.
CustomExportBaseEventArgsServes as the base for classes that provide data for events used to customize exported documents.
CustomExportEventArgsProvides data for the CustomExport events.
CustomItemBindingValueContains information about data items saved in custom item metadata.
CustomItemDataContains methods that allow you to work with custom item data.
CustomItemDescriptionAttributeSpecifies tooltip text that is displayed for a custom item’s bar in the Ribbon.
CustomItemExportControlCreatingEventArgsProvides data for the CustomItemExportControlCreating event.
CustomItemExportInfoContains custom item export settings.
CustomItemImageAttributeSpecifies an icon for a custom item’s bar in the Ribbon.
CustomItemMetadataA base class that contains metadata for custom dashboard items.
CustomItemMetadataTypesA collection of metadata types.
CustomItemSelectionContains methods that allow you to get the master filter‘s current state.
CustomItemWindowDefinitionA window definition used to perform calculations within the CustomDashboardItem. For internal use.
CustomizeExportDocumentEventArgsProvides data for the CustomizeExportDocument events.
CustomPaletteRepresents a palette that contains a specified set of colors.
CustomPaletteEventArgsProvides data for the CustomPalette events.
CustomParametersEventArgsProvides data for the CustomParameters event.
CustomPropertiesA collection of custom properties.
CustomPropertyChangedEventArgsProvides data for the DashboardViewer.DashboardCustomPropertyChanged and DashboardDesigner.DashboardCustomPropertyChanged events.
CustomScaleRepresents the scale that defines custom distribution of colors in the color range.
CustomShapefileRepresents a custom shapefile that is used to provide a map for the map dashboard items (such as Choropleth or Geo Point maps).
CustomShapefileDataRepresents custom shapefile data.
DashboardContains the full description of a dashboard used to visualize data.
DashboardConfiguratorBase
DashboardConfigureDataConnectionEventArgsProvides data for ConfigureDataConnection events.
DashboardConnectionErrorEventArgsProvides data for ConnectionError events.
DashboardConnectionExceptionThe exception that occurs when there is a problem with a connection to a database.
DashboardCustomAssemblyLoadingEventArgsProvides data for the CustomAssemblyLoading events.
DashboardCustomFilterExpressionEventArgsProvides data for the Dashboard.CustomFilterExpression event.
DashboardDataAxisNames staticLists constants used to identify various types of data axes.
DashboardDataLoadingEventArgsProvides data for the Dashboard.DataLoading event.
DashboardDataLoadingExceptionThe exception that occurs during loading data to a data source.
DashboardDataRowRepresents an individual record from the DashboardDataSet.
DashboardDataSetRepresents a list of records displayed within the dashboard item.
DashboardDataSourceModelAccumulates intermediate data source settings during the execution of a Data Source wizard.
DashboardEFDataSourceAn Entity Framework data source that provides data for the dashboard.
DashboardExcelDataSourceA data source used to extract data from Microsoft Excel workbooks or CSV files.
DashboardExcelDataSourceBeforeFillEventArgsProvides data for the ExcelDataSourceBeforeFill event.
DashboardExcelExportOptionsContains options related to exporting a dashboard/dashboard item to Excel format.
DashboardExporterAllows you to implement server export of a dashboard or dashboard items for all platforms.
DashboardExporterBaseThe base class for the DashboardExporter and WebDashboardExporter components.
DashboardExporterConnectionErrorEventArgsProvides data for the ConnectionError event.
DashboardExportSettings staticContains settings related to exporting a dashboard/dashboard items.
DashboardExtractDataSourceAn extract data source that is a local snapshot of data.
DashboardFederationDataSourceA federated data source that retrieves data from different data sources.
DashboardFlatDataColumnA data column in DashboardFlatDataSource.
DashboardFlatDataSourceA data source that contains a custom item‘s data in a tabular format.
DashboardFlatDataSourceOptionsContains DashboardFlatDataSource settings.
DashboardFlatDataSourceRowAn individual record from DashboardFlatDataSource.
DashboardImageExportOptionsContains options related to exporting a dashboard/dashboard item to an image.
DashboardInternalExceptionThe exception that occurs during dashboard application execution.
DashboardItemServes as the base class for dashboard items.
DashboardItemCollectionA collection that contains dashboard items.
DashboardItemColoringOptionsContains dashboard item coloring options.
DashboardItemDataLoadingErrorAn error occurred while a dashboard item loaded data.
DashboardItemDataLoadingErrorEventArgsProvides data for the DashboardItemDataLoadingError event.
DashboardItemFormatRuleRepresents a format rule used to apply conditional formatting to dashboard items.
DashboardItemGroupRepresents a group used to arrange dashboard items within a dashboard.
DashboardItemGroupCollectionA collection of DashboardItemGroup objects.
DashboardItemGroupInteractivityOptionsContains options that control interactivity features, such as Master Filtering and drill-down.
DashboardItemInteractivityOptionsContains options that control interactivity features, such as Master Filtering and drill-down.
DashboardItemStateA dashboard item state that includes selected master filter values, current drill-down values, etc.
DashboardItemVisualInteractivityBaseEventArgsServes as a base class for classes that provides data for the DashboardDesigner.DashboardItemVisualInteractivity / DashboardViewer.DashboardItemVisualInteractivity / DashboardControl.DashboardItemVisualInteractivity events.
DashboardJsonDataSourceA data source that retrieves data stored in JSON format.
DashboardLayoutGroupA layout group used to arrange layout items or other groups within a dashboard.
DashboardLayoutItemRepresents a layout item that displays a dashboard item.
DashboardLayoutNodeServes as the base class for layout items and groups.
DashboardLayoutNodeCollectionA collection of DashboardLayoutNode elements representing layout items and groups.
DashboardLayoutTabContainerA layout tab container used to arrange layout tab pages within a dashboard.
DashboardLayoutTabPageA layout tab page used to arrange layout items and groups.
DashboardMongoDBDataSourceA data source that retrieves data from MongoDB.
DashboardObjectDataSourceAn object data source that provides data for the dashboard.
DashboardOlapDataSourceAn OLAP data source that provides data for the dashboard.
DashboardOptionsChangedEventArgsProvides data for the Dashboard.OptionsChanged event.
DashboardPaletteA palette that contains colors used to paint dashboard item elements.
DashboardParameterA dashboard parameter.
DashboardParameterCollectionA collection of DashboardParameter objects.
DashboardParameterStateA state of dashboard parameters that includes currently selected parameter values.
DashboardPdfExportOptionsContains options related to exporting a dashboard/dashboard item to PDF format.
DashboardPrintPreviewOptionsContains options related to printing a dashboard/dashboard item.
DashboardPrivateSettings staticContains experimental settings that affect dashboard controls and their elements.
DashboardSettings staticContains appearance and behavior settings common to WinForms/WPF Dashboard Controls.
DashboardSpecialValues staticProvides access to the dashboard special values.
DashboardSqlDataSourceAn SQL data source that provides data for the dashboard.
DashboardStateA data container for changes resulting from end-user interaction - selected master filter values, drill-down levels, Range Filter settings, dashboard item layers and current parameter values.
DashboardTabPageA tab page in a TabContainerDashboardItem.
DashboardTabPageCollectionA collection of DashboardTabPage objects.
DashboardTitleRepresents a dashboard title.
DashboardToggles staticContains settings that can be used to enable or disable a specific Dashboard functionality.
DashboardUnderlyingDataRowRepresents an individual record from the DashboardUnderlyingDataSet.
DashboardUnderlyingDataSetRepresents a list of records from the dashboard data source.
DashboardUriValidationContext
DashboardXpoDataSourceRetrieves data from XPO (eXpress Persistent Objects).
DataDashboardItemServes as the base class for data-bound dashboard items.
DataItemServes as the base class for data items - measures and dimensions.
DataItemCollection<TDataItem>Serves as the base class for classes that represent collections of DataItem descendants.
DataItemContainerServes as the base class for data item containers.
DataItemContainerCollection<TContainer>A collection of DataItemContainer descendants.
DataItemDateTimeFormatContains formatting settings for date-time values.
DataItemDefinitionA data item definition.
DataItemNumericFormatContains format settings for numeric values.
DataLoadingErrorAn error occurred during loading data to a data source.
DataLoadingErrorEventArgsProvides data for the DataLoadingError events.
DataLoadingEventArgsContains members used to fill an Object data source with data.
DataSourceObsolete. A data source that provides data for the dashboard.
DataSourceCollectionA collection that contains dashboard data sources.
DataSourceEventArgsServes as the base class for classes that provide data for dashboard events.
DataSourceFilterContainsAggrFunctionExceptionOccurs when the Object or Excel data source attempts to apply a filter containing the Aggr function.
DateFilterDashboardItemA Date Filter dashboard item that allows end users to filter other dashboard items by date-time values.
DateTimePeriodA date-time period that is used to select a predefined range in the Range Filter and Date Filter items.
DateTimePeriodCollectionA collection of DateTimePeriod objects.
DateTimePeriodLimitBaseServes as the base class for classes that are used to specify boundaries for the DateTimePeriod.
DefaultGroupIntervalAttributeSpecifies the default group interval for data items.
DeltaMapContains measures that provide data used to visualize the difference between these measures in the ChoroplethMapDashboardItem.
DeltaOptionsContains options that control how the difference between actual and target values should be displayed.
DeltaOptionsBaseServes as the base for classes that control how the difference between actual and target values should be displayed.
DeltaValueContains delta element values.
DifferenceCalculationA difference calculation that is used to compute the difference between measure values across a window.
DimensionA dimension that is a DataItem whose values are used to categorize data.
DimensionCollectionA collection of Dimension objects.
DimensionDefinitionA dimension definition.
DimensionTopNOptionsContains the Top N settings.
DimensionValueContains dimension values at the specified axis point.
DrillActionEventArgsProvides data for the DrillDownPerformed and DrillUpPerformed events of the DashboardDesigner and DashboardViewer.
DuplicateDataItemIdExceptionThe exception that occurs when you have two data items with the same id.
DynamicListLookUpSettingsProvides the look-up editor settings for dashboard parameters that are bound to a data source.
EmptyDataItemPlaceholderAttributeSpecifies placeholder text for a pane where you can place a data item.
ExcelDataSourceConnectionParametersContains parameters used to establish a connection to an Excel workbook or CSV file.
ExcelExportOptionsObsolete. Contains options which define how the dashboard item is exported to Excel format.
ExportFontInfoContains the font settings of the exported document.
ExtractCacheBaseServes as the base class for classes that are in-memory caches used by the Extract Data Source.
ExtractCacheOptions staticProvides access to cache options of the Extract Data Source.
ExtractConnectionErrorEventArgsProvides data for the DashboardExtractDataSource.ConnectionError event.
ExtractDataSourceConnectionParametersContains parameters used to establish a connection to an Extract Data Source.
ExtractDataSourceConnectionParametersBaseServes as the base class for classes containing parameters used to establish a connection to DashboardExtractDataSource.
ExtractDriverStorage staticA storage of drivers used to manage writing/reading operations for data extracts.
ExtractPersistentCacheA persistent in-memory cache used by the Extract Data Source.
ExtractSourceOptionsContains settings of the original data source used to create a data extract.
ExtractWeakCacheA weak in-memory cache used by the Extract Data Source.
FileExtractDriverA default driver used to write data to/read data from a standard data extract stored in a file.
FilterableDashboardItemInteractivityOptionsContains options related to the specifics of Master Filtering in the dashboard items that can be filtered.
FilterElementDashboardItemServes as the base class for classes that represent filter elements.
FilterElementDefaultValuesEventArgsObsolete. Provides data for FilterElementDefaultValues events.
FixedDateTimePeriodLimitA fixed date-time value used to specify boundaries for the DateTimePeriod.
FlowDateTimePeriodLimitA floating date-time value used to specify boundaries for the DateTimePeriod.
FormatConditionAverageA format condition used to apply formatting according to the average value.
FormatConditionBarA format condition used to visualize numeric values using bars.
FormatConditionBarOptionsContains options related to format conditions that use a bar to visualize numeric values.
FormatConditionBaseServes as a base for classes that represent format conditions used to apply formatting.
FormatConditionColorRangeBarA format condition used to visualize numeric values using bars whose colors are contained in the specified color set.
FormatConditionDateOccuringUse the FormatConditionDateOccurring class instead.
FormatConditionDateOccurringA format condition used to apply formatting to date-time values concerning a specific date and/or date interval relative to today.
FormatConditionExpressionA format condition used to apply formatting according to the specified expression.
FormatConditionGradientRangeBarA format condition used to visualize numeric values using bars whose colors are contained in the specified color gradient.
FormatConditionMinMaxBaseServes as the base class for classes that provides the capability to specify minimum/maximum values used in visualizing numeric data.
FormatConditionRangeBaseServes as a base for classes that are used to apply conditional formatting using value ranges.
FormatConditionRangeGradientA format condition used to apply formatting using value ranges and a specified color gradient.
FormatConditionRangeSetA format condition used to apply formatting using value ranges and corresponding style settings.
FormatConditionStyleBaseServes as a base for classes used to apply conditional formatting by modifying style settings.
FormatConditionTopBottomA format condition used to apply formatting to top/bottom values.
FormatConditionValueA format condition used to apply formatting according to predefined values.
FormatRuleCollection<T>Serves as a base for classes that are collections of DashboardItemFormatRule descendants.
GaugeContains measures that provide data for a gauge in the GaugeDashboardItem.
GaugeCollectionA collection of Gauge objects.
GaugeDashboardItemA Gauge dashboard item that visualizes data within a series of KPI elements (gauges).
GaugeExportContextProvides a connection between data item containers from the Gauges section and underlying control’s gauges during export.
GaugeWindowDefinitionA window definition used to perform calculations within the GaugeDashboardItem.
GeoPointMapDashboardItemA Geo Point Map dashboard item that allows you to place callouts on the map using geographical coordinates.
GeoPointMapDashboardItemBaseServes as the base class for Map dashboard items that visualize data based on the geographical coordinates.
GradientPaletteRepresents a palette that contains a gradient between two given colors.
GridColumnBaseServes as the base for classes that represent grid columns.
GridColumnCollectionA collection containing GridColumnBase descendants that are columns of the Grid dashboard item.
GridColumnFilterOptionsContains settings of the column filters that allow users to search data in the Grid item.
GridColumnTotalA total calculated based on Grid column values.
GridColumnTotalCollectionA collection of GridColumnTotal objects that are totals calculated based on Grid column values.
GridDashboardItemA Grid dashboard item that visualizes data in tabular form.
GridDeltaColumnA delta column in a GridDashboardItem.
GridDimensionColumnA dimension column in a GridDashboardItem.
GridHyperlinkColumnA hyperlink column in a GridDashboardItem.
GridItemFormatRuleA format rule used to apply conditional formatting to the Grid dashboard item.
GridItemFormatRuleCollectionA collection of GridItemFormatRule objects.
GridMeasureColumnA measure column in a GridDashboardItem.
GridOptionsContains options of the GridDashboardItem.
GridSparklineColumnA sparkline column in a GridDashboardItem.
GridWindowDefinitionA window definition used to perform calculations within the GridDashboardItem.
HighLowCloseSeriesA High-Low-Close series.
IconSettingsContains style settings used to apply conditional formatting using icons.
ImageDashboardItemAn Image dashboard item that displays static images.
IndicatorFactory staticContains the custom indicator types used in a chart dashboard item.
InvalidCultureNameExceptionThe exception that occurs when it is impossible to create the CultureInfo object for the provided locale.
JsonConnectionParametersBaseServes as the base class for classes containing parameters used to establish a connection to DashboardJsonDataSource.
JsonSourceConnectionParametersProvides access to connection parameters of the JSON data source.
KpiDashboardItem<TKpiElement>Serves as the base class for dashboard items used to communicate KPI-related data.
KpiElementServes as the base for classes that provide data for card and gauge dashboard items.
LayoutDimensionOptionsContains settings that allow you to adjust the height and width of a dashboard surface.
LayoutOptionsContains dashboard layout settings.
ListBoxDashboardItemA List Box dashboard item that allows end-users to filter other dashboard items.
MapDashboardItemServes as the base class for map dashboard items.
MapLegendA color map legend.
MapLegendBaseServes as the base class for classes that represent map legends.
MapPaletteServes as the base class for classes that represent map palettes.
MapScaleServes as the base class for classes representing the scale that defines the distribution of colors in the color range.
MasterFilterClearedEventArgsProvides data for the MasterFilterCleared event of the DashboardDesigner and DashboardViewer.
MasterFilterDefaultValuesEventArgsProvides data for the MasterFilterDefaultValues events.
MasterFilterSetEventArgsProvides data for the MasterFilterSet event of the DashboardDesigner and DashboardViewer.
MeasureA measure which is a DataItem whose values are summarized before they are used in the dashboard.
MeasureCalculationServes as the base class for classes that are measure calculations allowing you to apply specific computations to Measure values that are related to the currently processed value.
MeasureCalculationWindowDefinitionServes as the base class for classes that specify a window definition used to perform calculations within different dashboard items.
MeasureCollectionA collection of Measure objects.
MeasureDefinitionA measure definition.
MeasureDefinitionCollectionA collection of MeasureDefinition objects.
MeasureValueContains the measure value and display text.
MovingCalculationA moving calculation that is computed for the specified measure across a window.
NamedDataItemContainerServes as the base class for named data item containers.
ObjectDataSourceFillParametersContains parameters used to fill the DashboardObjectDataSource.
OlapConnectionExceptionTHe exception that occurs when you try to connect to OLAP cubes.
OlapDataConnectionRepresents a connection to a cube in an MS Analysis Services database.
OlapDataProviderObsolete. Represents a data provider for an OLAP data source.
OpenHighLowCloseSeriesAn Open-High-Low-Close series.
PaletteColorCollectionA collection of palette colors.
ParameterLookUpSettingsServes as the base class for classes that provide the look-up editor settings for dashboard parameters.
PercentNumericFormatContains format settings for numeric delta values expressed as percentage.
PercentOfTotalCalculationA calculation that is used to compute a percent of the total for the specified measure across a window.
PieDashboardItemA Pie dashboard item that displays a series of pies or donuts.
PieMapDashboardItemA Pie Map dashboard item that allows you to place pies on the map using geographical coordinates.
PieWindowDefinitionA window definition used to perform calculations within the PieDashboardItem.
PivotDashboardItemA Pivot dashboard item that displays cross-tabular reports.
PivotItemFormatRuleA format rule used to apply conditional formatting to the Pivot dashboard item.
PivotItemFormatRuleCollectionA collection of PivotItemFormatRule objects.
PivotItemFormatRuleLevelA pivot level used to apply conditional formatting to specific cells.
PivotWindowDefinitionA window definition used to perform calculations within the PivotDashboardItem.
PointLabelOptionsContains options related to series point labels.
PointLabelOptionsBaseServes as the base for classes containing options related to chart point labels.
RangeFilterDashboardItemA Range Filter dashboard item that allows end-users to apply filtering to other dashboard items.
RangeFilterDefaultValueEventArgsProvides data for the RangeFilterDefaultValue events.
RangeFilterPredefinedDateTimePeriodsEventArgsProvides data for the DashboardDesigner.RangeFilterPredefinedDateTimePeriods event.
RangeFilterSelectionA range in the Range Filter or Date Filter dashboard items.
RangeFilterSeriesCollectionA collection of series displayed within the RangeFilterDashboardItem.
RangeFilterStateA state of the Range Filter dashboard item.
RangeFilterWindowDefinitionA window definition used to perform calculations within the RangeFilterDashboardItem.
RangeInfoProvides custom range boundaries and corresponding style settings used to apply conditional formatting to value ranges.
RangeSeriesA Range series.
RangeSetA collection of RangeInfo objects providing custom range boundaries and corresponding style settings used to apply conditional formatting to value ranges.
RangeStopCollectionA collection of endpoints for color ranges in the custom palette.
RankCalculationA rank calculation that is used to compute rankings for the specified measure across a window.
RunningTotalCalculationA running total calculation that is used to compute a cumulative total for the specified measure across a window.
ScatterChartAxisA scatter chart’s axis.
ScatterChartDashboardItemA Scatter Chart dashboard item that visualizes relationships between numerical variables.
ScatterChartItemFormatRuleA format rule that is used to apply conditional formatting to the Scatter Chart dashboard item.
ScatterChartItemFormatRuleCollectionA collection of ScatterChartItemFormatRule descendants that are format rules of a Scatter Chart dashboard item.
ScatterPointLabelOptionsContains options related to point labels of a scatter chart.
ScatterWindowDefinitionA window definition used to perform calculations within the ScatterChartDashboardItem.
SelectedTabPageChangedEventArgsProvides data for the DashboardDesigner.SelectedTabPageChanged, DashboardViewer.SelectedTabPageChanged and DashboardControl.SelectedTabPageChanged events.
SeriesDashboardItemServes as the base class for dashboard item that have the Series data section.
SetInitialDashboardStateBaseEventArgsBase class that provides data for the platform-specific SetInitialDashboardState events.
SimpleSeriesA Simple series.
SingleFilterDefaultValueEventArgsObsolete. Provides data for the SingleFilterDefaultValue events.
SparklineOptionsContains options used to control the sparkline appearance.
SpecificWindowDefinitionA window definition that defines a window by specifying a predefined set of dimensions.
SqlDataProviderObsolete. Represents a data provider for regular data sources.
StaticListLookUpSettingsProvides the look-up editor settings for dashboard parameters that are not bound to a data source.
StyleSettingsBaseServes as the base for classes providing style settings used to apply conditional formatting.
SupportColoringAttributeSpecifies whether data items in a section support coloring.
SupportedDataTypesAttributeSpecifies types of data fields that can be used for data items in a section.
SupportInteractivityAttributeSpecifies whether data items in a data section support interactivity.
TabContainerDashboardItemA tab container used to arrange dashboard items and groups within a dashboard.
TextBoxDashboardItemA Text Box dashboard item used to display rich text within a dashboard.
TreemapDashboardItemA Treemap dashboard item that allows you to display large amounts of hierarchically structured (tree-structured) data.
TreemapDashboardItemInteractivityOptionsContains options related to the specifics of Master Filtering in the Treemap dashboard item.
TreeViewDashboardItemA Tree View dashboard item that allows end-users to filter other dashboard items.
UniformScaleRepresents the scale that defines uniform distribution of colors in the color range.
UnregisteredIndicatorExceptionThe exception that occurs when a trend indicator’s custom type is not registered in the application.
UpdateExtractDataSourceConnectionParametersFor internal use
ValidateDashboardCustomSqlQueryEventArgsProvides data for ValidateCustomSqlQuery events.
ValueMapContains a measure that provides data to color a map in the ChoroplethMapDashboardItem.
WeightedLegendA weighted map legend used to identify values corresponding to specific bubble/pie sizes.
WeightedSeriesA Weighted series that allow you to visualize data in three dimensions.
XpoDataSourceConnectionParametersContains parameters used to establish a connection to the XPO (eXpress Persistent Objects).
XRDashboardGaugeA printable gauge in the exported Gauge dashboard item.
XRDashboardItemPanelA Panel control that can contain other controls.
XRGaugeDashboardItemA panel that represents a Gauge dashboard item in the exported document.
XRTextBoxAn XRTextBox control that displays a TextBox dashboard item in the exported document.

Interfaces

NameDescription
ICustomExportControlProviderAllows you to specify a printable control that corresponds to the custom dashboard item.
ICustomExtractDriverWhen implemented, represents a custom driver used to write data to/read data from a data extract.
ICustomPropertyHistoryAttribute<T>Specifies the message displayed in the Dashboard Designer’s history when a user changes a custom property value.
ICustomPropertyProviderWhen implemented, provides an access to the collection of custom properties.
ICustomPropertyValueConverterAttribute<T>Converts a custom property value declared in metadata from its original type to a string and vice versa.
IDashboardDataSourceIf implemented by a class, provides members related to a dashboard data source.
IDashboardItemContainerProvides base properties for dashboard containers.
IDataSourceCacheKeyDefines members for data source cache keys.
IDriverReadSessionWhen implemented, represents a session used to read data from a data extract.
IDriverWriteSessionWhen implemented, represents a session used to write data to a data extract.
IObjectDataSourceCustomFillServiceAllows you to implement a custom fill service for the DashboardObjectDataSource.

Delegates

NameDescription
BeforeExportDocumentEventHandlerReferences a method that handles the BeforeExportDocument events.
ChartIndicatorCalculateFunctionCalculates data points that are used to draw a custom trend indicator in the Chart dashboard item.
ConfigureItemDataCalculationEventHandler
ConfigureOlapConnectionEventHandlerReferences a method that handles the DashboardOlapDataSource.ConfigureOlapConnection event.
CustomExportEventHandlerReferences a method that handles the DashboardDesigner.CustomExport and DashboardViewer.CustomExport events.
CustomItemExportControlCreatingEventHandler
CustomizeExportDocumentEventHandlerReferences a method that handles the CustomizeExportDocument events.
CustomPaletteEventHandlerReferences a method that handles the DashboardDesigner.CustomPalette and DashboardViewer.CustomPalette events.
CustomParametersEventHandlerReferences a method that handles the CustomParameters event.
CustomPropertyChangedEventHandlerReferences a method that handles the DashboardDesigner.DashboardCustomPropertyChanged, DashboardViewer.DashboardCustomPropertyChanged, IDashboardControl.DashboardCustomPropertyChanged events.
DashboardConfigureDataConnectionEventHandlerReferences a method that handles the ConnectionError events.
DashboardConnectionErrorEventHandlerReferences a method that handles the ConnectionError events.
DashboardCustomAssemblyLoadingEventHandlerReferences a method that handles the CustomAssemblyLoading events.
DashboardCustomFilterExpressionEventHandlerReferences a method that handles the Dashboard.CustomFilterExpression event.
DashboardDataLoadingEventHandlerReferences a method that handles the Dashboard.DataLoading event.
DashboardExcelDataSourceBeforeFillEventHandler
DashboardExporterConnectionErrorEventHandlerReferences a method that handles the DashboardExporterConnectionError events.
DashboardItemDataLoadingErrorEventHandlerReferences a method that handles the DashboardItemDataLoadingError events.
DashboardOptionsChangedEventHandlerReferences a method that handles the Dashboard.OptionsChanged event.
DataLoadingErrorEventHandlerReferences a method that handles the DataLoadingError events.
DataLoadingEventHandlerReferences a method that handles DataLoading events.
DrillActionEventHandlerReferences a method that handles the DrillDownPerformed and DrillUpPerformed events of the DashboardDesigner, DashboardViewer, and DashboardControl.
ExtractConnectionErrorEventHandlerReferences a method that handles the DashboardExtractDataSource.ConnectionError event.
FilterElementDefaultValuesEventHandlerObsolete. References a method that handles FilterElementDefaultValues events.
MasterFilterClearedEventHandlerReferences a method that handles the MasterFilterCleared event of the DashboardDesigner and DashboardViewer.
MasterFilterDefaultValuesEventHandlerReferences a method that handles the MasterFilterDefaultValues events.
MasterFilterSetEventHandlerReferences a method that handles the MasterFiltersSet event of the DashboardDesigner and DashboardViewer.
RangeFilterDefaultValueEventHandlerReferences a method that handles the RangeFilterDefaultValue events.
RangeFilterPredefinedDateTimePeriodsEventHandlerReferences a method that handles the DashboardDesigner.RangeFilterPredefinedDateTimePeriods event.
SelectedTabPageChangedEventHandlerReferences a method that handles the DashboardDesigner.SelectedTabPageChanged, DashboardViewer.SelectedTabPageChanged and DashboardControl.SelectedTabPageChanged events.
SingleFilterDefaultValueEventHandlerObsolete. References a method that handles the SingleFilterDefaultValue event.
ValidateDashboardCustomSqlQueryEventHandlerReferences a method that handles ValidateCustomSqlQuery events.

Enums

NameDescription
CalculatedFieldTypeLists values used to specify the type of calculated field.
CardHorizontalAlignmentLists values that identify the horizontal alignment of a visual element within a card layout row.
CardPredefinedColorLists values that identify colors used to paint text visual elements within a card layout row.
CardRowDataElementTypeLists values that identify the type of a value displayed within a card layout row.
CardVerticalAlignmentLists values that identify the vertical alignment of a card layout row.
CardWindowDefinitionModeA window definition mode used to specify a window within the CardDashboardItem.
ChartLegendInsidePositionLists the values that specify the legend position and orientation within a chart diagram.
ChartLegendOutsidePositionLists the values that specify the legend position and orientation outside the chart diagram.
ChartWindowDefinitionModeA window definition mode used to specify a window within the ChartDashboardItem.
ColoringModeLists values used to set the coloring mode for dimension values and measures.
ComboBoxDashboardItemTypeLists values that specify the type of the Combo Box dashboard item.
ContentArrangementModeLists values that specify how individual elements contained within the dashboard item (such as Card, Pie or Gauge) should be arranged.
CustomNumericFormatModeLists values used to specify a custom numeric format mode.
DashboardExportActionLists values that specify the export action performed by an end-user.
DashboardExportCompatibilityModeLists values specifying the compatibility mode used to export a dashboard/dashboard items.
DashboardExportFormatLists values that specify the format used to export a dashboard/dashboard item.
DashboardExportModeLists values that specifies the document export mode.
DashboardExportScaleModeObsolete. Lists values that specify a scale mode when exporting a dashboard/dashboard item.
DashboardFormatConditionLists values specifying comparison operators used to apply conditional styles.
DashboardFormatConditionAboveBelowTypeLists values used to specify the comparison logic used to apply formatting according to the average value.
DashboardFormatConditionComparisonTypeLists values used to specify the comparison logic used to apply conditional formatting.
DashboardFormatConditionTopBottomTypeLists values used to apply conditional formatting to top/bottom values.
DashboardFormatConditionValueTypeLists values used to specify the value type used in conditional formatting.
DashboardItemMasterFilterModeLists values that specify the selection mode of the master filter item.
DashboardLayoutGroupOrientationLists values that specify the orientation of layout items and groups within the group.
DashboardSettingsCompatibilityModeLists values that specify the DevExpress installation version.
DashboardTitleAlignmentLists values that specify the alignment of the dashboard title.
DashboardTreemapLayoutAlgorithmLists values that specify a layout algorithm used to arrange tiles of TreemapDashboardItem.
DashboardTreemapLayoutDirectionLists values that specify a layout direction used to arrange tiles of TreemapDashboardItem depending on their sizes.
DataItemNumericFormatTypeLists values that specify format types for numeric values.
DataItemNumericUnitLists values that specify numeric units.
DataProcessingModeLists values used to specify the data processing mode.
DataSourceFieldTypeLists values that specify the field type used for data items in a section.
DateFilterArrangementModeLists values used to specify how the DateFilter dashboard item arranges quick filter elements.
DateFilterTypeLists how the Date Filter range’s Start and End values can be interpreted to filter dates.
DateFormatLists values that specify format types for date values.
DatePickerLocationLists values used to specify the Date Picker’s location in the Date Filter.
DateTimeFormatLists values that specify format types for date-time values.
DateTimeGroupIntervalLists values that specify the group interval for date-time values.
DateTimeIntervalLists values that identify available date-time intervals for the FlowDateTimePeriodLimit.
DateTimePeriodFilterTypeLists values that identify filter types available in the Edit Periods dialog.
DayOfWeekFormatLists values that specify format types for days of the week.
DefaultColoringModeLists default coloring mode values.
DeltaIndicationModeLists values that specify types of indication displayed within delta elements.
DeltaIndicationThresholdTypeLists values that define how the comparison tolerance is specified.
DeltaValueTypeLists values that specify types of values displayed within delta elements.
DifferenceTargetLists values used to calculate differences in the DifferenceCalculation.
DifferenceTypeA difference type of the DifferenceCalculation.
DimensionSortModeLists the values that specify how dimension values should be sorted.
DimensionSortOrderLists values that specify the sort order for dimension values.
DimensionTopNModeLists values that specify whether the largest or smallest values should be displayed.
ExactDateFormatLists values that specify format types for DateTime and DateOnly values grouped using the DateTimeGroupInterval.None group interval.
ExactTimeFormatLists values that specify format types for TimeOnly values grouped using the DateTimeGroupInterval.None group interval.
ExcelExportFilterStateLists values that specify the filter state’s location in the exported Excel file.
ExtractUpdateResultLists values passed as a parameter to the action specified in the UpdateExtractDataSourcesAsync method overloads.
FormatConditionAppearanceTypeLists values used to specify style settings used in conditional formatting.
FormatConditionIconTypeLists values used to specify the icon used in conditional formatting.
FormatConditionIntersectionLevelModeLists values used to specify the level on which to apply conditional formatting to pivot cells.
FormatConditionRangeGradientPredefinedTypeLists predefined color gradients used to apply conditional formatting using value ranges.
FormatConditionRangeSetPredefinedTypeLists predefined styles used to apply conditional formatting using value ranges.
FormatRuleChartElementLists values that specify the chart element to which a format rule applies.
GaugeViewTypeLists values that specify types of gauges.
GridColumnFixedWidthTypeLists values that specify the mode used to manage the width of individual columns.
GridColumnTotalTypeLists values that specify the summary function used to calculate a total for the Grid column.
GridColumnWidthModeLists values that specify the mode used to manage grid column widths.
GridDeltaColumnDisplayModeLists values that specify how delta column values should be displayed.
GridDimensionColumnDisplayModeLists values that specify how dimension column values should be displayed.
GridMeasureColumnDisplayModeLists values that specify how measure column values should be displayed.
GridWindowDefinitionModeA window definition mode used to specify a window within the GridDashboardItem.
HourFormatLists values that specify format types for hours.
ImageDataBindingModeLists values that specify the data binding mode for the BoundImageDashboardItem.
ImageHorizontalAlignmentLists values that specify the horizontal alignment of an image displayed in the Image dashboard item.
ImageSizeModeLists values that specify how an image is positioned within an ImageDashboardItem or BoundImageDashboardItem.
ImageVerticalAlignmentLists values that specify the vertical alignment of an image displayed in the Image dashboard item.
IndicatorTypeLists values used to identify delta indicator types.
InspectedTypeLists values used to identify the data type in the Data Inspector.
LayoutDimensionModeLists values that specify how a dashboard surface‘s height or width is calculated.
ListBoxDashboardItemTypeLists values that specify the type of the List Box dashboard item.
LogarithmicBaseLists values used to specify a logarithmic base.
MapLegendOrientationLists the values that specify the legend orientation within the Map dashboard items.
MapLegendPositionLists the values that specify the legend position within a map.
MonthFormatLists values that specify format types for months.
OlapDataProviderTypeLists values that specify a data provider used to connect to the DashboardOlapDataSource.
OpenHighLowCloseSeriesTypeLists values that specify the types of Open-High-Low-Close series.
PieLegendPositionLists values that specify the position of the legend within the PieDashboardItem.
PieTypeLists values that identify PieDashboardItem types.
PieValueTypeLists values that identify types of PieDashboardItem values and combinations of these values.
PieWindowDefinitionModeA window definition mode used to specify a window within the PieDashboardItem.
PivotColumnTotalsPositionLists values that specify the position of column totals/grand totals in the Pivot dashboard item.
PivotLayoutTypeLists values that specify the layout type of the Pivot dashboard item.
PivotRowTotalsPositionLists values that specify the position of row totals/grand totals in the Pivot dashboard item.
PivotValuesPositionLists values that specify the position of headers used to arrange summary values corresponding to different measures.
PivotWindowDefinitionModeA window definition mode used to specify a window within the PivotDashboardItem.
PointLabelContentTypeLists values that identify types of content displayed within series point labels.
PointLabelContentTypeExLists values that identify types of content displayed within series point labels.
PointLabelOrientationLists values used to specify point label orientation.
PointLabelOverlappingModeLists values used to specify the mode to resolve series point label overlap.
PointLabelPositionLists values used to specify the point label position.
QuarterFormatLists values that specify format types for quarters.
RangeFilterWindowDefinitionModeA window definition mode used to specify a window within the RangeFilterDashboardItem.
RangeSeriesTypeLists values that specify the types of Range series.
RankOrderA rank order of the RankCalculation.
RankTypeA rank type of the RankCalculation.
ScatterPointLabelContentTypeLists values that identify types of content displayed within point labels.
ShapefileAreaLists values that specify default maps provided by the Dashboard.
SimpleSeriesTypeLists values that specify the types of Simple series.
SparklineViewTypeLists values used to specify sparkline view types.
SummaryTypeLists values that specify the summary function types.
TargetDimensionsLists values that specify data items for which interactivity actions can be performed in a Chart and Pie dashboard items.
TextGroupIntervalLists values that specify the group interval for string values.
TreemapValueTypeLists types of values displayed within labels/tooltips of TreemapDashboardItem.
WeightedLegendTypeLists values used to specify the type of weighted legend.
YearFormatLists values that specify format types for years.