DevExpress.Dashboard.Model Module
Contains classes and members that comprise the Dashboard object model. Provides API to perform the actions that are available to users in client UI.
#Classes
Name | Description |
---|---|
Absolute |
Provides access to the format settings for absolute variation values. |
Appearance |
Contains style settings used to apply conditional formatting by changing appearance settings. |
Auto |
|
Bar |
|
Bound |
A Bound Image dashboard item. |
Bubble |
A Bubble Map dashboard item that allows you to place bubbles on the map using geographical coordinates. |
Calculated |
A calculated field that allows you to apply complex expressions to data fields obtained from the data source. |
Calculation | |
Card |
A card |
Card |
The Centered layout template used to center card elements so that they occupy a specified width/height. |
Card |
The Compact layout template used to arrange card elements so that they occupy the minimum area. |
Card |
The Custom layout template that allows you to create a card layout manually. |
Card |
|
Card |
An empty layout template for a card. |
Card |
|
Card |
A Card dashboard item that displays a series of KPI elements (cards), each illustrating the difference between two values. |
Card |
|
Card |
|
Card |
|
Card |
Contains settings related to the layout of cards for the Card |
Card |
Serves as the base for classes that define a layout template for the Card |
Card |
A visual element within a card layout that displays bound data in text form. |
Card |
A visual element within a card layout that displays delta. |
Card |
Serves as the base class for visual elements within a card layout. |
Card |
A visual element within a card layout that displays sparkline. |
Card |
The Lightweight layout template that displays the minimum set of elements within a card. |
Card |
A row in the Card |
Card |
Serves as the base for classes that are rows in the Card |
Card |
A card element that displays bound data. |
Card |
Serves as the base for classes that are a card’s visual elements. |
Card |
A delta indicator within a card. |
Card |
A card element that displays static text. |
Card |
Serves as the base for classes that are card elements displaying text data. |
Card |
A sparkline row in the Card |
Card |
The Stretched layout template that arranges card elements so that they occupy an entire card area. |
Card |
|
Cells |
|
Chart |
Serves as the base class for classes that represent chart axes. |
Chart |
The chart’s X-axis. |
Chart |
The chart’s Y-axis. |
Chart |
Contains settings for Trend Indicators of the Chart dashboard item. |
Chart |
Contains options related to the specifics of Master Filtering and drill-down in the Chart and Pie dashboard items. |
Chart |
A Chart dashboard item that visualizes data in an XY-diagram. |
Chart |
Serves as the base class for chart dashboard items, such as the Chart |
Chart |
|
Chart |
|
Chart |
A chart legend. |
Chart |
A chart pane. |
Chart |
The chart’s secondary Y-axis. |
Chart |
Serves as the base class for chart series. |
Chart |
|
Choropleth |
Serves as the base class for classes that provide values for different types of the Choropleth |
Choropleth |
A Choropleth Map dashboard item that colors areas depending on the provided values. |
Color | An ARGB (alpha, red, green, blue) color. |
Color |
|
Color |
A color scheme entry used to map the dimension values/measures and the specified color. |
Color |
|
Combo |
A Combo Box dashboard item that allows end users to filter other dashboard items. |
Complex |
|
Context |
|
Custom |
A custom item that allows you to implement and embed any additional items into the Web Dashboard. |
Custom |
|
Custom |
|
Custom |
A custom shapefile that is used to provide a map for the map dashboard items (such as Choropleth or Geo Point maps). |
Custom |
Custom shapefile data. |
Dashboard | Contains the full description of a dashboard used to visualize data. |
Dashboard |
Serves as the base class for dashboard items. |
Dashboard |
|
Dashboard |
Contains dashboard item coloring options. |
Dashboard |
|
Dashboard |
A format rule used to apply conditional formatting to dashboard items. |
Dashboard |
|
Dashboard |
|
Dashboard |
|
Dashboard |
A layout group used to arrange layout items or other groups within a dashboard. |
Dashboard |
A layout item that displays a dashboard item. |
Dashboard |
Serves as the base class for layout items and groups. |
Dashboard |
|
Dashboard |
A layout tab container used to arrange layout tab pages within a dashboard. |
Dashboard |
A layout tab page used to arrange layout items and groups. |
Dashboard |
A data container for changes resulting from end-user interaction - selected master filter values, drill-down levels, selected dashboard item layers and current parameter values. |
Dashboard |
|
Dashboard |
A tab page in a Tab |
Dashboard |
A dashboard title. |
Data |
Serves as the base class for data-bound dashboard items. |
Data |
Serves as the base class for data items - measures and dimensions. |
Data |
Serves as the base class for data item containers. |
Data |
Contains formatting settings for date-time values. |
Data |
For internal use. |
Data |
Contains format settings for numeric values. |
Data |
A data source that provides data for the dashboard. |
Date |
A Date Filter dashboard item that allows end users to filter other dashboard items by date-time values. |
Date |
A date-time period that is used to select a predefined range in the Range Filter and Date Filter items. |
Delta |
|
Delta |
|
Difference |
|
Dimension |
A dimension that is a Data |
Dimension |
|
Disposable |
|
Dynamic |
|
EFData |
An Entity Framework data source that provides data for the dashboard. |
Excel |
A data source used to extract data from Microsoft Excel workbooks or CSV files. |
Extract |
An extract data source that is a local snapshot of data. |
Federation |
A federated data source that retrieves data from different data sources. |
Filterable |
Contains options related to the specifics of Master Filtering in the dashboard items that can be filtered. |
Filter |
|
Fixed |
A fixed date-time value used to specify boundaries for the Date |
Flow |
A floating date-time value used to specify boundaries for the Date |
Format |
A format condition used to apply formatting according to the average value. |
Format |
A format condition used to visualize numeric values using bars. |
Format |
Contains options related to format conditions that use a bar to visualize numeric values. |
Format |
Serves as a base for classes that represent format conditions used to apply formatting. |
Format |
A format condition used to visualize numeric values using bars whose colors are contained in the specified color set. |
Format |
|
Format |
A format condition used to apply formatting to date-time values concerning a specific date and/or date interval relative to today. |
Format |
A format condition used to apply formatting according to the specified expression. |
Format |
A format condition used to visualize numeric values using bars whose colors are contained in the specified color gradient. |
Format |
Serves as the base class for classes that provides the capability to specify minimum/maximum values used in visualizing numeric data. |
Format |
Serves as a base for classes that are used to apply conditional formatting using value ranges. |
Format |
|
Format |
A format condition used to apply formatting using value ranges and a specified color gradient. |
Format |
A format condition used to apply formatting using value ranges and corresponding style settings. |
Format |
Serves as a base for classes used to apply conditional formatting by modifying style settings. |
Format |
A format condition used to apply formatting to top/bottom values. |
Format |
A format condition used to apply formatting according to predefined values. |
Gauge | |
Gauge |
A Gauge dashboard item that visualizes data within a series of KPI elements (gauges). |
Gauge |
|
Geo |
A Geo Point Map dashboard item that allows you to place callouts on the map using geographical coordinates. |
Geo |
Serves as the base class for Map dashboard items that visualize data based on the geographical coordinates. |
Grid |
Serves as the base for classes that represent grid columns. |
Grid |
Contains settings of the column filters that allow users to search data in the Grid item. |
Grid |
A total calculated based on Grid column values. |
Grid |
A delta column in a Grid |
Grid |
A dimension column in a Grid |
Grid |
A hyperlink column in a Grid |
Grid |
A Grid dashboard item that visualizes data in tabular form. |
Grid |
|
Grid |
A measure column in a Grid |
Grid |
Contains options of the Grid |
Grid |
A sparkline column in a Grid |
Grid |
|
Group |
A group used to arrange dashboard items within a dashboard. |
High |
A High-Low-Close series. |
Icon |
|
Image |
An Image dashboard item that displays static images. |
Item |
Contains states of individual dashboard items displayed in the dashboard. |
Json |
A data source that retrieves data stored in JSON format. |
Kpi |
Serves as the base for classes that provide data for card and gauge dashboard items. |
Kpi |
|
Layout |
Contains settings that allow you to adjust the height and width of a dashboard surface. |
Layout |
Contains dashboard layout settings. |
Limit |
|
List |
A List Box dashboard item that allows end users to filter other dashboard items. |
Look |
Look-up values used in the dashboard parameters. |
Map |
|
Map |
|
Map |
|
Map |
|
Measure |
A measure which is a Data |
Measure |
|
Measure |
|
Measure |
|
Mongo |
|
Mongo |
|
Moving |
|
Object |
An object data source that provides data for the dashboard. |
Olap |
An OLAP data source that provides data for the dashboard. |
Open |
An Open-High-Low-Close series. |
Parameter | A dashboard parameter. |
Percent |
|
Percent |
|
Percent |
|
Pie |
A Pie dashboard item that displays a series of pies or donuts. |
Pie |
A Pie Map dashboard item that allows you to place pies on the map using geographical coordinates. |
Pie |
|
Pivot |
A Pivot dashboard item that displays cross-tabular reports. |
Pivot |
|
Pivot |
|
Pivot |
|
Point |
Contains options related to series point labels. |
Point |
Serves as the base for classes containing options related to chart point labels. |
Query |
|
Range |
A Range Filter dashboard item that allows end-users to apply filtering to other dashboard items. |
Range |
A range in the Range Filter dashboard item. |
Range |
A state of the Range Filter and Date Filter dashboard items. |
Range |
|
Range |
|
Range |
|
Range |
A Range series. |
Range |
|
Rank |
|
Running |
|
Scatter |
|
Scatter |
A Scatter Chart dashboard item that visualizes relationships between numerical variables. |
Scatter |
|
Scatter |
Contains options related to point labels of a scatter chart. |
Scatter |
|
Serializable |
|
Series |
|
Simple |
A Simple series. |
Slice |
|
Source | |
Sparkline |
Contains options used to control the sparkline appearance. |
Specific |
|
Sql |
|
Sql |
An SQL data source that provides data for the dashboard. |
Static |
|
Style |
Serves as the base for classes providing style settings used to apply conditional formatting. |
Tab |
A tab container used to arrange dashboard items and groups within a dashboard. |
Text |
A Text Box dashboard item used to display rich text within a dashboard. |
Treemap |
A Treemap dashboard item that allows you to display large amounts of hierarchically structured (tree-structured) data. |
Tree |
A Tree View dashboard item that allows end users to filter other dashboard items. |
Typed |
|
Value |
|
Weighted |
|
Weighted |
A Weighted series that allow you to visualize data in three dimensions. |
Window |
|
Xpo |
Retrieves data from XPO (e |
#Interfaces
Name | Description |
---|---|
Custom |
A custom property definition. |
IBinding |
When implemented, represents a data binding used to provide data for the dashboard item. |
ICustom |
When implemented, represents a custom data row. |
ICustom |
When implemented, represents a data binding used to provide data for the custom dashboard item. |
ICustom |
When implemented, represents a data binding. |
ICustom |
When implemented, represents a custom item model. |
ICustom |
When implemented, represents a custom property used to configure a custom item. |
IDimension |
|
IDimension |
|
IDisposable | |
IStyle |
#Enums
Name | Description |
---|---|
Filter |
|
Format |
|
Format |
Lists predefined color gradients used to apply conditional formatting using value ranges. |
Format |
Lists predefined styles used to apply conditional formatting using value ranges. |
Point |
#Variables
Name |
---|
item |
Point |
#Functions
Name | Description |
---|---|
current |
|
get |
|
parse |
|
register |
Registers the custom property definition. |
serialize |
#Type Aliases
#Remarks
Explore the DevExpress Dashboard object model starting with the Dashboard class. Examine its properties for more information on the available functionality and related objects.