Class RVDashboard

The class representing a Dashboard model."/>

Inheritance

System.Object

RVDashboard

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 RVDashboard

Constructors

RVDashboard()

Declaration

public RVDashboard()

RVDashboard(Stream)

Declaration

public RVDashboard(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream

RVDashboard(String)

Declaration

public RVDashboard(string path)

Parameters

Type	Name	Description
System.String	path

Properties

DateFilter

Backwards compatibility property. Assumes single date global filter. For scenarios with multiple date global filters, use DateFilters property instead. When setting a value, it will replace the first date global filter it finds, or add a new one if it finds none. When setting null as the value, it will delete the first date global filter it finds. Returns the first global filter available or null if there's none.

Declaration

[Obsolete("Use DateFilters property instead.")]
public RVDateDashboardFilter DateFilter { get; set; }

Property Value

Type	Description
RVDateDashboardFilter

Description

A description of the dashboard

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Filters

The list of filters in the dashboard. Dashboard filters can be used to apply filters to multiple widgets at the same time.

Declaration

public ReadOnlyObservableCollection<IRVDashboardFilter> Filters { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyObservableCollection<IRVDashboardFilter>

HasPendingChanges

Returns true if the user made changes to the dashboard that were not saved yet.

Declaration

public bool HasPendingChanges { get; }

Property Value

Type	Description
System.Boolean

Title

The name or title of the dashboard

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Visualizations

The list of visualizations in the dashboard.

Declaration

public ReadOnlyObservableCollection<RVVisualization> Visualizations { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyObservableCollection<RVVisualization>

Methods

DateFilterChanged(RVDateDashboardFilter)

Declaration

public void DateFilterChanged(RVDateDashboardFilter filter)

Parameters

Type	Name	Description
RVDateDashboardFilter	filter

ExportToJson()

Exports the dashboard to JSON formatted string.

Declaration

public string ExportToJson()

Returns

Type	Description
System.String	JSON formatted representation of the dashboard.

GetThumbnailImage(Double, Double)

Returns an image with the thumbnail of this dashboard with the specified size.

Declaration

public ImageSource GetThumbnailImage(double width, double height)

Parameters

Type	Name	Description
System.Double	width	Width of the output image
System.Double	height	Height of the output image

Returns

Type	Description
System.Windows.Media.ImageSource	an image with the thumbnail of this dashboard with the specified size

LoadDashboardAsync(Stream)

Loads dashboard from a Stream.

Declaration

public static Task<RVDashboard> LoadDashboardAsync(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream, from which the dashboard should be loaded.

Returns

Type	Description
System.Threading.Tasks.Task<RVDashboard>	The loaded dashboard.

LoadDashboardAsync(String)

Loads dashboard from a path on the disk.

Declaration

public static Task<RVDashboard> LoadDashboardAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path on the dist to the rdash file to be loaded.

Returns

Type	Description
System.Threading.Tasks.Task<RVDashboard>	The loaded dashboard.

LoadFromJsonAsync(String)

Loads dashboard from a JSON formatted string.

Declaration

public static Task<RVDashboard> LoadFromJsonAsync(string json)

Parameters

Type	Name	Description
System.String	json	The JSON string, from which the dashboard should be loaded.

Returns

Type	Description
System.Threading.Tasks.Task<RVDashboard>	The loaded dashboard.

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