@thoughtspot/visual-embed-sdk 1.30.0-alpha.1 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +0 -15
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +2 -13
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +0 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +0 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/config.d.ts +0 -1
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +0 -2
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/embed/app.d.ts +0 -49
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +0 -8
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +0 -6
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +0 -7
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -1
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +0 -2
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +0 -2
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +0 -30
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +0 -5
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +2 -18
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +0 -5
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +0 -11
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +0 -2
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +0 -33
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +0 -3
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +1 -31
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +6 -37
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/index.d.ts +0 -1
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +0 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +0 -1
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +0 -1
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -12
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -11
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +14 -2
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/test/test-utils.d.ts +0 -2
- package/cjs/src/test/test-utils.d.ts.map +1 -1
- package/cjs/src/test/test-utils.js +0 -2
- package/cjs/src/test/test-utils.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +0 -1
- package/cjs/src/tokenizedFetch.d.ts.map +1 -1
- package/cjs/src/tokenizedFetch.js +0 -1
- package/cjs/src/tokenizedFetch.js.map +1 -1
- package/cjs/src/types.d.ts +19 -337
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +18 -264
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +0 -1
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +0 -1
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +19 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +2 -14
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +43 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/cjs/src/utils/graphql/graphql-request.js +2 -1
- package/cjs/src/utils/graphql/graphql-request.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +0 -1
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +0 -2
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +0 -9
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +0 -11
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +0 -15
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +0 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/config.d.ts +0 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +0 -49
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +0 -6
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +0 -2
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +0 -30
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +2 -18
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +0 -11
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +0 -33
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +1 -31
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +0 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +0 -1
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -12
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +0 -2
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/tokenizedFetch.d.ts +0 -1
- package/dist/src/tokenizedFetch.d.ts.map +1 -1
- package/dist/src/types.d.ts +19 -337
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +0 -1
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +0 -1
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +0 -9
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +2030 -2380
- package/dist/tsembed-react.js +1871 -2217
- package/dist/tsembed.es.js +3443 -3790
- package/dist/tsembed.js +6371 -6710
- package/dist/visual-embed-sdk-react-full.d.ts +24 -550
- package/dist/visual-embed-sdk-react.d.ts +24 -550
- package/dist/visual-embed-sdk.d.ts +23 -538
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +0 -15
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +3 -14
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +0 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +0 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/config.d.ts +0 -1
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +0 -2
- package/lib/src/config.js.map +1 -1
- package/lib/src/embed/app.d.ts +0 -49
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +0 -8
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +0 -6
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +0 -7
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +0 -2
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +0 -2
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +0 -30
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/sage.d.ts +2 -18
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +0 -5
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +0 -11
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +0 -2
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +0 -33
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +0 -3
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -31
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +9 -40
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/index.d.ts +0 -1
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +0 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +0 -1
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +0 -1
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -12
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +1 -11
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +15 -3
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +0 -2
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +0 -2
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +0 -1
- package/lib/src/tokenizedFetch.d.ts.map +1 -1
- package/lib/src/tokenizedFetch.js +0 -1
- package/lib/src/tokenizedFetch.js.map +1 -1
- package/lib/src/types.d.ts +19 -337
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +18 -264
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +0 -1
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +0 -1
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +1 -1
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +18 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +2 -14
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +44 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/lib/src/utils/graphql/graphql-request.js +2 -1
- package/lib/src/utils/graphql/graphql-request.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +0 -1
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +0 -2
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +0 -9
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +0 -11
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +24 -539
- package/package.json +1 -1
- package/src/auth.ts +6 -23
- package/src/authToken.ts +0 -1
- package/src/config.ts +0 -2
- package/src/embed/app.ts +0 -49
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +0 -7
- package/src/embed/embedConfig.ts +0 -2
- package/src/embed/liveboard.ts +1 -38
- package/src/embed/sage.ts +2 -18
- package/src/embed/search-bar.tsx +0 -11
- package/src/embed/search.ts +0 -33
- package/src/embed/ts-embed.ts +38 -72
- package/src/index.ts +0 -1
- package/src/mixpanel-service.ts +0 -1
- package/src/react/index.spec.tsx +47 -59
- package/src/react/index.tsx +1 -12
- package/src/test/test-utils.ts +0 -2
- package/src/tokenizedFetch.ts +0 -1
- package/src/types.ts +19 -337
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/authService/authService.ts +0 -1
- package/src/utils/graphql/answerService/answer-queries.ts +19 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +53 -1
- package/src/utils/graphql/answerService/answerService.ts +2 -14
- package/src/utils/graphql/graphql-request.ts +2 -1
- package/src/utils/processTrigger.ts +0 -2
- package/src/utils.ts +0 -11
package/cjs/src/types.js
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
* Copyright (c) 2023
|
|
4
4
|
*
|
|
5
5
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
6
|
-
*
|
|
7
6
|
* @summary Type definitions for Embed SDK
|
|
8
7
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
9
8
|
*/
|
|
@@ -12,7 +11,6 @@ exports.LogLevel = exports.ContextMenuTriggerOptions = exports.PrefetchFeatures
|
|
|
12
11
|
/**
|
|
13
12
|
* The authentication mechanism for allowing access to the
|
|
14
13
|
* the embedded app
|
|
15
|
-
*
|
|
16
14
|
* @group Authentication / Init
|
|
17
15
|
*/
|
|
18
16
|
// eslint-disable-next-line no-shadow
|
|
@@ -21,7 +19,6 @@ var AuthType;
|
|
|
21
19
|
/**
|
|
22
20
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
23
21
|
* `Passthrough`.
|
|
24
|
-
*
|
|
25
22
|
* @example
|
|
26
23
|
* ```js
|
|
27
24
|
* init({
|
|
@@ -39,7 +36,6 @@ var AuthType;
|
|
|
39
36
|
* To use this:
|
|
40
37
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
41
38
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
42
|
-
*
|
|
43
39
|
* @example
|
|
44
40
|
* ```js
|
|
45
41
|
* init({
|
|
@@ -52,14 +48,12 @@ var AuthType;
|
|
|
52
48
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
53
49
|
/**
|
|
54
50
|
* SSO using SAML
|
|
55
|
-
*
|
|
56
51
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
57
52
|
* @hidden
|
|
58
53
|
*/
|
|
59
54
|
AuthType["SSO"] = "SSO_SAML";
|
|
60
55
|
/**
|
|
61
56
|
* SSO using SAML
|
|
62
|
-
*
|
|
63
57
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
64
58
|
* @hidden
|
|
65
59
|
*/
|
|
@@ -71,7 +65,6 @@ var AuthType;
|
|
|
71
65
|
*
|
|
72
66
|
* This redirects the host application to the SAML IdP. The host application
|
|
73
67
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
74
|
-
*
|
|
75
68
|
* @example
|
|
76
69
|
* ```js
|
|
77
70
|
* init({
|
|
@@ -112,7 +105,6 @@ var AuthType;
|
|
|
112
105
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
113
106
|
/**
|
|
114
107
|
* SSO using OIDC
|
|
115
|
-
*
|
|
116
108
|
* @hidden
|
|
117
109
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
118
110
|
*/
|
|
@@ -125,7 +117,6 @@ var AuthType;
|
|
|
125
117
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
126
118
|
/**
|
|
127
119
|
* Trusted authentication server
|
|
128
|
-
*
|
|
129
120
|
* @hidden
|
|
130
121
|
* @deprecated Use {@link TrustedAuth} instead
|
|
131
122
|
*/
|
|
@@ -134,7 +125,6 @@ var AuthType;
|
|
|
134
125
|
* Trusted authentication server. Use your own authentication server
|
|
135
126
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
136
127
|
* from ThoughtSpot.
|
|
137
|
-
*
|
|
138
128
|
* @example
|
|
139
129
|
* ```js
|
|
140
130
|
* init({
|
|
@@ -155,7 +145,6 @@ var AuthType;
|
|
|
155
145
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
156
146
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
157
147
|
* implemented by some browsers.
|
|
158
|
-
*
|
|
159
148
|
* @example
|
|
160
149
|
* ```js
|
|
161
150
|
* init({
|
|
@@ -285,7 +274,6 @@ var RuntimeFilterOp;
|
|
|
285
274
|
* **Note**: This option does not apply to the classic homepage.
|
|
286
275
|
* To access the updated modular homepage, set
|
|
287
276
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
288
|
-
*
|
|
289
277
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
290
278
|
*/
|
|
291
279
|
// eslint-disable-next-line no-shadow
|
|
@@ -321,7 +309,6 @@ var HomepageModule;
|
|
|
321
309
|
*
|
|
322
310
|
* To add an event listener use the corresponding
|
|
323
311
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
324
|
-
*
|
|
325
312
|
* @example
|
|
326
313
|
* ```js
|
|
327
314
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -341,7 +328,6 @@ var EmbedEvent;
|
|
|
341
328
|
(function (EmbedEvent) {
|
|
342
329
|
/**
|
|
343
330
|
* Rendering has initialized.
|
|
344
|
-
*
|
|
345
331
|
* @example
|
|
346
332
|
*```js
|
|
347
333
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -355,9 +341,7 @@ var EmbedEvent;
|
|
|
355
341
|
EmbedEvent["Init"] = "init";
|
|
356
342
|
/**
|
|
357
343
|
* Authentication has either succeeded or failed.
|
|
358
|
-
*
|
|
359
344
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
360
|
-
*
|
|
361
345
|
* @example
|
|
362
346
|
*```js
|
|
363
347
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -369,9 +353,7 @@ var EmbedEvent;
|
|
|
369
353
|
EmbedEvent["AuthInit"] = "authInit";
|
|
370
354
|
/**
|
|
371
355
|
* The embed object container has loaded.
|
|
372
|
-
*
|
|
373
356
|
* @returns timestamp - The timestamp when the event was generated.
|
|
374
|
-
*
|
|
375
357
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
376
358
|
* @example
|
|
377
359
|
*```js
|
|
@@ -385,9 +367,7 @@ var EmbedEvent;
|
|
|
385
367
|
EmbedEvent["Load"] = "load";
|
|
386
368
|
/**
|
|
387
369
|
* Data pertaining to answer or Liveboard is received
|
|
388
|
-
*
|
|
389
370
|
* @return data - The answer or Liveboard data
|
|
390
|
-
*
|
|
391
371
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
392
372
|
* @example
|
|
393
373
|
*```js
|
|
@@ -400,13 +380,11 @@ var EmbedEvent;
|
|
|
400
380
|
EmbedEvent["Data"] = "data";
|
|
401
381
|
/**
|
|
402
382
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
403
|
-
*
|
|
404
383
|
* @hidden
|
|
405
384
|
*/
|
|
406
385
|
EmbedEvent["FiltersChanged"] = "filtersChanged";
|
|
407
386
|
/**
|
|
408
387
|
* Search query has been updated by the user.
|
|
409
|
-
*
|
|
410
388
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
411
389
|
* @example
|
|
412
390
|
*```js
|
|
@@ -416,9 +394,7 @@ var EmbedEvent;
|
|
|
416
394
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
417
395
|
/**
|
|
418
396
|
* A drill-down operation has been performed.
|
|
419
|
-
*
|
|
420
397
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
421
|
-
*
|
|
422
398
|
* @returns additionalFilters - Any additional filters applied
|
|
423
399
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
424
400
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
@@ -455,9 +431,7 @@ var EmbedEvent;
|
|
|
455
431
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
456
432
|
/**
|
|
457
433
|
* One or more data sources have been selected.
|
|
458
|
-
*
|
|
459
434
|
* @returns dataSourceIds - the list of data sources
|
|
460
|
-
*
|
|
461
435
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
462
436
|
* @example
|
|
463
437
|
* ```js
|
|
@@ -469,7 +443,6 @@ var EmbedEvent;
|
|
|
469
443
|
EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
|
|
470
444
|
/**
|
|
471
445
|
* One or more data columns have been selected.
|
|
472
|
-
*
|
|
473
446
|
* @returns columnIds - the list of columns
|
|
474
447
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
475
448
|
* @example
|
|
@@ -482,11 +455,9 @@ var EmbedEvent;
|
|
|
482
455
|
EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
|
|
483
456
|
/**
|
|
484
457
|
* A custom action has been triggered.
|
|
485
|
-
*
|
|
486
458
|
* @returns actionId - ID of the custom action
|
|
487
459
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
488
460
|
* Answer or Liveboard data
|
|
489
|
-
*
|
|
490
461
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
491
462
|
* @example
|
|
492
463
|
* ```js
|
|
@@ -501,7 +472,6 @@ var EmbedEvent;
|
|
|
501
472
|
EmbedEvent["CustomAction"] = "customAction";
|
|
502
473
|
/**
|
|
503
474
|
* Listen to double click actions on a visualization.
|
|
504
|
-
*
|
|
505
475
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
506
476
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
507
477
|
* @example
|
|
@@ -514,7 +484,6 @@ var EmbedEvent;
|
|
|
514
484
|
EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
|
|
515
485
|
/**
|
|
516
486
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
517
|
-
*
|
|
518
487
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
519
488
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
520
489
|
* @important
|
|
@@ -535,17 +504,15 @@ var EmbedEvent;
|
|
|
535
504
|
/**
|
|
536
505
|
* An error has occurred. This event is fired for the following error types:
|
|
537
506
|
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
507
|
+
* `API` - API call failure error.
|
|
508
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
509
|
+
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
510
|
+
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
511
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
512
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
546
513
|
*
|
|
514
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
547
515
|
* @returns error - An error object or message
|
|
548
|
-
*
|
|
549
516
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
550
517
|
* @example
|
|
551
518
|
* ```js
|
|
@@ -570,11 +537,8 @@ var EmbedEvent;
|
|
|
570
537
|
EmbedEvent["Error"] = "Error";
|
|
571
538
|
/**
|
|
572
539
|
* The embedded object has sent an alert.
|
|
573
|
-
*
|
|
574
540
|
* @returns alert - An alert object
|
|
575
|
-
*
|
|
576
541
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
577
|
-
*
|
|
578
542
|
* @example
|
|
579
543
|
* ```js
|
|
580
544
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -583,9 +547,7 @@ var EmbedEvent;
|
|
|
583
547
|
EmbedEvent["Alert"] = "alert";
|
|
584
548
|
/**
|
|
585
549
|
* The ThoughtSpot auth session has expired.
|
|
586
|
-
*
|
|
587
550
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
588
|
-
*
|
|
589
551
|
* @example
|
|
590
552
|
*```js
|
|
591
553
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -598,26 +560,22 @@ var EmbedEvent;
|
|
|
598
560
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
599
561
|
/**
|
|
600
562
|
* ThoughtSpot failed to validate the auth session.
|
|
601
|
-
*
|
|
602
563
|
* @hidden
|
|
603
564
|
*/
|
|
604
565
|
EmbedEvent["AuthFailure"] = "ThoughtspotAuthFailure";
|
|
605
566
|
/**
|
|
606
567
|
* ThoughtSpot failed to validate the auth session.
|
|
607
|
-
*
|
|
608
568
|
* @hidden
|
|
609
569
|
*/
|
|
610
570
|
EmbedEvent["AuthLogout"] = "ThoughtspotAuthLogout";
|
|
611
571
|
/**
|
|
612
572
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
613
|
-
*
|
|
614
573
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
615
574
|
* @hidden
|
|
616
575
|
*/
|
|
617
576
|
EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
|
|
618
577
|
/**
|
|
619
578
|
* The center of visible iframe viewport is calculated.
|
|
620
|
-
*
|
|
621
579
|
* @returns data - The center of the visible Iframe viewport.
|
|
622
580
|
* @hidden
|
|
623
581
|
*/
|
|
@@ -625,7 +583,6 @@ var EmbedEvent;
|
|
|
625
583
|
/**
|
|
626
584
|
* Emitted when the **Get Data** action is initiated.
|
|
627
585
|
* Applicable to `SearchBarEmbed` only.
|
|
628
|
-
*
|
|
629
586
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
630
587
|
* @example
|
|
631
588
|
*```js
|
|
@@ -638,7 +595,6 @@ var EmbedEvent;
|
|
|
638
595
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
639
596
|
/**
|
|
640
597
|
* Detects the route change.
|
|
641
|
-
*
|
|
642
598
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
643
599
|
* @example
|
|
644
600
|
*```js
|
|
@@ -649,7 +605,6 @@ var EmbedEvent;
|
|
|
649
605
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
650
606
|
/**
|
|
651
607
|
* The v1 event type for Data
|
|
652
|
-
*
|
|
653
608
|
* @hidden
|
|
654
609
|
*/
|
|
655
610
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
@@ -657,7 +612,6 @@ var EmbedEvent;
|
|
|
657
612
|
* Emitted when the embed does not have cookie access. This happens
|
|
658
613
|
* when Safari and other Web browsers block third-party cookies
|
|
659
614
|
* are blocked by default. `NoCookieAccess` can trigger
|
|
660
|
-
*
|
|
661
615
|
* @example
|
|
662
616
|
*```js
|
|
663
617
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -667,14 +621,12 @@ var EmbedEvent;
|
|
|
667
621
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
668
622
|
/**
|
|
669
623
|
* Emitted when SAML is complete
|
|
670
|
-
*
|
|
671
624
|
* @private
|
|
672
625
|
* @hidden
|
|
673
626
|
*/
|
|
674
627
|
EmbedEvent["SAMLComplete"] = "samlComplete";
|
|
675
628
|
/**
|
|
676
629
|
* Emitted when any modal is opened in the app
|
|
677
|
-
*
|
|
678
630
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
679
631
|
* @example
|
|
680
632
|
*```js
|
|
@@ -686,7 +638,6 @@ var EmbedEvent;
|
|
|
686
638
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
687
639
|
/**
|
|
688
640
|
* Emitted when any modal is closed in the app
|
|
689
|
-
*
|
|
690
641
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
691
642
|
* @example
|
|
692
643
|
*```js
|
|
@@ -700,7 +651,6 @@ var EmbedEvent;
|
|
|
700
651
|
* Emitted when the Liveboard shell loads.
|
|
701
652
|
* You can use this event as a hook to trigger
|
|
702
653
|
* other events on the rendered Liveboard.
|
|
703
|
-
*
|
|
704
654
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
705
655
|
* @example
|
|
706
656
|
*```js
|
|
@@ -721,7 +671,6 @@ var EmbedEvent;
|
|
|
721
671
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
722
672
|
/**
|
|
723
673
|
* Emits all events.
|
|
724
|
-
*
|
|
725
674
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
726
675
|
* @example
|
|
727
676
|
*```js
|
|
@@ -733,7 +682,6 @@ var EmbedEvent;
|
|
|
733
682
|
EmbedEvent["ALL"] = "*";
|
|
734
683
|
/**
|
|
735
684
|
* Emitted when an Answer is saved in the app
|
|
736
|
-
*
|
|
737
685
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
738
686
|
* @example
|
|
739
687
|
*```js
|
|
@@ -757,7 +705,6 @@ var EmbedEvent;
|
|
|
757
705
|
* To fire an event when a download action is initiated on a chart or table,
|
|
758
706
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
759
707
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
760
|
-
*
|
|
761
708
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
762
709
|
* @example
|
|
763
710
|
*```js
|
|
@@ -769,7 +716,6 @@ var EmbedEvent;
|
|
|
769
716
|
EmbedEvent["Download"] = "download";
|
|
770
717
|
/**
|
|
771
718
|
* Emitted when the download action is triggered on an answer
|
|
772
|
-
*
|
|
773
719
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
774
720
|
* @example
|
|
775
721
|
*```js
|
|
@@ -784,7 +730,6 @@ var EmbedEvent;
|
|
|
784
730
|
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
785
731
|
/**
|
|
786
732
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
787
|
-
*
|
|
788
733
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
789
734
|
* @example
|
|
790
735
|
*```js
|
|
@@ -799,7 +744,6 @@ var EmbedEvent;
|
|
|
799
744
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
800
745
|
/**
|
|
801
746
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
802
|
-
*
|
|
803
747
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
804
748
|
* @example
|
|
805
749
|
*```js
|
|
@@ -814,7 +758,6 @@ var EmbedEvent;
|
|
|
814
758
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
815
759
|
/**
|
|
816
760
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
817
|
-
*
|
|
818
761
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
819
762
|
* @example
|
|
820
763
|
*```js
|
|
@@ -829,7 +772,6 @@ var EmbedEvent;
|
|
|
829
772
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
830
773
|
/**
|
|
831
774
|
* Emitted when an Answer is deleted in the app
|
|
832
|
-
*
|
|
833
775
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
834
776
|
* @example
|
|
835
777
|
*```js
|
|
@@ -844,7 +786,6 @@ var EmbedEvent;
|
|
|
844
786
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
845
787
|
/**
|
|
846
788
|
* Emitted when an answer is pinned to a Liveboard
|
|
847
|
-
*
|
|
848
789
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
849
790
|
* @example
|
|
850
791
|
*```js
|
|
@@ -863,7 +804,6 @@ var EmbedEvent;
|
|
|
863
804
|
EmbedEvent["Pin"] = "pin";
|
|
864
805
|
/**
|
|
865
806
|
* Emitted when SpotIQ analysis is triggered
|
|
866
|
-
*
|
|
867
807
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
868
808
|
* @example
|
|
869
809
|
*```js
|
|
@@ -882,7 +822,6 @@ var EmbedEvent;
|
|
|
882
822
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
883
823
|
/**
|
|
884
824
|
* Emitted when a user shares an object with another user or group
|
|
885
|
-
*
|
|
886
825
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
887
826
|
* @example
|
|
888
827
|
*```js
|
|
@@ -902,7 +841,6 @@ var EmbedEvent;
|
|
|
902
841
|
/**
|
|
903
842
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
904
843
|
* data on a chart or table.
|
|
905
|
-
*
|
|
906
844
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
907
845
|
* @example
|
|
908
846
|
*```js
|
|
@@ -915,7 +853,6 @@ var EmbedEvent;
|
|
|
915
853
|
/**
|
|
916
854
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
917
855
|
* data on a chart or table
|
|
918
|
-
*
|
|
919
856
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
920
857
|
* @example
|
|
921
858
|
*```js
|
|
@@ -927,7 +864,6 @@ var EmbedEvent;
|
|
|
927
864
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
928
865
|
/**
|
|
929
866
|
* Emitted when a column value is copied in the embedded app.
|
|
930
|
-
*
|
|
931
867
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
932
868
|
* @example
|
|
933
869
|
*```js
|
|
@@ -940,7 +876,6 @@ var EmbedEvent;
|
|
|
940
876
|
/**
|
|
941
877
|
* Emitted when a user clicks the **Update TML** action on
|
|
942
878
|
* embedded Liveboard.
|
|
943
|
-
*
|
|
944
879
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
945
880
|
* @example
|
|
946
881
|
*```js
|
|
@@ -952,7 +887,6 @@ var EmbedEvent;
|
|
|
952
887
|
/**
|
|
953
888
|
* Emitted when a user clicks the **Edit TML** action
|
|
954
889
|
* on an embedded Liveboard.
|
|
955
|
-
*
|
|
956
890
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
957
891
|
* @example
|
|
958
892
|
*```js
|
|
@@ -965,7 +899,6 @@ var EmbedEvent;
|
|
|
965
899
|
/**
|
|
966
900
|
* Emitted when the **Export TML** action is triggered on an
|
|
967
901
|
* an embedded object in the app
|
|
968
|
-
*
|
|
969
902
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
970
903
|
* @example
|
|
971
904
|
*```js
|
|
@@ -980,7 +913,6 @@ var EmbedEvent;
|
|
|
980
913
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
981
914
|
/**
|
|
982
915
|
* Emitted when an Answer is saved as a View.
|
|
983
|
-
*
|
|
984
916
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
985
917
|
* @example
|
|
986
918
|
*```js
|
|
@@ -992,7 +924,6 @@ var EmbedEvent;
|
|
|
992
924
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
993
925
|
/**
|
|
994
926
|
* Emitted when the user creates a copy of an Answer
|
|
995
|
-
*
|
|
996
927
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
997
928
|
* @example
|
|
998
929
|
*```js
|
|
@@ -1007,7 +938,6 @@ var EmbedEvent;
|
|
|
1007
938
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
1008
939
|
/**
|
|
1009
940
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
1010
|
-
*
|
|
1011
941
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1012
942
|
* @example
|
|
1013
943
|
*```js
|
|
@@ -1019,7 +949,6 @@ var EmbedEvent;
|
|
|
1019
949
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1020
950
|
/**
|
|
1021
951
|
* Emitted when an answer is switched to a chart or table view.
|
|
1022
|
-
*
|
|
1023
952
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1024
953
|
* @example
|
|
1025
954
|
*```js
|
|
@@ -1031,13 +960,11 @@ var EmbedEvent;
|
|
|
1031
960
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
1032
961
|
/**
|
|
1033
962
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
1034
|
-
*
|
|
1035
963
|
* @hidden
|
|
1036
964
|
*/
|
|
1037
965
|
EmbedEvent["APP_INIT"] = "appInit";
|
|
1038
966
|
/**
|
|
1039
967
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1040
|
-
*
|
|
1041
968
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1042
969
|
* @example
|
|
1043
970
|
*```js
|
|
@@ -1049,7 +976,6 @@ var EmbedEvent;
|
|
|
1049
976
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1050
977
|
/**
|
|
1051
978
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1052
|
-
*
|
|
1053
979
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1054
980
|
* @example
|
|
1055
981
|
*```js
|
|
@@ -1061,7 +987,6 @@ var EmbedEvent;
|
|
|
1061
987
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
1062
988
|
/**
|
|
1063
989
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1064
|
-
*
|
|
1065
990
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1066
991
|
* @example
|
|
1067
992
|
*```js
|
|
@@ -1073,7 +998,6 @@ var EmbedEvent;
|
|
|
1073
998
|
EmbedEvent["Schedule"] = "subscription";
|
|
1074
999
|
/**
|
|
1075
1000
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1076
|
-
*
|
|
1077
1001
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1078
1002
|
* @example
|
|
1079
1003
|
*```js
|
|
@@ -1085,7 +1009,6 @@ var EmbedEvent;
|
|
|
1085
1009
|
EmbedEvent["Edit"] = "edit";
|
|
1086
1010
|
/**
|
|
1087
1011
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1088
|
-
*
|
|
1089
1012
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1090
1013
|
* @example
|
|
1091
1014
|
*```js
|
|
@@ -1097,7 +1020,6 @@ var EmbedEvent;
|
|
|
1097
1020
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
1098
1021
|
/**
|
|
1099
1022
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1100
|
-
*
|
|
1101
1023
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1102
1024
|
* @example
|
|
1103
1025
|
*```js
|
|
@@ -1113,7 +1035,6 @@ var EmbedEvent;
|
|
|
1113
1035
|
EmbedEvent["Present"] = "present";
|
|
1114
1036
|
/**
|
|
1115
1037
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1116
|
-
*
|
|
1117
1038
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1118
1039
|
* @example
|
|
1119
1040
|
*```js
|
|
@@ -1124,7 +1045,6 @@ var EmbedEvent;
|
|
|
1124
1045
|
EmbedEvent["Delete"] = "delete";
|
|
1125
1046
|
/**
|
|
1126
1047
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1127
|
-
*
|
|
1128
1048
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1129
1049
|
* @example
|
|
1130
1050
|
*```js
|
|
@@ -1134,7 +1054,6 @@ var EmbedEvent;
|
|
|
1134
1054
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
1135
1055
|
/**
|
|
1136
1056
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1137
|
-
*
|
|
1138
1057
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1139
1058
|
* @example
|
|
1140
1059
|
*```js
|
|
@@ -1144,7 +1063,6 @@ var EmbedEvent;
|
|
|
1144
1063
|
EmbedEvent["Cancel"] = "cancel";
|
|
1145
1064
|
/**
|
|
1146
1065
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1147
|
-
*
|
|
1148
1066
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1149
1067
|
* @example
|
|
1150
1068
|
*```js
|
|
@@ -1155,7 +1073,6 @@ var EmbedEvent;
|
|
|
1155
1073
|
EmbedEvent["Explore"] = "explore";
|
|
1156
1074
|
/**
|
|
1157
1075
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
1158
|
-
*
|
|
1159
1076
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1160
1077
|
* @example
|
|
1161
1078
|
*```js
|
|
@@ -1166,7 +1083,6 @@ var EmbedEvent;
|
|
|
1166
1083
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
1167
1084
|
/**
|
|
1168
1085
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
1169
|
-
*
|
|
1170
1086
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1171
1087
|
* @example
|
|
1172
1088
|
*```js
|
|
@@ -1177,7 +1093,6 @@ var EmbedEvent;
|
|
|
1177
1093
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
1178
1094
|
/**
|
|
1179
1095
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
1180
|
-
*
|
|
1181
1096
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1182
1097
|
* @example
|
|
1183
1098
|
*```js
|
|
@@ -1189,7 +1104,6 @@ var EmbedEvent;
|
|
|
1189
1104
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
1190
1105
|
/**
|
|
1191
1106
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
1192
|
-
*
|
|
1193
1107
|
* @hidden
|
|
1194
1108
|
*/
|
|
1195
1109
|
EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
|
|
@@ -1197,7 +1111,6 @@ var EmbedEvent;
|
|
|
1197
1111
|
* Emitted when a user changes any filter on a Liveboard.
|
|
1198
1112
|
* Returns filter type and name, column name and ID, and runtime
|
|
1199
1113
|
* filter details.
|
|
1200
|
-
*
|
|
1201
1114
|
* @example
|
|
1202
1115
|
*
|
|
1203
1116
|
*```js
|
|
@@ -1210,32 +1123,27 @@ var EmbedEvent;
|
|
|
1210
1123
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
1211
1124
|
/**
|
|
1212
1125
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
1213
|
-
*
|
|
1214
1126
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1215
1127
|
*/
|
|
1216
1128
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
1217
1129
|
/**
|
|
1218
1130
|
* Emitted when a user selects a data source.
|
|
1219
|
-
*
|
|
1220
1131
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1221
1132
|
*/
|
|
1222
1133
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
1223
1134
|
/**
|
|
1224
1135
|
* Emitted when a user updates a connection on the **Data** page
|
|
1225
|
-
*
|
|
1226
1136
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
1227
1137
|
*/
|
|
1228
1138
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
1229
1139
|
/**
|
|
1230
1140
|
* Emitted when a user updates a connection on the **Data** page
|
|
1231
|
-
*
|
|
1232
1141
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
1233
1142
|
*/
|
|
1234
1143
|
EmbedEvent["CreateConnection"] = "createConnection";
|
|
1235
1144
|
/**
|
|
1236
1145
|
* Emitted when name, status (private or public) or filter values of a
|
|
1237
1146
|
* Personalised view is updated.
|
|
1238
|
-
*
|
|
1239
1147
|
* @returns viewName: string
|
|
1240
1148
|
* @returns viewId: string
|
|
1241
1149
|
* @returns liveboardId: string
|
|
@@ -1245,7 +1153,6 @@ var EmbedEvent;
|
|
|
1245
1153
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1246
1154
|
/**
|
|
1247
1155
|
* Emitted when a Personalised view is saved.
|
|
1248
|
-
*
|
|
1249
1156
|
* @returns viewName: string
|
|
1250
1157
|
* @returns viewId: string
|
|
1251
1158
|
* @returns liveboardId: string
|
|
@@ -1255,7 +1162,6 @@ var EmbedEvent;
|
|
|
1255
1162
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1256
1163
|
/**
|
|
1257
1164
|
* Emitted when a Liveboard is reset.
|
|
1258
|
-
*
|
|
1259
1165
|
* @returns viewName: string
|
|
1260
1166
|
* @returns viewId: string
|
|
1261
1167
|
* @returns liveboardId: string
|
|
@@ -1265,7 +1171,6 @@ var EmbedEvent;
|
|
|
1265
1171
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1266
1172
|
/**
|
|
1267
1173
|
* Emitted when a PersonalisedView is deleted.
|
|
1268
|
-
*
|
|
1269
1174
|
* @returns views: string[]
|
|
1270
1175
|
* @returns liveboardId: string
|
|
1271
1176
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -1273,13 +1178,11 @@ var EmbedEvent;
|
|
|
1273
1178
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1274
1179
|
/**
|
|
1275
1180
|
* Emitted when a user creates a new worksheet
|
|
1276
|
-
*
|
|
1277
1181
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
1278
1182
|
*/
|
|
1279
1183
|
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
1280
1184
|
/**
|
|
1281
1185
|
* Emitted when Ask Sage is initialized.
|
|
1282
|
-
*
|
|
1283
1186
|
* @returns viewName: string
|
|
1284
1187
|
* @returns viewId: string
|
|
1285
1188
|
* @returns liveboardId: string
|
|
@@ -1289,7 +1192,6 @@ var EmbedEvent;
|
|
|
1289
1192
|
EmbedEvent["AskSageInit"] = "AskSageInit";
|
|
1290
1193
|
/**
|
|
1291
1194
|
* Emitted when a LB/viz is renamed
|
|
1292
|
-
*
|
|
1293
1195
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
1294
1196
|
*/
|
|
1295
1197
|
EmbedEvent["Rename"] = "rename";
|
|
@@ -1313,7 +1215,6 @@ var EmbedEvent;
|
|
|
1313
1215
|
EmbedEvent["OnBeforeGetVizDataIntercept"] = "onBeforeGetVizDataIntercept";
|
|
1314
1216
|
/**
|
|
1315
1217
|
* Emitted when runtime parameters changes
|
|
1316
|
-
*
|
|
1317
1218
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
1318
1219
|
*/
|
|
1319
1220
|
EmbedEvent["ParameterChanged"] = "ParameterChanged";
|
|
@@ -1325,7 +1226,6 @@ var EmbedEvent;
|
|
|
1325
1226
|
* To trigger an event use the corresponding
|
|
1326
1227
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
1327
1228
|
* SearchEmbed.trigger} method.
|
|
1328
|
-
*
|
|
1329
1229
|
* @example
|
|
1330
1230
|
* ```js
|
|
1331
1231
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1348,7 +1248,6 @@ var HostEvent;
|
|
|
1348
1248
|
* the search query string.
|
|
1349
1249
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
1350
1250
|
* Includes the following properties:
|
|
1351
|
-
*
|
|
1352
1251
|
* @param - `searchQuery` - query string with search tokens
|
|
1353
1252
|
* @param - `dataSources` - Data source GUID to Search on
|
|
1354
1253
|
* - Although an array, only a single source
|
|
@@ -1367,7 +1266,6 @@ var HostEvent;
|
|
|
1367
1266
|
/**
|
|
1368
1267
|
* Triggers a drill on certain points of the specified column
|
|
1369
1268
|
* Includes the following properties:
|
|
1370
|
-
*
|
|
1371
1269
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
1372
1270
|
* to drill to. For example, { selectedPoints: []}
|
|
1373
1271
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -1417,19 +1315,16 @@ var HostEvent;
|
|
|
1417
1315
|
HostEvent["DrillDown"] = "triggerDrillDown";
|
|
1418
1316
|
/**
|
|
1419
1317
|
* Apply filters
|
|
1420
|
-
*
|
|
1421
1318
|
* @hidden
|
|
1422
1319
|
*/
|
|
1423
1320
|
HostEvent["Filter"] = "filter";
|
|
1424
1321
|
/**
|
|
1425
1322
|
* Reload the answer or visualization
|
|
1426
|
-
*
|
|
1427
1323
|
* @hidden
|
|
1428
1324
|
*/
|
|
1429
1325
|
HostEvent["Reload"] = "reload";
|
|
1430
1326
|
/**
|
|
1431
1327
|
* Display specific visualizations on a Liveboard.
|
|
1432
|
-
*
|
|
1433
1328
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
1434
1329
|
* in this parameter will be hidden.
|
|
1435
1330
|
* @example
|
|
@@ -1443,7 +1338,6 @@ var HostEvent;
|
|
|
1443
1338
|
HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
|
|
1444
1339
|
/**
|
|
1445
1340
|
* Set a Liveboard tab as an active tab.
|
|
1446
|
-
*
|
|
1447
1341
|
* @param - tabId - string of id of Tab to show
|
|
1448
1342
|
* @example
|
|
1449
1343
|
* ```js
|
|
@@ -1464,17 +1358,16 @@ var HostEvent;
|
|
|
1464
1358
|
* _String_. The name of the column to filter on.
|
|
1465
1359
|
*
|
|
1466
1360
|
* `operator`
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1361
|
+
* Runtime filter operator to apply. For information,
|
|
1362
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
1469
1363
|
*
|
|
1470
1364
|
* `values`
|
|
1471
|
-
*
|
|
1472
|
-
*
|
|
1473
|
-
*
|
|
1474
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
1475
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
1476
|
-
* embedding (SageEmbed).
|
|
1365
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
1366
|
+
* operators such as BW and IN accept multiple operands.
|
|
1477
1367
|
*
|
|
1368
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
1369
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
1370
|
+
* embedding (SageEmbed).
|
|
1478
1371
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
1479
1372
|
* @example
|
|
1480
1373
|
* ```js
|
|
@@ -1490,7 +1383,6 @@ var HostEvent;
|
|
|
1490
1383
|
/**
|
|
1491
1384
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
1492
1385
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1493
|
-
*
|
|
1494
1386
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
1495
1387
|
* be a number; for example, `1`, `-1`.
|
|
1496
1388
|
* @example
|
|
@@ -1503,7 +1395,6 @@ var HostEvent;
|
|
|
1503
1395
|
/**
|
|
1504
1396
|
* Open the filter panel for a particular column.
|
|
1505
1397
|
* Works with Search and Liveboard embed.
|
|
1506
|
-
*
|
|
1507
1398
|
* @param - { columnId: string,
|
|
1508
1399
|
* name: string,
|
|
1509
1400
|
* type: INT64/CHAR/DATE,
|
|
@@ -1520,7 +1411,6 @@ var HostEvent;
|
|
|
1520
1411
|
HostEvent["OpenFilter"] = "openFilter";
|
|
1521
1412
|
/**
|
|
1522
1413
|
* Add columns to the current search query.
|
|
1523
|
-
*
|
|
1524
1414
|
* @param - { columnIds: string[] }
|
|
1525
1415
|
* @example
|
|
1526
1416
|
* ```js
|
|
@@ -1531,7 +1421,6 @@ var HostEvent;
|
|
|
1531
1421
|
HostEvent["AddColumns"] = "addColumns";
|
|
1532
1422
|
/**
|
|
1533
1423
|
* Remove a column from the current search query.
|
|
1534
|
-
*
|
|
1535
1424
|
* @param - { columnId: string }
|
|
1536
1425
|
* @example
|
|
1537
1426
|
* ```js
|
|
@@ -1546,7 +1435,6 @@ var HostEvent;
|
|
|
1546
1435
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
1547
1436
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
1548
1437
|
* sorting, toggling of legends, and data drill down.
|
|
1549
|
-
*
|
|
1550
1438
|
* @example
|
|
1551
1439
|
* ```js
|
|
1552
1440
|
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
@@ -1557,7 +1445,6 @@ var HostEvent;
|
|
|
1557
1445
|
HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
|
|
1558
1446
|
/**
|
|
1559
1447
|
* Trigger the **Pin** action on an embedded object
|
|
1560
|
-
*
|
|
1561
1448
|
* @param - Liveboard embed takes the `vizId` as a
|
|
1562
1449
|
* key. Can be left undefined when embedding Search, full app, or
|
|
1563
1450
|
* a visualization.
|
|
@@ -1574,7 +1461,6 @@ var HostEvent;
|
|
|
1574
1461
|
/**
|
|
1575
1462
|
* Trigger the **Show Liveboard details** action
|
|
1576
1463
|
* on an embedded Liveboard.
|
|
1577
|
-
*
|
|
1578
1464
|
* @example
|
|
1579
1465
|
*```js
|
|
1580
1466
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -1584,7 +1470,6 @@ var HostEvent;
|
|
|
1584
1470
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1585
1471
|
/**
|
|
1586
1472
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
1587
|
-
*
|
|
1588
1473
|
* @example
|
|
1589
1474
|
* ```js
|
|
1590
1475
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -1594,7 +1479,6 @@ var HostEvent;
|
|
|
1594
1479
|
HostEvent["Schedule"] = "subscription";
|
|
1595
1480
|
/**
|
|
1596
1481
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
1597
|
-
*
|
|
1598
1482
|
* @example
|
|
1599
1483
|
* ```js
|
|
1600
1484
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -1605,20 +1489,16 @@ var HostEvent;
|
|
|
1605
1489
|
/**
|
|
1606
1490
|
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
1607
1491
|
* Answer.
|
|
1608
|
-
*
|
|
1609
1492
|
* @example
|
|
1610
1493
|
* ```js
|
|
1611
1494
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
1612
1495
|
* ```
|
|
1613
|
-
*
|
|
1614
1496
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1615
1497
|
*/
|
|
1616
1498
|
HostEvent["ExportTML"] = "exportTSL";
|
|
1617
1499
|
/**
|
|
1618
1500
|
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
1619
1501
|
* saved Answers in the full application embedding.
|
|
1620
|
-
*
|
|
1621
|
-
*
|
|
1622
1502
|
* @example
|
|
1623
1503
|
* ```js
|
|
1624
1504
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -1628,7 +1508,6 @@ var HostEvent;
|
|
|
1628
1508
|
HostEvent["EditTML"] = "editTSL";
|
|
1629
1509
|
/**
|
|
1630
1510
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
1631
|
-
*
|
|
1632
1511
|
* @example
|
|
1633
1512
|
* ```js
|
|
1634
1513
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -1642,7 +1521,6 @@ var HostEvent;
|
|
|
1642
1521
|
*
|
|
1643
1522
|
* **NOTE**: The **Download** > **PDF** action is available on
|
|
1644
1523
|
* visualizations and Answers if the data is in tabular format.
|
|
1645
|
-
*
|
|
1646
1524
|
* @example
|
|
1647
1525
|
* ```js
|
|
1648
1526
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -1653,7 +1531,6 @@ var HostEvent;
|
|
|
1653
1531
|
/**
|
|
1654
1532
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
1655
1533
|
* visualization page.
|
|
1656
|
-
*
|
|
1657
1534
|
* @example
|
|
1658
1535
|
* ```js
|
|
1659
1536
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -1669,7 +1546,6 @@ var HostEvent;
|
|
|
1669
1546
|
HostEvent["MakeACopy"] = "makeACopy";
|
|
1670
1547
|
/**
|
|
1671
1548
|
* Trigger the **Delete** action for a Liveboard.
|
|
1672
|
-
*
|
|
1673
1549
|
* @example
|
|
1674
1550
|
* ```js
|
|
1675
1551
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -1679,7 +1555,6 @@ var HostEvent;
|
|
|
1679
1555
|
HostEvent["Remove"] = "delete";
|
|
1680
1556
|
/**
|
|
1681
1557
|
* Trigger the **Explore** action on a visualization.
|
|
1682
|
-
*
|
|
1683
1558
|
* @param - an object with `vizId` as a key
|
|
1684
1559
|
* @example
|
|
1685
1560
|
* ```js
|
|
@@ -1690,7 +1565,6 @@ var HostEvent;
|
|
|
1690
1565
|
HostEvent["Explore"] = "explore";
|
|
1691
1566
|
/**
|
|
1692
1567
|
* Trigger the **Create alert** action on a visualization
|
|
1693
|
-
*
|
|
1694
1568
|
* @param - an object with `vizId` as a key
|
|
1695
1569
|
* @example
|
|
1696
1570
|
* ```js
|
|
@@ -1703,7 +1577,6 @@ var HostEvent;
|
|
|
1703
1577
|
HostEvent["CreateMonitor"] = "createMonitor";
|
|
1704
1578
|
/**
|
|
1705
1579
|
* Trigger the **Manage alerts** action on a visualization
|
|
1706
|
-
*
|
|
1707
1580
|
* @param - an object with `vizId` as a key
|
|
1708
1581
|
* @example
|
|
1709
1582
|
* ```js
|
|
@@ -1719,10 +1592,8 @@ var HostEvent;
|
|
|
1719
1592
|
* on a Liveboard.
|
|
1720
1593
|
*
|
|
1721
1594
|
* This event is not supported in visualization embed and search embed.
|
|
1722
|
-
*
|
|
1723
1595
|
* @param - object - To trigger the action for a specific visualization
|
|
1724
1596
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
1725
|
-
*
|
|
1726
1597
|
* @example
|
|
1727
1598
|
* ```js
|
|
1728
1599
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
@@ -1736,7 +1607,6 @@ var HostEvent;
|
|
|
1736
1607
|
HostEvent["Edit"] = "edit";
|
|
1737
1608
|
/**
|
|
1738
1609
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
1739
|
-
*
|
|
1740
1610
|
* @param - object - to trigger the action for a
|
|
1741
1611
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
1742
1612
|
* @example
|
|
@@ -1754,7 +1624,6 @@ var HostEvent;
|
|
|
1754
1624
|
HostEvent["CopyLink"] = "embedDocument";
|
|
1755
1625
|
/**
|
|
1756
1626
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
1757
|
-
*
|
|
1758
1627
|
* @param - object - to trigger the action for a specific visualization
|
|
1759
1628
|
* in Liveboard embed, pass in `vizId` as a key
|
|
1760
1629
|
* @example
|
|
@@ -1772,7 +1641,6 @@ var HostEvent;
|
|
|
1772
1641
|
HostEvent["Present"] = "present";
|
|
1773
1642
|
/**
|
|
1774
1643
|
* Get TML for the current search.
|
|
1775
|
-
*
|
|
1776
1644
|
* @example
|
|
1777
1645
|
* ```js
|
|
1778
1646
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
@@ -1787,7 +1655,6 @@ var HostEvent;
|
|
|
1787
1655
|
HostEvent["GetTML"] = "getTML";
|
|
1788
1656
|
/**
|
|
1789
1657
|
* Trigger the **Show underlying data** action on visualization or search
|
|
1790
|
-
*
|
|
1791
1658
|
* @param - an object with vizId as a key
|
|
1792
1659
|
* @example
|
|
1793
1660
|
* ```js
|
|
@@ -1807,7 +1674,6 @@ var HostEvent;
|
|
|
1807
1674
|
* Trigger the **Delete** action for a visualization
|
|
1808
1675
|
* in an embedded Liveboard, or a chart or table
|
|
1809
1676
|
* generated from Search.
|
|
1810
|
-
*
|
|
1811
1677
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
1812
1678
|
* Can be left empty if embedding Search or visualization.
|
|
1813
1679
|
* @example
|
|
@@ -1824,7 +1690,6 @@ var HostEvent;
|
|
|
1824
1690
|
/**
|
|
1825
1691
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
1826
1692
|
* or search.
|
|
1827
|
-
*
|
|
1828
1693
|
* @param - Liveboard embed takes `vizId` as a
|
|
1829
1694
|
* key. Can be left undefined when embedding Search or
|
|
1830
1695
|
* visualization.
|
|
@@ -1845,7 +1710,6 @@ var HostEvent;
|
|
|
1845
1710
|
/**
|
|
1846
1711
|
* Trigger the **Download** action on charts in
|
|
1847
1712
|
* the embedded view.
|
|
1848
|
-
*
|
|
1849
1713
|
* @example
|
|
1850
1714
|
* ```js
|
|
1851
1715
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -1862,7 +1726,6 @@ var HostEvent;
|
|
|
1862
1726
|
/**
|
|
1863
1727
|
* Trigger the **Download** > **PNG** action on
|
|
1864
1728
|
* charts in the embedded view.
|
|
1865
|
-
*
|
|
1866
1729
|
* @example
|
|
1867
1730
|
* ```js
|
|
1868
1731
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -1878,7 +1741,6 @@ var HostEvent;
|
|
|
1878
1741
|
/**
|
|
1879
1742
|
* Trigger the **Download** > **CSV** action on tables in
|
|
1880
1743
|
* the embedded view.
|
|
1881
|
-
*
|
|
1882
1744
|
* @example
|
|
1883
1745
|
* ```js
|
|
1884
1746
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -1896,7 +1758,6 @@ var HostEvent;
|
|
|
1896
1758
|
/**
|
|
1897
1759
|
* Trigger the **Download** > **XLSX** action on tables
|
|
1898
1760
|
* in the embedded view.
|
|
1899
|
-
*
|
|
1900
1761
|
* @example
|
|
1901
1762
|
* ```js
|
|
1902
1763
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -1914,7 +1775,6 @@ var HostEvent;
|
|
|
1914
1775
|
/**
|
|
1915
1776
|
* Trigger the **Share** action on an embedded
|
|
1916
1777
|
* Liveboard or Answer.
|
|
1917
|
-
*
|
|
1918
1778
|
* @example
|
|
1919
1779
|
* ```js
|
|
1920
1780
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -1928,7 +1788,6 @@ var HostEvent;
|
|
|
1928
1788
|
/**
|
|
1929
1789
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
1930
1790
|
* Saves the changes.
|
|
1931
|
-
*
|
|
1932
1791
|
* @example
|
|
1933
1792
|
* ```js
|
|
1934
1793
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -1942,7 +1801,6 @@ var HostEvent;
|
|
|
1942
1801
|
/**
|
|
1943
1802
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
1944
1803
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
1945
|
-
*
|
|
1946
1804
|
* @param - an object with `vizId` as a key
|
|
1947
1805
|
* @example
|
|
1948
1806
|
* ```js
|
|
@@ -1959,7 +1817,6 @@ var HostEvent;
|
|
|
1959
1817
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
1960
1818
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
1961
1819
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
1962
|
-
*
|
|
1963
1820
|
* @param - an object with vizId as a key
|
|
1964
1821
|
* @example
|
|
1965
1822
|
* ```js
|
|
@@ -1976,7 +1833,6 @@ var HostEvent;
|
|
|
1976
1833
|
* Trigger the **Manage pipelines** action on an embedded
|
|
1977
1834
|
* visualization or Answer.
|
|
1978
1835
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
1979
|
-
*
|
|
1980
1836
|
* @param - an object with `vizId` as a key
|
|
1981
1837
|
* @example
|
|
1982
1838
|
* ```js
|
|
@@ -1991,7 +1847,6 @@ var HostEvent;
|
|
|
1991
1847
|
HostEvent["ManagePipelines"] = "manage-pipeline";
|
|
1992
1848
|
/**
|
|
1993
1849
|
* Reset search operation on the Search or Answer page.
|
|
1994
|
-
*
|
|
1995
1850
|
* @example
|
|
1996
1851
|
* ```js
|
|
1997
1852
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -2005,19 +1860,16 @@ var HostEvent;
|
|
|
2005
1860
|
/**
|
|
2006
1861
|
* Get details of filters applied on the Liveboard.
|
|
2007
1862
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
2008
|
-
*
|
|
2009
1863
|
* @example
|
|
2010
1864
|
* ```js
|
|
2011
1865
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
2012
1866
|
* console.log('data', data);
|
|
2013
1867
|
* ```
|
|
2014
|
-
*
|
|
2015
1868
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2016
1869
|
*/
|
|
2017
1870
|
HostEvent["GetFilters"] = "getFilters";
|
|
2018
1871
|
/**
|
|
2019
1872
|
* Update one or several filters applied on a Liveboard.
|
|
2020
|
-
*
|
|
2021
1873
|
* @param - `filter`: a single filter object containing column name,
|
|
2022
1874
|
* filter operator, and values.
|
|
2023
1875
|
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
@@ -2034,7 +1886,6 @@ var HostEvent;
|
|
|
2034
1886
|
* `values` - An array of one or several values. The value definition on the
|
|
2035
1887
|
* data type you choose to filter on. For a complete list of supported data types,
|
|
2036
1888
|
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
2037
|
-
*
|
|
2038
1889
|
* @example
|
|
2039
1890
|
* ```js
|
|
2040
1891
|
*
|
|
@@ -2046,7 +1897,6 @@ var HostEvent;
|
|
|
2046
1897
|
* }
|
|
2047
1898
|
* });
|
|
2048
1899
|
* ```
|
|
2049
|
-
*
|
|
2050
1900
|
* @example
|
|
2051
1901
|
*
|
|
2052
1902
|
* ```js
|
|
@@ -2068,13 +1918,11 @@ var HostEvent;
|
|
|
2068
1918
|
* }]
|
|
2069
1919
|
* });
|
|
2070
1920
|
* ```
|
|
2071
|
-
*
|
|
2072
1921
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2073
1922
|
*/
|
|
2074
1923
|
HostEvent["UpdateFilters"] = "updateFilters";
|
|
2075
1924
|
/**
|
|
2076
1925
|
* Get tab details for the current Liveboard.
|
|
2077
|
-
*
|
|
2078
1926
|
* @example
|
|
2079
1927
|
* ```js
|
|
2080
1928
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -2088,7 +1936,6 @@ var HostEvent;
|
|
|
2088
1936
|
HostEvent["GetTabs"] = "getTabs";
|
|
2089
1937
|
/**
|
|
2090
1938
|
* Set the visible tabs on a Liveboard.
|
|
2091
|
-
*
|
|
2092
1939
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
2093
1940
|
* will be hidden.
|
|
2094
1941
|
* @example
|
|
@@ -2102,7 +1949,6 @@ var HostEvent;
|
|
|
2102
1949
|
HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
|
|
2103
1950
|
/**
|
|
2104
1951
|
* Set the hidden tabs on a Liveboard.
|
|
2105
|
-
*
|
|
2106
1952
|
* @param - an array of the IDs of the tabs to hide.
|
|
2107
1953
|
* The IDs not passed will be shown.
|
|
2108
1954
|
* @example
|
|
@@ -2116,7 +1962,6 @@ var HostEvent;
|
|
|
2116
1962
|
HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
|
|
2117
1963
|
/**
|
|
2118
1964
|
* Updates the search query string for Natural Language Search operations.
|
|
2119
|
-
*
|
|
2120
1965
|
* @param - `queryString`: Text string in Natural Language format
|
|
2121
1966
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
2122
1967
|
* @example
|
|
@@ -2131,7 +1976,6 @@ var HostEvent;
|
|
|
2131
1976
|
HostEvent["UpdateSageQuery"] = "updateSageQuery";
|
|
2132
1977
|
/**
|
|
2133
1978
|
* Get the answer session for a Search / Visualization.
|
|
2134
|
-
*
|
|
2135
1979
|
* @example
|
|
2136
1980
|
* ```js
|
|
2137
1981
|
* const {session} = await embed.trigger(
|
|
@@ -2144,7 +1988,6 @@ var HostEvent;
|
|
|
2144
1988
|
HostEvent["GetAnswerSession"] = "getAnswerSession";
|
|
2145
1989
|
/**
|
|
2146
1990
|
* Trigger Ask Sage for viz
|
|
2147
|
-
*
|
|
2148
1991
|
* @example
|
|
2149
1992
|
* ```js
|
|
2150
1993
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -2155,7 +1998,6 @@ var HostEvent;
|
|
|
2155
1998
|
HostEvent["AskSage"] = "AskSage";
|
|
2156
1999
|
/**
|
|
2157
2000
|
* Trigger UpdateCrossFilter for Liveboard
|
|
2158
|
-
*
|
|
2159
2001
|
* @example
|
|
2160
2002
|
* ```js
|
|
2161
2003
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -2171,7 +2013,6 @@ var HostEvent;
|
|
|
2171
2013
|
HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
|
|
2172
2014
|
/**
|
|
2173
2015
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
2174
|
-
*
|
|
2175
2016
|
* @example
|
|
2176
2017
|
* ```js
|
|
2177
2018
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
@@ -2181,7 +2022,6 @@ var HostEvent;
|
|
|
2181
2022
|
HostEvent["ResetLiveboardPersonalisedView"] = "ResetLiveboardPersonalisedView";
|
|
2182
2023
|
/**
|
|
2183
2024
|
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
2184
|
-
*
|
|
2185
2025
|
* @example
|
|
2186
2026
|
* ```js
|
|
2187
2027
|
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
@@ -2327,7 +2167,6 @@ var Param;
|
|
|
2327
2167
|
* specific actions in the embedded view, define the Action
|
|
2328
2168
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2329
2169
|
* or `hiddenActions` array.
|
|
2330
|
-
*
|
|
2331
2170
|
* @example
|
|
2332
2171
|
* ```js
|
|
2333
2172
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2353,7 +2192,6 @@ var Action;
|
|
|
2353
2192
|
/**
|
|
2354
2193
|
* The **Save** action on an Answer or Liveboard.
|
|
2355
2194
|
* Allows users to save the changes.
|
|
2356
|
-
*
|
|
2357
2195
|
* @example
|
|
2358
2196
|
* ```js
|
|
2359
2197
|
* disabledActions: [Action.Save]
|
|
@@ -2372,7 +2210,6 @@ var Action;
|
|
|
2372
2210
|
* The **Save as View** action on the Answer
|
|
2373
2211
|
* page. Saves an Answer as a View object in the full
|
|
2374
2212
|
* application embedding mode.
|
|
2375
|
-
*
|
|
2376
2213
|
* @example
|
|
2377
2214
|
* ```js
|
|
2378
2215
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -2386,7 +2223,6 @@ var Action;
|
|
|
2386
2223
|
* visualizations in the embedded Liveboard view.
|
|
2387
2224
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
2388
2225
|
* Liveboards and visualizations.
|
|
2389
|
-
*
|
|
2390
2226
|
* @example
|
|
2391
2227
|
* ```js
|
|
2392
2228
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -2396,7 +2232,6 @@ var Action;
|
|
|
2396
2232
|
/**
|
|
2397
2233
|
* The **Copy and Edit** action on a Liveboard.
|
|
2398
2234
|
* This action is now replaced with `Action.MakeACopy`.
|
|
2399
|
-
*
|
|
2400
2235
|
* @example
|
|
2401
2236
|
* ```js
|
|
2402
2237
|
* disabledActions: [Action.EditACopy]
|
|
@@ -2406,7 +2241,6 @@ var Action;
|
|
|
2406
2241
|
/**
|
|
2407
2242
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
2408
2243
|
* Copies the visualization URL
|
|
2409
|
-
*
|
|
2410
2244
|
* @example
|
|
2411
2245
|
* ```js
|
|
2412
2246
|
* disabledActions: [Action.CopyLink]
|
|
@@ -2420,7 +2254,6 @@ var Action;
|
|
|
2420
2254
|
/**
|
|
2421
2255
|
* The **Schedule** menu action on a Liveboard.
|
|
2422
2256
|
* Allows scheduling a Liveboard notification.
|
|
2423
|
-
*
|
|
2424
2257
|
* @example
|
|
2425
2258
|
* ```js
|
|
2426
2259
|
* disabledActions: [Action.Schedule]
|
|
@@ -2430,7 +2263,6 @@ var Action;
|
|
|
2430
2263
|
/**
|
|
2431
2264
|
* The **Manage schedules** menu action on a Liveboard.
|
|
2432
2265
|
* Allows users to manage scheduled Liveboard jobs.
|
|
2433
|
-
*
|
|
2434
2266
|
* @example
|
|
2435
2267
|
* ```js
|
|
2436
2268
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -2440,7 +2272,6 @@ var Action;
|
|
|
2440
2272
|
/**
|
|
2441
2273
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2442
2274
|
* Allows users to share an object with other users and groups.
|
|
2443
|
-
*
|
|
2444
2275
|
* @example
|
|
2445
2276
|
* ```js
|
|
2446
2277
|
* disabledActions: [Action.Share]
|
|
@@ -2450,7 +2281,6 @@ var Action;
|
|
|
2450
2281
|
/**
|
|
2451
2282
|
* The **Add filter** action on a Liveboard and Search page.
|
|
2452
2283
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2453
|
-
*
|
|
2454
2284
|
* @example
|
|
2455
2285
|
* ```js
|
|
2456
2286
|
* disabledActions: [Action.AddFilter]
|
|
@@ -2461,7 +2291,6 @@ var Action;
|
|
|
2461
2291
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
2462
2292
|
* Allows to show action menu to add different objects (like
|
|
2463
2293
|
* formulas, parameters) in data panel v2.
|
|
2464
|
-
*
|
|
2465
2294
|
* @example
|
|
2466
2295
|
* ```js
|
|
2467
2296
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -2473,7 +2302,6 @@ var Action;
|
|
|
2473
2302
|
* Filter configuration options on a Liveboard and Search page.
|
|
2474
2303
|
* Allows configuring filter options when adding filters to a
|
|
2475
2304
|
* Liveboard or Answer.
|
|
2476
|
-
*
|
|
2477
2305
|
* @example
|
|
2478
2306
|
* ```js
|
|
2479
2307
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -2484,7 +2312,6 @@ var Action;
|
|
|
2484
2312
|
/**
|
|
2485
2313
|
* The **Choose sources** button on Search page.
|
|
2486
2314
|
* Allows selecting data sources for search queries.
|
|
2487
|
-
*
|
|
2488
2315
|
* @example
|
|
2489
2316
|
* ```js
|
|
2490
2317
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -2494,7 +2321,6 @@ var Action;
|
|
|
2494
2321
|
/**
|
|
2495
2322
|
* The **Create formula** action on a Search or Answer page.
|
|
2496
2323
|
* Allows adding formulas to an Answer.
|
|
2497
|
-
*
|
|
2498
2324
|
* @example
|
|
2499
2325
|
* ```js
|
|
2500
2326
|
* disabledActions: [Action.AddFormula]
|
|
@@ -2504,7 +2330,6 @@ var Action;
|
|
|
2504
2330
|
/**
|
|
2505
2331
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
2506
2332
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
2507
|
-
*
|
|
2508
2333
|
* @example
|
|
2509
2334
|
* ```js
|
|
2510
2335
|
* disabledActions: [Action.AddParameter]
|
|
@@ -2514,7 +2339,6 @@ var Action;
|
|
|
2514
2339
|
/**
|
|
2515
2340
|
* The **Add Column Set** action on a Answer.
|
|
2516
2341
|
* Allows adding column sets to a Answer.
|
|
2517
|
-
*
|
|
2518
2342
|
* @example
|
|
2519
2343
|
* ```js
|
|
2520
2344
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -2525,7 +2349,6 @@ var Action;
|
|
|
2525
2349
|
/**
|
|
2526
2350
|
* The **Add Query Set** action on a Answer.
|
|
2527
2351
|
* Allows adding query sets to a Answer.
|
|
2528
|
-
*
|
|
2529
2352
|
* @example
|
|
2530
2353
|
* ```js
|
|
2531
2354
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -2540,7 +2363,6 @@ var Action;
|
|
|
2540
2363
|
/**
|
|
2541
2364
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
2542
2365
|
* Answer page.
|
|
2543
|
-
*
|
|
2544
2366
|
* @example
|
|
2545
2367
|
* ```js
|
|
2546
2368
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -2563,7 +2385,6 @@ var Action;
|
|
|
2563
2385
|
/**
|
|
2564
2386
|
* The **Show underlying data** menu action on a visualization or
|
|
2565
2387
|
* Answer page.
|
|
2566
|
-
*
|
|
2567
2388
|
* @example
|
|
2568
2389
|
* ```js
|
|
2569
2390
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -2574,7 +2395,6 @@ var Action;
|
|
|
2574
2395
|
* The **Download** menu action on Liveboard visualizations
|
|
2575
2396
|
* and Answers.
|
|
2576
2397
|
* Allows downloading a visualization or Answer.
|
|
2577
|
-
*
|
|
2578
2398
|
* @example
|
|
2579
2399
|
* ```js
|
|
2580
2400
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -2585,7 +2405,6 @@ var Action;
|
|
|
2585
2405
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
2586
2406
|
* or Answer page.
|
|
2587
2407
|
* Downloads a visualization or Answer as a PNG file.
|
|
2588
|
-
*
|
|
2589
2408
|
* @example
|
|
2590
2409
|
* ```js
|
|
2591
2410
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -2594,13 +2413,12 @@ var Action;
|
|
|
2594
2413
|
Action["DownloadAsPng"] = "downloadAsPng";
|
|
2595
2414
|
/**
|
|
2596
2415
|
*
|
|
2597
|
-
*
|
|
2598
|
-
*
|
|
2416
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
2417
|
+
*visualization, or Answer as a PDF file.
|
|
2599
2418
|
*
|
|
2600
2419
|
*
|
|
2601
|
-
|
|
2602
|
-
*
|
|
2603
|
-
*
|
|
2420
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
2421
|
+
*visualizations and Answers if the data is in tabular format.
|
|
2604
2422
|
* @example
|
|
2605
2423
|
* ```js
|
|
2606
2424
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -2611,7 +2429,6 @@ var Action;
|
|
|
2611
2429
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
2612
2430
|
* or Answer page.
|
|
2613
2431
|
* Downloads a visualization or Answer in the XLSX format.
|
|
2614
|
-
*
|
|
2615
2432
|
* @example
|
|
2616
2433
|
* ```js
|
|
2617
2434
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -2622,7 +2439,6 @@ var Action;
|
|
|
2622
2439
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
2623
2440
|
* or Answer page.
|
|
2624
2441
|
* Downloads a visualization or Answer in the XLSX format.
|
|
2625
|
-
*
|
|
2626
2442
|
* @example
|
|
2627
2443
|
* ```js
|
|
2628
2444
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -2637,7 +2453,6 @@ var Action;
|
|
|
2637
2453
|
* The **Export TML** menu action on Liveboard, Answers
|
|
2638
2454
|
* Worksheets and Data Connections page.
|
|
2639
2455
|
* Exports an object as a TML file.
|
|
2640
|
-
*
|
|
2641
2456
|
* @example
|
|
2642
2457
|
* ```js
|
|
2643
2458
|
* disabledActions: [Action.ExportTML]
|
|
@@ -2647,7 +2462,6 @@ var Action;
|
|
|
2647
2462
|
/**
|
|
2648
2463
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
2649
2464
|
* Imports TML representation of ThoughtSpot objects.
|
|
2650
|
-
*
|
|
2651
2465
|
* @example
|
|
2652
2466
|
* ```js
|
|
2653
2467
|
* disabledActions: [Action.ImportTML]
|
|
@@ -2657,7 +2471,6 @@ var Action;
|
|
|
2657
2471
|
/**
|
|
2658
2472
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
2659
2473
|
* Update TML representation of ThoughtSpot objects.
|
|
2660
|
-
*
|
|
2661
2474
|
* @example
|
|
2662
2475
|
* ```js
|
|
2663
2476
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -2667,7 +2480,6 @@ var Action;
|
|
|
2667
2480
|
/**
|
|
2668
2481
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
2669
2482
|
* Opens the TML editor.
|
|
2670
|
-
*
|
|
2671
2483
|
* @example
|
|
2672
2484
|
* ```js
|
|
2673
2485
|
* disabledActions: [Action.EditTML]
|
|
@@ -2678,7 +2490,6 @@ var Action;
|
|
|
2678
2490
|
* The **Present** menu action for Liveboards and Answers.
|
|
2679
2491
|
* Allows presenting a Liveboard or visualization in
|
|
2680
2492
|
* slideshow mode.
|
|
2681
|
-
*
|
|
2682
2493
|
* @example
|
|
2683
2494
|
* ```js
|
|
2684
2495
|
* disabledActions: [Action.Present]
|
|
@@ -2688,7 +2499,6 @@ var Action;
|
|
|
2688
2499
|
/**
|
|
2689
2500
|
* The tile resize options in the visualization menu.
|
|
2690
2501
|
* Allows switching between different preset layouts.
|
|
2691
|
-
*
|
|
2692
2502
|
* @example
|
|
2693
2503
|
* ```js
|
|
2694
2504
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -2699,7 +2509,6 @@ var Action;
|
|
|
2699
2509
|
* The *Edit* action on the Liveboard page and in the
|
|
2700
2510
|
* visualization menu.
|
|
2701
2511
|
* Opens a Liveboard or visualization in edit mode.
|
|
2702
|
-
*
|
|
2703
2512
|
* @example
|
|
2704
2513
|
* ```js
|
|
2705
2514
|
* disabledActions: [Action.Edit]
|
|
@@ -2708,7 +2517,6 @@ var Action;
|
|
|
2708
2517
|
Action["Edit"] = "edit";
|
|
2709
2518
|
/**
|
|
2710
2519
|
* The text edit option for Liveboard and visualization titles.
|
|
2711
|
-
*
|
|
2712
2520
|
* @example
|
|
2713
2521
|
* ```js
|
|
2714
2522
|
* disabledActions: [Action.EditTitle]
|
|
@@ -2718,7 +2526,6 @@ var Action;
|
|
|
2718
2526
|
/**
|
|
2719
2527
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
2720
2528
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
2721
|
-
*
|
|
2722
2529
|
* @example
|
|
2723
2530
|
* ```js
|
|
2724
2531
|
* disabledActions: [Action.Remove]
|
|
@@ -2750,7 +2557,6 @@ var Action;
|
|
|
2750
2557
|
* Displays details such as the name, description, and
|
|
2751
2558
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
2752
2559
|
* and update.
|
|
2753
|
-
*
|
|
2754
2560
|
* @example
|
|
2755
2561
|
* ```js
|
|
2756
2562
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -2768,7 +2574,6 @@ var Action;
|
|
|
2768
2574
|
/**
|
|
2769
2575
|
* The **Pin** menu action on an Answer or
|
|
2770
2576
|
* Search results page.
|
|
2771
|
-
*
|
|
2772
2577
|
* @example
|
|
2773
2578
|
* ```js
|
|
2774
2579
|
* disabledActions: [Action.Pin]
|
|
@@ -2781,7 +2586,6 @@ var Action;
|
|
|
2781
2586
|
Action["AnalysisInfo"] = "analysisInfo";
|
|
2782
2587
|
/**
|
|
2783
2588
|
* The **Schedule** menu action on a Liveboard.
|
|
2784
|
-
*
|
|
2785
2589
|
* @example
|
|
2786
2590
|
* ```js
|
|
2787
2591
|
* disabledActions: [Action.Subscription]
|
|
@@ -2790,7 +2594,6 @@ var Action;
|
|
|
2790
2594
|
Action["Subscription"] = "subscription";
|
|
2791
2595
|
/**
|
|
2792
2596
|
* The **Explore** action on Liveboard visualizations
|
|
2793
|
-
*
|
|
2794
2597
|
* @example
|
|
2795
2598
|
* ```js
|
|
2796
2599
|
* disabledActions: [Action.Explore]
|
|
@@ -2800,7 +2603,6 @@ var Action;
|
|
|
2800
2603
|
/**
|
|
2801
2604
|
* The action to include data points on a drilled-down Answer
|
|
2802
2605
|
* or visualization
|
|
2803
|
-
*
|
|
2804
2606
|
* @example
|
|
2805
2607
|
* ```js
|
|
2806
2608
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -2810,7 +2612,6 @@ var Action;
|
|
|
2810
2612
|
/**
|
|
2811
2613
|
* The action to exclude data points on a drilled-down Answer
|
|
2812
2614
|
* or visualization
|
|
2813
|
-
*
|
|
2814
2615
|
* @example
|
|
2815
2616
|
* ```js
|
|
2816
2617
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -2821,7 +2622,6 @@ var Action;
|
|
|
2821
2622
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
2822
2623
|
* or Liveboard.
|
|
2823
2624
|
* Copies the selected data point.
|
|
2824
|
-
*
|
|
2825
2625
|
* @example
|
|
2826
2626
|
* ```js
|
|
2827
2627
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -2839,7 +2639,6 @@ var Action;
|
|
|
2839
2639
|
* The **Drill down** menu action on Answers and Liveboard
|
|
2840
2640
|
* visualizations.
|
|
2841
2641
|
* Allows drilling down to a specific data point on a chart or table.
|
|
2842
|
-
*
|
|
2843
2642
|
* @example
|
|
2844
2643
|
* ```js
|
|
2845
2644
|
* disabledActions: [Action.DrillDown]
|
|
@@ -2849,7 +2648,6 @@ var Action;
|
|
|
2849
2648
|
/**
|
|
2850
2649
|
* The request access action on Liveboards.
|
|
2851
2650
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
2852
|
-
*
|
|
2853
2651
|
* @example
|
|
2854
2652
|
* ```js
|
|
2855
2653
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -2859,7 +2657,6 @@ var Action;
|
|
|
2859
2657
|
/**
|
|
2860
2658
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
2861
2659
|
* of the Answer page
|
|
2862
|
-
*
|
|
2863
2660
|
* @example
|
|
2864
2661
|
* ```js
|
|
2865
2662
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -2869,7 +2666,6 @@ var Action;
|
|
|
2869
2666
|
/**
|
|
2870
2667
|
* The **Delete** action for Answers in the full application
|
|
2871
2668
|
* embedding mode.
|
|
2872
|
-
*
|
|
2873
2669
|
* @example
|
|
2874
2670
|
* ```js
|
|
2875
2671
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -2879,7 +2675,6 @@ var Action;
|
|
|
2879
2675
|
Action["AnswerDelete"] = "onDeleteAnswer";
|
|
2880
2676
|
/**
|
|
2881
2677
|
* The Chart switcher icon on Answer and visualization pages.
|
|
2882
|
-
*
|
|
2883
2678
|
* @example
|
|
2884
2679
|
* ```js
|
|
2885
2680
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -2889,7 +2684,6 @@ var Action;
|
|
|
2889
2684
|
Action["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
2890
2685
|
/**
|
|
2891
2686
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
2892
|
-
*
|
|
2893
2687
|
* @example
|
|
2894
2688
|
* ```js
|
|
2895
2689
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -2899,7 +2693,6 @@ var Action;
|
|
|
2899
2693
|
Action["AddToFavorites"] = "addToFavorites";
|
|
2900
2694
|
/**
|
|
2901
2695
|
* The edit icon on Liveboards (Classic experience).
|
|
2902
|
-
*
|
|
2903
2696
|
* @example
|
|
2904
2697
|
* ```js
|
|
2905
2698
|
* disabledActions: [Action.EditDetails]
|
|
@@ -2909,7 +2702,6 @@ var Action;
|
|
|
2909
2702
|
Action["EditDetails"] = "editDetails";
|
|
2910
2703
|
/**
|
|
2911
2704
|
* The Create alert action on KPI charts.
|
|
2912
|
-
*
|
|
2913
2705
|
* @example
|
|
2914
2706
|
* ```js
|
|
2915
2707
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -2928,7 +2720,6 @@ var Action;
|
|
|
2928
2720
|
/**
|
|
2929
2721
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
2930
2722
|
* Allows sending data to a Google Sheet.
|
|
2931
|
-
*
|
|
2932
2723
|
* @example
|
|
2933
2724
|
* ```js
|
|
2934
2725
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -2940,7 +2731,6 @@ var Action;
|
|
|
2940
2731
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
2941
2732
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
2942
2733
|
* Microsoft Teams, and so on.
|
|
2943
|
-
*
|
|
2944
2734
|
* @example
|
|
2945
2735
|
* ```js
|
|
2946
2736
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2951,7 +2741,6 @@ var Action;
|
|
|
2951
2741
|
/**
|
|
2952
2742
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
2953
2743
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
2954
|
-
*
|
|
2955
2744
|
* @example
|
|
2956
2745
|
* ```js
|
|
2957
2746
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -2962,7 +2751,6 @@ var Action;
|
|
|
2962
2751
|
/**
|
|
2963
2752
|
* The **Filter** action on Liveboard visualizations.
|
|
2964
2753
|
* Allows users to apply cross-filters on a Liveboard.
|
|
2965
|
-
*
|
|
2966
2754
|
* @example
|
|
2967
2755
|
* ```js
|
|
2968
2756
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -2973,7 +2761,6 @@ var Action;
|
|
|
2973
2761
|
/**
|
|
2974
2762
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
2975
2763
|
* Allows sending data to third-party apps Slack
|
|
2976
|
-
*
|
|
2977
2764
|
* @example
|
|
2978
2765
|
* ```js
|
|
2979
2766
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -2984,7 +2771,6 @@ var Action;
|
|
|
2984
2771
|
/**
|
|
2985
2772
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
2986
2773
|
* Allows sending data to third-party apps Team
|
|
2987
|
-
*
|
|
2988
2774
|
* @example
|
|
2989
2775
|
* ```js
|
|
2990
2776
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -2996,7 +2782,6 @@ var Action;
|
|
|
2996
2782
|
* The **Remove** action that appears when cross filters are applied
|
|
2997
2783
|
* on a Liveboard.
|
|
2998
2784
|
* Removes filters applied o a visualization.
|
|
2999
|
-
*
|
|
3000
2785
|
* @example
|
|
3001
2786
|
* ```js
|
|
3002
2787
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3008,7 +2793,6 @@ var Action;
|
|
|
3008
2793
|
* The **Aggregate** option in the chart axis or the
|
|
3009
2794
|
* table column customization menu.
|
|
3010
2795
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3011
|
-
*
|
|
3012
2796
|
* @example
|
|
3013
2797
|
* ```js
|
|
3014
2798
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3020,7 +2804,6 @@ var Action;
|
|
|
3020
2804
|
* The **Time bucket** option in the chart axis or table column
|
|
3021
2805
|
* customization menu.
|
|
3022
2806
|
* Allows defining time metric for date comparison.
|
|
3023
|
-
*
|
|
3024
2807
|
* @example
|
|
3025
2808
|
* ```js
|
|
3026
2809
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3031,7 +2814,6 @@ var Action;
|
|
|
3031
2814
|
/**
|
|
3032
2815
|
* The **Filter** action in the chart axis or table column
|
|
3033
2816
|
* customization menu.
|
|
3034
|
-
*
|
|
3035
2817
|
* @example
|
|
3036
2818
|
* ```js
|
|
3037
2819
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3043,7 +2825,6 @@ var Action;
|
|
|
3043
2825
|
* The **Conditional formatting** action on chart or table.
|
|
3044
2826
|
* Allows adding rules for conditional formatting of data
|
|
3045
2827
|
* points on a chart or table.
|
|
3046
|
-
*
|
|
3047
2828
|
* @example
|
|
3048
2829
|
* ```js
|
|
3049
2830
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3055,7 +2836,6 @@ var Action;
|
|
|
3055
2836
|
* The **Sort** menu action on a table or chart axis
|
|
3056
2837
|
* Sorts data in ascending or descending order.
|
|
3057
2838
|
* Allows adding, editing, or removing filters.
|
|
3058
|
-
*
|
|
3059
2839
|
* @example
|
|
3060
2840
|
* ```js
|
|
3061
2841
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3068,7 +2848,6 @@ var Action;
|
|
|
3068
2848
|
* customization menu.
|
|
3069
2849
|
* Allows grouping data points if the axes use the same
|
|
3070
2850
|
* unit of measurement and a similar scale.
|
|
3071
|
-
*
|
|
3072
2851
|
* @example
|
|
3073
2852
|
* ```js
|
|
3074
2853
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3080,7 +2859,6 @@ var Action;
|
|
|
3080
2859
|
* The **Position** option in the axis customization menu.
|
|
3081
2860
|
* Allows changing the position of the axis to the
|
|
3082
2861
|
* left or right side of the chart.
|
|
3083
|
-
*
|
|
3084
2862
|
* @example
|
|
3085
2863
|
* ```js
|
|
3086
2864
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3091,7 +2869,6 @@ var Action;
|
|
|
3091
2869
|
/**
|
|
3092
2870
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3093
2871
|
* Renames the axis label on a chart or the column header on a table.
|
|
3094
|
-
*
|
|
3095
2872
|
* @example
|
|
3096
2873
|
* ```js
|
|
3097
2874
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3103,7 +2880,6 @@ var Action;
|
|
|
3103
2880
|
* The **Edit** action in the axis customization menu.
|
|
3104
2881
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3105
2882
|
* and format of a column.
|
|
3106
|
-
*
|
|
3107
2883
|
* @example
|
|
3108
2884
|
* ```js
|
|
3109
2885
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3114,7 +2890,6 @@ var Action;
|
|
|
3114
2890
|
/**
|
|
3115
2891
|
* The **Number format** action to customize the format of
|
|
3116
2892
|
* the data labels on a chart or table.
|
|
3117
|
-
*
|
|
3118
2893
|
* @example
|
|
3119
2894
|
* ```js
|
|
3120
2895
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3125,7 +2900,6 @@ var Action;
|
|
|
3125
2900
|
/**
|
|
3126
2901
|
* The **Text wrapping** action on a table.
|
|
3127
2902
|
* Wraps or clips column text on a table.
|
|
3128
|
-
*
|
|
3129
2903
|
* @example
|
|
3130
2904
|
* ```js
|
|
3131
2905
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3138,7 +2912,6 @@ var Action;
|
|
|
3138
2912
|
* customization menu.
|
|
3139
2913
|
* Removes the data labels from a chart or the column of a
|
|
3140
2914
|
* table visualization.
|
|
3141
|
-
*
|
|
3142
2915
|
* @example
|
|
3143
2916
|
* ```js
|
|
3144
2917
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3153,7 +2926,6 @@ var Action;
|
|
|
3153
2926
|
/**
|
|
3154
2927
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3155
2928
|
* Allows renaming a Liveboard or visualization.
|
|
3156
|
-
*
|
|
3157
2929
|
* @example
|
|
3158
2930
|
* ```js
|
|
3159
2931
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3197,7 +2969,6 @@ var Action;
|
|
|
3197
2969
|
/**
|
|
3198
2970
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
3199
2971
|
* Allows moving a visualization to a different tab.
|
|
3200
|
-
*
|
|
3201
2972
|
* @example
|
|
3202
2973
|
* ```js
|
|
3203
2974
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -3206,7 +2977,6 @@ var Action;
|
|
|
3206
2977
|
Action["MoveToTab"] = "onContainerMove";
|
|
3207
2978
|
/**
|
|
3208
2979
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
3209
|
-
*
|
|
3210
2980
|
* @example
|
|
3211
2981
|
* ```js
|
|
3212
2982
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -3215,7 +2985,6 @@ var Action;
|
|
|
3215
2985
|
Action["ManageMonitor"] = "ManageMonitor";
|
|
3216
2986
|
/**
|
|
3217
2987
|
* Action ID for Liveboard Personalised Views dropdown
|
|
3218
|
-
*
|
|
3219
2988
|
* @example
|
|
3220
2989
|
* ```js
|
|
3221
2990
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -3225,7 +2994,6 @@ var Action;
|
|
|
3225
2994
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
3226
2995
|
/**
|
|
3227
2996
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
3228
|
-
*
|
|
3229
2997
|
* @example
|
|
3230
2998
|
* ```js
|
|
3231
2999
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -3237,7 +3005,6 @@ var Action;
|
|
|
3237
3005
|
* Action ID for the Parent TML action
|
|
3238
3006
|
* The parent action **TML** must be included to access TML-related options
|
|
3239
3007
|
* within the cascading menu (specific to the answer page)
|
|
3240
|
-
*
|
|
3241
3008
|
* @example
|
|
3242
3009
|
* ```js
|
|
3243
3010
|
* // to include specific TML actions
|
|
@@ -3249,13 +3016,11 @@ var Action;
|
|
|
3249
3016
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
3250
3017
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
3251
3018
|
* ```
|
|
3252
|
-
*
|
|
3253
3019
|
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
3254
3020
|
*/
|
|
3255
3021
|
Action["TML"] = "tml";
|
|
3256
3022
|
/**
|
|
3257
3023
|
* Action ID for to hide Verified Liveboard Banner
|
|
3258
|
-
*
|
|
3259
3024
|
* @example
|
|
3260
3025
|
* ```js
|
|
3261
3026
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -3265,7 +3030,6 @@ var Action;
|
|
|
3265
3030
|
Action["VerifiedLiveboard"] = "verifiedLiveboard";
|
|
3266
3031
|
/**
|
|
3267
3032
|
* Action ID for ask sage button
|
|
3268
|
-
*
|
|
3269
3033
|
* @example
|
|
3270
3034
|
* ```js
|
|
3271
3035
|
* hiddenAction: [Action.AskAi]
|
|
@@ -3275,7 +3039,6 @@ var Action;
|
|
|
3275
3039
|
Action["AskAi"] = "AskAi";
|
|
3276
3040
|
/**
|
|
3277
3041
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
3278
|
-
*
|
|
3279
3042
|
* @example
|
|
3280
3043
|
* ```js
|
|
3281
3044
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -3285,7 +3048,6 @@ var Action;
|
|
|
3285
3048
|
Action["AddToWatchlist"] = "addToWatchlist";
|
|
3286
3049
|
/**
|
|
3287
3050
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
3288
|
-
*
|
|
3289
3051
|
* @example
|
|
3290
3052
|
* ```js
|
|
3291
3053
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -3295,7 +3057,6 @@ var Action;
|
|
|
3295
3057
|
Action["RemoveFromWatchlist"] = "removeFromWatchlist";
|
|
3296
3058
|
/**
|
|
3297
3059
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
3298
|
-
*
|
|
3299
3060
|
* @example
|
|
3300
3061
|
* ```js
|
|
3301
3062
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -3305,7 +3066,6 @@ var Action;
|
|
|
3305
3066
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
3306
3067
|
/**
|
|
3307
3068
|
* Action ID for AI Highlights button
|
|
3308
|
-
*
|
|
3309
3069
|
* @example
|
|
3310
3070
|
* ```js
|
|
3311
3071
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -3333,7 +3093,6 @@ var LogLevel;
|
|
|
3333
3093
|
(function (LogLevel) {
|
|
3334
3094
|
/**
|
|
3335
3095
|
* No logs will be logged in the console.
|
|
3336
|
-
*
|
|
3337
3096
|
* @example
|
|
3338
3097
|
* ```js
|
|
3339
3098
|
* init({
|
|
@@ -3346,7 +3105,6 @@ var LogLevel;
|
|
|
3346
3105
|
LogLevel["SILENT"] = "SILENT";
|
|
3347
3106
|
/**
|
|
3348
3107
|
* Only ERROR logs will be logged in the console.
|
|
3349
|
-
*
|
|
3350
3108
|
* @example
|
|
3351
3109
|
* ```js
|
|
3352
3110
|
* init({
|
|
@@ -3359,7 +3117,6 @@ var LogLevel;
|
|
|
3359
3117
|
LogLevel["ERROR"] = "ERROR";
|
|
3360
3118
|
/**
|
|
3361
3119
|
* Only WARN and ERROR logs will be logged in the console.
|
|
3362
|
-
*
|
|
3363
3120
|
* @example
|
|
3364
3121
|
* ```js
|
|
3365
3122
|
* init({
|
|
@@ -3372,7 +3129,6 @@ var LogLevel;
|
|
|
3372
3129
|
LogLevel["WARN"] = "WARN";
|
|
3373
3130
|
/**
|
|
3374
3131
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
3375
|
-
*
|
|
3376
3132
|
* @example
|
|
3377
3133
|
* ```js
|
|
3378
3134
|
* init({
|
|
@@ -3385,7 +3141,6 @@ var LogLevel;
|
|
|
3385
3141
|
LogLevel["INFO"] = "INFO";
|
|
3386
3142
|
/**
|
|
3387
3143
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
3388
|
-
*
|
|
3389
3144
|
* @example
|
|
3390
3145
|
* ```js
|
|
3391
3146
|
* init({
|
|
@@ -3398,7 +3153,6 @@ var LogLevel;
|
|
|
3398
3153
|
LogLevel["DEBUG"] = "DEBUG";
|
|
3399
3154
|
/**
|
|
3400
3155
|
* All logs will be logged in the console.
|
|
3401
|
-
*
|
|
3402
3156
|
* @example
|
|
3403
3157
|
* ```js
|
|
3404
3158
|
* init({
|