Class LookerEmbedExSDK

Hierarchy

LookerEmbedExSDK

Implements

ILookerEmbedSDK

Methods

clearSession

clearSession(): void

Implementation of ILookerEmbedSDK.clearSession
- Defined in src/LookerEmbedExSDK.ts:155
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

createDashboardWithId(id: string | number): IEmbedBuilder

Implementation of ILookerEmbedSDK.createDashboardWithId
- Defined in src/LookerEmbedExSDK.ts:185
Create an EmbedBuilder for an embedded Looker dashboard.

Parameters
- id: string | number
Returns IEmbedBuilder

createDashboardWithUrl

createDashboardWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createDashboardWithUrl
- Defined in src/LookerEmbedExSDK.ts:179
Create a builder the initially loads a Looker dasboard

Parameters
- url: string
Returns IEmbedBuilder

createExploreWithId

createExploreWithId(id: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createExploreWithId
- Defined in src/LookerEmbedExSDK.ts:195
Create an EmbedBuilder for an embedded Looker Explore.

Parameters
- id: string
Returns IEmbedBuilder

createExploreWithUrl

createExploreWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createExploreWithUrl
- Defined in src/LookerEmbedExSDK.ts:191
Create an EmbedBuilder for an embedded Looker Explore.

Parameters
- url: string
Returns IEmbedBuilder

createExtensionWithId

createExtensionWithId(id: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createExtensionWithId
- Defined in src/LookerEmbedExSDK.ts:234
Create an EmbedBuilder for an embedded Looker extension. Requires Looker 7.12

Parameters
- id: string
Returns IEmbedBuilder

createExtensionWithUrl

createExtensionWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createExtensionWithUrl
- Defined in src/LookerEmbedExSDK.ts:228
Create an EmbedBuilder for an embedded Looker extension.

Parameters
- url: string
Returns IEmbedBuilder

createLookWithId

createLookWithId(id: string | number): IEmbedBuilder

Implementation of ILookerEmbedSDK.createLookWithId
- Defined in src/LookerEmbedExSDK.ts:224
Create an EmbedBuilder for an embedded Looker look.

Parameters
- id: string | number
Returns IEmbedBuilder

createLookWithUrl

createLookWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createLookWithUrl
- Defined in src/LookerEmbedExSDK.ts:220
Create an EmbedBuilder for an embedded Looker Look.

Parameters
- url: string
Returns IEmbedBuilder

createMergeQueryWithId

createMergeQueryWithId(id: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createMergeQueryWithId
- Defined in src/LookerEmbedExSDK.ts:204
Create an EmbedBuilder for an embedded Looker Merge Query.

Parameters
- id: string
Returns IEmbedBuilder

createMergeQueryWithUrl

createMergeQueryWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createMergeQueryWithUrl
- Defined in src/LookerEmbedExSDK.ts:200
Create an EmbedBuilder for an embedded Looker Merge Query.

Parameters
- url: string
Returns IEmbedBuilder

createQueryVisualizationWithId

createQueryVisualizationWithId(id: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createQueryVisualizationWithId
- Defined in src/LookerEmbedExSDK.ts:246
Create an EmbedBuilder for an embedded Looker query visualization.

Parameters
- id: string
Returns IEmbedBuilder

createQueryVisualizationWithUrl

createQueryVisualizationWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createQueryVisualizationWithUrl
- Defined in src/LookerEmbedExSDK.ts:240
Create an EmbedBuilder for an embedded Looker query visualization.

Parameters
- url: string
Returns IEmbedBuilder

createQueryWithId

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

Implementation of ILookerEmbedSDK.createQueryWithId
- Defined in src/LookerEmbedExSDK.ts:214
Create an EmbedBuilder for an embedded Looker Query.

Parameters
- model: string
- view: string
- qid: string
Returns IEmbedBuilder

createQueryWithUrl

createQueryWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createQueryWithUrl
- Defined in src/LookerEmbedExSDK.ts:210
Create an EmbedBuilder for an embedded Looker Query.

Parameters
- url: string
Returns IEmbedBuilder

createReportWithId

createReportWithId(id: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createReportWithId
- Defined in src/LookerEmbedExSDK.ts:260
Create an EmbedBuilder for an embedded Looker report.

Parameters
- id: string
Returns IEmbedBuilder

createReportWithUrl

createReportWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createReportWithUrl
- Defined in src/LookerEmbedExSDK.ts:254
Create an EmbedBuilder for an embedded Looker re[prt].

Parameters
- url: string
Returns IEmbedBuilder

createWithUrl

createWithUrl(url: string): IEmbedBuilder

Implementation of ILookerEmbedSDK.createWithUrl
- Defined in src/LookerEmbedExSDK.ts:171
Create a builder that loads an embedded URL.

Parameters
- url: string
Returns IEmbedBuilder

init

init(apiHost: string, auth?: string | LookerAuthConfig): void

Implementation of ILookerEmbedSDK.init
- Defined in src/LookerEmbedExSDK.ts:133
Initialize the Embed SDK.

Parameters
- apiHost: string
- Optional auth: string | LookerAuthConfig
Returns void

initCookieless

initCookieless(apiHost: string, acquireSession: string | CookielessRequestInit | CookielessCallback, generateTokens: string | CookielessRequestInit | GenerateTokensCallback): void

Implementation of ILookerEmbedSDK.initCookieless
- Defined in src/LookerEmbedExSDK.ts:141
Initialize the Embed SDK to use a cookieless session.

Parameters
- apiHost: string
- acquireSession: string | CookielessRequestInit | CookielessCallback
- generateTokens: string | CookielessRequestInit | GenerateTokensCallback
Returns void

preload

preload(): IEmbedBuilder

Implementation of ILookerEmbedSDK.preload
- Defined in src/LookerEmbedExSDK.ts:167
Create an embed builder that preloads embedded Looker

Returns IEmbedBuilder

Generated using TypeDoc