Class RevealUtility

Utility class used to load dashboards.

Index

Methods

generateUID
getDashboardInfo
loadDashboard
loadDashboardFromContainer

Methods

`Static`generateUID

generateUID(): string
Generates a new universal identifier.

Returns string
a generated UID

`Static`getDashboardInfo

getDashboardInfo(dashboardId: string): Promise<any>
Fetches the dashboard info for the given dashboard ID from the server. The returned object contains id, displayName, and info properties. To render a thumbnail for a dashboard, use RVThumbnail.fromDashboard instead.
Parameters
- dashboardId: string
  The ID of the dashboard.
Returns Promise<any>
A promise that resolves with the dashboard info object, or null if the dashboard was not found.

`Static`loadDashboard

loadDashboard(dashboardId: string): Promise<RVDashboard>
Loads the dashboard with the given ID from the standard endpoint in the server.
Parameters
- dashboardId: string
  The ID of the dashboard to open, this ID will be received in the server: IRevealSdkContext.GetDashboardAsync
Returns Promise<RVDashboard>
loadDashboard(
    dashboardId: string,
    onSuccess: (dashboard: RVDashboard) => void,
    onError: (msg: string) => void,
): void
Loads the dashboard with the given ID from the standard endpoint in the server.
Parameters
- dashboardId: string
  The ID of the dashboard to open, this ID will be received in the server: IRevealSdkContext.GetDashboardAsync
- onSuccess: (dashboard: RVDashboard) => void
  A callback that will receive an instance of RVDashboard class if the loading was successful.
- onError: (msg: string) => void
  A callback with the error message if the loading operation failed.
Returns void

`Static`loadDashboardFromContainer

loadDashboardFromContainer(blob: Blob): Promise<RVDashboard>
Loads a dashboard from the Blob object with the contents of a .rdash file.
Parameters
- blob: Blob
  The Blob object containing the binary contents of the dashboard in rdash file format.
Returns Promise<RVDashboard>
loadDashboardFromContainer(
    blob: Blob,
    onSuccess: (dashboard: RVDashboard) => void,
    onError: (msg: string) => void,
    dashboardId?: string,
): void
Loads a dashboard from the Blob object with the contents of a .rdash file.
Parameters
- blob: Blob
  The Blob object containing the binary contents of the dashboard in rdash file format.
- onSuccess: (dashboard: RVDashboard) => void
  A callback that will receive an instance of RVDashboard class if the loading was successful.
- onError: (msg: string) => void
  A callback with the error message if the loading operation failed.
- OptionaldashboardId: string
Returns void