Class RVDateDashboardFilter

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

Inheritance

System.Object

RVDateDashboardFilter

Implements

IRVDashboardFilter

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 : IRVDashboardFilter

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

RVDateDashboardFilter(RVDateRange)

Creates a new date filter with the specified custom range/>

Declaration

public RVDateDashboardFilter(RVDateRange customRange)

Parameters

Type	Name	Description
RVDateRange	customRange

RVDateDashboardFilter(RVDateRule)

Creates a new date filter with the specified rule./>

Declaration

public RVDateDashboardFilter(RVDateRule rule)

Parameters

Type	Name	Description
RVDateRule	rule	Date rule to use for the filter

RVDateDashboardFilter(String, RVDateFilterType)

Creates a new date filter with the specified filter type. This constructor should not be used with CustomRange.

Declaration

public RVDateDashboardFilter(string title, RVDateFilterType filterType)

Parameters

Type	Name	Description
System.String	title	Filters title
RVDateFilterType	filterType	The filter type to use in the filter

RVDateDashboardFilter(String, 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(string title, RVDateFilterType filterType, RVDateRange customRange)

Parameters

Type	Name	Description
System.String	title	Filters title
RVDateFilterType	filterType
RVDateRange	customRange

RVDateDashboardFilter(String, RVDateRange)

Creates a new date filter with the specified custom range/>

Declaration

public RVDateDashboardFilter(string title, RVDateRange customRange)

Parameters

Type	Name	Description
System.String	title	Filters title
RVDateRange	customRange

Properties

DateFilterType

The legacy date rule used for filtering. Eg. YearToDate, MonthToDate, CustomRange, etc.

Declaration

[Obsolete]
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. If set to a non-null value, it will null out the filter's CustomRule property.

Declaration

public RVDateRange Range { get; set; }

Property Value

Type	Description
RVDateRange	The date range used for filtering.

Rule

The date rule used for filtering. If set to a non-null value, it will null out the filter's CustomDateRange property.

Declaration

public RVDateRule Rule { get; set; }

Property Value

Type	Description
RVDateRule

Title

The title of the filter.

Declaration

public string Title { get; }

Property Value

Type	Description
System.String	The title of the filter.

Implements

IRVDashboardFilter