Class RVDashboardFilter

Class used to represent a dashboard filter

Inheritance
System.Object
RVDashboardFilter
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public class RVDashboardFilter : IRVDashboardFilter

Constructors

RVDashboardFilter(IDashboardDocument, GlobalFilter)

Declaration
public RVDashboardFilter(IDashboardDocument dashboard, GlobalFilter filterModel)
Parameters
Type Name Description
Infragistics.IDashboardDocument dashboard
Infragistics.ReportPlus.DashboardModel.GlobalFilter filterModel

RVDashboardFilter(String, IEnumerable<Object>)

Declaration
public RVDashboardFilter(string fieldName, IEnumerable<object> values)
Parameters
Type Name Description
System.String fieldName
System.Collections.Generic.IEnumerable<System.Object> values

Properties

DataSourceItem

Data Source Item where this filter is getting the data from.

Declaration
public RVDataSourceItem DataSourceItem { get; }
Property Value
Type Description
Reveal.Sdk.Data.RVDataSourceItem

Id

The ID of the filter.

Declaration
public string Id { get; }
Property Value
Type Description
System.String

The ID of the filter.

SelectedValues

Get/set the filter's selected values. No items in the enumeration means all available values are selected. To retrieve the available values for the filter see GetFilterValuesAsync(CancellationToken)

Declaration
public IEnumerable<object> SelectedValues { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Object>

Title

The title of the filter.

Declaration
public string Title { get; }
Property Value
Type Description
System.String

The title of the filter.

Methods

GetFilterValuesAsync(CancellationToken)

Method used to get the possible values for a given filter. For a Country filter, this will return the list of all countries, not only the selected ones. You can use this method to create your own UI to select filter values.

Declaration
public Task<IEnumerable<RVFilterValue>> GetFilterValuesAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

Optional parameter that can be used to cancel the asynchronous operation
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<RVFilterValue>>

The list of values for the given filter
See Also

RaisePropertyChanged(String)

Declaration
protected void RaisePropertyChanged(string propertyName)
Parameters
Type Name Description
System.String propertyName

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged
IRVDashboardFilter