Class RevealSettings

The class used to configure a new RevealView instance, including the dashboard to render and properties to control the different features of the product (like , , etc.)

Inheritance

System.Object

RevealSettings

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 RevealSettings

Constructors

RevealSettings()

Creates a new instance of the settings class with the dashboard that must be rendered in the view.

Declaration

public RevealSettings()

Properties

DateFilter

The initial date filter to use when rendering the dashboard for the first time. Please note the dashboard needs to be defined with a date filter, if not this attribute will be ignored. After the RevealView object is created the date filter might be updated using Reveal.Sdk.RevealView.SetDateFilter(Reveal.Sdk.RVDateDashboardFilter).

Declaration

public RVDateDashboardFilter DateFilter { get; set; }

Property Value

Type	Description
RVDateDashboardFilter

Methods

GetFilterSelectedValues(String)

Returns the list of selected values for the given filter previously set using SetFilterSelectedValues(RVDashboardFilter, List<Object>). Please note this method will return only those selections previously set, it does not return selections stored in the dashboard.

Declaration

public List<object> GetFilterSelectedValues(string filterId)

Parameters

Type	Name	Description
System.String	filterId	the ID of the filter to return the values for, as returned by Id

Returns

Type	Description
System.Collections.Generic.List<System.Object>	The list of selected values for the given filter previously set using SetFilterSelectedValues(RVDashboardFilter, List<Object>).

SetFilterSelectedValues(RVDashboardFilter, List<Object>)

Sets the initially selected values for the given filter.

Declaration

public void SetFilterSelectedValues(RVDashboardFilter filter, List<object> values)

Parameters

Type	Name	Description
RVDashboardFilter	filter	The filter to set the selection to. It might be obtained from Filters or
System.Collections.Generic.List<System.Object>	values	The array of selected values containing the new selection for the filter, like ['United States', 'France'].