@thoughtspot/visual-embed-sdk 1.53.1 → 1.53.2-beta
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/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +25 -6
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.js +40 -8
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/contracts/contracts.spec.js +165 -2
- package/cjs/src/contracts/contracts.spec.js.map +1 -1
- package/cjs/src/contracts/embed-event-payloads.d.ts +212 -14
- package/cjs/src/contracts/embed-event-payloads.d.ts.map +1 -1
- package/cjs/src/contracts/host-event-contracts.d.ts +1 -0
- package/cjs/src/contracts/host-event-contracts.d.ts.map +1 -1
- package/cjs/src/css-variables.d.ts +140 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/auto-frame-renderer.d.ts +14 -1
- package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -1
- package/cjs/src/embed/auto-frame-renderer.js +91 -2
- package/cjs/src/embed/auto-frame-renderer.js.map +1 -1
- package/cjs/src/embed/auto-frame-renderer.spec.js +112 -7
- package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +18 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +42 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/react/util.d.ts +8 -1
- package/cjs/src/react/util.d.ts.map +1 -1
- package/cjs/src/react/util.js.map +1 -1
- package/cjs/src/types.d.ts +181 -1
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +180 -0
- package/cjs/src/types.js.map +1 -1
- package/dist/{index-CrBnZBZv.js → index-DQ7r5f1z.js} +1 -1
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/contracts/embed-event-payloads.d.ts +212 -14
- package/dist/src/contracts/embed-event-payloads.d.ts.map +1 -1
- package/dist/src/contracts/host-event-contracts.d.ts +1 -0
- package/dist/src/contracts/host-event-contracts.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +140 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/auto-frame-renderer.d.ts +14 -1
- package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -1
- package/dist/src/react/util.d.ts +8 -1
- package/dist/src/react/util.d.ts.map +1 -1
- package/dist/src/types.d.ts +181 -1
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +230 -9
- package/dist/tsembed-react.js +229 -8
- package/dist/tsembed.es.js +298 -10
- package/dist/tsembed.js +297 -9
- package/dist/visual-embed-sdk-react-full.d.ts +534 -13
- package/dist/visual-embed-sdk-react.d.ts +531 -11
- package/dist/visual-embed-sdk.d.ts +527 -12
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +25 -6
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +40 -8
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/contracts/contracts.spec.js +165 -2
- package/lib/src/contracts/contracts.spec.js.map +1 -1
- package/lib/src/contracts/embed-event-payloads.d.ts +212 -14
- package/lib/src/contracts/embed-event-payloads.d.ts.map +1 -1
- package/lib/src/contracts/host-event-contracts.d.ts +1 -0
- package/lib/src/contracts/host-event-contracts.d.ts.map +1 -1
- package/lib/src/css-variables.d.ts +140 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/auto-frame-renderer.d.ts +14 -1
- package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -1
- package/lib/src/embed/auto-frame-renderer.js +91 -2
- package/lib/src/embed/auto-frame-renderer.js.map +1 -1
- package/lib/src/embed/auto-frame-renderer.spec.js +113 -8
- package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +18 -0
- package/lib/src/embed/host-events.spec.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +42 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/react/util.d.ts +8 -1
- package/lib/src/react/util.d.ts.map +1 -1
- package/lib/src/react/util.js.map +1 -1
- package/lib/src/types.d.ts +181 -1
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +180 -0
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +527 -12
- package/package.json +1 -1
- package/src/auth.spec.ts +47 -11
- package/src/auth.ts +35 -6
- package/src/contracts/contracts.spec.ts +182 -3
- package/src/contracts/embed-event-payloads.ts +281 -14
- package/src/contracts/host-event-contracts.ts +1 -0
- package/src/css-variables.ts +168 -0
- package/src/embed/auto-frame-renderer.spec.ts +134 -8
- package/src/embed/auto-frame-renderer.ts +103 -2
- package/src/embed/host-events.spec.ts +24 -0
- package/src/embed/liveboard.spec.ts +45 -0
- package/src/react/util.ts +13 -1
- package/src/types.ts +181 -0
|
@@ -1468,6 +1468,146 @@ export interface CustomCssVariables {
|
|
|
1468
1468
|
* Background color of the shimmer sweep animation's gradient mid-stop.
|
|
1469
1469
|
*/
|
|
1470
1470
|
"--ts-var-shimmer-sweep-background"?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* Secondary accent color. Used as the background of cross-filter chips in the
|
|
1473
|
+
* filter panel and to highlight Liveboard visualizations and Answer headers
|
|
1474
|
+
* impacted by a cross filter.
|
|
1475
|
+
*/
|
|
1476
|
+
"--ts-var-root-secondary-color"?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* Background color of the action items in the top navigation bar, such as the
|
|
1479
|
+
* search bar, Help menu, Org switcher, user menu, and notifications, on hover
|
|
1480
|
+
* or when selected.
|
|
1481
|
+
*/
|
|
1482
|
+
"--ts-var-nav-action-item-background"?: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* Border color of the action items in the top navigation bar, such as the
|
|
1485
|
+
* Org switcher and the search bar.
|
|
1486
|
+
*/
|
|
1487
|
+
"--ts-var-nav-action-item-border-color"?: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* Border color of the search bar in the top navigation bar on hover.
|
|
1490
|
+
*/
|
|
1491
|
+
"--ts-var-nav-action-item-border-secondary-color"?: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* Placeholder text color of the search bar and menus in the top navigation
|
|
1494
|
+
* bar. Also used as the background of the Help menu button when the menu
|
|
1495
|
+
* is open.
|
|
1496
|
+
*/
|
|
1497
|
+
"--ts-var-nav-action-item-placeholder-color"?: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* Background color of the natural language search bar header in Sage
|
|
1500
|
+
* embed.
|
|
1501
|
+
*/
|
|
1502
|
+
"--ts-var-sage-bar-header-background-color"?: string;
|
|
1503
|
+
/**
|
|
1504
|
+
* Background color of the data source selector in the natural language
|
|
1505
|
+
* search bar.
|
|
1506
|
+
*/
|
|
1507
|
+
"--ts-var-source-selector-background-color"?: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* Background color of the data source selector in the natural language
|
|
1510
|
+
* search bar on hover.
|
|
1511
|
+
*/
|
|
1512
|
+
"--ts-var-source-selector-hover-color"?: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* Font color of the text in the natural language search box.
|
|
1515
|
+
*/
|
|
1516
|
+
"--ts-var-sage-search-box-font-color"?: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Background color of the natural language search box.
|
|
1519
|
+
*/
|
|
1520
|
+
"--ts-var-sage-search-box-background-color"?: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* Background color of the AI-generated answer container in Sage embed.
|
|
1523
|
+
*/
|
|
1524
|
+
"--ts-var-sage-embed-background-color"?: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* Background color of the suggested (seed) questions shown in the natural
|
|
1527
|
+
* language search bar and Spotter.
|
|
1528
|
+
*/
|
|
1529
|
+
"--ts-var-sage-seed-questions-background"?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Font color of the suggested (seed) questions shown in the natural
|
|
1532
|
+
* language search bar and Spotter.
|
|
1533
|
+
*/
|
|
1534
|
+
"--ts-var-sage-seed-questions-font-color"?: string;
|
|
1535
|
+
/**
|
|
1536
|
+
* Background color of the suggested (seed) questions shown in the natural
|
|
1537
|
+
* language search bar and Spotter on hover.
|
|
1538
|
+
*/
|
|
1539
|
+
"--ts-var-sage-seed-questions-hover-background"?: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* Background of the AI gradient border around the natural language search bar
|
|
1542
|
+
* and the Spotter prompt input. Accepts any CSS background value, for example,
|
|
1543
|
+
* a `linear-gradient(...)` or a solid color.
|
|
1544
|
+
*/
|
|
1545
|
+
"--ts-var-ai-gradient-color"?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* Background color of the separator line between sections of a menu.
|
|
1548
|
+
*/
|
|
1549
|
+
"--ts-var-menu-seperator-background"?: string;
|
|
1550
|
+
/**
|
|
1551
|
+
* Start color of the gradient background on the icon of custom menu items in
|
|
1552
|
+
* the navigation. Defaults to the value of `--ts-var-root-color`.
|
|
1553
|
+
*/
|
|
1554
|
+
"--ts-var-home-card-color"?: string;
|
|
1555
|
+
/**
|
|
1556
|
+
* Font color of the heading text on the suggestion cards in the favorites
|
|
1557
|
+
* carousel on the Home page.
|
|
1558
|
+
*/
|
|
1559
|
+
"--ts-var-home-favorite-suggestion-card-text-font-color"?: string;
|
|
1560
|
+
/**
|
|
1561
|
+
* Background color of a highlighted checkbox row on hover.
|
|
1562
|
+
*/
|
|
1563
|
+
"--ts-var-checkbox-highlighted-hover-color"?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* Font family of the group title in a Liveboard. Defaults to the value of
|
|
1566
|
+
* `--ts-var-viz-title-font-family`.
|
|
1567
|
+
*/
|
|
1568
|
+
"--ts-var-liveboard-group-title-font-family"?: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* Font family of the group description in a Liveboard. Defaults to the value
|
|
1571
|
+
* of `--ts-var-viz-description-font-family`.
|
|
1572
|
+
*/
|
|
1573
|
+
"--ts-var-liveboard-group-description-font-family"?: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* Font family of the visualization titles inside a Liveboard group. Defaults
|
|
1576
|
+
* to the value of `--ts-var-viz-title-font-family`.
|
|
1577
|
+
*/
|
|
1578
|
+
"--ts-var-liveboard-group-tile-title-font-family"?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* Font family of the visualization descriptions inside a Liveboard group.
|
|
1581
|
+
* Defaults to the value of `--ts-var-viz-description-font-family`.
|
|
1582
|
+
*/
|
|
1583
|
+
"--ts-var-liveboard-group-tile-description-font-family"?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Font color of the filter chips in a Liveboard on hover. Defaults to the
|
|
1586
|
+
* value of `--ts-var-chip--hover-color`.
|
|
1587
|
+
*/
|
|
1588
|
+
"--ts-var-liveboard-chip--hover-color"?: string;
|
|
1589
|
+
/**
|
|
1590
|
+
* Font color of the filter chips in a Liveboard when active. Defaults to the
|
|
1591
|
+
* value of `--ts-var-chip--active-color`.
|
|
1592
|
+
*/
|
|
1593
|
+
"--ts-var-liveboard-chip--active-color"?: string;
|
|
1594
|
+
/**
|
|
1595
|
+
* Background color of the styling panel in the Liveboard. Defaults to the
|
|
1596
|
+
* value of `--ts-var-liveboard-edit-bar-background`.
|
|
1597
|
+
*/
|
|
1598
|
+
"--ts-var-liveboard-styling-panel-background"?: string;
|
|
1599
|
+
/**
|
|
1600
|
+
* Border radius of the visualization container on the Answer page. On a
|
|
1601
|
+
* Liveboard, this value is derived from `--ts-var-liveboard-tile-border-radius`
|
|
1602
|
+
* and `--ts-var-viz-border-radius`; use those to style Liveboard tiles.
|
|
1603
|
+
*/
|
|
1604
|
+
"--ts-var-tile-viz-border-radius"?: string;
|
|
1605
|
+
/**
|
|
1606
|
+
* Color of the outline (halo) drawn around data labels on charts, which keeps
|
|
1607
|
+
* the labels readable over chart elements. Defaults to the value of
|
|
1608
|
+
* `--ts-var-root-color`.
|
|
1609
|
+
*/
|
|
1610
|
+
"--ts-var-chart-data-label-stroke-color"?: string;
|
|
1471
1611
|
}
|
|
1472
1612
|
export interface SessionInterface {
|
|
1473
1613
|
sessionId: string;
|
|
@@ -4446,6 +4586,7 @@ export declare enum EmbedEvent {
|
|
|
4446
4586
|
* })
|
|
4447
4587
|
* ```
|
|
4448
4588
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
4589
|
+
* Payload: {@link AuthInitPayload}.
|
|
4449
4590
|
*/
|
|
4450
4591
|
AuthInit = "authInit",
|
|
4451
4592
|
/**
|
|
@@ -4465,6 +4606,7 @@ export declare enum EmbedEvent {
|
|
|
4465
4606
|
/**
|
|
4466
4607
|
* Data pertaining to an Answer, Liveboard or Spotter visualization is received.
|
|
4467
4608
|
* The event payload includes the raw data of the object.
|
|
4609
|
+
* Payload: {@link DataEventPayload}.
|
|
4468
4610
|
* @return data - Answer of Liveboard data
|
|
4469
4611
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
4470
4612
|
* @example
|
|
@@ -4478,6 +4620,7 @@ export declare enum EmbedEvent {
|
|
|
4478
4620
|
Data = "data",
|
|
4479
4621
|
/**
|
|
4480
4622
|
* Search query has been updated by the user.
|
|
4623
|
+
* Payload: {@link QueryChangedPayload} or a string.
|
|
4481
4624
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
4482
4625
|
* @example
|
|
4483
4626
|
* ```js
|
|
@@ -4520,6 +4663,7 @@ export declare enum EmbedEvent {
|
|
|
4520
4663
|
* })
|
|
4521
4664
|
* })
|
|
4522
4665
|
* ```
|
|
4666
|
+
* Payload: {@link DrilldownPayload}.
|
|
4523
4667
|
*/
|
|
4524
4668
|
Drilldown = "drillDown",
|
|
4525
4669
|
/**
|
|
@@ -4532,6 +4676,7 @@ export declare enum EmbedEvent {
|
|
|
4532
4676
|
* console.log('DataSourceSelected', payload);
|
|
4533
4677
|
* })
|
|
4534
4678
|
* ```
|
|
4679
|
+
* Payload: {@link DataSourceSelectedPayload} or string[].
|
|
4535
4680
|
*/
|
|
4536
4681
|
DataSourceSelected = "dataSourceSelected",
|
|
4537
4682
|
/**
|
|
@@ -4544,6 +4689,7 @@ export declare enum EmbedEvent {
|
|
|
4544
4689
|
* console.log('AddRemoveColumns', payload);
|
|
4545
4690
|
* })
|
|
4546
4691
|
* ```
|
|
4692
|
+
* Payload: string[].
|
|
4547
4693
|
*/
|
|
4548
4694
|
AddRemoveColumns = "addRemoveColumns",
|
|
4549
4695
|
/**
|
|
@@ -4561,6 +4707,7 @@ export declare enum EmbedEvent {
|
|
|
4561
4707
|
* }
|
|
4562
4708
|
* })
|
|
4563
4709
|
* ```
|
|
4710
|
+
* Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
|
|
4564
4711
|
*/
|
|
4565
4712
|
CustomAction = "customAction",
|
|
4566
4713
|
/**
|
|
@@ -4573,6 +4720,7 @@ export declare enum EmbedEvent {
|
|
|
4573
4720
|
* console.log('VizPointDoubleClick', payload);
|
|
4574
4721
|
* })
|
|
4575
4722
|
* ```
|
|
4723
|
+
* Payload: {@link VizInteractionPayload}.
|
|
4576
4724
|
*/
|
|
4577
4725
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
4578
4726
|
/**
|
|
@@ -4592,6 +4740,7 @@ export declare enum EmbedEvent {
|
|
|
4592
4740
|
* )
|
|
4593
4741
|
* });
|
|
4594
4742
|
* ```
|
|
4743
|
+
* Payload: {@link VizInteractionPayload}.
|
|
4595
4744
|
*/
|
|
4596
4745
|
VizPointClick = "vizPointClick",
|
|
4597
4746
|
/**
|
|
@@ -4644,6 +4793,7 @@ export declare enum EmbedEvent {
|
|
|
4644
4793
|
* // { errorType: "API", message: '...', code: '...' }
|
|
4645
4794
|
* });
|
|
4646
4795
|
* ```
|
|
4796
|
+
* Payload: {@link EmbedErrorPayload} or a string.
|
|
4647
4797
|
*/
|
|
4648
4798
|
Error = "Error",
|
|
4649
4799
|
/**
|
|
@@ -4694,6 +4844,7 @@ export declare enum EmbedEvent {
|
|
|
4694
4844
|
* The center of visible iframe viewport is calculated.
|
|
4695
4845
|
* @returns data - The center of the visible Iframe viewport.
|
|
4696
4846
|
* @hidden
|
|
4847
|
+
* Payload: none.
|
|
4697
4848
|
*/
|
|
4698
4849
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
4699
4850
|
/**
|
|
@@ -4750,6 +4901,7 @@ export declare enum EmbedEvent {
|
|
|
4750
4901
|
* console.log('dialog open', payload);
|
|
4751
4902
|
* })
|
|
4752
4903
|
* ```
|
|
4904
|
+
* Payload: none.
|
|
4753
4905
|
*/
|
|
4754
4906
|
DialogOpen = "dialog-open",
|
|
4755
4907
|
/**
|
|
@@ -4761,6 +4913,7 @@ export declare enum EmbedEvent {
|
|
|
4761
4913
|
* console.log('dialog close', payload);
|
|
4762
4914
|
* })
|
|
4763
4915
|
* ```
|
|
4916
|
+
* Payload: none.
|
|
4764
4917
|
*/
|
|
4765
4918
|
DialogClose = "dialog-close",
|
|
4766
4919
|
/**
|
|
@@ -4783,6 +4936,7 @@ export declare enum EmbedEvent {
|
|
|
4783
4936
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
4784
4937
|
* };
|
|
4785
4938
|
* ```
|
|
4939
|
+
* Payload: none.
|
|
4786
4940
|
*/
|
|
4787
4941
|
LiveboardRendered = "PinboardRendered",
|
|
4788
4942
|
/**
|
|
@@ -4813,6 +4967,7 @@ export declare enum EmbedEvent {
|
|
|
4813
4967
|
* console.log('Save', payload)
|
|
4814
4968
|
* })
|
|
4815
4969
|
* ```
|
|
4970
|
+
* Payload: {@link SaveEventPayload}.
|
|
4816
4971
|
*/
|
|
4817
4972
|
Save = "save",
|
|
4818
4973
|
/**
|
|
@@ -4829,6 +4984,7 @@ export declare enum EmbedEvent {
|
|
|
4829
4984
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
4830
4985
|
* })
|
|
4831
4986
|
* ```
|
|
4987
|
+
* Payload: {@link VizScope}.
|
|
4832
4988
|
*/
|
|
4833
4989
|
Download = "download",
|
|
4834
4990
|
/**
|
|
@@ -4848,6 +5004,7 @@ export declare enum EmbedEvent {
|
|
|
4848
5004
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
4849
5005
|
* console.log('download PNG', payload)})
|
|
4850
5006
|
* ```
|
|
5007
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4851
5008
|
*/
|
|
4852
5009
|
DownloadAsPng = "downloadAsPng",
|
|
4853
5010
|
/**
|
|
@@ -4867,6 +5024,7 @@ export declare enum EmbedEvent {
|
|
|
4867
5024
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
4868
5025
|
* console.log('download PDF', payload)})
|
|
4869
5026
|
* ```
|
|
5027
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4870
5028
|
*/
|
|
4871
5029
|
DownloadAsPdf = "downloadAsPdf",
|
|
4872
5030
|
/**
|
|
@@ -4886,6 +5044,7 @@ export declare enum EmbedEvent {
|
|
|
4886
5044
|
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
4887
5045
|
* console.log('download CSV', payload)})
|
|
4888
5046
|
* ```
|
|
5047
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4889
5048
|
*/
|
|
4890
5049
|
DownloadAsCsv = "downloadAsCsv",
|
|
4891
5050
|
/**
|
|
@@ -4905,6 +5064,7 @@ export declare enum EmbedEvent {
|
|
|
4905
5064
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
4906
5065
|
* console.log('download Xlsx', payload)})
|
|
4907
5066
|
* ```
|
|
5067
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4908
5068
|
*/
|
|
4909
5069
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
4910
5070
|
/**
|
|
@@ -4916,6 +5076,7 @@ export declare enum EmbedEvent {
|
|
|
4916
5076
|
* liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
|
|
4917
5077
|
* console.log('download liveboard as continuous PDF', payload)})
|
|
4918
5078
|
* ```
|
|
5079
|
+
* Payload: {@link LiveboardScope}.
|
|
4919
5080
|
*/
|
|
4920
5081
|
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
4921
5082
|
/**
|
|
@@ -4932,6 +5093,7 @@ export declare enum EmbedEvent {
|
|
|
4932
5093
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
4933
5094
|
* console.log('delete answer', payload)})
|
|
4934
5095
|
* ```
|
|
5096
|
+
* Payload: {@link AnswerScope}.
|
|
4935
5097
|
*/
|
|
4936
5098
|
AnswerDelete = "answerDelete",
|
|
4937
5099
|
/**
|
|
@@ -4943,6 +5105,7 @@ export declare enum EmbedEvent {
|
|
|
4943
5105
|
* console.log('AI Highlights', payload);
|
|
4944
5106
|
* })
|
|
4945
5107
|
* ```
|
|
5108
|
+
* Payload: {@link LiveboardScope}.
|
|
4946
5109
|
*/
|
|
4947
5110
|
AIHighlights = "AIHighlights",
|
|
4948
5111
|
/**
|
|
@@ -4964,6 +5127,7 @@ export declare enum EmbedEvent {
|
|
|
4964
5127
|
* console.log('pin', payload)
|
|
4965
5128
|
* })
|
|
4966
5129
|
* ```
|
|
5130
|
+
* Payload: {@link PinEventPayload}.
|
|
4967
5131
|
*/
|
|
4968
5132
|
Pin = "pin",
|
|
4969
5133
|
/**
|
|
@@ -4982,6 +5146,7 @@ export declare enum EmbedEvent {
|
|
|
4982
5146
|
* console.log('SpotIQ analyze', payload)
|
|
4983
5147
|
* })
|
|
4984
5148
|
* ```
|
|
5149
|
+
* Payload: {@link AnswerScope}.
|
|
4985
5150
|
*/
|
|
4986
5151
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
4987
5152
|
/**
|
|
@@ -5035,6 +5200,7 @@ export declare enum EmbedEvent {
|
|
|
5035
5200
|
* console.log('copy to clipboard', payload);
|
|
5036
5201
|
* })
|
|
5037
5202
|
* ```
|
|
5203
|
+
* Payload: {@link CopyToClipboardPayload}.
|
|
5038
5204
|
*/
|
|
5039
5205
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
5040
5206
|
/**
|
|
@@ -5046,6 +5212,7 @@ export declare enum EmbedEvent {
|
|
|
5046
5212
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
5047
5213
|
* })
|
|
5048
5214
|
* ```
|
|
5215
|
+
* Payload: {@link TmlEventPayload}.
|
|
5049
5216
|
*/
|
|
5050
5217
|
UpdateTML = "updateTSL",
|
|
5051
5218
|
/**
|
|
@@ -5058,6 +5225,7 @@ export declare enum EmbedEvent {
|
|
|
5058
5225
|
* console.log('Edit TML', payload);
|
|
5059
5226
|
* })
|
|
5060
5227
|
* ```
|
|
5228
|
+
* Payload: {@link TmlEventPayload}.
|
|
5061
5229
|
*/
|
|
5062
5230
|
EditTML = "editTSL",
|
|
5063
5231
|
/**
|
|
@@ -5075,6 +5243,7 @@ export declare enum EmbedEvent {
|
|
|
5075
5243
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
5076
5244
|
* console.log('Export TML', payload)})
|
|
5077
5245
|
* ```
|
|
5246
|
+
* Payload: {@link TmlEventPayload}.
|
|
5078
5247
|
*/
|
|
5079
5248
|
ExportTML = "exportTSL",
|
|
5080
5249
|
/**
|
|
@@ -5113,6 +5282,7 @@ export declare enum EmbedEvent {
|
|
|
5113
5282
|
* console.log('show data', payload);
|
|
5114
5283
|
* })
|
|
5115
5284
|
* ```
|
|
5285
|
+
* Payload: {@link AnswerScope}.
|
|
5116
5286
|
*/
|
|
5117
5287
|
ShowUnderlyingData = "showUnderlyingData",
|
|
5118
5288
|
/**
|
|
@@ -5124,6 +5294,7 @@ export declare enum EmbedEvent {
|
|
|
5124
5294
|
* console.log('switch view', payload);
|
|
5125
5295
|
* })
|
|
5126
5296
|
* ```
|
|
5297
|
+
* Payload: {@link AnswerChartSwitcherPayload}.
|
|
5127
5298
|
*/
|
|
5128
5299
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5129
5300
|
/**
|
|
@@ -5145,6 +5316,7 @@ export declare enum EmbedEvent {
|
|
|
5145
5316
|
* console.log('Liveboard details', payload);
|
|
5146
5317
|
* })
|
|
5147
5318
|
* ```
|
|
5319
|
+
* Payload: {@link LiveboardScope}.
|
|
5148
5320
|
*/
|
|
5149
5321
|
LiveboardInfo = "pinboardInfo",
|
|
5150
5322
|
/**
|
|
@@ -5156,6 +5328,7 @@ export declare enum EmbedEvent {
|
|
|
5156
5328
|
* console.log('favorites', payload);
|
|
5157
5329
|
* })
|
|
5158
5330
|
* ```
|
|
5331
|
+
* Payload: {@link FavoritePayload}.
|
|
5159
5332
|
*/
|
|
5160
5333
|
AddToFavorites = "addToFavorites",
|
|
5161
5334
|
/**
|
|
@@ -5167,6 +5340,7 @@ export declare enum EmbedEvent {
|
|
|
5167
5340
|
* console.log('Liveboard schedule', payload);
|
|
5168
5341
|
* })
|
|
5169
5342
|
* ```
|
|
5343
|
+
* Payload: {@link LiveboardScope}.
|
|
5170
5344
|
*/
|
|
5171
5345
|
Schedule = "subscription",
|
|
5172
5346
|
/**
|
|
@@ -5181,6 +5355,7 @@ export declare enum EmbedEvent {
|
|
|
5181
5355
|
* console.log('Liveboard edit', payload);
|
|
5182
5356
|
* })
|
|
5183
5357
|
* ```
|
|
5358
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5184
5359
|
*/
|
|
5185
5360
|
Edit = "edit",
|
|
5186
5361
|
/**
|
|
@@ -5222,6 +5397,7 @@ export declare enum EmbedEvent {
|
|
|
5222
5397
|
* console.log('Copy', payload);
|
|
5223
5398
|
* })
|
|
5224
5399
|
* ```
|
|
5400
|
+
* Payload: {@link MakeACopyPayload}.
|
|
5225
5401
|
*/
|
|
5226
5402
|
MakeACopy = "makeACopy",
|
|
5227
5403
|
/**
|
|
@@ -5237,6 +5413,7 @@ export declare enum EmbedEvent {
|
|
|
5237
5413
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5238
5414
|
* })
|
|
5239
5415
|
* ```
|
|
5416
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5240
5417
|
*/
|
|
5241
5418
|
Present = "present",
|
|
5242
5419
|
/**
|
|
@@ -5247,6 +5424,7 @@ export declare enum EmbedEvent {
|
|
|
5247
5424
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
5248
5425
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5249
5426
|
* ```
|
|
5427
|
+
* Payload: {@link LiveboardScope}.
|
|
5250
5428
|
*/
|
|
5251
5429
|
Delete = "delete",
|
|
5252
5430
|
/**
|
|
@@ -5256,6 +5434,7 @@ export declare enum EmbedEvent {
|
|
|
5256
5434
|
* ```js
|
|
5257
5435
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
5258
5436
|
* ```
|
|
5437
|
+
* Payload: {@link LiveboardScope}.
|
|
5259
5438
|
*/
|
|
5260
5439
|
SchedulesList = "schedule-list",
|
|
5261
5440
|
/**
|
|
@@ -5265,6 +5444,7 @@ export declare enum EmbedEvent {
|
|
|
5265
5444
|
* ```js
|
|
5266
5445
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
5267
5446
|
* ```
|
|
5447
|
+
* Payload: {@link LiveboardScope}.
|
|
5268
5448
|
*/
|
|
5269
5449
|
Cancel = "cancel",
|
|
5270
5450
|
/**
|
|
@@ -5275,6 +5455,7 @@ export declare enum EmbedEvent {
|
|
|
5275
5455
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
5276
5456
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5277
5457
|
* ```
|
|
5458
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5278
5459
|
*/
|
|
5279
5460
|
Explore = "explore",
|
|
5280
5461
|
/**
|
|
@@ -5285,6 +5466,7 @@ export declare enum EmbedEvent {
|
|
|
5285
5466
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
5286
5467
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5287
5468
|
* ```
|
|
5469
|
+
* Payload: {@link CopyLinkPayload}.
|
|
5288
5470
|
*/
|
|
5289
5471
|
CopyLink = "embedDocument",
|
|
5290
5472
|
/**
|
|
@@ -5296,6 +5478,7 @@ export declare enum EmbedEvent {
|
|
|
5296
5478
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
5297
5479
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5298
5480
|
* ```
|
|
5481
|
+
* Payload: {@link CrossFilterChangedPayload}.
|
|
5299
5482
|
*/
|
|
5300
5483
|
CrossFilterChanged = "cross-filter-changed",
|
|
5301
5484
|
/**
|
|
@@ -5307,6 +5490,7 @@ export declare enum EmbedEvent {
|
|
|
5307
5490
|
* console.log('VizPointClick', payload)
|
|
5308
5491
|
* })
|
|
5309
5492
|
* ```
|
|
5493
|
+
* Payload: {@link VizInteractionPayload}.
|
|
5310
5494
|
*/
|
|
5311
5495
|
VizPointRightClick = "vizPointRightClick",
|
|
5312
5496
|
/**
|
|
@@ -5334,6 +5518,7 @@ export declare enum EmbedEvent {
|
|
|
5334
5518
|
* })
|
|
5335
5519
|
* ```
|
|
5336
5520
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
5521
|
+
* Payload: {@link FilterChangedPayload}.
|
|
5337
5522
|
*/
|
|
5338
5523
|
FilterChanged = "filterChanged",
|
|
5339
5524
|
/**
|
|
@@ -5356,6 +5541,7 @@ export declare enum EmbedEvent {
|
|
|
5356
5541
|
* @returns isPublic: boolean
|
|
5357
5542
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5358
5543
|
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5544
|
+
* Payload: {@link PersonalisedViewPayload}.
|
|
5359
5545
|
*/
|
|
5360
5546
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
5361
5547
|
/**
|
|
@@ -5377,6 +5563,7 @@ export declare enum EmbedEvent {
|
|
|
5377
5563
|
* @returns isPublic: boolean
|
|
5378
5564
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5379
5565
|
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5566
|
+
* Payload: {@link PersonalisedViewPayload}.
|
|
5380
5567
|
*/
|
|
5381
5568
|
SavePersonalisedView = "savePersonalisedView",
|
|
5382
5569
|
/**
|
|
@@ -5451,6 +5638,7 @@ export declare enum EmbedEvent {
|
|
|
5451
5638
|
/**
|
|
5452
5639
|
* Emitted when a Liveboard or visualization is renamed.
|
|
5453
5640
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
5641
|
+
* Payload: {@link RenamePayload}.
|
|
5454
5642
|
*/
|
|
5455
5643
|
Rename = "rename",
|
|
5456
5644
|
/**
|
|
@@ -5536,6 +5724,7 @@ export declare enum EmbedEvent {
|
|
|
5536
5724
|
* })
|
|
5537
5725
|
* ```
|
|
5538
5726
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
5727
|
+
* Payload: {@link ParameterChangedPayload}.
|
|
5539
5728
|
*/
|
|
5540
5729
|
ParameterChanged = "parameterChanged",
|
|
5541
5730
|
/**
|
|
@@ -5579,6 +5768,7 @@ export declare enum EmbedEvent {
|
|
|
5579
5768
|
* })
|
|
5580
5769
|
* ```
|
|
5581
5770
|
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
5771
|
+
* Payload: {@link TableVizRenderedPayload}.
|
|
5582
5772
|
*/
|
|
5583
5773
|
TableVizRendered = "TableVizRendered",
|
|
5584
5774
|
/**
|
|
@@ -5603,12 +5793,14 @@ export declare enum EmbedEvent {
|
|
|
5603
5793
|
* @hidden
|
|
5604
5794
|
* Emitted when a user exits present mode.
|
|
5605
5795
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5796
|
+
* Payload: {@link ExitPresentModePayload}.
|
|
5606
5797
|
*/
|
|
5607
5798
|
ExitPresentMode = "exitPresentMode",
|
|
5608
5799
|
/**
|
|
5609
5800
|
* Emitted when a user requests the full height lazy load data.
|
|
5610
5801
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
5611
5802
|
* @hidden
|
|
5803
|
+
* Payload: none.
|
|
5612
5804
|
*/
|
|
5613
5805
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
5614
5806
|
/**
|
|
@@ -5642,6 +5834,7 @@ export declare enum EmbedEvent {
|
|
|
5642
5834
|
* })
|
|
5643
5835
|
* ```
|
|
5644
5836
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5837
|
+
* Payload: {@link VizScope}.
|
|
5645
5838
|
*/
|
|
5646
5839
|
AddToCoaching = "addToCoaching",
|
|
5647
5840
|
/**
|
|
@@ -5731,6 +5924,7 @@ export declare enum EmbedEvent {
|
|
|
5731
5924
|
* console.log('EmbedListenerReady');
|
|
5732
5925
|
* })
|
|
5733
5926
|
* ```
|
|
5927
|
+
* Payload: none.
|
|
5734
5928
|
*/
|
|
5735
5929
|
EmbedListenerReady = "EmbedListenerReady",
|
|
5736
5930
|
/**
|
|
@@ -6105,6 +6299,7 @@ export declare enum EmbedEvent {
|
|
|
6105
6299
|
* })
|
|
6106
6300
|
* ```
|
|
6107
6301
|
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
6302
|
+
* Payload: {@link TestScheduleEmailPayload}.
|
|
6108
6303
|
*/
|
|
6109
6304
|
SendTestScheduleEmail = "sendTestScheduleEmail",
|
|
6110
6305
|
/**
|
|
@@ -6615,6 +6810,19 @@ export declare enum HostEvent {
|
|
|
6615
6810
|
* ```
|
|
6616
6811
|
*/
|
|
6617
6812
|
OpenAddParameterModal = "openAddParameterModal",
|
|
6813
|
+
/**
|
|
6814
|
+
* Add a tab to the Liveboard, the same action as the *Tab* option in the
|
|
6815
|
+
* *Add* dropdown in the Liveboard edit header.
|
|
6816
|
+
*
|
|
6817
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
6818
|
+
*
|
|
6819
|
+
* @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
|
|
6820
|
+
* @example
|
|
6821
|
+
* ```js
|
|
6822
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
|
|
6823
|
+
* ```
|
|
6824
|
+
*/
|
|
6825
|
+
OpenAddTabModal = "openAddTabModal",
|
|
6618
6826
|
/**
|
|
6619
6827
|
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
6620
6828
|
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
@@ -8832,6 +9040,21 @@ export type SpotterFileUploadFileTypes = {
|
|
|
8832
9040
|
*/
|
|
8833
9041
|
export declare enum Action {
|
|
8834
9042
|
/**
|
|
9043
|
+
* The **Add** button on a Liveboard in edit mode.
|
|
9044
|
+
* Controls the visibility and disabled state of the Add panel button
|
|
9045
|
+
* in the Liveboard edit toolbar, which allows users to add
|
|
9046
|
+
* visualizations, filters, parameters, and tabs.
|
|
9047
|
+
* @example
|
|
9048
|
+
* ```js
|
|
9049
|
+
* hiddenActions: [Action.LiveboardAddPanel]
|
|
9050
|
+
* // or
|
|
9051
|
+
* disabledActions: [Action.LiveboardAddPanel]
|
|
9052
|
+
* ```
|
|
9053
|
+
* @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
|
|
9054
|
+
*/
|
|
9055
|
+
LiveboardAddPanel = "liveboardAddPanel",
|
|
9056
|
+
/**
|
|
9057
|
+
*
|
|
8835
9058
|
* The **Save** action on an Answer or Liveboard.
|
|
8836
9059
|
* Allows users to save the changes.
|
|
8837
9060
|
* @example
|
|
@@ -11082,7 +11305,103 @@ export declare enum Action {
|
|
|
11082
11305
|
* });
|
|
11083
11306
|
* ```
|
|
11084
11307
|
*/
|
|
11085
|
-
Cancel = "cancel"
|
|
11308
|
+
Cancel = "cancel",
|
|
11309
|
+
/**
|
|
11310
|
+
* Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
|
|
11311
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
11312
|
+
* @example
|
|
11313
|
+
* ```js
|
|
11314
|
+
* {
|
|
11315
|
+
* hiddenActions: [Action.ShowVersionHistory],
|
|
11316
|
+
* disabledActions: [Action.ShowVersionHistory],
|
|
11317
|
+
* }
|
|
11318
|
+
* ```
|
|
11319
|
+
*/
|
|
11320
|
+
ShowVersionHistory = "showVersionHistory",
|
|
11321
|
+
/**
|
|
11322
|
+
* Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
|
|
11323
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
|
|
11324
|
+
* @example
|
|
11325
|
+
* ```js
|
|
11326
|
+
* {
|
|
11327
|
+
* hiddenActions: [Action.EnableVersionControl],
|
|
11328
|
+
* disabledActions: [Action.EnableVersionControl],
|
|
11329
|
+
* }
|
|
11330
|
+
* ```
|
|
11331
|
+
*/
|
|
11332
|
+
EnableVersionControl = "enableVersionControl",
|
|
11333
|
+
/**
|
|
11334
|
+
* Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
|
|
11335
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
|
|
11336
|
+
* @example
|
|
11337
|
+
* ```js
|
|
11338
|
+
* {
|
|
11339
|
+
* hiddenActions: [Action.DisableVersionControl],
|
|
11340
|
+
* disabledActions: [Action.DisableVersionControl],
|
|
11341
|
+
* }
|
|
11342
|
+
* ```
|
|
11343
|
+
*/
|
|
11344
|
+
DisableVersionControl = "disableVersionControl",
|
|
11345
|
+
/**
|
|
11346
|
+
* Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
|
|
11347
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
11348
|
+
* @example
|
|
11349
|
+
* ```js
|
|
11350
|
+
* {
|
|
11351
|
+
* hiddenActions: [Action.WithdrawVerification],
|
|
11352
|
+
* disabledActions: [Action.WithdrawVerification],
|
|
11353
|
+
* }
|
|
11354
|
+
* ```
|
|
11355
|
+
*/
|
|
11356
|
+
WithdrawVerification = "withdrawVerification",
|
|
11357
|
+
/**
|
|
11358
|
+
* Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
|
|
11359
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
11360
|
+
* @example
|
|
11361
|
+
* ```js
|
|
11362
|
+
* {
|
|
11363
|
+
* hiddenActions: [Action.SwitchToNewChartExperience],
|
|
11364
|
+
* disabledActions: [Action.SwitchToNewChartExperience],
|
|
11365
|
+
* }
|
|
11366
|
+
* ```
|
|
11367
|
+
*/
|
|
11368
|
+
SwitchToNewChartExperience = "switchToNewChartExperience",
|
|
11369
|
+
/**
|
|
11370
|
+
* Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
|
|
11371
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
11372
|
+
* @example
|
|
11373
|
+
* ```js
|
|
11374
|
+
* {
|
|
11375
|
+
* hiddenActions: [Action.SwitchToClassicChartExperience],
|
|
11376
|
+
* disabledActions: [Action.SwitchToClassicChartExperience],
|
|
11377
|
+
* }
|
|
11378
|
+
* ```
|
|
11379
|
+
*/
|
|
11380
|
+
SwitchToClassicChartExperience = "switchToClassicChartExperience",
|
|
11381
|
+
/**
|
|
11382
|
+
* Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
|
|
11383
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
|
|
11384
|
+
* @example
|
|
11385
|
+
* ```js
|
|
11386
|
+
* {
|
|
11387
|
+
* hiddenActions: [Action.Monitor],
|
|
11388
|
+
* disabledActions: [Action.Monitor],
|
|
11389
|
+
* }
|
|
11390
|
+
* ```
|
|
11391
|
+
*/
|
|
11392
|
+
Monitor = "monitor",
|
|
11393
|
+
/**
|
|
11394
|
+
* Controls the visibility and disabled state of the "View explanation" button in the footer of a Spotter answer, which opens the explanation and verification details.
|
|
11395
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
|
|
11396
|
+
* @example
|
|
11397
|
+
* ```js
|
|
11398
|
+
* {
|
|
11399
|
+
* hiddenActions: [Action.SpotterViewExplanation],
|
|
11400
|
+
* disabledActions: [Action.SpotterViewExplanation],
|
|
11401
|
+
* }
|
|
11402
|
+
* ```
|
|
11403
|
+
*/
|
|
11404
|
+
SpotterViewExplanation = "spotterViewExplanation"
|
|
11086
11405
|
}
|
|
11087
11406
|
declare enum ContextMenuTriggerOptions {
|
|
11088
11407
|
LEFT_CLICK = "left-click",
|
|
@@ -12593,6 +12912,7 @@ export interface HostEventRequestMap {
|
|
|
12593
12912
|
[HostEvent.AIHighlights]: void;
|
|
12594
12913
|
[HostEvent.SendTestScheduleEmail]: ScheduleEmailRequest;
|
|
12595
12914
|
[HostEvent.RefreshLiveboardBrowserCache]: ScheduleEmailRequest;
|
|
12915
|
+
[HostEvent.OpenAddTabModal]: void;
|
|
12596
12916
|
[HostEvent.SpotterSearch]: SpotterSearchRequest;
|
|
12597
12917
|
[HostEvent.ResetSpotterConversation]: void;
|
|
12598
12918
|
[HostEvent.ShareSpotterConversation]: ConversationScopedRequest;
|
|
@@ -12654,22 +12974,216 @@ export type TriggerData<HostEventT extends HostEvent> = HostEventRequest<HostEve
|
|
|
12654
12974
|
*/
|
|
12655
12975
|
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType = ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
12656
12976
|
/**
|
|
12657
|
-
*
|
|
12977
|
+
* Base for every payload. Known fields are declared on the interfaces below;
|
|
12978
|
+
* additional fields the host may send stay `any`, so a callback reading one
|
|
12979
|
+
* keeps compiling.
|
|
12658
12980
|
*/
|
|
12659
|
-
export interface
|
|
12660
|
-
[
|
|
12661
|
-
|
|
12662
|
-
|
|
12663
|
-
|
|
12664
|
-
|
|
12665
|
-
|
|
12981
|
+
export interface EmbedEventPayloadBase {
|
|
12982
|
+
[key: string]: any;
|
|
12983
|
+
}
|
|
12984
|
+
/** Present on events raised from a Spotter conversation. */
|
|
12985
|
+
export interface ConversationScope extends EmbedEventPayloadBase {
|
|
12986
|
+
convId?: string;
|
|
12987
|
+
messageId?: string;
|
|
12988
|
+
}
|
|
12989
|
+
/** Scoped to a single visualization (optionally within a conversation). */
|
|
12990
|
+
export interface VizScope extends ConversationScope {
|
|
12991
|
+
vizId?: string;
|
|
12992
|
+
}
|
|
12993
|
+
/** Scoped to a Liveboard. */
|
|
12994
|
+
export interface LiveboardScope extends EmbedEventPayloadBase {
|
|
12995
|
+
liveboardId?: string;
|
|
12996
|
+
}
|
|
12997
|
+
/** Scoped to an Answer. */
|
|
12998
|
+
export interface AnswerScope extends EmbedEventPayloadBase {
|
|
12999
|
+
answerId?: string;
|
|
13000
|
+
vizId?: string;
|
|
13001
|
+
}
|
|
13002
|
+
/** Actions available on a viz within a Liveboard. */
|
|
13003
|
+
export interface LiveboardVizScope extends LiveboardScope, VizScope {
|
|
13004
|
+
}
|
|
13005
|
+
/** An empty payload — the event carries no data. */
|
|
13006
|
+
export type EmptyPayload = Record<string, never>;
|
|
13007
|
+
/** The answer data backing the embed, delivered with {@link EmbedEvent.Data}. */
|
|
13008
|
+
export interface DataEventPayload extends VizScope {
|
|
13009
|
+
embedAnswerData?: any;
|
|
13010
|
+
}
|
|
13011
|
+
/** {@link EmbedEvent.Error}. `message` may be a single string or a list. */
|
|
13012
|
+
export interface EmbedErrorPayload extends EmbedEventPayloadBase {
|
|
13013
|
+
errorType?: any;
|
|
13014
|
+
message?: string | string[];
|
|
13015
|
+
code?: any;
|
|
13016
|
+
error?: {
|
|
13017
|
+
message?: string;
|
|
12666
13018
|
};
|
|
13019
|
+
errors?: string[];
|
|
13020
|
+
}
|
|
13021
|
+
export interface FilterChangedPayload extends EmbedEventPayloadBase {
|
|
13022
|
+
liveboardFilters?: any[];
|
|
13023
|
+
runtimeFilters?: RuntimeFilter[];
|
|
13024
|
+
}
|
|
13025
|
+
export interface CrossFilterChangedPayload extends EmbedEventPayloadBase {
|
|
13026
|
+
action?: string;
|
|
13027
|
+
filterContentList?: any;
|
|
13028
|
+
filterRemoved?: string[];
|
|
13029
|
+
removableColumnsFilterContent?: any;
|
|
13030
|
+
}
|
|
13031
|
+
export interface ParameterChangedPayload extends ConversationScope {
|
|
13032
|
+
parameters?: any[];
|
|
13033
|
+
}
|
|
13034
|
+
export interface QueryChangedPayload extends VizScope {
|
|
13035
|
+
search?: string;
|
|
13036
|
+
}
|
|
13037
|
+
/**
|
|
13038
|
+
* Data-source(s) chosen in the picker. The host sends an object; older hosts may
|
|
13039
|
+
* send a bare list of worksheet ids, so {@link EmbedEvent.DataSourceSelected}
|
|
13040
|
+
* resolves to `string[] | DataSourceSelectedPayload`.
|
|
13041
|
+
*/
|
|
13042
|
+
export interface DataSourceSelectedPayload extends EmbedEventPayloadBase {
|
|
13043
|
+
worksheetId?: string;
|
|
13044
|
+
worksheetName?: string;
|
|
13045
|
+
worksheetIds?: string[];
|
|
13046
|
+
}
|
|
13047
|
+
/** Shared by {@link EmbedEvent.VizPointClick} and its siblings. */
|
|
13048
|
+
export interface VizInteractionPayload extends VizScope {
|
|
13049
|
+
clickedPoint?: any;
|
|
13050
|
+
selectedPoints?: any[];
|
|
13051
|
+
embedAnswerData?: any;
|
|
13052
|
+
}
|
|
13053
|
+
export interface DrilldownPayload extends ConversationScope {
|
|
13054
|
+
drillColumn?: any;
|
|
13055
|
+
clickedPoint?: any;
|
|
13056
|
+
selectedPoints?: any[];
|
|
13057
|
+
}
|
|
13058
|
+
export interface TableVizRenderedPayload extends VizScope {
|
|
13059
|
+
id?: string;
|
|
13060
|
+
data?: any;
|
|
13061
|
+
}
|
|
13062
|
+
export interface SaveEventPayload extends LiveboardVizScope {
|
|
13063
|
+
answerId?: string;
|
|
13064
|
+
}
|
|
13065
|
+
export interface MakeACopyPayload extends LiveboardVizScope {
|
|
13066
|
+
newLiveboardId?: string;
|
|
13067
|
+
}
|
|
13068
|
+
/** Downloads, either viz/answer scoped or Liveboard scoped. */
|
|
13069
|
+
export interface DownloadEventPayload extends VizScope {
|
|
13070
|
+
answerId?: string;
|
|
13071
|
+
liveboardId?: string;
|
|
13072
|
+
}
|
|
13073
|
+
/** TML export/edit/update — answer or Liveboard scoped. */
|
|
13074
|
+
export interface TmlEventPayload extends EmbedEventPayloadBase {
|
|
13075
|
+
answerId?: string;
|
|
13076
|
+
liveboardId?: string;
|
|
13077
|
+
vizId?: string;
|
|
13078
|
+
}
|
|
13079
|
+
export interface AnswerChartSwitcherPayload extends ConversationScope {
|
|
13080
|
+
answerId?: string;
|
|
13081
|
+
/** The mode switched to (chart or table). */
|
|
13082
|
+
chartType?: string;
|
|
13083
|
+
}
|
|
13084
|
+
export interface CopyToClipboardPayload extends ConversationScope {
|
|
13085
|
+
answerId?: string;
|
|
13086
|
+
}
|
|
13087
|
+
export interface PinEventPayload extends VizScope {
|
|
13088
|
+
liveboardId?: string;
|
|
13089
|
+
containerId?: string;
|
|
13090
|
+
answerId?: string;
|
|
13091
|
+
}
|
|
13092
|
+
export interface CopyLinkPayload extends LiveboardScope {
|
|
13093
|
+
vizId?: string;
|
|
13094
|
+
metricId?: any;
|
|
13095
|
+
}
|
|
13096
|
+
export interface FavoritePayload extends LiveboardScope {
|
|
13097
|
+
isFavorite?: boolean;
|
|
13098
|
+
}
|
|
13099
|
+
export interface TestScheduleEmailPayload extends LiveboardScope {
|
|
13100
|
+
sendToSelf?: boolean;
|
|
13101
|
+
}
|
|
13102
|
+
/** Note: the app sends `liveboardID` (capital ID) for this event. */
|
|
13103
|
+
export interface RenamePayload extends EmbedEventPayloadBase {
|
|
13104
|
+
liveboardID?: string;
|
|
13105
|
+
vizId?: string;
|
|
13106
|
+
title?: string;
|
|
13107
|
+
description?: string;
|
|
13108
|
+
}
|
|
13109
|
+
export interface PersonalisedViewPayload extends LiveboardScope {
|
|
13110
|
+
viewName?: string;
|
|
13111
|
+
viewId?: string;
|
|
13112
|
+
isPublic?: boolean;
|
|
13113
|
+
}
|
|
13114
|
+
export interface ExitPresentModePayload extends EmbedEventPayloadBase {
|
|
13115
|
+
type?: string;
|
|
13116
|
+
data?: any;
|
|
13117
|
+
}
|
|
13118
|
+
/** {@link EmbedEvent.AuthInit}. */
|
|
13119
|
+
export interface AuthInitPayload extends EmbedEventPayloadBase {
|
|
13120
|
+
/** Whether authentication was successful. */
|
|
13121
|
+
isLoggedIn?: boolean;
|
|
13122
|
+
}
|
|
13123
|
+
/**
|
|
13124
|
+
* Typed `data` field per embed event. Events not listed resolve to `any`.
|
|
13125
|
+
*/
|
|
13126
|
+
export interface EmbedEventDataExtension {
|
|
13127
|
+
[EmbedEvent.AuthInit]: AuthInitPayload;
|
|
12667
13128
|
[EmbedEvent.EmbedListenerReady]: Record<string, any>;
|
|
13129
|
+
[EmbedEvent.Error]: EmbedErrorPayload | string;
|
|
12668
13130
|
/**
|
|
12669
13131
|
* Fired when a callback-type custom action is triggered. Use
|
|
12670
|
-
* `payload.data.id` to identify which action fired
|
|
13132
|
+
* `payload.data.id` to identify which action fired; see also
|
|
13133
|
+
* {@link CustomActionEventPayload} for the `answerService` enrichment.
|
|
12671
13134
|
*/
|
|
12672
13135
|
[EmbedEvent.CustomAction]: CustomActionPayload;
|
|
13136
|
+
[EmbedEvent.FilterChanged]: FilterChangedPayload;
|
|
13137
|
+
[EmbedEvent.CrossFilterChanged]: CrossFilterChangedPayload;
|
|
13138
|
+
[EmbedEvent.ParameterChanged]: ParameterChangedPayload;
|
|
13139
|
+
[EmbedEvent.VizPointClick]: VizInteractionPayload;
|
|
13140
|
+
[EmbedEvent.VizPointDoubleClick]: VizInteractionPayload;
|
|
13141
|
+
[EmbedEvent.VizPointRightClick]: VizInteractionPayload;
|
|
13142
|
+
[EmbedEvent.Drilldown]: DrilldownPayload;
|
|
13143
|
+
[EmbedEvent.TableVizRendered]: TableVizRenderedPayload;
|
|
13144
|
+
[EmbedEvent.Data]: DataEventPayload;
|
|
13145
|
+
[EmbedEvent.QueryChanged]: string | QueryChangedPayload;
|
|
13146
|
+
[EmbedEvent.Save]: SaveEventPayload;
|
|
13147
|
+
[EmbedEvent.Edit]: LiveboardVizScope;
|
|
13148
|
+
[EmbedEvent.Present]: LiveboardVizScope;
|
|
13149
|
+
[EmbedEvent.Explore]: LiveboardVizScope;
|
|
13150
|
+
[EmbedEvent.MakeACopy]: MakeACopyPayload;
|
|
13151
|
+
[EmbedEvent.AnswerDelete]: AnswerScope;
|
|
13152
|
+
[EmbedEvent.AnswerChartSwitcher]: AnswerChartSwitcherPayload;
|
|
13153
|
+
[EmbedEvent.CopyToClipboard]: CopyToClipboardPayload;
|
|
13154
|
+
[EmbedEvent.SpotIQAnalyze]: AnswerScope;
|
|
13155
|
+
[EmbedEvent.ShowUnderlyingData]: AnswerScope;
|
|
13156
|
+
[EmbedEvent.AddToCoaching]: VizScope;
|
|
13157
|
+
[EmbedEvent.Pin]: PinEventPayload;
|
|
13158
|
+
[EmbedEvent.Download]: VizScope;
|
|
13159
|
+
[EmbedEvent.DownloadAsPng]: DownloadEventPayload;
|
|
13160
|
+
[EmbedEvent.DownloadAsCsv]: DownloadEventPayload;
|
|
13161
|
+
[EmbedEvent.DownloadAsXlsx]: DownloadEventPayload;
|
|
13162
|
+
[EmbedEvent.DownloadAsPdf]: DownloadEventPayload;
|
|
13163
|
+
[EmbedEvent.DownloadLiveboardAsContinuousPDF]: LiveboardScope;
|
|
13164
|
+
[EmbedEvent.ExportTML]: TmlEventPayload;
|
|
13165
|
+
[EmbedEvent.EditTML]: TmlEventPayload;
|
|
13166
|
+
[EmbedEvent.UpdateTML]: TmlEventPayload;
|
|
13167
|
+
[EmbedEvent.Cancel]: LiveboardScope;
|
|
13168
|
+
[EmbedEvent.Delete]: LiveboardScope;
|
|
13169
|
+
[EmbedEvent.Schedule]: LiveboardScope;
|
|
13170
|
+
[EmbedEvent.SchedulesList]: LiveboardScope;
|
|
13171
|
+
[EmbedEvent.SendTestScheduleEmail]: TestScheduleEmailPayload;
|
|
13172
|
+
[EmbedEvent.LiveboardInfo]: LiveboardScope;
|
|
13173
|
+
[EmbedEvent.AIHighlights]: LiveboardScope;
|
|
13174
|
+
[EmbedEvent.Rename]: RenamePayload;
|
|
13175
|
+
[EmbedEvent.AddToFavorites]: FavoritePayload;
|
|
13176
|
+
[EmbedEvent.CopyLink]: CopyLinkPayload;
|
|
13177
|
+
[EmbedEvent.ExitPresentMode]: ExitPresentModePayload;
|
|
13178
|
+
[EmbedEvent.SavePersonalisedView]: PersonalisedViewPayload;
|
|
13179
|
+
[EmbedEvent.UpdatePersonalisedView]: PersonalisedViewPayload;
|
|
13180
|
+
[EmbedEvent.AddRemoveColumns]: string[];
|
|
13181
|
+
[EmbedEvent.DataSourceSelected]: string[] | DataSourceSelectedPayload;
|
|
13182
|
+
[EmbedEvent.DialogOpen]: EmptyPayload;
|
|
13183
|
+
[EmbedEvent.DialogClose]: EmptyPayload;
|
|
13184
|
+
[EmbedEvent.LiveboardRendered]: EmptyPayload;
|
|
13185
|
+
[EmbedEvent.RequestVisibleEmbedCoordinates]: EmptyPayload;
|
|
13186
|
+
[EmbedEvent.EmbedIframeCenter]: EmptyPayload;
|
|
12673
13187
|
}
|
|
12674
13188
|
/**
|
|
12675
13189
|
* Resolves the typed `data` payload for an embed event; `any` when the
|
|
@@ -16503,8 +17017,14 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
16503
17017
|
}
|
|
16504
17018
|
export interface EmbedViewConfig extends AllEmbedViewConfig, EmbedEventHandlers {
|
|
16505
17019
|
}
|
|
17020
|
+
/**
|
|
17021
|
+
* `on{Event}` handler props for the React components. Each handler receives the
|
|
17022
|
+
* payload typed for its event (the same {@link EmbedEventPayload} the imperative
|
|
17023
|
+
* `embed.on()` delivers), so `onData`, `onVizPointClick`, etc. are per-event
|
|
17024
|
+
* typed rather than the loose {@link MessageCallback}.
|
|
17025
|
+
*/
|
|
16506
17026
|
export type EmbedEventHandlers = {
|
|
16507
|
-
[
|
|
17027
|
+
[K in keyof typeof EmbedEvent as `on${Capitalize<K>}`]?: (payload: EmbedEventPayload<(typeof EmbedEvent)[K]>, responder?: (data: any) => void) => void;
|
|
16508
17028
|
};
|
|
16509
17029
|
export interface EmbedProps extends EmbedViewConfig {
|
|
16510
17030
|
className?: string;
|