Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LookerEmbedSDK

deprecated

Use getEmbedSDK() instead.

Hierarchy

  • LookerEmbedSDK

Index

Constructors

Methods

Constructors

constructor

Methods

Static createDashboardWithId

  • Create an EmbedBuilder for an embedded Looker dashboard.

    deprecated

    Use getEmbedSDK().createDashboardWithId(...) instead.

    Parameters

    • id: string | number

      The numeric ID of a Looker User Defined Dashboard, or LookML Dashboard ID

    Returns IEmbedBuilder

Static createDashboardWithUrl

  • Create an EmbedBuilder for an embedded Looker dashboard.

    deprecated

    Use getEmbedSDK().createDashboardWithUrl(...) instead.

    Parameters

    • url: string

      A signed SSO embed URL or embed URL for an already authenticated Looker user

    Returns IEmbedBuilder

Static createExploreWithId

  • Create an EmbedBuilder for an embedded Looker Explore.

    deprecated

    Use getEmbedSDK().createExploreWithId(...) instead.

    Parameters

    • id: string

      The ID of a Looker explore

    Returns IEmbedBuilder

Static createExploreWithUrl

  • Create an EmbedBuilder for an embedded Looker Explore.

    deprecated

    Use getEmbedSDK().createExploreWithUrl(...) instead.

    Parameters

    • url: string

      A signed SSO embed URL or embed URL for an already authenticated Looker user

    Returns IEmbedBuilder

Static createExtensionWithId

  • Create an EmbedBuilder for an embedded Looker extension. Requires Looker 7.12

    deprecated

    Use getEmbedSDK().createExtensionWithId(...) instead.

    Parameters

    • id: string

      The ID of a Looker Look

    Returns IEmbedBuilder

Static createExtensionWithUrl

  • Create an EmbedBuilder for an embedded Looker extension.

    deprecated

    Use getEmbedSDK().createExtensionWithUrl(...) instead.

    Parameters

    • url: string

      A signed SSO embed URL or embed URL for an already authenticated Looker user

    Returns IEmbedBuilder

Static createLookWithId

  • Create an EmbedBuilder for an embedded Looker dashboard.

    deprecated

    Use getEmbedSDK().createLookWithId(...) instead.

    Parameters

    • id: number

      The ID of a Looker Look

    Returns IEmbedBuilder

Static createLookWithUrl

  • Create an EmbedBuilder for an embedded Looker Look.

    deprecated

    Use getEmbedSDK().createLookWithUrl(...) instead.

    Parameters

    • url: string

      A signed SSO embed URL or embed URL for an already authenticated Looker user

    Returns IEmbedBuilder

Static init

  • Initialize the Embed SDK.

    deprecated

    Use getEmbedSDK().init(...) instead.

    Parameters

    • apiHost: string

      The address or base URL of the Looker host (example.looker.com:9999, https://example.looker.com:9999) This is required for verification of messages sent from the embedded content.

    • Optional auth: string | LookerAuthConfig

    Returns void

Static initCookieless

  • Initialize the Embed SDK to use a cookieless session.

    deprecated

    Use getEmbedSDK().initCookieless(...) instead.

    Parameters

    • apiHost: string

      The address or base URL of the host (example.looker.com:9999, https://example.looker.com:9999)

    • acquireSession: string | CookielessRequestInit | CookielessCallback

      is either a string containing a server endpoint that will acquire the embed session OR a RequestInfo object for a fetch call to the server endpoint that will acquire the embed session OR a callback that will invoke the server endpoint that will acquire the embed session. The server endpoint must ultimately call the Looker endpoint acquire_embed_cookieless_session.

    • generateTokens: string | CookielessRequestInit | CookielessCallback

      is either a string containing a server endpoint that will generate new tokens OR a RequestInfo object for a fetch call to the server endpoint that will generate new tokens OR a callback that will invoke the server endpoint that will generate new tokens. The server endpoint should ultimately call the Looker endpoint generate_tokens_for_cookieless_session.

      Looker 22.20+

    Returns void

Generated using TypeDoc