Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EmbedBuilder

Convenience type to aid migration from Looker 1.8.x to 2.0.0. In 1.8 this is a class that is treated as a type.

deprecated

use IEmbedBuilder

Hierarchy

Index

Methods

  • Allows specifying allow attributes (for example fullscreen) for an embedded content iframe.

    Parameters

    • Rest ...attr: string[]

      one or more allow attributes for an embedded content iframe.

    Returns IEmbedBuilder

  • withDynamicIFrameHeight(dynamicIFrameHeight?: boolean): IEmbedBuilder
  • In the event of a dashboard:tile:merge event the embed SDK will inititate a flow to seamlessly handle it within the existing page. The flow is as follows:

    1. The existing IFRAME is hidden.
    2. A new IFRAME is created using the merge query edit URL
    3. Once the edit page is loaded, the hidden IFRAME is destroyed.

    This is okay to do as the user is returned to the dashboard edit on save or cancel or the merged query edit. Note that the options allow the embedding application to control what happens should the dashboard have unsaved changes. If no options are provided any unsaved changes will be lost.

    Parameters

    Returns IEmbedBuilder

  • deprecated

    dashboards legacy was was replaced by dashboards next. The -next suffix has no impact aside from the overhead of redirecting to /dashboards. Please remove. The current implementation is a noop.

    Parameters

    • Optional _: string

    Returns IEmbedBuilder

  • Allows specifying sandbox attributes for an embedded content iframe. Sandbox attributes should include allow-scripts or embedded content will not execute.

    Parameters

    • Rest ...attr: string[]

      one or more sandbox attributes for an embedded content iframe.

    Returns IEmbedBuilder

  • Monitors scroll position and informs the embedded Looker IFRAME of the current scroll position and the offset of the containing IFRAME within the window. Looker uses this information to position dialogs within the users viewport.

    Parameters

    • Optional monitor: boolean

      defaults to true

    Returns IEmbedBuilder

Generated using TypeDoc