Class RVVisualizationFilter
Inheritance
Implements
Inherited Members
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public class RVVisualizationFilter
Constructors
RVVisualizationFilter(String, RVFilterType, IEnumerable<FilterValue>, RVVisualization, QuickFilter, Nullable<RVDateFilterType>, RVDateRange)
Create a visualization filter based on a tabular data source.
Declaration
public RVVisualizationFilter(string fieldName, RVFilterType filterType, IEnumerable<FilterValue> selectedValues, RVVisualization visualization, QuickFilter filterModel, RVDateFilterType? dateRuleType, RVDateRange dateRange)
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | Name of the field that the filter applies to |
RVFilterType | filterType | Type of filter |
System.Collections.Generic.IEnumerable<Infragistics.ReportPlus.DashboardModel.FilterValue> | selectedValues | List of selected values |
RVVisualization | visualization | Visualization the the filter is linked to |
Infragistics.ReportPlus.DashboardModel.QuickFilter | filterModel | Model object representing the filter |
System.Nullable<RVDateFilterType> | dateRuleType | Type of rule for date filters having type "Filter By Rule" |
RVDateRange | dateRange | Date range for date filters having type "Filter By Rule" and rule type "Date Range" |
RVVisualizationFilter(String, RVFilterType, IEnumerable<FilterValue>, RVVisualization, XmlaDimensionElement, Nullable<RVDateFilterType>, RVDateRange)
Create a visualization filter based on an XMLA data source.
Declaration
public RVVisualizationFilter(string fieldName, RVFilterType filterType, IEnumerable<FilterValue> selectedValues, RVVisualization visualization, XmlaDimensionElement xmlaFilterModel, RVDateFilterType? dateRuleType, RVDateRange dateRange)
Parameters
Type | Name | Description |
---|---|---|
System.String | fieldName | Name of the field that the filter applies to |
RVFilterType | filterType | Type of filter |
System.Collections.Generic.IEnumerable<Infragistics.ReportPlus.DashboardModel.FilterValue> | selectedValues | List of selected values |
RVVisualization | visualization | Visualization the the filter is linked to |
Infragistics.ReportPlus.DashboardModel.XmlaDimensionElement | xmlaFilterModel | Model object representing the filter |
System.Nullable<RVDateFilterType> | dateRuleType | Type of rule for date filters having type "Filter By Rule" |
RVDateRange | dateRange | Date range for date filters having type "Filter By Rule" and rule type "Date Range" |
Fields
DateRange
Date range for date filters having type "Filter By Rule" and rule type "Date Range".
Declaration
public readonly RVDateRange DateRange
Field Value
Type | Description |
---|---|
RVDateRange |
DateRuleType
Type of rule for date filters having type "Filter By Rule".
Declaration
public readonly RVDateFilterType? DateRuleType
Field Value
Type | Description |
---|---|
System.Nullable<RVDateFilterType> |
FieldName
Name of the field that the filter applies to. For all purposes this is used as an Id, since it's guaranteed to be unique per visualization.
Declaration
public readonly string FieldName
Field Value
Type | Description |
---|---|
System.String |
FilterType
Type of the filter (All Values, Filter Empty Values, Selected Values, Filter By Rule).
Declaration
public readonly RVFilterType FilterType
Field Value
Type | Description |
---|---|
RVFilterType |
Properties
SelectedValues
Get/set the filter's selected values. No items in the enumeration means all available values are selected. To check what the values for the filter see GetFilterValuesAsync(CancellationToken)
Declaration
public IEnumerable<RVFilterValue> SelectedValues { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<RVFilterValue> |
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
Notify of changes in the filter's properties.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type | Description |
---|---|
System.ComponentModel.PropertyChangedEventHandler |