@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;
|
|
@@ -4432,6 +4572,7 @@ export declare enum EmbedEvent {
|
|
|
4432
4572
|
* })
|
|
4433
4573
|
* ```
|
|
4434
4574
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
4575
|
+
* Payload: {@link AuthInitPayload}.
|
|
4435
4576
|
*/
|
|
4436
4577
|
AuthInit = "authInit",
|
|
4437
4578
|
/**
|
|
@@ -4451,6 +4592,7 @@ export declare enum EmbedEvent {
|
|
|
4451
4592
|
/**
|
|
4452
4593
|
* Data pertaining to an Answer, Liveboard or Spotter visualization is received.
|
|
4453
4594
|
* The event payload includes the raw data of the object.
|
|
4595
|
+
* Payload: {@link DataEventPayload}.
|
|
4454
4596
|
* @return data - Answer of Liveboard data
|
|
4455
4597
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
4456
4598
|
* @example
|
|
@@ -4464,6 +4606,7 @@ export declare enum EmbedEvent {
|
|
|
4464
4606
|
Data = "data",
|
|
4465
4607
|
/**
|
|
4466
4608
|
* Search query has been updated by the user.
|
|
4609
|
+
* Payload: {@link QueryChangedPayload} or a string.
|
|
4467
4610
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
4468
4611
|
* @example
|
|
4469
4612
|
* ```js
|
|
@@ -4506,6 +4649,7 @@ export declare enum EmbedEvent {
|
|
|
4506
4649
|
* })
|
|
4507
4650
|
* })
|
|
4508
4651
|
* ```
|
|
4652
|
+
* Payload: {@link DrilldownPayload}.
|
|
4509
4653
|
*/
|
|
4510
4654
|
Drilldown = "drillDown",
|
|
4511
4655
|
/**
|
|
@@ -4518,6 +4662,7 @@ export declare enum EmbedEvent {
|
|
|
4518
4662
|
* console.log('DataSourceSelected', payload);
|
|
4519
4663
|
* })
|
|
4520
4664
|
* ```
|
|
4665
|
+
* Payload: {@link DataSourceSelectedPayload} or string[].
|
|
4521
4666
|
*/
|
|
4522
4667
|
DataSourceSelected = "dataSourceSelected",
|
|
4523
4668
|
/**
|
|
@@ -4530,6 +4675,7 @@ export declare enum EmbedEvent {
|
|
|
4530
4675
|
* console.log('AddRemoveColumns', payload);
|
|
4531
4676
|
* })
|
|
4532
4677
|
* ```
|
|
4678
|
+
* Payload: string[].
|
|
4533
4679
|
*/
|
|
4534
4680
|
AddRemoveColumns = "addRemoveColumns",
|
|
4535
4681
|
/**
|
|
@@ -4547,6 +4693,7 @@ export declare enum EmbedEvent {
|
|
|
4547
4693
|
* }
|
|
4548
4694
|
* })
|
|
4549
4695
|
* ```
|
|
4696
|
+
* Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
|
|
4550
4697
|
*/
|
|
4551
4698
|
CustomAction = "customAction",
|
|
4552
4699
|
/**
|
|
@@ -4559,6 +4706,7 @@ export declare enum EmbedEvent {
|
|
|
4559
4706
|
* console.log('VizPointDoubleClick', payload);
|
|
4560
4707
|
* })
|
|
4561
4708
|
* ```
|
|
4709
|
+
* Payload: {@link VizInteractionPayload}.
|
|
4562
4710
|
*/
|
|
4563
4711
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
4564
4712
|
/**
|
|
@@ -4578,6 +4726,7 @@ export declare enum EmbedEvent {
|
|
|
4578
4726
|
* )
|
|
4579
4727
|
* });
|
|
4580
4728
|
* ```
|
|
4729
|
+
* Payload: {@link VizInteractionPayload}.
|
|
4581
4730
|
*/
|
|
4582
4731
|
VizPointClick = "vizPointClick",
|
|
4583
4732
|
/**
|
|
@@ -4630,6 +4779,7 @@ export declare enum EmbedEvent {
|
|
|
4630
4779
|
* // { errorType: "API", message: '...', code: '...' }
|
|
4631
4780
|
* });
|
|
4632
4781
|
* ```
|
|
4782
|
+
* Payload: {@link EmbedErrorPayload} or a string.
|
|
4633
4783
|
*/
|
|
4634
4784
|
Error = "Error",
|
|
4635
4785
|
/**
|
|
@@ -4680,6 +4830,7 @@ export declare enum EmbedEvent {
|
|
|
4680
4830
|
* The center of visible iframe viewport is calculated.
|
|
4681
4831
|
* @returns data - The center of the visible Iframe viewport.
|
|
4682
4832
|
* @hidden
|
|
4833
|
+
* Payload: none.
|
|
4683
4834
|
*/
|
|
4684
4835
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
4685
4836
|
/**
|
|
@@ -4736,6 +4887,7 @@ export declare enum EmbedEvent {
|
|
|
4736
4887
|
* console.log('dialog open', payload);
|
|
4737
4888
|
* })
|
|
4738
4889
|
* ```
|
|
4890
|
+
* Payload: none.
|
|
4739
4891
|
*/
|
|
4740
4892
|
DialogOpen = "dialog-open",
|
|
4741
4893
|
/**
|
|
@@ -4747,6 +4899,7 @@ export declare enum EmbedEvent {
|
|
|
4747
4899
|
* console.log('dialog close', payload);
|
|
4748
4900
|
* })
|
|
4749
4901
|
* ```
|
|
4902
|
+
* Payload: none.
|
|
4750
4903
|
*/
|
|
4751
4904
|
DialogClose = "dialog-close",
|
|
4752
4905
|
/**
|
|
@@ -4769,6 +4922,7 @@ export declare enum EmbedEvent {
|
|
|
4769
4922
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
4770
4923
|
* };
|
|
4771
4924
|
* ```
|
|
4925
|
+
* Payload: none.
|
|
4772
4926
|
*/
|
|
4773
4927
|
LiveboardRendered = "PinboardRendered",
|
|
4774
4928
|
/**
|
|
@@ -4799,6 +4953,7 @@ export declare enum EmbedEvent {
|
|
|
4799
4953
|
* console.log('Save', payload)
|
|
4800
4954
|
* })
|
|
4801
4955
|
* ```
|
|
4956
|
+
* Payload: {@link SaveEventPayload}.
|
|
4802
4957
|
*/
|
|
4803
4958
|
Save = "save",
|
|
4804
4959
|
/**
|
|
@@ -4815,6 +4970,7 @@ export declare enum EmbedEvent {
|
|
|
4815
4970
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
4816
4971
|
* })
|
|
4817
4972
|
* ```
|
|
4973
|
+
* Payload: {@link VizScope}.
|
|
4818
4974
|
*/
|
|
4819
4975
|
Download = "download",
|
|
4820
4976
|
/**
|
|
@@ -4834,6 +4990,7 @@ export declare enum EmbedEvent {
|
|
|
4834
4990
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
4835
4991
|
* console.log('download PNG', payload)})
|
|
4836
4992
|
* ```
|
|
4993
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4837
4994
|
*/
|
|
4838
4995
|
DownloadAsPng = "downloadAsPng",
|
|
4839
4996
|
/**
|
|
@@ -4853,6 +5010,7 @@ export declare enum EmbedEvent {
|
|
|
4853
5010
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
4854
5011
|
* console.log('download PDF', payload)})
|
|
4855
5012
|
* ```
|
|
5013
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4856
5014
|
*/
|
|
4857
5015
|
DownloadAsPdf = "downloadAsPdf",
|
|
4858
5016
|
/**
|
|
@@ -4872,6 +5030,7 @@ export declare enum EmbedEvent {
|
|
|
4872
5030
|
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
4873
5031
|
* console.log('download CSV', payload)})
|
|
4874
5032
|
* ```
|
|
5033
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4875
5034
|
*/
|
|
4876
5035
|
DownloadAsCsv = "downloadAsCsv",
|
|
4877
5036
|
/**
|
|
@@ -4891,6 +5050,7 @@ export declare enum EmbedEvent {
|
|
|
4891
5050
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
4892
5051
|
* console.log('download Xlsx', payload)})
|
|
4893
5052
|
* ```
|
|
5053
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4894
5054
|
*/
|
|
4895
5055
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
4896
5056
|
/**
|
|
@@ -4902,6 +5062,7 @@ export declare enum EmbedEvent {
|
|
|
4902
5062
|
* liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
|
|
4903
5063
|
* console.log('download liveboard as continuous PDF', payload)})
|
|
4904
5064
|
* ```
|
|
5065
|
+
* Payload: {@link LiveboardScope}.
|
|
4905
5066
|
*/
|
|
4906
5067
|
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
4907
5068
|
/**
|
|
@@ -4918,6 +5079,7 @@ export declare enum EmbedEvent {
|
|
|
4918
5079
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
4919
5080
|
* console.log('delete answer', payload)})
|
|
4920
5081
|
* ```
|
|
5082
|
+
* Payload: {@link AnswerScope}.
|
|
4921
5083
|
*/
|
|
4922
5084
|
AnswerDelete = "answerDelete",
|
|
4923
5085
|
/**
|
|
@@ -4929,6 +5091,7 @@ export declare enum EmbedEvent {
|
|
|
4929
5091
|
* console.log('AI Highlights', payload);
|
|
4930
5092
|
* })
|
|
4931
5093
|
* ```
|
|
5094
|
+
* Payload: {@link LiveboardScope}.
|
|
4932
5095
|
*/
|
|
4933
5096
|
AIHighlights = "AIHighlights",
|
|
4934
5097
|
/**
|
|
@@ -4950,6 +5113,7 @@ export declare enum EmbedEvent {
|
|
|
4950
5113
|
* console.log('pin', payload)
|
|
4951
5114
|
* })
|
|
4952
5115
|
* ```
|
|
5116
|
+
* Payload: {@link PinEventPayload}.
|
|
4953
5117
|
*/
|
|
4954
5118
|
Pin = "pin",
|
|
4955
5119
|
/**
|
|
@@ -4968,6 +5132,7 @@ export declare enum EmbedEvent {
|
|
|
4968
5132
|
* console.log('SpotIQ analyze', payload)
|
|
4969
5133
|
* })
|
|
4970
5134
|
* ```
|
|
5135
|
+
* Payload: {@link AnswerScope}.
|
|
4971
5136
|
*/
|
|
4972
5137
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
4973
5138
|
/**
|
|
@@ -5021,6 +5186,7 @@ export declare enum EmbedEvent {
|
|
|
5021
5186
|
* console.log('copy to clipboard', payload);
|
|
5022
5187
|
* })
|
|
5023
5188
|
* ```
|
|
5189
|
+
* Payload: {@link CopyToClipboardPayload}.
|
|
5024
5190
|
*/
|
|
5025
5191
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
5026
5192
|
/**
|
|
@@ -5032,6 +5198,7 @@ export declare enum EmbedEvent {
|
|
|
5032
5198
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
5033
5199
|
* })
|
|
5034
5200
|
* ```
|
|
5201
|
+
* Payload: {@link TmlEventPayload}.
|
|
5035
5202
|
*/
|
|
5036
5203
|
UpdateTML = "updateTSL",
|
|
5037
5204
|
/**
|
|
@@ -5044,6 +5211,7 @@ export declare enum EmbedEvent {
|
|
|
5044
5211
|
* console.log('Edit TML', payload);
|
|
5045
5212
|
* })
|
|
5046
5213
|
* ```
|
|
5214
|
+
* Payload: {@link TmlEventPayload}.
|
|
5047
5215
|
*/
|
|
5048
5216
|
EditTML = "editTSL",
|
|
5049
5217
|
/**
|
|
@@ -5061,6 +5229,7 @@ export declare enum EmbedEvent {
|
|
|
5061
5229
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
5062
5230
|
* console.log('Export TML', payload)})
|
|
5063
5231
|
* ```
|
|
5232
|
+
* Payload: {@link TmlEventPayload}.
|
|
5064
5233
|
*/
|
|
5065
5234
|
ExportTML = "exportTSL",
|
|
5066
5235
|
/**
|
|
@@ -5099,6 +5268,7 @@ export declare enum EmbedEvent {
|
|
|
5099
5268
|
* console.log('show data', payload);
|
|
5100
5269
|
* })
|
|
5101
5270
|
* ```
|
|
5271
|
+
* Payload: {@link AnswerScope}.
|
|
5102
5272
|
*/
|
|
5103
5273
|
ShowUnderlyingData = "showUnderlyingData",
|
|
5104
5274
|
/**
|
|
@@ -5110,6 +5280,7 @@ export declare enum EmbedEvent {
|
|
|
5110
5280
|
* console.log('switch view', payload);
|
|
5111
5281
|
* })
|
|
5112
5282
|
* ```
|
|
5283
|
+
* Payload: {@link AnswerChartSwitcherPayload}.
|
|
5113
5284
|
*/
|
|
5114
5285
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5115
5286
|
/**
|
|
@@ -5131,6 +5302,7 @@ export declare enum EmbedEvent {
|
|
|
5131
5302
|
* console.log('Liveboard details', payload);
|
|
5132
5303
|
* })
|
|
5133
5304
|
* ```
|
|
5305
|
+
* Payload: {@link LiveboardScope}.
|
|
5134
5306
|
*/
|
|
5135
5307
|
LiveboardInfo = "pinboardInfo",
|
|
5136
5308
|
/**
|
|
@@ -5142,6 +5314,7 @@ export declare enum EmbedEvent {
|
|
|
5142
5314
|
* console.log('favorites', payload);
|
|
5143
5315
|
* })
|
|
5144
5316
|
* ```
|
|
5317
|
+
* Payload: {@link FavoritePayload}.
|
|
5145
5318
|
*/
|
|
5146
5319
|
AddToFavorites = "addToFavorites",
|
|
5147
5320
|
/**
|
|
@@ -5153,6 +5326,7 @@ export declare enum EmbedEvent {
|
|
|
5153
5326
|
* console.log('Liveboard schedule', payload);
|
|
5154
5327
|
* })
|
|
5155
5328
|
* ```
|
|
5329
|
+
* Payload: {@link LiveboardScope}.
|
|
5156
5330
|
*/
|
|
5157
5331
|
Schedule = "subscription",
|
|
5158
5332
|
/**
|
|
@@ -5167,6 +5341,7 @@ export declare enum EmbedEvent {
|
|
|
5167
5341
|
* console.log('Liveboard edit', payload);
|
|
5168
5342
|
* })
|
|
5169
5343
|
* ```
|
|
5344
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5170
5345
|
*/
|
|
5171
5346
|
Edit = "edit",
|
|
5172
5347
|
/**
|
|
@@ -5208,6 +5383,7 @@ export declare enum EmbedEvent {
|
|
|
5208
5383
|
* console.log('Copy', payload);
|
|
5209
5384
|
* })
|
|
5210
5385
|
* ```
|
|
5386
|
+
* Payload: {@link MakeACopyPayload}.
|
|
5211
5387
|
*/
|
|
5212
5388
|
MakeACopy = "makeACopy",
|
|
5213
5389
|
/**
|
|
@@ -5223,6 +5399,7 @@ export declare enum EmbedEvent {
|
|
|
5223
5399
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5224
5400
|
* })
|
|
5225
5401
|
* ```
|
|
5402
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5226
5403
|
*/
|
|
5227
5404
|
Present = "present",
|
|
5228
5405
|
/**
|
|
@@ -5233,6 +5410,7 @@ export declare enum EmbedEvent {
|
|
|
5233
5410
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
5234
5411
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5235
5412
|
* ```
|
|
5413
|
+
* Payload: {@link LiveboardScope}.
|
|
5236
5414
|
*/
|
|
5237
5415
|
Delete = "delete",
|
|
5238
5416
|
/**
|
|
@@ -5242,6 +5420,7 @@ export declare enum EmbedEvent {
|
|
|
5242
5420
|
* ```js
|
|
5243
5421
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
5244
5422
|
* ```
|
|
5423
|
+
* Payload: {@link LiveboardScope}.
|
|
5245
5424
|
*/
|
|
5246
5425
|
SchedulesList = "schedule-list",
|
|
5247
5426
|
/**
|
|
@@ -5251,6 +5430,7 @@ export declare enum EmbedEvent {
|
|
|
5251
5430
|
* ```js
|
|
5252
5431
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
5253
5432
|
* ```
|
|
5433
|
+
* Payload: {@link LiveboardScope}.
|
|
5254
5434
|
*/
|
|
5255
5435
|
Cancel = "cancel",
|
|
5256
5436
|
/**
|
|
@@ -5261,6 +5441,7 @@ export declare enum EmbedEvent {
|
|
|
5261
5441
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
5262
5442
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5263
5443
|
* ```
|
|
5444
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5264
5445
|
*/
|
|
5265
5446
|
Explore = "explore",
|
|
5266
5447
|
/**
|
|
@@ -5271,6 +5452,7 @@ export declare enum EmbedEvent {
|
|
|
5271
5452
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
5272
5453
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5273
5454
|
* ```
|
|
5455
|
+
* Payload: {@link CopyLinkPayload}.
|
|
5274
5456
|
*/
|
|
5275
5457
|
CopyLink = "embedDocument",
|
|
5276
5458
|
/**
|
|
@@ -5282,6 +5464,7 @@ export declare enum EmbedEvent {
|
|
|
5282
5464
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
5283
5465
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5284
5466
|
* ```
|
|
5467
|
+
* Payload: {@link CrossFilterChangedPayload}.
|
|
5285
5468
|
*/
|
|
5286
5469
|
CrossFilterChanged = "cross-filter-changed",
|
|
5287
5470
|
/**
|
|
@@ -5293,6 +5476,7 @@ export declare enum EmbedEvent {
|
|
|
5293
5476
|
* console.log('VizPointClick', payload)
|
|
5294
5477
|
* })
|
|
5295
5478
|
* ```
|
|
5479
|
+
* Payload: {@link VizInteractionPayload}.
|
|
5296
5480
|
*/
|
|
5297
5481
|
VizPointRightClick = "vizPointRightClick",
|
|
5298
5482
|
/**
|
|
@@ -5320,6 +5504,7 @@ export declare enum EmbedEvent {
|
|
|
5320
5504
|
* })
|
|
5321
5505
|
* ```
|
|
5322
5506
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
5507
|
+
* Payload: {@link FilterChangedPayload}.
|
|
5323
5508
|
*/
|
|
5324
5509
|
FilterChanged = "filterChanged",
|
|
5325
5510
|
/**
|
|
@@ -5342,6 +5527,7 @@ export declare enum EmbedEvent {
|
|
|
5342
5527
|
* @returns isPublic: boolean
|
|
5343
5528
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5344
5529
|
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5530
|
+
* Payload: {@link PersonalisedViewPayload}.
|
|
5345
5531
|
*/
|
|
5346
5532
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
5347
5533
|
/**
|
|
@@ -5363,6 +5549,7 @@ export declare enum EmbedEvent {
|
|
|
5363
5549
|
* @returns isPublic: boolean
|
|
5364
5550
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5365
5551
|
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5552
|
+
* Payload: {@link PersonalisedViewPayload}.
|
|
5366
5553
|
*/
|
|
5367
5554
|
SavePersonalisedView = "savePersonalisedView",
|
|
5368
5555
|
/**
|
|
@@ -5437,6 +5624,7 @@ export declare enum EmbedEvent {
|
|
|
5437
5624
|
/**
|
|
5438
5625
|
* Emitted when a Liveboard or visualization is renamed.
|
|
5439
5626
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
5627
|
+
* Payload: {@link RenamePayload}.
|
|
5440
5628
|
*/
|
|
5441
5629
|
Rename = "rename",
|
|
5442
5630
|
/**
|
|
@@ -5522,6 +5710,7 @@ export declare enum EmbedEvent {
|
|
|
5522
5710
|
* })
|
|
5523
5711
|
* ```
|
|
5524
5712
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
5713
|
+
* Payload: {@link ParameterChangedPayload}.
|
|
5525
5714
|
*/
|
|
5526
5715
|
ParameterChanged = "parameterChanged",
|
|
5527
5716
|
/**
|
|
@@ -5565,6 +5754,7 @@ export declare enum EmbedEvent {
|
|
|
5565
5754
|
* })
|
|
5566
5755
|
* ```
|
|
5567
5756
|
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
5757
|
+
* Payload: {@link TableVizRenderedPayload}.
|
|
5568
5758
|
*/
|
|
5569
5759
|
TableVizRendered = "TableVizRendered",
|
|
5570
5760
|
/**
|
|
@@ -5589,12 +5779,14 @@ export declare enum EmbedEvent {
|
|
|
5589
5779
|
* @hidden
|
|
5590
5780
|
* Emitted when a user exits present mode.
|
|
5591
5781
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5782
|
+
* Payload: {@link ExitPresentModePayload}.
|
|
5592
5783
|
*/
|
|
5593
5784
|
ExitPresentMode = "exitPresentMode",
|
|
5594
5785
|
/**
|
|
5595
5786
|
* Emitted when a user requests the full height lazy load data.
|
|
5596
5787
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
5597
5788
|
* @hidden
|
|
5789
|
+
* Payload: none.
|
|
5598
5790
|
*/
|
|
5599
5791
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
5600
5792
|
/**
|
|
@@ -5628,6 +5820,7 @@ export declare enum EmbedEvent {
|
|
|
5628
5820
|
* })
|
|
5629
5821
|
* ```
|
|
5630
5822
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5823
|
+
* Payload: {@link VizScope}.
|
|
5631
5824
|
*/
|
|
5632
5825
|
AddToCoaching = "addToCoaching",
|
|
5633
5826
|
/**
|
|
@@ -5717,6 +5910,7 @@ export declare enum EmbedEvent {
|
|
|
5717
5910
|
* console.log('EmbedListenerReady');
|
|
5718
5911
|
* })
|
|
5719
5912
|
* ```
|
|
5913
|
+
* Payload: none.
|
|
5720
5914
|
*/
|
|
5721
5915
|
EmbedListenerReady = "EmbedListenerReady",
|
|
5722
5916
|
/**
|
|
@@ -6091,6 +6285,7 @@ export declare enum EmbedEvent {
|
|
|
6091
6285
|
* })
|
|
6092
6286
|
* ```
|
|
6093
6287
|
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
6288
|
+
* Payload: {@link TestScheduleEmailPayload}.
|
|
6094
6289
|
*/
|
|
6095
6290
|
SendTestScheduleEmail = "sendTestScheduleEmail",
|
|
6096
6291
|
/**
|
|
@@ -6601,6 +6796,19 @@ export declare enum HostEvent {
|
|
|
6601
6796
|
* ```
|
|
6602
6797
|
*/
|
|
6603
6798
|
OpenAddParameterModal = "openAddParameterModal",
|
|
6799
|
+
/**
|
|
6800
|
+
* Add a tab to the Liveboard, the same action as the *Tab* option in the
|
|
6801
|
+
* *Add* dropdown in the Liveboard edit header.
|
|
6802
|
+
*
|
|
6803
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
6804
|
+
*
|
|
6805
|
+
* @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
|
|
6806
|
+
* @example
|
|
6807
|
+
* ```js
|
|
6808
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
|
|
6809
|
+
* ```
|
|
6810
|
+
*/
|
|
6811
|
+
OpenAddTabModal = "openAddTabModal",
|
|
6604
6812
|
/**
|
|
6605
6813
|
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
6606
6814
|
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
@@ -8836,6 +9044,21 @@ export type SpotterFileUploadFileTypes = {
|
|
|
8836
9044
|
*/
|
|
8837
9045
|
export declare enum Action {
|
|
8838
9046
|
/**
|
|
9047
|
+
* The **Add** button on a Liveboard in edit mode.
|
|
9048
|
+
* Controls the visibility and disabled state of the Add panel button
|
|
9049
|
+
* in the Liveboard edit toolbar, which allows users to add
|
|
9050
|
+
* visualizations, filters, parameters, and tabs.
|
|
9051
|
+
* @example
|
|
9052
|
+
* ```js
|
|
9053
|
+
* hiddenActions: [Action.LiveboardAddPanel]
|
|
9054
|
+
* // or
|
|
9055
|
+
* disabledActions: [Action.LiveboardAddPanel]
|
|
9056
|
+
* ```
|
|
9057
|
+
* @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
|
|
9058
|
+
*/
|
|
9059
|
+
LiveboardAddPanel = "liveboardAddPanel",
|
|
9060
|
+
/**
|
|
9061
|
+
*
|
|
8839
9062
|
* The **Save** action on an Answer or Liveboard.
|
|
8840
9063
|
* Allows users to save the changes.
|
|
8841
9064
|
* @example
|
|
@@ -11086,7 +11309,103 @@ export declare enum Action {
|
|
|
11086
11309
|
* });
|
|
11087
11310
|
* ```
|
|
11088
11311
|
*/
|
|
11089
|
-
Cancel = "cancel"
|
|
11312
|
+
Cancel = "cancel",
|
|
11313
|
+
/**
|
|
11314
|
+
* Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
|
|
11315
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
11316
|
+
* @example
|
|
11317
|
+
* ```js
|
|
11318
|
+
* {
|
|
11319
|
+
* hiddenActions: [Action.ShowVersionHistory],
|
|
11320
|
+
* disabledActions: [Action.ShowVersionHistory],
|
|
11321
|
+
* }
|
|
11322
|
+
* ```
|
|
11323
|
+
*/
|
|
11324
|
+
ShowVersionHistory = "showVersionHistory",
|
|
11325
|
+
/**
|
|
11326
|
+
* Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
|
|
11327
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
|
|
11328
|
+
* @example
|
|
11329
|
+
* ```js
|
|
11330
|
+
* {
|
|
11331
|
+
* hiddenActions: [Action.EnableVersionControl],
|
|
11332
|
+
* disabledActions: [Action.EnableVersionControl],
|
|
11333
|
+
* }
|
|
11334
|
+
* ```
|
|
11335
|
+
*/
|
|
11336
|
+
EnableVersionControl = "enableVersionControl",
|
|
11337
|
+
/**
|
|
11338
|
+
* Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
|
|
11339
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
|
|
11340
|
+
* @example
|
|
11341
|
+
* ```js
|
|
11342
|
+
* {
|
|
11343
|
+
* hiddenActions: [Action.DisableVersionControl],
|
|
11344
|
+
* disabledActions: [Action.DisableVersionControl],
|
|
11345
|
+
* }
|
|
11346
|
+
* ```
|
|
11347
|
+
*/
|
|
11348
|
+
DisableVersionControl = "disableVersionControl",
|
|
11349
|
+
/**
|
|
11350
|
+
* Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
|
|
11351
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
11352
|
+
* @example
|
|
11353
|
+
* ```js
|
|
11354
|
+
* {
|
|
11355
|
+
* hiddenActions: [Action.WithdrawVerification],
|
|
11356
|
+
* disabledActions: [Action.WithdrawVerification],
|
|
11357
|
+
* }
|
|
11358
|
+
* ```
|
|
11359
|
+
*/
|
|
11360
|
+
WithdrawVerification = "withdrawVerification",
|
|
11361
|
+
/**
|
|
11362
|
+
* Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
|
|
11363
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
11364
|
+
* @example
|
|
11365
|
+
* ```js
|
|
11366
|
+
* {
|
|
11367
|
+
* hiddenActions: [Action.SwitchToNewChartExperience],
|
|
11368
|
+
* disabledActions: [Action.SwitchToNewChartExperience],
|
|
11369
|
+
* }
|
|
11370
|
+
* ```
|
|
11371
|
+
*/
|
|
11372
|
+
SwitchToNewChartExperience = "switchToNewChartExperience",
|
|
11373
|
+
/**
|
|
11374
|
+
* Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
|
|
11375
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
11376
|
+
* @example
|
|
11377
|
+
* ```js
|
|
11378
|
+
* {
|
|
11379
|
+
* hiddenActions: [Action.SwitchToClassicChartExperience],
|
|
11380
|
+
* disabledActions: [Action.SwitchToClassicChartExperience],
|
|
11381
|
+
* }
|
|
11382
|
+
* ```
|
|
11383
|
+
*/
|
|
11384
|
+
SwitchToClassicChartExperience = "switchToClassicChartExperience",
|
|
11385
|
+
/**
|
|
11386
|
+
* Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
|
|
11387
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
|
|
11388
|
+
* @example
|
|
11389
|
+
* ```js
|
|
11390
|
+
* {
|
|
11391
|
+
* hiddenActions: [Action.Monitor],
|
|
11392
|
+
* disabledActions: [Action.Monitor],
|
|
11393
|
+
* }
|
|
11394
|
+
* ```
|
|
11395
|
+
*/
|
|
11396
|
+
Monitor = "monitor",
|
|
11397
|
+
/**
|
|
11398
|
+
* 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.
|
|
11399
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
|
|
11400
|
+
* @example
|
|
11401
|
+
* ```js
|
|
11402
|
+
* {
|
|
11403
|
+
* hiddenActions: [Action.SpotterViewExplanation],
|
|
11404
|
+
* disabledActions: [Action.SpotterViewExplanation],
|
|
11405
|
+
* }
|
|
11406
|
+
* ```
|
|
11407
|
+
*/
|
|
11408
|
+
SpotterViewExplanation = "spotterViewExplanation"
|
|
11090
11409
|
}
|
|
11091
11410
|
export declare enum PrefetchFeatures {
|
|
11092
11411
|
FullApp = "FullApp",
|
|
@@ -12692,6 +13011,7 @@ export interface HostEventRequestMap {
|
|
|
12692
13011
|
[HostEvent.AIHighlights]: void;
|
|
12693
13012
|
[HostEvent.SendTestScheduleEmail]: ScheduleEmailRequest;
|
|
12694
13013
|
[HostEvent.RefreshLiveboardBrowserCache]: ScheduleEmailRequest;
|
|
13014
|
+
[HostEvent.OpenAddTabModal]: void;
|
|
12695
13015
|
[HostEvent.SpotterSearch]: SpotterSearchRequest;
|
|
12696
13016
|
[HostEvent.ResetSpotterConversation]: void;
|
|
12697
13017
|
[HostEvent.ShareSpotterConversation]: ConversationScopedRequest;
|
|
@@ -12753,22 +13073,216 @@ export type TriggerData<HostEventT extends HostEvent> = HostEventRequest<HostEve
|
|
|
12753
13073
|
*/
|
|
12754
13074
|
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType = ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
12755
13075
|
/**
|
|
12756
|
-
*
|
|
13076
|
+
* Base for every payload. Known fields are declared on the interfaces below;
|
|
13077
|
+
* additional fields the host may send stay `any`, so a callback reading one
|
|
13078
|
+
* keeps compiling.
|
|
12757
13079
|
*/
|
|
12758
|
-
export interface
|
|
12759
|
-
[
|
|
12760
|
-
|
|
12761
|
-
|
|
12762
|
-
|
|
12763
|
-
|
|
12764
|
-
|
|
13080
|
+
export interface EmbedEventPayloadBase {
|
|
13081
|
+
[key: string]: any;
|
|
13082
|
+
}
|
|
13083
|
+
/** Present on events raised from a Spotter conversation. */
|
|
13084
|
+
export interface ConversationScope extends EmbedEventPayloadBase {
|
|
13085
|
+
convId?: string;
|
|
13086
|
+
messageId?: string;
|
|
13087
|
+
}
|
|
13088
|
+
/** Scoped to a single visualization (optionally within a conversation). */
|
|
13089
|
+
export interface VizScope extends ConversationScope {
|
|
13090
|
+
vizId?: string;
|
|
13091
|
+
}
|
|
13092
|
+
/** Scoped to a Liveboard. */
|
|
13093
|
+
export interface LiveboardScope extends EmbedEventPayloadBase {
|
|
13094
|
+
liveboardId?: string;
|
|
13095
|
+
}
|
|
13096
|
+
/** Scoped to an Answer. */
|
|
13097
|
+
export interface AnswerScope extends EmbedEventPayloadBase {
|
|
13098
|
+
answerId?: string;
|
|
13099
|
+
vizId?: string;
|
|
13100
|
+
}
|
|
13101
|
+
/** Actions available on a viz within a Liveboard. */
|
|
13102
|
+
export interface LiveboardVizScope extends LiveboardScope, VizScope {
|
|
13103
|
+
}
|
|
13104
|
+
/** An empty payload — the event carries no data. */
|
|
13105
|
+
export type EmptyPayload = Record<string, never>;
|
|
13106
|
+
/** The answer data backing the embed, delivered with {@link EmbedEvent.Data}. */
|
|
13107
|
+
export interface DataEventPayload extends VizScope {
|
|
13108
|
+
embedAnswerData?: any;
|
|
13109
|
+
}
|
|
13110
|
+
/** {@link EmbedEvent.Error}. `message` may be a single string or a list. */
|
|
13111
|
+
export interface EmbedErrorPayload extends EmbedEventPayloadBase {
|
|
13112
|
+
errorType?: any;
|
|
13113
|
+
message?: string | string[];
|
|
13114
|
+
code?: any;
|
|
13115
|
+
error?: {
|
|
13116
|
+
message?: string;
|
|
12765
13117
|
};
|
|
13118
|
+
errors?: string[];
|
|
13119
|
+
}
|
|
13120
|
+
export interface FilterChangedPayload extends EmbedEventPayloadBase {
|
|
13121
|
+
liveboardFilters?: any[];
|
|
13122
|
+
runtimeFilters?: RuntimeFilter[];
|
|
13123
|
+
}
|
|
13124
|
+
export interface CrossFilterChangedPayload extends EmbedEventPayloadBase {
|
|
13125
|
+
action?: string;
|
|
13126
|
+
filterContentList?: any;
|
|
13127
|
+
filterRemoved?: string[];
|
|
13128
|
+
removableColumnsFilterContent?: any;
|
|
13129
|
+
}
|
|
13130
|
+
export interface ParameterChangedPayload extends ConversationScope {
|
|
13131
|
+
parameters?: any[];
|
|
13132
|
+
}
|
|
13133
|
+
export interface QueryChangedPayload extends VizScope {
|
|
13134
|
+
search?: string;
|
|
13135
|
+
}
|
|
13136
|
+
/**
|
|
13137
|
+
* Data-source(s) chosen in the picker. The host sends an object; older hosts may
|
|
13138
|
+
* send a bare list of worksheet ids, so {@link EmbedEvent.DataSourceSelected}
|
|
13139
|
+
* resolves to `string[] | DataSourceSelectedPayload`.
|
|
13140
|
+
*/
|
|
13141
|
+
export interface DataSourceSelectedPayload extends EmbedEventPayloadBase {
|
|
13142
|
+
worksheetId?: string;
|
|
13143
|
+
worksheetName?: string;
|
|
13144
|
+
worksheetIds?: string[];
|
|
13145
|
+
}
|
|
13146
|
+
/** Shared by {@link EmbedEvent.VizPointClick} and its siblings. */
|
|
13147
|
+
export interface VizInteractionPayload extends VizScope {
|
|
13148
|
+
clickedPoint?: any;
|
|
13149
|
+
selectedPoints?: any[];
|
|
13150
|
+
embedAnswerData?: any;
|
|
13151
|
+
}
|
|
13152
|
+
export interface DrilldownPayload extends ConversationScope {
|
|
13153
|
+
drillColumn?: any;
|
|
13154
|
+
clickedPoint?: any;
|
|
13155
|
+
selectedPoints?: any[];
|
|
13156
|
+
}
|
|
13157
|
+
export interface TableVizRenderedPayload extends VizScope {
|
|
13158
|
+
id?: string;
|
|
13159
|
+
data?: any;
|
|
13160
|
+
}
|
|
13161
|
+
export interface SaveEventPayload extends LiveboardVizScope {
|
|
13162
|
+
answerId?: string;
|
|
13163
|
+
}
|
|
13164
|
+
export interface MakeACopyPayload extends LiveboardVizScope {
|
|
13165
|
+
newLiveboardId?: string;
|
|
13166
|
+
}
|
|
13167
|
+
/** Downloads, either viz/answer scoped or Liveboard scoped. */
|
|
13168
|
+
export interface DownloadEventPayload extends VizScope {
|
|
13169
|
+
answerId?: string;
|
|
13170
|
+
liveboardId?: string;
|
|
13171
|
+
}
|
|
13172
|
+
/** TML export/edit/update — answer or Liveboard scoped. */
|
|
13173
|
+
export interface TmlEventPayload extends EmbedEventPayloadBase {
|
|
13174
|
+
answerId?: string;
|
|
13175
|
+
liveboardId?: string;
|
|
13176
|
+
vizId?: string;
|
|
13177
|
+
}
|
|
13178
|
+
export interface AnswerChartSwitcherPayload extends ConversationScope {
|
|
13179
|
+
answerId?: string;
|
|
13180
|
+
/** The mode switched to (chart or table). */
|
|
13181
|
+
chartType?: string;
|
|
13182
|
+
}
|
|
13183
|
+
export interface CopyToClipboardPayload extends ConversationScope {
|
|
13184
|
+
answerId?: string;
|
|
13185
|
+
}
|
|
13186
|
+
export interface PinEventPayload extends VizScope {
|
|
13187
|
+
liveboardId?: string;
|
|
13188
|
+
containerId?: string;
|
|
13189
|
+
answerId?: string;
|
|
13190
|
+
}
|
|
13191
|
+
export interface CopyLinkPayload extends LiveboardScope {
|
|
13192
|
+
vizId?: string;
|
|
13193
|
+
metricId?: any;
|
|
13194
|
+
}
|
|
13195
|
+
export interface FavoritePayload extends LiveboardScope {
|
|
13196
|
+
isFavorite?: boolean;
|
|
13197
|
+
}
|
|
13198
|
+
export interface TestScheduleEmailPayload extends LiveboardScope {
|
|
13199
|
+
sendToSelf?: boolean;
|
|
13200
|
+
}
|
|
13201
|
+
/** Note: the app sends `liveboardID` (capital ID) for this event. */
|
|
13202
|
+
export interface RenamePayload extends EmbedEventPayloadBase {
|
|
13203
|
+
liveboardID?: string;
|
|
13204
|
+
vizId?: string;
|
|
13205
|
+
title?: string;
|
|
13206
|
+
description?: string;
|
|
13207
|
+
}
|
|
13208
|
+
export interface PersonalisedViewPayload extends LiveboardScope {
|
|
13209
|
+
viewName?: string;
|
|
13210
|
+
viewId?: string;
|
|
13211
|
+
isPublic?: boolean;
|
|
13212
|
+
}
|
|
13213
|
+
export interface ExitPresentModePayload extends EmbedEventPayloadBase {
|
|
13214
|
+
type?: string;
|
|
13215
|
+
data?: any;
|
|
13216
|
+
}
|
|
13217
|
+
/** {@link EmbedEvent.AuthInit}. */
|
|
13218
|
+
export interface AuthInitPayload extends EmbedEventPayloadBase {
|
|
13219
|
+
/** Whether authentication was successful. */
|
|
13220
|
+
isLoggedIn?: boolean;
|
|
13221
|
+
}
|
|
13222
|
+
/**
|
|
13223
|
+
* Typed `data` field per embed event. Events not listed resolve to `any`.
|
|
13224
|
+
*/
|
|
13225
|
+
export interface EmbedEventDataExtension {
|
|
13226
|
+
[EmbedEvent.AuthInit]: AuthInitPayload;
|
|
12766
13227
|
[EmbedEvent.EmbedListenerReady]: Record<string, any>;
|
|
13228
|
+
[EmbedEvent.Error]: EmbedErrorPayload | string;
|
|
12767
13229
|
/**
|
|
12768
13230
|
* Fired when a callback-type custom action is triggered. Use
|
|
12769
|
-
* `payload.data.id` to identify which action fired
|
|
13231
|
+
* `payload.data.id` to identify which action fired; see also
|
|
13232
|
+
* {@link CustomActionEventPayload} for the `answerService` enrichment.
|
|
12770
13233
|
*/
|
|
12771
13234
|
[EmbedEvent.CustomAction]: CustomActionPayload;
|
|
13235
|
+
[EmbedEvent.FilterChanged]: FilterChangedPayload;
|
|
13236
|
+
[EmbedEvent.CrossFilterChanged]: CrossFilterChangedPayload;
|
|
13237
|
+
[EmbedEvent.ParameterChanged]: ParameterChangedPayload;
|
|
13238
|
+
[EmbedEvent.VizPointClick]: VizInteractionPayload;
|
|
13239
|
+
[EmbedEvent.VizPointDoubleClick]: VizInteractionPayload;
|
|
13240
|
+
[EmbedEvent.VizPointRightClick]: VizInteractionPayload;
|
|
13241
|
+
[EmbedEvent.Drilldown]: DrilldownPayload;
|
|
13242
|
+
[EmbedEvent.TableVizRendered]: TableVizRenderedPayload;
|
|
13243
|
+
[EmbedEvent.Data]: DataEventPayload;
|
|
13244
|
+
[EmbedEvent.QueryChanged]: string | QueryChangedPayload;
|
|
13245
|
+
[EmbedEvent.Save]: SaveEventPayload;
|
|
13246
|
+
[EmbedEvent.Edit]: LiveboardVizScope;
|
|
13247
|
+
[EmbedEvent.Present]: LiveboardVizScope;
|
|
13248
|
+
[EmbedEvent.Explore]: LiveboardVizScope;
|
|
13249
|
+
[EmbedEvent.MakeACopy]: MakeACopyPayload;
|
|
13250
|
+
[EmbedEvent.AnswerDelete]: AnswerScope;
|
|
13251
|
+
[EmbedEvent.AnswerChartSwitcher]: AnswerChartSwitcherPayload;
|
|
13252
|
+
[EmbedEvent.CopyToClipboard]: CopyToClipboardPayload;
|
|
13253
|
+
[EmbedEvent.SpotIQAnalyze]: AnswerScope;
|
|
13254
|
+
[EmbedEvent.ShowUnderlyingData]: AnswerScope;
|
|
13255
|
+
[EmbedEvent.AddToCoaching]: VizScope;
|
|
13256
|
+
[EmbedEvent.Pin]: PinEventPayload;
|
|
13257
|
+
[EmbedEvent.Download]: VizScope;
|
|
13258
|
+
[EmbedEvent.DownloadAsPng]: DownloadEventPayload;
|
|
13259
|
+
[EmbedEvent.DownloadAsCsv]: DownloadEventPayload;
|
|
13260
|
+
[EmbedEvent.DownloadAsXlsx]: DownloadEventPayload;
|
|
13261
|
+
[EmbedEvent.DownloadAsPdf]: DownloadEventPayload;
|
|
13262
|
+
[EmbedEvent.DownloadLiveboardAsContinuousPDF]: LiveboardScope;
|
|
13263
|
+
[EmbedEvent.ExportTML]: TmlEventPayload;
|
|
13264
|
+
[EmbedEvent.EditTML]: TmlEventPayload;
|
|
13265
|
+
[EmbedEvent.UpdateTML]: TmlEventPayload;
|
|
13266
|
+
[EmbedEvent.Cancel]: LiveboardScope;
|
|
13267
|
+
[EmbedEvent.Delete]: LiveboardScope;
|
|
13268
|
+
[EmbedEvent.Schedule]: LiveboardScope;
|
|
13269
|
+
[EmbedEvent.SchedulesList]: LiveboardScope;
|
|
13270
|
+
[EmbedEvent.SendTestScheduleEmail]: TestScheduleEmailPayload;
|
|
13271
|
+
[EmbedEvent.LiveboardInfo]: LiveboardScope;
|
|
13272
|
+
[EmbedEvent.AIHighlights]: LiveboardScope;
|
|
13273
|
+
[EmbedEvent.Rename]: RenamePayload;
|
|
13274
|
+
[EmbedEvent.AddToFavorites]: FavoritePayload;
|
|
13275
|
+
[EmbedEvent.CopyLink]: CopyLinkPayload;
|
|
13276
|
+
[EmbedEvent.ExitPresentMode]: ExitPresentModePayload;
|
|
13277
|
+
[EmbedEvent.SavePersonalisedView]: PersonalisedViewPayload;
|
|
13278
|
+
[EmbedEvent.UpdatePersonalisedView]: PersonalisedViewPayload;
|
|
13279
|
+
[EmbedEvent.AddRemoveColumns]: string[];
|
|
13280
|
+
[EmbedEvent.DataSourceSelected]: string[] | DataSourceSelectedPayload;
|
|
13281
|
+
[EmbedEvent.DialogOpen]: EmptyPayload;
|
|
13282
|
+
[EmbedEvent.DialogClose]: EmptyPayload;
|
|
13283
|
+
[EmbedEvent.LiveboardRendered]: EmptyPayload;
|
|
13284
|
+
[EmbedEvent.RequestVisibleEmbedCoordinates]: EmptyPayload;
|
|
13285
|
+
[EmbedEvent.EmbedIframeCenter]: EmptyPayload;
|
|
12772
13286
|
}
|
|
12773
13287
|
/**
|
|
12774
13288
|
* Resolves the typed `data` payload for an embed event; `any` when the
|
|
@@ -16616,8 +17130,14 @@ declare class ConversationMessage extends TsEmbed {
|
|
|
16616
17130
|
}
|
|
16617
17131
|
export interface EmbedViewConfig extends AllEmbedViewConfig, EmbedEventHandlers {
|
|
16618
17132
|
}
|
|
17133
|
+
/**
|
|
17134
|
+
* `on{Event}` handler props for the React components. Each handler receives the
|
|
17135
|
+
* payload typed for its event (the same {@link EmbedEventPayload} the imperative
|
|
17136
|
+
* `embed.on()` delivers), so `onData`, `onVizPointClick`, etc. are per-event
|
|
17137
|
+
* typed rather than the loose {@link MessageCallback}.
|
|
17138
|
+
*/
|
|
16619
17139
|
export type EmbedEventHandlers = {
|
|
16620
|
-
[
|
|
17140
|
+
[K in keyof typeof EmbedEvent as `on${Capitalize<K>}`]?: (payload: EmbedEventPayload<(typeof EmbedEvent)[K]>, responder?: (data: any) => void) => void;
|
|
16621
17141
|
};
|
|
16622
17142
|
export interface EmbedProps extends EmbedViewConfig {
|
|
16623
17143
|
className?: string;
|
|
@@ -16803,7 +17323,7 @@ export interface FilterChangedFilterGroup {
|
|
|
16803
17323
|
/**
|
|
16804
17324
|
* Shape of the payload received via `LiveboardEmbed.on(EmbedEvent.FilterChanged, ...)`.
|
|
16805
17325
|
*/
|
|
16806
|
-
|
|
17326
|
+
interface FilterChangedPayload$1 {
|
|
16807
17327
|
liveboardFilters?: FilterChangedFilterGroup[];
|
|
16808
17328
|
runtimeFilters?: RuntimeFilter[];
|
|
16809
17329
|
}
|
|
@@ -16851,7 +17371,7 @@ export interface UpdateFiltersPayload {
|
|
|
16851
17371
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, savedFilters);
|
|
16852
17372
|
* ```
|
|
16853
17373
|
*/
|
|
16854
|
-
export declare function convertFilterChangedToUpdateFiltersPayload(filterChangedPayload: FilterChangedPayload): UpdateFiltersPayload;
|
|
17374
|
+
export declare function convertFilterChangedToUpdateFiltersPayload(filterChangedPayload: FilterChangedPayload$1): UpdateFiltersPayload;
|
|
16855
17375
|
/**
|
|
16856
17376
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
16857
17377
|
* @example
|
|
@@ -17223,6 +17743,7 @@ export {
|
|
|
17223
17743
|
AppEmbed$1 as AppEmbed,
|
|
17224
17744
|
ConversationEmbed$1 as ConversationEmbed,
|
|
17225
17745
|
DataPanelCustomColumnGroupsAccordionState$1 as DataPanelCustomColumnGroupsAccordionState,
|
|
17746
|
+
FilterChangedPayload$1 as FilterChangedPayload,
|
|
17226
17747
|
LiveboardEmbed$1 as LiveboardEmbed,
|
|
17227
17748
|
SearchBarEmbed$1 as SearchBarEmbed,
|
|
17228
17749
|
SearchEmbed$1 as SearchEmbed,
|