All
  • Public
  • Public/Protected
  • All

Class RVDashboard

The class representing a Dashboard model. To get an instance of this class you could use:

Hierarchy

  • RVDashboard

Index

Properties

Accessors

Methods

Properties

onDateFilterChanged

onDateFilterChanged: null | function = null

This event is triggered when the date filter was modified.

onFiltersChanged

onFiltersChanged: null | function = null

This event is triggered when the list of filters has changed because a filter was added or removed.

onHasPendingChangesChanged

onHasPendingChangesChanged: null | function = null

This event is triggered when the hasPendingChanges flag has changed its value.

onTitleChanged

onTitleChanged: null | function = null

This event is triggered when the the title of the dashboard is changed was added/removed or updated.

onVisualizationsChanged

onVisualizationsChanged: null | function = null

This event is triggered when the list of visualizations has changed because a visualization was added/removed or updated.

Accessors

dashboardId

  • get dashboardId(): null | string

  • The id of the dashboard.

    Returns null | string

dateFilter

  • The date global filter configured in this dashboard, null if no date filter is configured. Setting the date filter is only supported when the dashboard has a date filter defined. You can change the currently selected value of a date filter. En error is thrown if you try to set a filter to a dashboard which does not have one defined or setting it to null if there is date filter in the dashboard.

    Returns null | RVDateDashboardFilter

  • The date global filter configured in this dashboard, null if no date filter is configured. Setting the date filter is only supported when the dashboard has a date filter defined. You can change the currently selected value of a date filter. En error is thrown if you try to set a filter to a dashboard which does not have one defined or setting it to null if there is date filter in the dashboard.

    Parameters

    Returns void

description

  • get description(): string
  • set description(text: string): void

  • The description of the dashboard.

    Returns string

  • The description of the dashboard.

    Parameters

    • text: string

    Returns void

filters

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

    Returns FiltersArray

hasPendingChanges

  • get hasPendingChanges(): boolean

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

    Returns boolean

title

  • get title(): string
  • set title(text: string): void

  • The name or title of the dashboard.

    Returns string

  • The name or title of the dashboard.

    Parameters

    • text: string

    Returns void

visualizations

Methods

Static loadDashboard

  • loadDashboard(dashboardId: string): Promise<RVDashboard>
  • loadDashboard(dashboardId: string, onSuccess: function): void
  • loadDashboard(dashboardId: string, onSuccess: function, onError: function): void

  • Loads the dashboard

    Parameters

    • dashboardId: string

    Returns Promise<RVDashboard>

  • Parameters

    • dashboardId: string
    • onSuccess: function

    Returns void

  • Parameters

    • dashboardId: string
    • onSuccess: function
    • onError: function
        • (msg: string): void

        • Parameters

          • msg: string

          Returns void

    Returns void

Static loadDashboardAsync

  • loadDashboardAsync(dashboardId: string): Promise<RVDashboard>
  • @deprecated

    Loads the dashboard asynchronously. Please use the loadDashboard method, as this method will be removed in a future release.

    Parameters

    • dashboardId: string

    Returns Promise<RVDashboard>

Static loadDashboardFromContainer

  • loadDashboardFromContainer(blob: Blob): Promise<RVDashboard>
  • loadDashboardFromContainer(blob: Blob, onSuccess: function, onError: function): void

  • Loads the dashboard from container

    Parameters

    • blob: Blob

    Returns Promise<RVDashboard>

  • Parameters

    • blob: Blob
    • onSuccess: function
    • onError: function
        • (msg: string): void

        • Parameters

          • msg: string

          Returns void

    Returns void