Class Dashboard
An immutable representation of a Dashboard. Could be instantiated by Stream of a .rdash file or by providing JSON string representation of the model.
Inheritance
Namespace: Reveal.Sdk
Assembly: Infragistics.Reveal.SDK.Server.dll
Syntax
public class Dashboard : ObjectConstructors
Dashboard(Byte[])
Creates a dashboard from byte array.
Declaration
public Dashboard(byte[] array)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | array | Array representing rdash definition of a dashboard. |
Dashboard(Stream)
Creates a Dashboard object out of Stream of an .rdash file.
Declaration
public Dashboard(Stream stream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | stream | A stream of an .rdash file |
Dashboard(String)
Creates a dashboard from file system path.
Declaration
public Dashboard(string filePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filePath | File system path of the .rdash files. |
Methods
FromJsonString(String)
Creates a dashboard object out of json formatted string.
Declaration
public static Dashboard FromJsonString(string jsonString)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | jsonString | Json formatted string. |
Returns
| Type | Description |
|---|---|
| Dashboard | A Dashboard or null in case of failure. |
GetInfoAsync(String)
Gets the DashboardInfo which should be used to render the RevealDashboardThumbnailView. You need to send the object to the client and set RevealDashboardThumbnailView.dashboardInfo to be this .Info property.
Declaration
public Task<DashboardInfo> GetInfoAsync(string dashboardId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | dashboardId |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<DashboardInfo> |
GetModelAsync()
For internal use only.
Declaration
public Task<DashboardModel> GetModelAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Infragistics.ReportPlus.DashboardModel.DashboardModel> |
SaveToFileAsync(String)
Saves the dashboard to a file.
Declaration
public Task SaveToFileAsync(string filePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filePath | The path the file where the dashboard(rdash) should be saved. If the file exists it will be overridden. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
ToByteArrayAsync()
Asynchronously serializes the dashboard object to .rdash byte array.
Declaration
public Task<byte[]> ToByteArrayAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Byte[]> | Rdash file as byte array. |
ToJsonStringAsync()
Asynchronously serializes the dashboard object to json formatter string.
Declaration
public Task<string> ToJsonStringAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | Json formatted representation of the dashboard. |
ToStreamAsync()
Asynchronously serializes the dashboard object to .rdash stream.
Declaration
public Task<Stream> ToStreamAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.IO.Stream> | Stream of an .rdash representation of the dashboard. |