Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LookerEmbedDashboard

Client that communicates with an embedded Looker dashboard. Messages are documented here

Hierarchy

Index

Methods

Methods

edit

  • edit(): void

loadDashboard

  • loadDashboard(id: string, pushHistory?: boolean): Promise<void>

  • Convenience method for loading a new dashboard. Requires Looker 7.12 and Dashboards Next (see EmbedBuilder.withNext). Throws an error if the dashboard load did not happen, which can happen if the current dashboard is in edit mode.

    Parameters

    • id: string

      The ID of the dashboard to load

    • pushHistory: boolean = false

      Whether to push the new page onto history. Default is false.

    Returns Promise<void>

openScheduleDialog

  • openScheduleDialog(): Promise<void>

run

  • run(): void

send

  • send(message: string, params?: any): void

  • Send a message to the embedded content.

    Parameters

    • message: string

      String message identifier.

    • Optional params: any

      Additional parameters to be sent to the client. After transmission ownership of the parameters is transferred to the embedded Explore.

    Returns void

sendAndReceive

  • sendAndReceive(message: string, params?: any): Promise<any>

  • Send a message to the embedded content and resolve with a response

    Parameters

    • message: string

      String message identifier.

    • Optional params: any

      Additional parameters to be sent to the client. After transmission ownership of the parameters is transferred to the embedded Explore.

    Returns Promise<any>

setOptions

stop

  • stop(): void

updateFilters

Generated using TypeDoc