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

Accessors

Methods

Properties

Private _allowAttrs

_allowAttrs: string[] = []

Private _appendTo

_appendTo: null | HTMLElement = null

Private _classNames

_classNames: string[] = []

Private Optional _dialogScroll

_dialogScroll?: boolean

Private Optional _dynamicIFrameHeight

_dynamicIFrameHeight?: boolean

Private _frameBorder

_frameBorder: string = '0'

Private _handlers

_handlers: CallbackStore = {}

Private Optional _id

_id?: string | number

Private _params

_params: UrlParams

Private _sandboxAttrs

_sandboxAttrs: string[] = []

Private Optional _sandboxedHost

_sandboxedHost?: boolean

Private Optional _scrollMonitor

_scrollMonitor?: boolean

Private _suffix

_suffix: string = ''

Private Optional _url

_url?: null | string

Accessors

acquireSession

allowAttrs

  • get allowAttrs(): string[]

apiHost

  • get apiHost(): string

auth

authUrl

  • get authUrl(): undefined | string

  • The auth URL of this embedded content, if provided

    deprecated

    Returns undefined | string

classNames

  • get classNames(): string[]

dialogScroll

  • get dialogScroll(): undefined | boolean

dynamicIFrameHeight

  • get dynamicIFrameHeight(): undefined | boolean

el

  • get el(): HTMLElement

endpoint

  • get endpoint(): string

frameBorder

  • get frameBorder(): string

generateTokens

id

  • get id(): undefined | string | number

isCookielessEmbed

  • get isCookielessEmbed(): boolean

sandboxAttrs

  • get sandboxAttrs(): string[]

scrollMonitor

  • get scrollMonitor(): undefined | boolean

suffix

  • get suffix(): string

type

  • get type(): string

url

  • get url(): undefined | null | string

  • The content URL of this embedded content, if provided

    Returns undefined | null | string

Methods

appendTo

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

    Parameters

    • el: string | HTMLElement

    Returns EmbedBuilder<T>

build

on

withAllowAttr

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

withApiHost

withAuth

withAuthUrl

withClassName

  • Allows specifying classes for an embedded content

    Parameters

    • Rest ...className: string[]

      one or more sandbox attributes for an embedded content.

    Returns EmbedBuilder<T>

withDialogScroll

  • 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

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

withFilters

withFrameBorder

withNext

  • Allows specifying next generation content

    Parameters

    • suffix: string = '-next'

      Next generation suffix. Defaults to '-next'.

    Returns EmbedBuilder<T>

withParams

withSandboxAttr

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

withScrollMonitor

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

withTheme

Generated using TypeDoc