Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IEmbedBuilder

Embed client/connection builder

Hierarchy

Index

Methods

  • Select an element to append the embedded content to, either a content selector or the DOM element.

    Parameters

    • el: string | HTMLElement

    Returns IEmbedBuilder

  • Constructs the embedded content, including creating the DOM element that contains the content.

    Returns IEmbedClient

  • 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

  • If private embed, appends allow_login_screen=true to the URL. This will be ignored if the SDK is initialized with auth or cookieless. willAllowLoginScreen does NOT work with Looker Core.

    Returns IEmbedBuilder

  • Allows auth url to be specified

    Parameters

    • authUrl: string

      URL to endpoint that can sign Looker SSO URLs

    Returns IEmbedBuilder

  • Allows specifying classes for an embedded content

    Parameters

    • Rest ...className: string[]

      one or more sandbox attributes for an embedded content.

    Returns IEmbedBuilder

  • Listens for covering dialogs being opened in the Looker IFRAME and scrolls the top of dialog into view.

    Parameters

    • Optional dialogScroll: boolean

      defaults to true

    Returns IEmbedBuilder

  • withDynamicIFrameHeight(dynamicIFrameHeight?: boolean): IEmbedBuilder
  • Listens for page changed events from the embedded Looker IFRAME and updates the height of the IFRAME.

    Parameters

    • Optional dynamicIFrameHeight: boolean

      defaults to true

    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.

    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