The requested page is not available for the requested platform. You are viewing the content for Default platform.

DevExpress.Dashboard.Model Module

Contains classes and members that comprise the Dashboard object model. Provides API to perform the actions available for end-users in client UI.

Explore the DevExpress Dashboard object model starting with the Dashboard class. Examine its properties for more information on the available functionality and related objects.

Classes

Name Description
AbsoluteVariationNumericFormat

Provides access to the format settings for absolute variation values.

AppearanceSettings
AutoColorSchemeEntry
BarStyleSettings
BoundImageItem

A Bound Image dashboard item.

BubbleMapItem

A Bubble Map dashboard item that allows you to place bubbles on the map using geographical coordinates.

CalculatedField

A calculated field that allows you to apply complex expressions to data fields obtained from the data source.

Calculation
Card

A card(s) displayed within the CardItem.

CardCenteredLayoutTemplate

The Centered layout template used to center card elements so that they occupy a specified width/height.

CardCompactLayoutTemplate

The Compact layout template used to arrange card elements so that they occupy the minimum area.

CardCustomLayoutTemplate

The Custom layout template that allows you to create a card layout manually.

CardDeltaOptions
CardEmptyLayoutTemplate

An empty layout template for a card.

CardItem

A Card dashboard item that displays a series of KPI elements (cards), each illustrating the difference between two values.

CardLayout

Contains settings related to the layout of cards for the CardItem.

CardLayoutPropertyTypeSelectorModel
CardLayoutTemplate

Serves as the base for classes that define a layout template for the CardItem.

CardLayoutTemplateDataElement

A visual element within a card layout that displays bound data in text form.

CardLayoutTemplateDeltaElement

A visual element within a card layout that displays delta.

CardLayoutTemplateElementBase

Serves as the base class for visual elements within a card layout.

CardLayoutTemplateSparklineElement

A visual element within a card layout that displays sparkline.

CardLightweightLayoutTemplate

The Lightweight layout template that displays the minimum set of elements within a card.

CardRow

A row in the CardItem's layout.

CardRowBase

Serves as the base for classes that are rows in the CardItem's layout.

CardRowDataElement

A card element that displays bound data.

CardRowElement

Serves as the base for classes that are a card's visual elements.

CardRowIndicatorElement

A delta indicator within a card.

CardRowTextElement

A card element that displays static text.

CardRowTextElementBase

Serves as the base for classes that are card elements displaying text data.

CardSparklineRow

A sparkline row in the CardItem's layout.

CardStretchedLayoutTemplate

The Stretched layout template that arranges card elements so that they occupy an entire card area.

CardWindowDefinition
CellsItemFormatRule
ChartAxis

Serves as the base class for classes that represent chart axes.

ChartAxisX

The chart's X-axis.

ChartAxisY

The chart's Y-axis.

ChartInteractivityOptions

Contains options related to the specifics of Master Filtering and drill-down in the Chart and Pie dashboard items.

ChartItem

A Chart dashboard item that visualizes data in an XY-diagram.

ChartItemBase

Serves as the base class for chart dashboard items, such as the ChartItem and PieItem.

ChartLegend

A chart legend.

ChartPane

A chart pane.

ChartSecondaryAxisY

The chart's secondary Y-axis.

ChartSeries

Serves as the base class for chart series.

ChartWindowDefinition
ChoroplethMap

Serves as the base class for classes that provide values for different types of the ChoroplethMapItem.

ChoroplethMapItem

A Choropleth Map dashboard item that colors areas depending on the provided values.

Color
ColorSchemeDefinition
ColorSchemeEntry

A color scheme entry used to map the dimension values/measures and the specified color.

ComboBoxItem

A Combo Box dashboard item that allows end users to filter other dashboard items.

ComplexValue
ContextItem
CustomItem

A custom item that allows you to implement and embed any additional items into the Web Dashboard.

CustomItemWindowDefinition
CustomShapefile

A custom shapefile that is used to provide a map for the map dashboard items (such as Choropleth or Geo Point maps).

CustomShapefileData

Custom shapefile data.

Dashboard

