Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EmbedBuilder<T>

The builder class for EmbedClient. Contains methods for defining the properties of embedded Looker content.

Type Parameters

  • T

Hierarchy

  • EmbedBuilder

Index

Properties

_allowAttrs: string[] = []
_appendTo: null | HTMLElement = null
_classNames: string[] = []
_dialogScroll?: boolean
_dynamicIFrameHeight?: boolean
_frameBorder: string = '0'
_handlers: CallbackStore = {}
_id?: string | number
_params: UrlParams
_sandboxAttrs: string[] = []
_sandboxedHost?: boolean
_scrollMonitor?: boolean
_suffix: string = ''
_url?: null | string

Accessors

  • get allowAttrs(): string[]
  • get apiHost(): string
  • get authUrl(): undefined | string
  • The auth URL of this embedded content, if provided

    deprecated

    Returns undefined | string

  • get classNames(): string[]
  • get dialogScroll(): undefined | boolean
  • get dynamicIFrameHeight(): undefined | boolean
  • get el(): HTMLElement
  • get endpoint(): string
  • get frameBorder(): string
  • get id(): undefined | string | number
  • get isCookielessEmbed(): boolean
  • get sandboxAttrs(): string[]
  • get scrollMonitor(): undefined | boolean
  • get suffix(): string
  • get type(): string
  • get url(): undefined | null | string
  • The content URL of this embedded content, if provided

    Returns undefined | null | string

Methods

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

    Parameters

    • el: string | HTMLElement

    Returns EmbedBuilder<T>

  • 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 EmbedBuilder<T>

  • Allows specifying classes for an embedded content

    Parameters

    • Rest ...className: string[]

      one or more sandbox attributes for an embedded content.

    Returns EmbedBuilder<T>

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

    Parameters

    • dialogScroll: boolean = true

      defaults to true

    Returns EmbedBuilder<T>

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

    Parameters

    • dynamicIFrameHeight: boolean = true

      defaults to true

    Returns EmbedBuilder<T>

  • Allows specifying next generation content

    Parameters

    • suffix: string = '-next'

      Next generation suffix. Defaults to '-next'.

    Returns EmbedBuilder<T>

  • 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 EmbedBuilder<T>

  • 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.

    Requires Looker >=23.6.0

    Parameters

    • monitor: boolean = true

      defaults to true

    Returns EmbedBuilder<T>

Generated using TypeDoc