All
  • Public
  • Public/Protected
  • All

Class RevealUtility

Utility class used to load dashboards.

Hierarchy

  • RevealUtility

Index

Methods

Methods

Static generateUID

  • generateUID(): string

  • Generates a new universal identifier.

    Returns string

    a generated UID

Static loadDashboard

  • loadDashboard(dashboardId: string, onSuccess: function, onError: function): 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: function

      A callback that will receive an instance of $.ig.RVDashboard class if the loading was successful.

    • onError: function

      A callback with the error message if the loading operation failed.

        • (msg: string): void

        • Parameters

          • msg: string

          Returns void

    Returns void

Static loadDashboardFromContainer

  • loadDashboardFromContainer(blob: Blob, onSuccess: function, onError: function, 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: function

      A callback that will receive an instance of $.ig.RVDashboard class if the loading was successful.

    • onError: function

      A callback with the error message if the loading operation failed.

        • (msg: string): void

        • Parameters

          • msg: string

          Returns void

    • Optional dashboardId: string

    Returns void