Class Dashboard<S>

constructor

• new Dashboard<S>(conn, id): Dashboard<S>

• Type Parameters

  • S extends Schema

  Parameters

  • conn: Connection<S>
  • id: string

  Returns Dashboard<S>

_conn

del

delete

id

clone

• clone(config, folderId?): Promise<DashboardMetadata>

• Clone a dashboard

  Parameters

  • config: string | {
        folderId?: string;
        name: string;
    }
  • Optional folderId: string

  Returns Promise<DashboardMetadata>

components

• components(componentIds?): Promise<DashboardResult>

• Get details about dashboard components

  Parameters

  • Optional componentIds: string | string[]

  Returns Promise<DashboardResult>

describe

• describe(): Promise<DashboardMetadata>

• Describe dashboard metadata

  Returns Promise<DashboardMetadata>

  Method

  Analytics~Dashboard#describe

destroy

• destroy(): Promise<void>

• Destroy a dashboard

  Returns Promise<void>

refresh

• refresh(): Promise<DashboardRefreshResult>

• Refresh a dashboard

  Returns Promise<DashboardRefreshResult>

status

• status(): Promise<DashboardStatusResult>

• Get dashboard status

  Returns Promise<DashboardStatusResult>