Skip to main content
All docs
V25.1
  • DashboardViewer.GetAvailableFilterValuesAsync(String) Method

    Gets the data (axis point tuples) that identifies selectable elements in the current state of the master filter item.

    Namespace: DevExpress.DashboardWin

    Assembly: DevExpress.Dashboard.v25.1.Win.dll

    NuGet Package: DevExpress.Win.Dashboard

    Declaration

    public Task<IList<AxisPointTuple>> GetAvailableFilterValuesAsync(
        string dashboardItemName
    )

    Parameters

    Name Type Description
    dashboardItemName String

    A String that is the component name of the master filter item.

    Returns

    Type Description
    Task<IList<AxisPointTuple>>

    The task object that is the asynchronous operation to get a list of AxisPointTuple objects.

    Example

    This example demonstrates how to work in asynchronous mode to get filter values, set the master filter and perform an asynchronous task when the dashboard is loaded for the first time.

    Click Random Filter to get available filters and apply a random filter asynchronously.

    win-async-random-filter-example

    using DevExpress.DashboardCommon.ViewerData;
    using DevExpress.XtraEditors;
    using System;
    using System.Collections.Generic;
    using System.Threading.Tasks;
    using System.Windows.Forms;
    
    namespace RandomFilterExample
    {
        public partial class ViewerForm1 : XtraForm {
            public ViewerForm1() {
                InitializeComponent();
                dashboardViewer1.Initialized += OnDashboardViewerInitialized;
    
            }
            async void OnMouseClick(object sender, MouseEventArgs e) {
                await RandomFilter();
            }
            async Task RandomFilter() {
                string itemName = "choroplethMapDashboardItem1";
                IList<AxisPointTuple> filters = await dashboardViewer1.GetAvailableFilterValuesAsync(itemName);
                Random r = new Random();
                int index = r.Next(0, filters.Count - 1);
                await dashboardViewer1.SetMasterFilterAsync(itemName, filters[index]);
            }
    
            async void OnDashboardViewerInitialized(object sender, EventArgs e) {
                await RandomFilter();
            }
        }
    }
    
    See Also