Class RVDateDashboardFilter

Class representing the optional date filter defined in a dashboard model.

Inheritance
System.Object
RVDateDashboardFilter
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 RVDateDashboardFilter

Constructors

RVDateDashboardFilter(RVDateFilterType)

Creates a new date filter with the specified filter type, this constructor should not be used with CustomRange

Declaration
public RVDateDashboardFilter(RVDateFilterType filterType)
Parameters
Type Name Description
RVDateFilterType filterType

The filter type to use in the filter

RVDateDashboardFilter(RVDateFilterType, RVDateRange)

Creates a new date filter with the specified type and custom range, this is the constructor that should be used with CustomRange

Declaration
public RVDateDashboardFilter(RVDateFilterType filterType, RVDateRange customRange)
Parameters
Type Name Description
RVDateFilterType filterType
RVDateRange customRange

Properties

DateFilterType

The type of date filter, like YearToDate, MonthToDate, CustomRange, etc.

Declaration
public RVDateFilterType DateFilterType { get; }
Property Value
Type Description
RVDateFilterType

The type of date filter, like YearToDate, MonthToDate, CustomRange, etc.

Id

The ID of the filter.

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

Range

The date range used for filtering, when DateFilterType is CustomRange it returns the custom range configured in the filter, when set to another filter type, it returns the range calculated from the configured filter type.

Declaration
public RVDateRange Range { get; set; }
Property Value
Type Description
RVDateRange

The date range used for filtering.