Contains the full description of a dashboard used to visualize data.

DashboardItem

Serves as the base class for dashboard items.

DashboardItemBaseInteractivityOptions
DashboardItemColoringOptions
DashboardItemDrillDownInteractivityOptions
DashboardItemFormatRule

A format rule used to apply conditional formatting to dashboard items.

DashboardItemGroupInteractivityOptions
DashboardItemInteractivityOptions
DashboardItemMasterFilterInteractivityOptions
DashboardLayoutGroup

A layout group used to arrange layout items or other groups within a dashboard.

DashboardLayoutItem

A layout item that displays a dashboard item.

DashboardLayoutNode

Serves as the base class for layout items and groups.

DashboardLayoutRootGroup
DashboardLayoutTabContainer

A layout tab container used to arrange layout tab pages within a dashboard.

DashboardLayoutTabPage

A layout tab page used to arrange layout items and groups.

DashboardState

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.

DashboardTabItemInteractivityOptions
DashboardTabPage

A tab page in a TabContainerItem.

DashboardTitle

A dashboard title.

DataDashboardItem

Serves as the base class for data-bound dashboard items.

DataItem

Serves as the base class for data items - measures and dimensions.

DataItemDateTimeFormat
DataItemLink
DataItemNumericFormat
DataSource

A data source that provides data for the dashboard.

DateFilterItem

A Date Filter dashboard item that allows end users to filter other dashboard items by date-time values.

DateTimePeriod

A date-time period that is used to select a predefined range in the Range Filter and Date Filter items.

DeltaMap
DeltaOptions
DifferenceCalculation
Dimension

A dimension that is a DataItem whose values are used to categorize data.

DimensionKey
DisposableObject
DynamicListLookUpSettings
EFDataSource

An Entity Framework data source that provides data for the dashboard.

ExcelDataSource

A data source used to extract data from Microsoft Excel workbooks or CSV files.

ExtractDataSource

An extract data source that is a local snapshot of data.

FederationDataSource

A federated data source that retrieves data from different data sources.

FilterElementItemBase
FilterableDashboardItemInteractivityOptions

Contains options related to the specifics of Master Filtering in the dashboard items that can be filtered.

FixedDateTimePeriodLimit

A fixed date-time value used to specify boundaries for the DateTimePeriod.

FlowDateTimePeriodLimit

A floating date-time value used to specify boundaries for the DateTimePeriod.

FormatConditionAverage

A format condition used to apply formatting according to the average value.

FormatConditionBar

A format condition used to visualize numeric values using bars.

FormatConditionBarOptions

Contains options related to format conditions that use a bar to visualize numeric values.

FormatConditionBase

Serves as a base for classes that represent format conditions used to apply formatting.

FormatConditionColorRangeBar

A format condition used to visualize numeric values using bars whose colors are contained in the specified color set.

FormatConditionConverter
FormatConditionDateOccurring

A format condition used to apply formatting to date-time values concerning a specific date and/or date interval relative to today.

FormatConditionExpression

A format condition used to apply formatting according to the specified expression.

FormatConditionGradientRangeBar

A format condition used to visualize numeric values using bars whose colors are contained in the specified color gradient.

FormatConditionMinMaxBase

Serves as the base class for classes that provides the capability to specify minimum/maximum values used in visualizing numeric data.

FormatConditionRangeBase

Serves as a base for classes that are used to apply conditional formatting using value ranges.

FormatConditionRangeGenerator
FormatConditionRangeGradient

A format condition used to apply formatting using value ranges and a specified color gradient.

FormatConditionRangeSet

A format condition used to apply formatting using value ranges and corresponding style settings.

FormatConditionStyleBase

Serves as a base for classes used to apply conditional formatting by modifying style settings.

FormatConditionTopBottom

A format condition used to apply formatting to top/bottom values.

FormatConditionValue

A format condition used to apply formatting according to predefined values.

Gauge
GaugeItem

A Gauge dashboard item that visualizes data within a series of KPI elements (gauges).

GaugeWindowDefinition
GeoPointMapItem

