RangeFilterDashboardItem Class

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

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v18.1.Core.dll

Declaration

[DashboardItemType("RANGEFILTER")]
public class RangeFilterDashboardItem :
    SeriesDashboardItem,
    IDashboardComponent,
    IComponent,
    ISupportInitialize,
    IDisposable,
    IChangeService,
    ISupportPrefix,
    ICurrencyCultureNameProvider,
    ISliceDataQueryProvider,
    IDimensionAxes,
    IMasterFilter,
    IMasterFilterItem,
    IDataItemRepositoryProvider,
    IDataSourceSchemaProvider,
    IDataItemContainerContext,
    IDataItemContext,
    IColorSchemeContext,
    IFormatRulesContext,
    IFiltersProvider,
    IInteractivityOptionsProvider,
    IArgumentsDashboardItem,
    IDateTimePeriodContext
<DashboardItemType("RANGEFILTER")>
Public Class RangeFilterDashboardItem
    Inherits SeriesDashboardItem
    Implements IDashboardComponent,
               IComponent,
               ISupportInitialize,
               IDisposable,
               IChangeService,
               ISupportPrefix,
               ICurrencyCultureNameProvider,
               ISliceDataQueryProvider,
               IDimensionAxes,
               IMasterFilter,
               IMasterFilterItem,
               IDataItemRepositoryProvider,
               IDataSourceSchemaProvider,
               IDataItemContainerContext,
               IDataItemContext,
               IColorSchemeContext,
               IFormatRulesContext,
               IFiltersProvider,
               IInteractivityOptionsProvider,
               IArgumentsDashboardItem,
               IDateTimePeriodContext

The Range Filter allows end-users to apply filtering to other dashboard items. It displays a chart with selection thumbs above that allow you to filter out values displayed along the argument axis.

MainFeatures_RangeFilter

The following documentation is available.

Note

The Range Filter dashboard item cannot be bound to the OLAP data source.

Examples

The following example demonstrates how to bind a Range Filter dashboard item to data in code.

In this example, the Range Filter is used to apply filtering to a pivot dashboard item's data.

´╗┐Imports System
Imports System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess

Namespace Dashboard_CreateRangeFilter
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub
        Private Function CreateRangeFilter(ByVal dataSource As DashboardObjectDataSource) _
            As RangeFilterDashboardItem

            ' Creates a Range Filter dashboard item and specifies its data source.
            Dim rangeFilter As New RangeFilterDashboardItem()
            rangeFilter.DataSource = dataSource

            ' Creates a new series of the Area type and adds this series to the Series collection to
            ' display it within the Range Filter.
            Dim salesAmountSeries As New SimpleSeries(SimpleSeriesType.Area)
            rangeFilter.Series.Add(salesAmountSeries)

            ' Specifies a measure to provide data used to calculate the Y-coordinate of the data points.
            salesAmountSeries.Value = New Measure("Extended Price")

            ' Specifies a dimension to provide Range Filter argument values.
            rangeFilter.Argument = New Dimension("OrderDate")

            ' Specifies a group interval for argument values.
            rangeFilter.Argument.DateTimeGroupInterval = DateTimeGroupInterval.MonthYear

            Return rangeFilter
        End Function
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load

            ' Creates a dashboard and sets it as the currently opened dashboard in the dashboard viewer.
            dashboardViewer1.Dashboard = New Dashboard()

            ' Creates a data source and adds it to the dashboard data source collection.
            Dim dataSource As New DashboardObjectDataSource()
            dataSource.DataSource = (New nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData()
            dashboardViewer1.Dashboard.DataSources.Add(dataSource)

            ' Creates a Range Filter dashboard item with the specified data source 
            ' and adds it to the Items collection to display within the dashboard.
            Dim rangeFilter As RangeFilterDashboardItem = CreateRangeFilter(dataSource)
            dashboardViewer1.Dashboard.Items.Add(rangeFilter)

            ' Creates a pivot and adds it to the dashboard. 
            ' Range Filter applies filtering to pivot data.
            Dim pivot As PivotDashboardItem = CreatePivot(dataSource)
            dashboardViewer1.Dashboard.Items.Add(pivot)

            ' Reloads data in the data sources.
            dashboardViewer1.ReloadData()
        End Sub
    End Class
End Namespace

Inheritance

See Also