Class RVDashboard

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

Index

Properties

Accessors

Methods

Properties

onDateFilterChanged: ((dateFilter: RVDateDashboardFilter | null) => void) | null = null

This event is triggered when the date filter was modified.

onFiltersChanged: ((filters: IRVDashboardFilter[]) => void) | null = null

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

onHasPendingChangesChanged: ((hasPendingChanges: boolean) => void) | null = null

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

onTitleChanged: ((newTitle: string) => void) | null = null

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

onVisualizationsChanged: ((visualizations: RVVisualization[]) => void) | null = null

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

Accessors

  • get dashboardId(): string | null

    The id of the dashboard.

    Returns string | null

  • get description(): string

    The description of the dashboard.

    Returns string

  • set description(text: string): void

    The description of the dashboard.

    Parameters

    • text: string

    Returns void

  • get hasPendingChanges(): boolean

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

    Returns boolean

  • get title(): string

    The name or title of the dashboard.

    Returns string

  • set title(text: string): void

    The name or title of the dashboard.

    Parameters

    • text: string

    Returns void

Methods

  • Loads the dashboard

    Parameters

    • dashboardId: string

    Returns Promise<RVDashboard>

  • Loads the dashboard

    Parameters

    • dashboardId: string
    • onSuccess: (dashboard: RVDashboard) => void

    Returns void

  • Loads the dashboard

    Parameters

    • dashboardId: string
    • onSuccess: (dashboard: RVDashboard) => void
    • onError: (msg: string) => void

    Returns void

  • Parameters

    • dashboardId: string

    Returns Promise<RVDashboard>

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

  • Loads the dashboard from container

    Parameters

    • blob: Blob

    Returns Promise<RVDashboard>

  • Loads the dashboard from container

    Parameters

    • blob: Blob
    • onSuccess: (dashboard: RVDashboard) => void
    • onError: (msg: string) => void

    Returns void