A Geo Point Map dashboard item that allows you to place callouts on the map using geographical coordinates.

GeoPointMapItemBase

Serves as the base class for Map dashboard items that visualize data based on the geographical coordinates.

GridColumn

Serves as the base for classes that represent grid columns.

GridColumnTotal

A total calculated based on Grid column values.

GridDeltaColumn

A delta column in a GridItem.

GridDimensionColumn

A dimension column in a GridItem.

GridHyperlinkColumn

A hyperlink column in a GridItem.

GridItem

A Grid dashboard item that visualizes data in tabular form.

GridItemFormatRule
GridMeasureColumn

A measure column in a GridItem.

GridOptions

Contains options of the GridItem.

GridSparklineColumn

A sparkline column in a GridItem.

GridWindowDefinition
GroupItem

A group used to arrange dashboard items within a dashboard.

HighLowCloseSeries

A High-Low-Close series.

IconSettings
ImageItem

An Image dashboard item that displays static images.

ItemState
KpiElement

Serves as the base for classes that provide data for card and gauge dashboard items.

KpiItem
LimitContainer
ListBoxItem

A List Box dashboard item that allows end users to filter other dashboard items.

LookUpValue
MapItem
MapLegend
MapLegendBase
MapViewport
Measure

A measure which is a DataItem whose values are summarized before they are used in the dashboard.

MeasureCalculation
MeasureCalculationWindowDefinition
MeasureDefinition
MovingCalculation
ObjectDataSource

An object data source that provides data for the dashboard.

OlapDataSource

An OLAP data source that provides data for the dashboard.

OpenHighLowCloseSeries

An Open-High-Low-Close series.

Parameter

A dashboard parameter.

PercentOfTargetNumericFormat
PercentOfTotalCalculation
PercentVariationNumericFormat
PieItem

A Pie dashboard item that displays a series of pies or donuts.

PieMapItem

A Pie Map dashboard item that allows you to place pies on the map using geographical coordinates.

PieWindowDefinition
PivotItem

A Pivot dashboard item that displays cross-tabular reports.

PivotItemFormatRule
PivotItemFormatRuleLevel
PivotWindowDefinition
PointLabelOptions

Contains options related to series point labels.

PointLabelOptionsBase

Serves as the base for classes containing options related to chart point labels.

QueryNode
RangeFilterItem

A Range Filter dashboard item that allows end-users to apply filtering to other dashboard items.

RangeFilterSelection
RangeFilterState
RangeFilterWindowDefinition
RangeIndexSettings
RangeInfo
RangeSeries

A Range series.

RangeSet
RankCalculation
RunningTotalCalculation
ScatterChartAxisY
ScatterChartItem

A Scatter Chart dashboard item that visualizes relationships between numerical variables.

ScatterPointLabelOptions

Contains options related to point labels of a scatter chart.

ScatterWindowDefinition
SerializableModel
SeriesItem
SimpleSeries

A Simple series.

SliceTable
Source
SparklineOptions

Contains options used to control the sparkline appearance.

SpecificWindowDefinition
SqlConnection
SqlDataSource

An SQL data source that provides data for the dashboard.

StaticListLookUpSettings
StyleSettingsBase
TabContainerItem

A tab container used to arrange dashboard items and groups within a dashboard.

TextBoxItem

A Text Box dashboard item used to display rich text within a dashboard.

TreeViewItem

A Tree View dashboard item that allows end users to filter other dashboard items.

TreemapItem

A Treemap dashboard item that allows you to display large amounts of hierarchically structured (tree-structured) data.

TypedSerializableModel
ValueMap
WeightedLegend
WeightedSeries

A Weighted series that allow you to visualize data in three dimensions.

WindowDefinition

Interfaces

Name Description
IBindingProperty
ICustomDataRow

When implemented, represents a custom data row.

ICustomItemBinding

When implemented, represents a data binding used to provide data for the dashboard item.

ICustomItemBindingValue

When implemented, represents a data binding.

ICustomItemMetaData

When implemented, represents a custom item model.

ICustomItemProperty

When implemented, represents a custom property used to configure a custom item.

