Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILookerEmbedSDK

Hierarchy

  • ILookerEmbedSDK

Implemented by

Index

Methods

Methods

clearSession

  • clearSession(): void

  • Clears all session data currently being tracked by the SDK. Use when it is desirable to modify or change the existing user for signed or cookieless sessions. Has little to no impact for private embed sessions.

    Returns void

createDashboardWithId

  • Create an EmbedBuilder for an embedded Looker dashboard.

    Parameters

    • id: string | number

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

    Returns IEmbedBuilder

createDashboardWithUrl

  • Create a builder the initially loads a Looker dasboard

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createExploreWithId

  • Create an EmbedBuilder for an embedded Looker Explore.

    Parameters

    • id: string

      The ID of a Looker explore

    Returns IEmbedBuilder

createExploreWithUrl

  • Create an EmbedBuilder for an embedded Looker Explore.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createExtensionWithId

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

    Parameters

    • id: string

      The ID of a Looker Look

    Returns IEmbedBuilder

createExtensionWithUrl

  • Create an EmbedBuilder for an embedded Looker extension.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createLookWithId

  • Create an EmbedBuilder for an embedded Looker look.

    Parameters

    • id: string | number

      The ID of a Looker Look

    Returns IEmbedBuilder

createLookWithUrl

  • Create an EmbedBuilder for an embedded Looker Look.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createMergeQueryWithId

  • Create an EmbedBuilder for an embedded Looker Merge Query.

    Parameters

    • id: string

      The ID of a Looker explore

    Returns IEmbedBuilder

createMergeQueryWithUrl

  • Create an EmbedBuilder for an embedded Looker Merge Query.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createQueryVisualizationWithId

  • Create an EmbedBuilder for an embedded Looker query visualization.

    Parameters

    • id: string

      The ID of a Looker query visualization

    Returns IEmbedBuilder

createQueryVisualizationWithUrl

  • Create an EmbedBuilder for an embedded Looker query visualization.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createQueryWithId

  • createQueryWithId(model: string, view: string, qid: string): IEmbedBuilder

  • Create an EmbedBuilder for an embedded Looker Query.

    Parameters

    • model: string
    • view: string
    • qid: string

    Returns IEmbedBuilder

createQueryWithUrl

  • Create an EmbedBuilder for an embedded Looker Query.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createReportWithId

  • Create an EmbedBuilder for an embedded Looker report.

    Parameters

    • id: string

      The ID of a Looker report

    Returns IEmbedBuilder

createReportWithUrl

  • Create an EmbedBuilder for an embedded Looker re[prt].

    Parameters

    • url: string

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

    Returns IEmbedBuilder

createWithUrl

  • Create a builder that loads an embedded URL.

    Parameters

    • url: string

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

    Returns IEmbedBuilder

init

initCookieless

  • Initialize the Embed SDK to use a cookieless session.

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

      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.

    Returns void

preload

Generated using TypeDoc