IDimensionDefinition
IDimensionValue
IDisposable
IStyleList

Enums

Name Description
FilterDateType
FormatConditionIconGroups
FormatConditionRangeGradientPredefinedType

Lists predefined color gradients used to apply conditional formatting using value ranges.

FormatConditionRangeSetPredefinedType

Lists predefined styles used to apply conditional formatting using value ranges.

PointLabelContentType

Variables

Name Description
PointLabelContentTypeDictionary
getPointLabelContentTypeValues
itemTypesMap
parsePointLabelContentType
serializePointLabelContentType

Type Aliases

Name Description
CardLayoutTemplateType
CardRowDataElementType

Lists values that identify the type of a value displayed within a card layout row.

CardWindowDefinitionMode

A window definition mode used to specify a window within the CardDashboardItem.

ChartLegendInsidePosition
ChartLegendOutsidePosition
ChartWindowDefinitionMode
ColoringMode
ComboBoxDashboardItemType

Lists values that specify the type of the Combo Box dashboard item.

ContentArrangementMode
DashboardFormatCondition

Lists values specifying comparison operators used to apply conditional styles.

DashboardFormatConditionAboveBelowType
DashboardFormatConditionComparisonType
DashboardFormatConditionTopBottomType
DashboardFormatConditionValueType
DashboardLayoutGroupOrientation
DashboardTitleAlignment
DashboardTreemapLayoutAlgorithm
DashboardTreemapLayoutDirection
DataItemNumericFormatType
DataItemNumericUnit
DataItemType
DataType
DateFilterArrangementMode

Lists values used to specify how the Date Filter dashboard item arranges quick filter elements.

DateFilterType

Lists how the Date Filter range's Start and End values can be interpreted to filter dates.

DateFormat
DateOccurringFilterDateType
DatePickerLocation

Lists values used to specify the Date Picker's location in the Date Filter.

DateTimeFormat
DateTimeGroupInterval

Lists values that specify the group interval for date-time values.

DateTimeInterval
DayOfWeekFormat
DeltaIndicationMode
DeltaIndicationThresholdType
DeltaValueType
DifferenceTarget
DifferenceType
DimensionSortMode
DimensionSortOrder
DimensionTopNMode
DisposableType
ExactDateFormat
FontStyle
FormatConditionAppearanceType
FormatConditionIconType
FormatConditionIntersectionLevelMode
GaugeViewType
GridColumnFixedWidthType
GridColumnTotalType
GridColumnValueBarDisplayMode
GridColumnWidthMode
GridDimensionColumnDisplayMode

Lists values that specify how dimension column values should be displayed.

GridMeasureColumnDisplayMode
GridWindowDefinitionMode
HourFormat
ImageDataBindingMode
ImageHorizontalAlignment
ImageSizeMode
ImageVerticalAlignment
LayoutItemInsertPosition
ListBoxDashboardItemType

Lists values that specify the type of the List Box dashboard item.

LogarithmicBase

Lists values used to specify a logarithmic base.

MapLegendOrientation
MapLegendPosition
MasterFilterValues

Contains values that are used to select elements in the master filter item.

MonthFormat
OpenHighLowCloseSeriesType

Lists values that specify the types of Open-High-Low-Close series.

PieValueType
PieWindowDefinitionMode
PivotColumnTotalsPosition
PivotLayoutType
PivotRowTotalsPosition
PivotValuesPosition
PivotWindowDefinitionMode
PointLabelOrientation

Lists values used to specify point label orientation.

PointLabelOverlappingMode
PointLabelPosition

Lists values used to specify the point label position.

QuarterFormat
RangeFilterWindowDefinitionMode
RangeSeriesType

Lists values that specify the types of Range series.

RankOrder
RankType
ScatterPointLabelContentType

Lists values that identify types of content displayed within point labels.

ShapefileArea

Lists values that specify default maps provided by the dashboard.

SimpleSeriesType

Lists values that specify the types of Simple series.

SparklineViewType
SummaryType
TargetDimensions
TextGroupInterval
TreemapValueType
WeightedLegendType
YearFormat