@thoughtspot/visual-embed-sdk 1.53.0 → 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 +169 -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 +11 -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/app.d.ts +1 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js.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/conversation.d.ts +14 -0
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +22 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +50 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +2 -16
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +29 -10
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +139 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +1 -0
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +7 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +19 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +21 -16
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +77 -63
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +240 -7
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.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 +249 -2
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +247 -0
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/runtimeTelemetry.d.ts +11 -0
- package/cjs/src/utils/runtimeTelemetry.d.ts.map +1 -0
- package/cjs/src/utils/runtimeTelemetry.js +34 -0
- package/cjs/src/utils/runtimeTelemetry.js.map +1 -0
- package/cjs/src/utils/runtimeTelemetry.spec.d.ts +2 -0
- package/cjs/src/utils/runtimeTelemetry.spec.d.ts.map +1 -0
- package/cjs/src/utils/runtimeTelemetry.spec.js +124 -0
- package/cjs/src/utils/runtimeTelemetry.spec.js.map +1 -0
- package/dist/{index-CyDR8j_0.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 +11 -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/app.d.ts +1 -0
- package/dist/src/embed/app.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/embed/conversation.d.ts +14 -0
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +2 -16
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +1 -0
- package/dist/src/embed/spotter-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +21 -16
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.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 +249 -2
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/runtimeTelemetry.d.ts +11 -0
- package/dist/src/utils/runtimeTelemetry.d.ts.map +1 -0
- package/dist/src/utils/runtimeTelemetry.spec.d.ts +2 -0
- package/dist/src/utils/runtimeTelemetry.spec.d.ts.map +1 -0
- package/dist/tsembed-react.es.js +474 -84
- package/dist/tsembed-react.js +473 -83
- package/dist/tsembed.es.js +542 -85
- package/dist/tsembed.js +541 -84
- package/dist/visual-embed-sdk-react-full.d.ts +649 -30
- package/dist/visual-embed-sdk-react.d.ts +646 -28
- package/dist/visual-embed-sdk.d.ts +642 -44
- 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 +169 -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 +11 -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/app.d.ts +1 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js.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/conversation.d.ts +14 -0
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +22 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +50 -0
- package/lib/src/embed/host-events.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +2 -16
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +28 -10
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +139 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +1 -0
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +7 -1
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +19 -0
- package/lib/src/embed/spotter-utils.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +21 -16
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +78 -64
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +240 -7
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.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 +249 -2
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +247 -0
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/runtimeTelemetry.d.ts +11 -0
- package/lib/src/utils/runtimeTelemetry.d.ts.map +1 -0
- package/lib/src/utils/runtimeTelemetry.js +28 -0
- package/lib/src/utils/runtimeTelemetry.js.map +1 -0
- package/lib/src/utils/runtimeTelemetry.spec.d.ts +2 -0
- package/lib/src/utils/runtimeTelemetry.spec.d.ts.map +1 -0
- package/lib/src/utils/runtimeTelemetry.spec.js +122 -0
- package/lib/src/utils/runtimeTelemetry.spec.js.map +1 -0
- package/lib/src/visual-embed-sdk.d.ts +642 -44
- package/package.json +1 -1
- package/src/auth.spec.ts +47 -11
- package/src/auth.ts +35 -6
- package/src/contracts/contracts.spec.ts +186 -3
- package/src/contracts/embed-event-payloads.ts +281 -14
- package/src/contracts/host-event-contracts.ts +14 -0
- package/src/css-variables.ts +168 -0
- package/src/embed/app.ts +1 -0
- package/src/embed/auto-frame-renderer.spec.ts +134 -8
- package/src/embed/auto-frame-renderer.ts +103 -2
- package/src/embed/conversation.spec.ts +24 -0
- package/src/embed/conversation.ts +14 -0
- package/src/embed/host-events.spec.ts +68 -0
- package/src/embed/liveboard.spec.ts +156 -0
- package/src/embed/liveboard.ts +34 -10
- package/src/embed/spotter-utils.spec.ts +20 -0
- package/src/embed/spotter-utils.ts +12 -1
- package/src/embed/ts-embed.spec.ts +297 -8
- package/src/embed/ts-embed.ts +79 -64
- package/src/index.ts +2 -0
- package/src/react/all-types-export.ts +1 -0
- package/src/react/util.ts +13 -1
- package/src/types.ts +249 -0
- package/src/utils/runtimeTelemetry.spec.ts +148 -0
- package/src/utils/runtimeTelemetry.ts +50 -0
|
@@ -1467,6 +1467,146 @@ export interface CustomCssVariables {
|
|
|
1467
1467
|
* Background color of the shimmer sweep animation's gradient mid-stop.
|
|
1468
1468
|
*/
|
|
1469
1469
|
"--ts-var-shimmer-sweep-background"?: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* Secondary accent color. Used as the background of cross-filter chips in the
|
|
1472
|
+
* filter panel and to highlight Liveboard visualizations and Answer headers
|
|
1473
|
+
* impacted by a cross filter.
|
|
1474
|
+
*/
|
|
1475
|
+
"--ts-var-root-secondary-color"?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* Background color of the action items in the top navigation bar, such as the
|
|
1478
|
+
* search bar, Help menu, Org switcher, user menu, and notifications, on hover
|
|
1479
|
+
* or when selected.
|
|
1480
|
+
*/
|
|
1481
|
+
"--ts-var-nav-action-item-background"?: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* Border color of the action items in the top navigation bar, such as the
|
|
1484
|
+
* Org switcher and the search bar.
|
|
1485
|
+
*/
|
|
1486
|
+
"--ts-var-nav-action-item-border-color"?: string;
|
|
1487
|
+
/**
|
|
1488
|
+
* Border color of the search bar in the top navigation bar on hover.
|
|
1489
|
+
*/
|
|
1490
|
+
"--ts-var-nav-action-item-border-secondary-color"?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* Placeholder text color of the search bar and menus in the top navigation
|
|
1493
|
+
* bar. Also used as the background of the Help menu button when the menu
|
|
1494
|
+
* is open.
|
|
1495
|
+
*/
|
|
1496
|
+
"--ts-var-nav-action-item-placeholder-color"?: string;
|
|
1497
|
+
/**
|
|
1498
|
+
* Background color of the natural language search bar header in Sage
|
|
1499
|
+
* embed.
|
|
1500
|
+
*/
|
|
1501
|
+
"--ts-var-sage-bar-header-background-color"?: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* Background color of the data source selector in the natural language
|
|
1504
|
+
* search bar.
|
|
1505
|
+
*/
|
|
1506
|
+
"--ts-var-source-selector-background-color"?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* Background color of the data source selector in the natural language
|
|
1509
|
+
* search bar on hover.
|
|
1510
|
+
*/
|
|
1511
|
+
"--ts-var-source-selector-hover-color"?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* Font color of the text in the natural language search box.
|
|
1514
|
+
*/
|
|
1515
|
+
"--ts-var-sage-search-box-font-color"?: string;
|
|
1516
|
+
/**
|
|
1517
|
+
* Background color of the natural language search box.
|
|
1518
|
+
*/
|
|
1519
|
+
"--ts-var-sage-search-box-background-color"?: string;
|
|
1520
|
+
/**
|
|
1521
|
+
* Background color of the AI-generated answer container in Sage embed.
|
|
1522
|
+
*/
|
|
1523
|
+
"--ts-var-sage-embed-background-color"?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* Background color of the suggested (seed) questions shown in the natural
|
|
1526
|
+
* language search bar and Spotter.
|
|
1527
|
+
*/
|
|
1528
|
+
"--ts-var-sage-seed-questions-background"?: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* Font color of the suggested (seed) questions shown in the natural
|
|
1531
|
+
* language search bar and Spotter.
|
|
1532
|
+
*/
|
|
1533
|
+
"--ts-var-sage-seed-questions-font-color"?: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* Background color of the suggested (seed) questions shown in the natural
|
|
1536
|
+
* language search bar and Spotter on hover.
|
|
1537
|
+
*/
|
|
1538
|
+
"--ts-var-sage-seed-questions-hover-background"?: string;
|
|
1539
|
+
/**
|
|
1540
|
+
* Background of the AI gradient border around the natural language search bar
|
|
1541
|
+
* and the Spotter prompt input. Accepts any CSS background value, for example,
|
|
1542
|
+
* a `linear-gradient(...)` or a solid color.
|
|
1543
|
+
*/
|
|
1544
|
+
"--ts-var-ai-gradient-color"?: string;
|
|
1545
|
+
/**
|
|
1546
|
+
* Background color of the separator line between sections of a menu.
|
|
1547
|
+
*/
|
|
1548
|
+
"--ts-var-menu-seperator-background"?: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* Start color of the gradient background on the icon of custom menu items in
|
|
1551
|
+
* the navigation. Defaults to the value of `--ts-var-root-color`.
|
|
1552
|
+
*/
|
|
1553
|
+
"--ts-var-home-card-color"?: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* Font color of the heading text on the suggestion cards in the favorites
|
|
1556
|
+
* carousel on the Home page.
|
|
1557
|
+
*/
|
|
1558
|
+
"--ts-var-home-favorite-suggestion-card-text-font-color"?: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* Background color of a highlighted checkbox row on hover.
|
|
1561
|
+
*/
|
|
1562
|
+
"--ts-var-checkbox-highlighted-hover-color"?: string;
|
|
1563
|
+
/**
|
|
1564
|
+
* Font family of the group title in a Liveboard. Defaults to the value of
|
|
1565
|
+
* `--ts-var-viz-title-font-family`.
|
|
1566
|
+
*/
|
|
1567
|
+
"--ts-var-liveboard-group-title-font-family"?: string;
|
|
1568
|
+
/**
|
|
1569
|
+
* Font family of the group description in a Liveboard. Defaults to the value
|
|
1570
|
+
* of `--ts-var-viz-description-font-family`.
|
|
1571
|
+
*/
|
|
1572
|
+
"--ts-var-liveboard-group-description-font-family"?: string;
|
|
1573
|
+
/**
|
|
1574
|
+
* Font family of the visualization titles inside a Liveboard group. Defaults
|
|
1575
|
+
* to the value of `--ts-var-viz-title-font-family`.
|
|
1576
|
+
*/
|
|
1577
|
+
"--ts-var-liveboard-group-tile-title-font-family"?: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* Font family of the visualization descriptions inside a Liveboard group.
|
|
1580
|
+
* Defaults to the value of `--ts-var-viz-description-font-family`.
|
|
1581
|
+
*/
|
|
1582
|
+
"--ts-var-liveboard-group-tile-description-font-family"?: string;
|
|
1583
|
+
/**
|
|
1584
|
+
* Font color of the filter chips in a Liveboard on hover. Defaults to the
|
|
1585
|
+
* value of `--ts-var-chip--hover-color`.
|
|
1586
|
+
*/
|
|
1587
|
+
"--ts-var-liveboard-chip--hover-color"?: string;
|
|
1588
|
+
/**
|
|
1589
|
+
* Font color of the filter chips in a Liveboard when active. Defaults to the
|
|
1590
|
+
* value of `--ts-var-chip--active-color`.
|
|
1591
|
+
*/
|
|
1592
|
+
"--ts-var-liveboard-chip--active-color"?: string;
|
|
1593
|
+
/**
|
|
1594
|
+
* Background color of the styling panel in the Liveboard. Defaults to the
|
|
1595
|
+
* value of `--ts-var-liveboard-edit-bar-background`.
|
|
1596
|
+
*/
|
|
1597
|
+
"--ts-var-liveboard-styling-panel-background"?: string;
|
|
1598
|
+
/**
|
|
1599
|
+
* Border radius of the visualization container on the Answer page. On a
|
|
1600
|
+
* Liveboard, this value is derived from `--ts-var-liveboard-tile-border-radius`
|
|
1601
|
+
* and `--ts-var-viz-border-radius`; use those to style Liveboard tiles.
|
|
1602
|
+
*/
|
|
1603
|
+
"--ts-var-tile-viz-border-radius"?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* Color of the outline (halo) drawn around data labels on charts, which keeps
|
|
1606
|
+
* the labels readable over chart elements. Defaults to the value of
|
|
1607
|
+
* `--ts-var-root-color`.
|
|
1608
|
+
*/
|
|
1609
|
+
"--ts-var-chart-data-label-stroke-color"?: string;
|
|
1470
1610
|
}
|
|
1471
1611
|
export interface SessionInterface {
|
|
1472
1612
|
sessionId: string;
|
|
@@ -4544,6 +4684,7 @@ export enum EmbedEvent {
|
|
|
4544
4684
|
* })
|
|
4545
4685
|
* ```
|
|
4546
4686
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
4687
|
+
* Payload: {@link AuthInitPayload}.
|
|
4547
4688
|
*/
|
|
4548
4689
|
AuthInit = "authInit",
|
|
4549
4690
|
/**
|
|
@@ -4563,6 +4704,7 @@ export enum EmbedEvent {
|
|
|
4563
4704
|
/**
|
|
4564
4705
|
* Data pertaining to an Answer, Liveboard or Spotter visualization is received.
|
|
4565
4706
|
* The event payload includes the raw data of the object.
|
|
4707
|
+
* Payload: {@link DataEventPayload}.
|
|
4566
4708
|
* @return data - Answer of Liveboard data
|
|
4567
4709
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
4568
4710
|
* @example
|
|
@@ -4576,6 +4718,7 @@ export enum EmbedEvent {
|
|
|
4576
4718
|
Data = "data",
|
|
4577
4719
|
/**
|
|
4578
4720
|
* Search query has been updated by the user.
|
|
4721
|
+
* Payload: {@link QueryChangedPayload} or a string.
|
|
4579
4722
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
4580
4723
|
* @example
|
|
4581
4724
|
* ```js
|
|
@@ -4618,6 +4761,7 @@ export enum EmbedEvent {
|
|
|
4618
4761
|
* })
|
|
4619
4762
|
* })
|
|
4620
4763
|
* ```
|
|
4764
|
+
* Payload: {@link DrilldownPayload}.
|
|
4621
4765
|
*/
|
|
4622
4766
|
Drilldown = "drillDown",
|
|
4623
4767
|
/**
|
|
@@ -4630,6 +4774,7 @@ export enum EmbedEvent {
|
|
|
4630
4774
|
* console.log('DataSourceSelected', payload);
|
|
4631
4775
|
* })
|
|
4632
4776
|
* ```
|
|
4777
|
+
* Payload: {@link DataSourceSelectedPayload} or string[].
|
|
4633
4778
|
*/
|
|
4634
4779
|
DataSourceSelected = "dataSourceSelected",
|
|
4635
4780
|
/**
|
|
@@ -4642,6 +4787,7 @@ export enum EmbedEvent {
|
|
|
4642
4787
|
* console.log('AddRemoveColumns', payload);
|
|
4643
4788
|
* })
|
|
4644
4789
|
* ```
|
|
4790
|
+
* Payload: string[].
|
|
4645
4791
|
*/
|
|
4646
4792
|
AddRemoveColumns = "addRemoveColumns",
|
|
4647
4793
|
/**
|
|
@@ -4659,6 +4805,7 @@ export enum EmbedEvent {
|
|
|
4659
4805
|
* }
|
|
4660
4806
|
* })
|
|
4661
4807
|
* ```
|
|
4808
|
+
* Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
|
|
4662
4809
|
*/
|
|
4663
4810
|
CustomAction = "customAction",
|
|
4664
4811
|
/**
|
|
@@ -4671,6 +4818,7 @@ export enum EmbedEvent {
|
|
|
4671
4818
|
* console.log('VizPointDoubleClick', payload);
|
|
4672
4819
|
* })
|
|
4673
4820
|
* ```
|
|
4821
|
+
* Payload: {@link VizInteractionPayload}.
|
|
4674
4822
|
*/
|
|
4675
4823
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
4676
4824
|
/**
|
|
@@ -4690,6 +4838,7 @@ export enum EmbedEvent {
|
|
|
4690
4838
|
* )
|
|
4691
4839
|
* });
|
|
4692
4840
|
* ```
|
|
4841
|
+
* Payload: {@link VizInteractionPayload}.
|
|
4693
4842
|
*/
|
|
4694
4843
|
VizPointClick = "vizPointClick",
|
|
4695
4844
|
/**
|
|
@@ -4742,6 +4891,7 @@ export enum EmbedEvent {
|
|
|
4742
4891
|
* // { errorType: "API", message: '...', code: '...' }
|
|
4743
4892
|
* });
|
|
4744
4893
|
* ```
|
|
4894
|
+
* Payload: {@link EmbedErrorPayload} or a string.
|
|
4745
4895
|
*/
|
|
4746
4896
|
Error = "Error",
|
|
4747
4897
|
/**
|
|
@@ -4792,6 +4942,7 @@ export enum EmbedEvent {
|
|
|
4792
4942
|
* The center of visible iframe viewport is calculated.
|
|
4793
4943
|
* @returns data - The center of the visible Iframe viewport.
|
|
4794
4944
|
* @hidden
|
|
4945
|
+
* Payload: none.
|
|
4795
4946
|
*/
|
|
4796
4947
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
4797
4948
|
/**
|
|
@@ -4848,6 +4999,7 @@ export enum EmbedEvent {
|
|
|
4848
4999
|
* console.log('dialog open', payload);
|
|
4849
5000
|
* })
|
|
4850
5001
|
* ```
|
|
5002
|
+
* Payload: none.
|
|
4851
5003
|
*/
|
|
4852
5004
|
DialogOpen = "dialog-open",
|
|
4853
5005
|
/**
|
|
@@ -4859,6 +5011,7 @@ export enum EmbedEvent {
|
|
|
4859
5011
|
* console.log('dialog close', payload);
|
|
4860
5012
|
* })
|
|
4861
5013
|
* ```
|
|
5014
|
+
* Payload: none.
|
|
4862
5015
|
*/
|
|
4863
5016
|
DialogClose = "dialog-close",
|
|
4864
5017
|
/**
|
|
@@ -4881,6 +5034,7 @@ export enum EmbedEvent {
|
|
|
4881
5034
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
4882
5035
|
* };
|
|
4883
5036
|
* ```
|
|
5037
|
+
* Payload: none.
|
|
4884
5038
|
*/
|
|
4885
5039
|
LiveboardRendered = "PinboardRendered",
|
|
4886
5040
|
/**
|
|
@@ -4911,6 +5065,7 @@ export enum EmbedEvent {
|
|
|
4911
5065
|
* console.log('Save', payload)
|
|
4912
5066
|
* })
|
|
4913
5067
|
* ```
|
|
5068
|
+
* Payload: {@link SaveEventPayload}.
|
|
4914
5069
|
*/
|
|
4915
5070
|
Save = "save",
|
|
4916
5071
|
/**
|
|
@@ -4927,6 +5082,7 @@ export enum EmbedEvent {
|
|
|
4927
5082
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
4928
5083
|
* })
|
|
4929
5084
|
* ```
|
|
5085
|
+
* Payload: {@link VizScope}.
|
|
4930
5086
|
*/
|
|
4931
5087
|
Download = "download",
|
|
4932
5088
|
/**
|
|
@@ -4946,6 +5102,7 @@ export enum EmbedEvent {
|
|
|
4946
5102
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
4947
5103
|
* console.log('download PNG', payload)})
|
|
4948
5104
|
* ```
|
|
5105
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4949
5106
|
*/
|
|
4950
5107
|
DownloadAsPng = "downloadAsPng",
|
|
4951
5108
|
/**
|
|
@@ -4965,6 +5122,7 @@ export enum EmbedEvent {
|
|
|
4965
5122
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
4966
5123
|
* console.log('download PDF', payload)})
|
|
4967
5124
|
* ```
|
|
5125
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4968
5126
|
*/
|
|
4969
5127
|
DownloadAsPdf = "downloadAsPdf",
|
|
4970
5128
|
/**
|
|
@@ -4984,6 +5142,7 @@ export enum EmbedEvent {
|
|
|
4984
5142
|
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
4985
5143
|
* console.log('download CSV', payload)})
|
|
4986
5144
|
* ```
|
|
5145
|
+
* Payload: {@link DownloadEventPayload}.
|
|
4987
5146
|
*/
|
|
4988
5147
|
DownloadAsCsv = "downloadAsCsv",
|
|
4989
5148
|
/**
|
|
@@ -5003,6 +5162,7 @@ export enum EmbedEvent {
|
|
|
5003
5162
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
5004
5163
|
* console.log('download Xlsx', payload)})
|
|
5005
5164
|
* ```
|
|
5165
|
+
* Payload: {@link DownloadEventPayload}.
|
|
5006
5166
|
*/
|
|
5007
5167
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
5008
5168
|
/**
|
|
@@ -5014,6 +5174,7 @@ export enum EmbedEvent {
|
|
|
5014
5174
|
* liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
|
|
5015
5175
|
* console.log('download liveboard as continuous PDF', payload)})
|
|
5016
5176
|
* ```
|
|
5177
|
+
* Payload: {@link LiveboardScope}.
|
|
5017
5178
|
*/
|
|
5018
5179
|
DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
|
|
5019
5180
|
/**
|
|
@@ -5030,6 +5191,7 @@ export enum EmbedEvent {
|
|
|
5030
5191
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
5031
5192
|
* console.log('delete answer', payload)})
|
|
5032
5193
|
* ```
|
|
5194
|
+
* Payload: {@link AnswerScope}.
|
|
5033
5195
|
*/
|
|
5034
5196
|
AnswerDelete = "answerDelete",
|
|
5035
5197
|
/**
|
|
@@ -5041,6 +5203,7 @@ export enum EmbedEvent {
|
|
|
5041
5203
|
* console.log('AI Highlights', payload);
|
|
5042
5204
|
* })
|
|
5043
5205
|
* ```
|
|
5206
|
+
* Payload: {@link LiveboardScope}.
|
|
5044
5207
|
*/
|
|
5045
5208
|
AIHighlights = "AIHighlights",
|
|
5046
5209
|
/**
|
|
@@ -5062,6 +5225,7 @@ export enum EmbedEvent {
|
|
|
5062
5225
|
* console.log('pin', payload)
|
|
5063
5226
|
* })
|
|
5064
5227
|
* ```
|
|
5228
|
+
* Payload: {@link PinEventPayload}.
|
|
5065
5229
|
*/
|
|
5066
5230
|
Pin = "pin",
|
|
5067
5231
|
/**
|
|
@@ -5080,6 +5244,7 @@ export enum EmbedEvent {
|
|
|
5080
5244
|
* console.log('SpotIQ analyze', payload)
|
|
5081
5245
|
* })
|
|
5082
5246
|
* ```
|
|
5247
|
+
* Payload: {@link AnswerScope}.
|
|
5083
5248
|
*/
|
|
5084
5249
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
5085
5250
|
/**
|
|
@@ -5133,6 +5298,7 @@ export enum EmbedEvent {
|
|
|
5133
5298
|
* console.log('copy to clipboard', payload);
|
|
5134
5299
|
* })
|
|
5135
5300
|
* ```
|
|
5301
|
+
* Payload: {@link CopyToClipboardPayload}.
|
|
5136
5302
|
*/
|
|
5137
5303
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
5138
5304
|
/**
|
|
@@ -5144,6 +5310,7 @@ export enum EmbedEvent {
|
|
|
5144
5310
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
5145
5311
|
* })
|
|
5146
5312
|
* ```
|
|
5313
|
+
* Payload: {@link TmlEventPayload}.
|
|
5147
5314
|
*/
|
|
5148
5315
|
UpdateTML = "updateTSL",
|
|
5149
5316
|
/**
|
|
@@ -5156,6 +5323,7 @@ export enum EmbedEvent {
|
|
|
5156
5323
|
* console.log('Edit TML', payload);
|
|
5157
5324
|
* })
|
|
5158
5325
|
* ```
|
|
5326
|
+
* Payload: {@link TmlEventPayload}.
|
|
5159
5327
|
*/
|
|
5160
5328
|
EditTML = "editTSL",
|
|
5161
5329
|
/**
|
|
@@ -5173,6 +5341,7 @@ export enum EmbedEvent {
|
|
|
5173
5341
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
5174
5342
|
* console.log('Export TML', payload)})
|
|
5175
5343
|
* ```
|
|
5344
|
+
* Payload: {@link TmlEventPayload}.
|
|
5176
5345
|
*/
|
|
5177
5346
|
ExportTML = "exportTSL",
|
|
5178
5347
|
/**
|
|
@@ -5211,6 +5380,7 @@ export enum EmbedEvent {
|
|
|
5211
5380
|
* console.log('show data', payload);
|
|
5212
5381
|
* })
|
|
5213
5382
|
* ```
|
|
5383
|
+
* Payload: {@link AnswerScope}.
|
|
5214
5384
|
*/
|
|
5215
5385
|
ShowUnderlyingData = "showUnderlyingData",
|
|
5216
5386
|
/**
|
|
@@ -5222,6 +5392,7 @@ export enum EmbedEvent {
|
|
|
5222
5392
|
* console.log('switch view', payload);
|
|
5223
5393
|
* })
|
|
5224
5394
|
* ```
|
|
5395
|
+
* Payload: {@link AnswerChartSwitcherPayload}.
|
|
5225
5396
|
*/
|
|
5226
5397
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5227
5398
|
/**
|
|
@@ -5243,6 +5414,7 @@ export enum EmbedEvent {
|
|
|
5243
5414
|
* console.log('Liveboard details', payload);
|
|
5244
5415
|
* })
|
|
5245
5416
|
* ```
|
|
5417
|
+
* Payload: {@link LiveboardScope}.
|
|
5246
5418
|
*/
|
|
5247
5419
|
LiveboardInfo = "pinboardInfo",
|
|
5248
5420
|
/**
|
|
@@ -5254,6 +5426,7 @@ export enum EmbedEvent {
|
|
|
5254
5426
|
* console.log('favorites', payload);
|
|
5255
5427
|
* })
|
|
5256
5428
|
* ```
|
|
5429
|
+
* Payload: {@link FavoritePayload}.
|
|
5257
5430
|
*/
|
|
5258
5431
|
AddToFavorites = "addToFavorites",
|
|
5259
5432
|
/**
|
|
@@ -5265,6 +5438,7 @@ export enum EmbedEvent {
|
|
|
5265
5438
|
* console.log('Liveboard schedule', payload);
|
|
5266
5439
|
* })
|
|
5267
5440
|
* ```
|
|
5441
|
+
* Payload: {@link LiveboardScope}.
|
|
5268
5442
|
*/
|
|
5269
5443
|
Schedule = "subscription",
|
|
5270
5444
|
/**
|
|
@@ -5279,6 +5453,7 @@ export enum EmbedEvent {
|
|
|
5279
5453
|
* console.log('Liveboard edit', payload);
|
|
5280
5454
|
* })
|
|
5281
5455
|
* ```
|
|
5456
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5282
5457
|
*/
|
|
5283
5458
|
Edit = "edit",
|
|
5284
5459
|
/**
|
|
@@ -5320,6 +5495,7 @@ export enum EmbedEvent {
|
|
|
5320
5495
|
* console.log('Copy', payload);
|
|
5321
5496
|
* })
|
|
5322
5497
|
* ```
|
|
5498
|
+
* Payload: {@link MakeACopyPayload}.
|
|
5323
5499
|
*/
|
|
5324
5500
|
MakeACopy = "makeACopy",
|
|
5325
5501
|
/**
|
|
@@ -5335,6 +5511,7 @@ export enum EmbedEvent {
|
|
|
5335
5511
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5336
5512
|
* })
|
|
5337
5513
|
* ```
|
|
5514
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5338
5515
|
*/
|
|
5339
5516
|
Present = "present",
|
|
5340
5517
|
/**
|
|
@@ -5345,6 +5522,7 @@ export enum EmbedEvent {
|
|
|
5345
5522
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
5346
5523
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5347
5524
|
* ```
|
|
5525
|
+
* Payload: {@link LiveboardScope}.
|
|
5348
5526
|
*/
|
|
5349
5527
|
Delete = "delete",
|
|
5350
5528
|
/**
|
|
@@ -5354,6 +5532,7 @@ export enum EmbedEvent {
|
|
|
5354
5532
|
* ```js
|
|
5355
5533
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
5356
5534
|
* ```
|
|
5535
|
+
* Payload: {@link LiveboardScope}.
|
|
5357
5536
|
*/
|
|
5358
5537
|
SchedulesList = "schedule-list",
|
|
5359
5538
|
/**
|
|
@@ -5363,6 +5542,7 @@ export enum EmbedEvent {
|
|
|
5363
5542
|
* ```js
|
|
5364
5543
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
5365
5544
|
* ```
|
|
5545
|
+
* Payload: {@link LiveboardScope}.
|
|
5366
5546
|
*/
|
|
5367
5547
|
Cancel = "cancel",
|
|
5368
5548
|
/**
|
|
@@ -5373,6 +5553,7 @@ export enum EmbedEvent {
|
|
|
5373
5553
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
5374
5554
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5375
5555
|
* ```
|
|
5556
|
+
* Payload: {@link LiveboardVizScope}.
|
|
5376
5557
|
*/
|
|
5377
5558
|
Explore = "explore",
|
|
5378
5559
|
/**
|
|
@@ -5383,6 +5564,7 @@ export enum EmbedEvent {
|
|
|
5383
5564
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
5384
5565
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5385
5566
|
* ```
|
|
5567
|
+
* Payload: {@link CopyLinkPayload}.
|
|
5386
5568
|
*/
|
|
5387
5569
|
CopyLink = "embedDocument",
|
|
5388
5570
|
/**
|
|
@@ -5394,6 +5576,7 @@ export enum EmbedEvent {
|
|
|
5394
5576
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
5395
5577
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
5396
5578
|
* ```
|
|
5579
|
+
* Payload: {@link CrossFilterChangedPayload}.
|
|
5397
5580
|
*/
|
|
5398
5581
|
CrossFilterChanged = "cross-filter-changed",
|
|
5399
5582
|
/**
|
|
@@ -5405,6 +5588,7 @@ export enum EmbedEvent {
|
|
|
5405
5588
|
* console.log('VizPointClick', payload)
|
|
5406
5589
|
* })
|
|
5407
5590
|
* ```
|
|
5591
|
+
* Payload: {@link VizInteractionPayload}.
|
|
5408
5592
|
*/
|
|
5409
5593
|
VizPointRightClick = "vizPointRightClick",
|
|
5410
5594
|
/**
|
|
@@ -5432,6 +5616,7 @@ export enum EmbedEvent {
|
|
|
5432
5616
|
* })
|
|
5433
5617
|
* ```
|
|
5434
5618
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
5619
|
+
* Payload: {@link FilterChangedPayload}.
|
|
5435
5620
|
*/
|
|
5436
5621
|
FilterChanged = "filterChanged",
|
|
5437
5622
|
/**
|
|
@@ -5454,6 +5639,7 @@ export enum EmbedEvent {
|
|
|
5454
5639
|
* @returns isPublic: boolean
|
|
5455
5640
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5456
5641
|
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5642
|
+
* Payload: {@link PersonalisedViewPayload}.
|
|
5457
5643
|
*/
|
|
5458
5644
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
5459
5645
|
/**
|
|
@@ -5475,6 +5661,7 @@ export enum EmbedEvent {
|
|
|
5475
5661
|
* @returns isPublic: boolean
|
|
5476
5662
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5477
5663
|
* @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5664
|
+
* Payload: {@link PersonalisedViewPayload}.
|
|
5478
5665
|
*/
|
|
5479
5666
|
SavePersonalisedView = "savePersonalisedView",
|
|
5480
5667
|
/**
|
|
@@ -5549,6 +5736,7 @@ export enum EmbedEvent {
|
|
|
5549
5736
|
/**
|
|
5550
5737
|
* Emitted when a Liveboard or visualization is renamed.
|
|
5551
5738
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
5739
|
+
* Payload: {@link RenamePayload}.
|
|
5552
5740
|
*/
|
|
5553
5741
|
Rename = "rename",
|
|
5554
5742
|
/**
|
|
@@ -5634,6 +5822,7 @@ export enum EmbedEvent {
|
|
|
5634
5822
|
* })
|
|
5635
5823
|
* ```
|
|
5636
5824
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
5825
|
+
* Payload: {@link ParameterChangedPayload}.
|
|
5637
5826
|
*/
|
|
5638
5827
|
ParameterChanged = "parameterChanged",
|
|
5639
5828
|
/**
|
|
@@ -5677,6 +5866,7 @@ export enum EmbedEvent {
|
|
|
5677
5866
|
* })
|
|
5678
5867
|
* ```
|
|
5679
5868
|
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
5869
|
+
* Payload: {@link TableVizRenderedPayload}.
|
|
5680
5870
|
*/
|
|
5681
5871
|
TableVizRendered = "TableVizRendered",
|
|
5682
5872
|
/**
|
|
@@ -5701,12 +5891,14 @@ export enum EmbedEvent {
|
|
|
5701
5891
|
* @hidden
|
|
5702
5892
|
* Emitted when a user exits present mode.
|
|
5703
5893
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
5894
|
+
* Payload: {@link ExitPresentModePayload}.
|
|
5704
5895
|
*/
|
|
5705
5896
|
ExitPresentMode = "exitPresentMode",
|
|
5706
5897
|
/**
|
|
5707
5898
|
* Emitted when a user requests the full height lazy load data.
|
|
5708
5899
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
5709
5900
|
* @hidden
|
|
5901
|
+
* Payload: none.
|
|
5710
5902
|
*/
|
|
5711
5903
|
RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
|
|
5712
5904
|
/**
|
|
@@ -5740,6 +5932,7 @@ export enum EmbedEvent {
|
|
|
5740
5932
|
* })
|
|
5741
5933
|
* ```
|
|
5742
5934
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5935
|
+
* Payload: {@link VizScope}.
|
|
5743
5936
|
*/
|
|
5744
5937
|
AddToCoaching = "addToCoaching",
|
|
5745
5938
|
/**
|
|
@@ -5829,6 +6022,7 @@ export enum EmbedEvent {
|
|
|
5829
6022
|
* console.log('EmbedListenerReady');
|
|
5830
6023
|
* })
|
|
5831
6024
|
* ```
|
|
6025
|
+
* Payload: none.
|
|
5832
6026
|
*/
|
|
5833
6027
|
EmbedListenerReady = "EmbedListenerReady",
|
|
5834
6028
|
/**
|
|
@@ -6203,6 +6397,7 @@ export enum EmbedEvent {
|
|
|
6203
6397
|
* })
|
|
6204
6398
|
* ```
|
|
6205
6399
|
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
6400
|
+
* Payload: {@link TestScheduleEmailPayload}.
|
|
6206
6401
|
*/
|
|
6207
6402
|
SendTestScheduleEmail = "sendTestScheduleEmail",
|
|
6208
6403
|
/**
|
|
@@ -6713,6 +6908,19 @@ export enum HostEvent {
|
|
|
6713
6908
|
* ```
|
|
6714
6909
|
*/
|
|
6715
6910
|
OpenAddParameterModal = "openAddParameterModal",
|
|
6911
|
+
/**
|
|
6912
|
+
* Add a tab to the Liveboard, the same action as the *Tab* option in the
|
|
6913
|
+
* *Add* dropdown in the Liveboard edit header.
|
|
6914
|
+
*
|
|
6915
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
6916
|
+
*
|
|
6917
|
+
* @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
|
|
6918
|
+
* @example
|
|
6919
|
+
* ```js
|
|
6920
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
|
|
6921
|
+
* ```
|
|
6922
|
+
*/
|
|
6923
|
+
OpenAddTabModal = "openAddTabModal",
|
|
6716
6924
|
/**
|
|
6717
6925
|
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
6718
6926
|
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
@@ -7310,6 +7518,17 @@ export enum HostEvent {
|
|
|
7310
7518
|
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
|
|
7311
7519
|
*/
|
|
7312
7520
|
EditVisualization = "editVisualization",
|
|
7521
|
+
/**
|
|
7522
|
+
* Exits Liveboard edit mode , equivalent to clicking the
|
|
7523
|
+
* *Cancel* button in the Liveboard edit header. The Liveboard returns to
|
|
7524
|
+
* view mode and the embedded app emits the {@link EmbedEvent.Cancel} event.
|
|
7525
|
+
* @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
|
|
7526
|
+
* @example
|
|
7527
|
+
* ```js
|
|
7528
|
+
* liveboardEmbed.trigger(HostEvent.ExitEditMode);
|
|
7529
|
+
* ```
|
|
7530
|
+
*/
|
|
7531
|
+
ExitEditMode = "exitEditMode",
|
|
7313
7532
|
/**
|
|
7314
7533
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
7315
7534
|
* Payload: {@link VizScopedRequest}.
|
|
@@ -8843,7 +9062,40 @@ export enum HostEvent {
|
|
|
8843
9062
|
* ```
|
|
8844
9063
|
* @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
|
|
8845
9064
|
*/
|
|
8846
|
-
RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache"
|
|
9065
|
+
RefreshLiveboardBrowserCache = "refreshLiveboardBrowserCache",
|
|
9066
|
+
/**
|
|
9067
|
+
* Switch the embed between dark appearance and its default appearance
|
|
9068
|
+
* while it is open, without reloading it.
|
|
9069
|
+
* Payload: {@link UpdateThemeRequest}.
|
|
9070
|
+
*
|
|
9071
|
+
* Use it to keep the embed in step with a theme switch in your
|
|
9072
|
+
* application; the appearance the embed loads with is set by `isDarkMode`.
|
|
9073
|
+
* The event resolves with the applied value, such as `{ isDarkMode: true }`.
|
|
9074
|
+
* When dark appearance is not available in the embed, the embed does not
|
|
9075
|
+
* change and the event rejects with an error message instead.
|
|
9076
|
+
* @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
|
|
9077
|
+
* @param - `isDarkMode` - `true` for dark appearance, `false` for the
|
|
9078
|
+
* default appearance.
|
|
9079
|
+
* @example
|
|
9080
|
+
* ```js
|
|
9081
|
+
* appEmbed.trigger(HostEvent.UpdateTheme, { isDarkMode: true });
|
|
9082
|
+
* ```
|
|
9083
|
+
* @example
|
|
9084
|
+
* ```js
|
|
9085
|
+
* // Follow a theme switch in your application
|
|
9086
|
+
* const themeSwitch = document.querySelector('#theme-switch');
|
|
9087
|
+
* themeSwitch.addEventListener('change', async (event) => {
|
|
9088
|
+
* try {
|
|
9089
|
+
* await appEmbed.trigger(HostEvent.UpdateTheme, {
|
|
9090
|
+
* isDarkMode: event.target.checked,
|
|
9091
|
+
* });
|
|
9092
|
+
* } catch (error) {
|
|
9093
|
+
* console.warn(error);
|
|
9094
|
+
* }
|
|
9095
|
+
* });
|
|
9096
|
+
* ```
|
|
9097
|
+
*/
|
|
9098
|
+
UpdateTheme = "UpdateTheme"
|
|
8847
9099
|
}
|
|
8848
9100
|
/**
|
|
8849
9101
|
* The different visual modes that the data sources panel within
|
|
@@ -8904,6 +9156,21 @@ export type SpotterFileUploadFileTypes = {
|
|
|
8904
9156
|
*/
|
|
8905
9157
|
export enum Action {
|
|
8906
9158
|
/**
|
|
9159
|
+
* The **Add** button on a Liveboard in edit mode.
|
|
9160
|
+
* Controls the visibility and disabled state of the Add panel button
|
|
9161
|
+
* in the Liveboard edit toolbar, which allows users to add
|
|
9162
|
+
* visualizations, filters, parameters, and tabs.
|
|
9163
|
+
* @example
|
|
9164
|
+
* ```js
|
|
9165
|
+
* hiddenActions: [Action.LiveboardAddPanel]
|
|
9166
|
+
* // or
|
|
9167
|
+
* disabledActions: [Action.LiveboardAddPanel]
|
|
9168
|
+
* ```
|
|
9169
|
+
* @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
|
|
9170
|
+
*/
|
|
9171
|
+
LiveboardAddPanel = "liveboardAddPanel",
|
|
9172
|
+
/**
|
|
9173
|
+
*
|
|
8907
9174
|
* The **Save** action on an Answer or Liveboard.
|
|
8908
9175
|
* Allows users to save the changes.
|
|
8909
9176
|
* @example
|
|
@@ -11131,7 +11398,126 @@ export enum Action {
|
|
|
11131
11398
|
* }
|
|
11132
11399
|
* ```
|
|
11133
11400
|
*/
|
|
11134
|
-
CustomizeHomepage = "customizeHomepage"
|
|
11401
|
+
CustomizeHomepage = "customizeHomepage",
|
|
11402
|
+
/**
|
|
11403
|
+
* Controls the visibility and disabled state of the *Cancel* button in the
|
|
11404
|
+
* Liveboard edit header, the button that discards the changes made in edit
|
|
11405
|
+
* mode and returns the Liveboard to view mode. The button is shown only
|
|
11406
|
+
* while the Liveboard is in edit mode.
|
|
11407
|
+
* @version SDK: 1.55.0 | ThoughtSpot Cloud: 26.12.0.cl
|
|
11408
|
+
* @example
|
|
11409
|
+
* ```js
|
|
11410
|
+
* const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
|
|
11411
|
+
* ... // other embed view config
|
|
11412
|
+
* hiddenActions: [Action.Cancel],
|
|
11413
|
+
* });
|
|
11414
|
+
* ```
|
|
11415
|
+
* @example
|
|
11416
|
+
* ```js
|
|
11417
|
+
* const liveboardEmbed = new LiveboardEmbed('#tsEmbed', {
|
|
11418
|
+
* ... // other embed view config
|
|
11419
|
+
* disabledActions: [Action.Cancel],
|
|
11420
|
+
* disabledActionReason: 'Save your changes to leave edit mode',
|
|
11421
|
+
* });
|
|
11422
|
+
* ```
|
|
11423
|
+
*/
|
|
11424
|
+
Cancel = "cancel",
|
|
11425
|
+
/**
|
|
11426
|
+
* Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
|
|
11427
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
11428
|
+
* @example
|
|
11429
|
+
* ```js
|
|
11430
|
+
* {
|
|
11431
|
+
* hiddenActions: [Action.ShowVersionHistory],
|
|
11432
|
+
* disabledActions: [Action.ShowVersionHistory],
|
|
11433
|
+
* }
|
|
11434
|
+
* ```
|
|
11435
|
+
*/
|
|
11436
|
+
ShowVersionHistory = "showVersionHistory",
|
|
11437
|
+
/**
|
|
11438
|
+
* Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
|
|
11439
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
|
|
11440
|
+
* @example
|
|
11441
|
+
* ```js
|
|
11442
|
+
* {
|
|
11443
|
+
* hiddenActions: [Action.EnableVersionControl],
|
|
11444
|
+
* disabledActions: [Action.EnableVersionControl],
|
|
11445
|
+
* }
|
|
11446
|
+
* ```
|
|
11447
|
+
*/
|
|
11448
|
+
EnableVersionControl = "enableVersionControl",
|
|
11449
|
+
/**
|
|
11450
|
+
* Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
|
|
11451
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
|
|
11452
|
+
* @example
|
|
11453
|
+
* ```js
|
|
11454
|
+
* {
|
|
11455
|
+
* hiddenActions: [Action.DisableVersionControl],
|
|
11456
|
+
* disabledActions: [Action.DisableVersionControl],
|
|
11457
|
+
* }
|
|
11458
|
+
* ```
|
|
11459
|
+
*/
|
|
11460
|
+
DisableVersionControl = "disableVersionControl",
|
|
11461
|
+
/**
|
|
11462
|
+
* Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
|
|
11463
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
11464
|
+
* @example
|
|
11465
|
+
* ```js
|
|
11466
|
+
* {
|
|
11467
|
+
* hiddenActions: [Action.WithdrawVerification],
|
|
11468
|
+
* disabledActions: [Action.WithdrawVerification],
|
|
11469
|
+
* }
|
|
11470
|
+
* ```
|
|
11471
|
+
*/
|
|
11472
|
+
WithdrawVerification = "withdrawVerification",
|
|
11473
|
+
/**
|
|
11474
|
+
* Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
|
|
11475
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
11476
|
+
* @example
|
|
11477
|
+
* ```js
|
|
11478
|
+
* {
|
|
11479
|
+
* hiddenActions: [Action.SwitchToNewChartExperience],
|
|
11480
|
+
* disabledActions: [Action.SwitchToNewChartExperience],
|
|
11481
|
+
* }
|
|
11482
|
+
* ```
|
|
11483
|
+
*/
|
|
11484
|
+
SwitchToNewChartExperience = "switchToNewChartExperience",
|
|
11485
|
+
/**
|
|
11486
|
+
* Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
|
|
11487
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
11488
|
+
* @example
|
|
11489
|
+
* ```js
|
|
11490
|
+
* {
|
|
11491
|
+
* hiddenActions: [Action.SwitchToClassicChartExperience],
|
|
11492
|
+
* disabledActions: [Action.SwitchToClassicChartExperience],
|
|
11493
|
+
* }
|
|
11494
|
+
* ```
|
|
11495
|
+
*/
|
|
11496
|
+
SwitchToClassicChartExperience = "switchToClassicChartExperience",
|
|
11497
|
+
/**
|
|
11498
|
+
* Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
|
|
11499
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
|
|
11500
|
+
* @example
|
|
11501
|
+
* ```js
|
|
11502
|
+
* {
|
|
11503
|
+
* hiddenActions: [Action.Monitor],
|
|
11504
|
+
* disabledActions: [Action.Monitor],
|
|
11505
|
+
* }
|
|
11506
|
+
* ```
|
|
11507
|
+
*/
|
|
11508
|
+
Monitor = "monitor",
|
|
11509
|
+
/**
|
|
11510
|
+
* 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.
|
|
11511
|
+
* @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
|
|
11512
|
+
* @example
|
|
11513
|
+
* ```js
|
|
11514
|
+
* {
|
|
11515
|
+
* hiddenActions: [Action.SpotterViewExplanation],
|
|
11516
|
+
* disabledActions: [Action.SpotterViewExplanation],
|
|
11517
|
+
* }
|
|
11518
|
+
* ```
|
|
11519
|
+
*/
|
|
11520
|
+
SpotterViewExplanation = "spotterViewExplanation"
|
|
11135
11521
|
}
|
|
11136
11522
|
export enum PrefetchFeatures {
|
|
11137
11523
|
FullApp = "FullApp",
|
|
@@ -12607,6 +12993,15 @@ export interface SetActiveTabRequest {
|
|
|
12607
12993
|
*/
|
|
12608
12994
|
tabId: string;
|
|
12609
12995
|
}
|
|
12996
|
+
/**
|
|
12997
|
+
* Request payload for {@link HostEvent.UpdateTheme}.
|
|
12998
|
+
*/
|
|
12999
|
+
export interface UpdateThemeRequest {
|
|
13000
|
+
/**
|
|
13001
|
+
* `true` for dark appearance, `false` for the default appearance.
|
|
13002
|
+
*/
|
|
13003
|
+
isDarkMode: boolean;
|
|
13004
|
+
}
|
|
12610
13005
|
/**
|
|
12611
13006
|
* Typed request payloads for host events that do not go through the UI
|
|
12612
13007
|
* passthrough pipeline (`HostEvent` member → request type; `void` = no payload).
|
|
@@ -12681,6 +13076,7 @@ export interface HostEventRequestMap {
|
|
|
12681
13076
|
[HostEvent.AIHighlights]: void;
|
|
12682
13077
|
[HostEvent.SendTestScheduleEmail]: ScheduleEmailRequest;
|
|
12683
13078
|
[HostEvent.RefreshLiveboardBrowserCache]: ScheduleEmailRequest;
|
|
13079
|
+
[HostEvent.OpenAddTabModal]: void;
|
|
12684
13080
|
[HostEvent.SpotterSearch]: SpotterSearchRequest;
|
|
12685
13081
|
[HostEvent.ResetSpotterConversation]: void;
|
|
12686
13082
|
[HostEvent.ShareSpotterConversation]: ConversationScopedRequest;
|
|
@@ -12697,6 +13093,7 @@ export interface HostEventRequestMap {
|
|
|
12697
13093
|
[HostEvent.InitSpotterVizConversation]: void;
|
|
12698
13094
|
[HostEvent.OpenSpotterVizPanel]: void;
|
|
12699
13095
|
[HostEvent.CloseSpotterVizPanel]: void;
|
|
13096
|
+
[HostEvent.UpdateTheme]: UpdateThemeRequest;
|
|
12700
13097
|
}
|
|
12701
13098
|
/**
|
|
12702
13099
|
* Per-context request shapes for events whose payload varies by
|
|
@@ -12741,22 +13138,216 @@ export type TriggerData<HostEventT extends HostEvent> = HostEventRequest<HostEve
|
|
|
12741
13138
|
*/
|
|
12742
13139
|
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType = ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
12743
13140
|
/**
|
|
12744
|
-
*
|
|
13141
|
+
* Base for every payload. Known fields are declared on the interfaces below;
|
|
13142
|
+
* additional fields the host may send stay `any`, so a callback reading one
|
|
13143
|
+
* keeps compiling.
|
|
12745
13144
|
*/
|
|
12746
|
-
export interface
|
|
12747
|
-
[
|
|
12748
|
-
|
|
12749
|
-
|
|
12750
|
-
|
|
12751
|
-
|
|
12752
|
-
|
|
13145
|
+
export interface EmbedEventPayloadBase {
|
|
13146
|
+
[key: string]: any;
|
|
13147
|
+
}
|
|
13148
|
+
/** Present on events raised from a Spotter conversation. */
|
|
13149
|
+
export interface ConversationScope extends EmbedEventPayloadBase {
|
|
13150
|
+
convId?: string;
|
|
13151
|
+
messageId?: string;
|
|
13152
|
+
}
|
|
13153
|
+
/** Scoped to a single visualization (optionally within a conversation). */
|
|
13154
|
+
export interface VizScope extends ConversationScope {
|
|
13155
|
+
vizId?: string;
|
|
13156
|
+
}
|
|
13157
|
+
/** Scoped to a Liveboard. */
|
|
13158
|
+
export interface LiveboardScope extends EmbedEventPayloadBase {
|
|
13159
|
+
liveboardId?: string;
|
|
13160
|
+
}
|
|
13161
|
+
/** Scoped to an Answer. */
|
|
13162
|
+
export interface AnswerScope extends EmbedEventPayloadBase {
|
|
13163
|
+
answerId?: string;
|
|
13164
|
+
vizId?: string;
|
|
13165
|
+
}
|
|
13166
|
+
/** Actions available on a viz within a Liveboard. */
|
|
13167
|
+
export interface LiveboardVizScope extends LiveboardScope, VizScope {
|
|
13168
|
+
}
|
|
13169
|
+
/** An empty payload — the event carries no data. */
|
|
13170
|
+
export type EmptyPayload = Record<string, never>;
|
|
13171
|
+
/** The answer data backing the embed, delivered with {@link EmbedEvent.Data}. */
|
|
13172
|
+
export interface DataEventPayload extends VizScope {
|
|
13173
|
+
embedAnswerData?: any;
|
|
13174
|
+
}
|
|
13175
|
+
/** {@link EmbedEvent.Error}. `message` may be a single string or a list. */
|
|
13176
|
+
export interface EmbedErrorPayload extends EmbedEventPayloadBase {
|
|
13177
|
+
errorType?: any;
|
|
13178
|
+
message?: string | string[];
|
|
13179
|
+
code?: any;
|
|
13180
|
+
error?: {
|
|
13181
|
+
message?: string;
|
|
12753
13182
|
};
|
|
13183
|
+
errors?: string[];
|
|
13184
|
+
}
|
|
13185
|
+
export interface FilterChangedPayload extends EmbedEventPayloadBase {
|
|
13186
|
+
liveboardFilters?: any[];
|
|
13187
|
+
runtimeFilters?: RuntimeFilter[];
|
|
13188
|
+
}
|
|
13189
|
+
export interface CrossFilterChangedPayload extends EmbedEventPayloadBase {
|
|
13190
|
+
action?: string;
|
|
13191
|
+
filterContentList?: any;
|
|
13192
|
+
filterRemoved?: string[];
|
|
13193
|
+
removableColumnsFilterContent?: any;
|
|
13194
|
+
}
|
|
13195
|
+
export interface ParameterChangedPayload extends ConversationScope {
|
|
13196
|
+
parameters?: any[];
|
|
13197
|
+
}
|
|
13198
|
+
export interface QueryChangedPayload extends VizScope {
|
|
13199
|
+
search?: string;
|
|
13200
|
+
}
|
|
13201
|
+
/**
|
|
13202
|
+
* Data-source(s) chosen in the picker. The host sends an object; older hosts may
|
|
13203
|
+
* send a bare list of worksheet ids, so {@link EmbedEvent.DataSourceSelected}
|
|
13204
|
+
* resolves to `string[] | DataSourceSelectedPayload`.
|
|
13205
|
+
*/
|
|
13206
|
+
export interface DataSourceSelectedPayload extends EmbedEventPayloadBase {
|
|
13207
|
+
worksheetId?: string;
|
|
13208
|
+
worksheetName?: string;
|
|
13209
|
+
worksheetIds?: string[];
|
|
13210
|
+
}
|
|
13211
|
+
/** Shared by {@link EmbedEvent.VizPointClick} and its siblings. */
|
|
13212
|
+
export interface VizInteractionPayload extends VizScope {
|
|
13213
|
+
clickedPoint?: any;
|
|
13214
|
+
selectedPoints?: any[];
|
|
13215
|
+
embedAnswerData?: any;
|
|
13216
|
+
}
|
|
13217
|
+
export interface DrilldownPayload extends ConversationScope {
|
|
13218
|
+
drillColumn?: any;
|
|
13219
|
+
clickedPoint?: any;
|
|
13220
|
+
selectedPoints?: any[];
|
|
13221
|
+
}
|
|
13222
|
+
export interface TableVizRenderedPayload extends VizScope {
|
|
13223
|
+
id?: string;
|
|
13224
|
+
data?: any;
|
|
13225
|
+
}
|
|
13226
|
+
export interface SaveEventPayload extends LiveboardVizScope {
|
|
13227
|
+
answerId?: string;
|
|
13228
|
+
}
|
|
13229
|
+
export interface MakeACopyPayload extends LiveboardVizScope {
|
|
13230
|
+
newLiveboardId?: string;
|
|
13231
|
+
}
|
|
13232
|
+
/** Downloads, either viz/answer scoped or Liveboard scoped. */
|
|
13233
|
+
export interface DownloadEventPayload extends VizScope {
|
|
13234
|
+
answerId?: string;
|
|
13235
|
+
liveboardId?: string;
|
|
13236
|
+
}
|
|
13237
|
+
/** TML export/edit/update — answer or Liveboard scoped. */
|
|
13238
|
+
export interface TmlEventPayload extends EmbedEventPayloadBase {
|
|
13239
|
+
answerId?: string;
|
|
13240
|
+
liveboardId?: string;
|
|
13241
|
+
vizId?: string;
|
|
13242
|
+
}
|
|
13243
|
+
export interface AnswerChartSwitcherPayload extends ConversationScope {
|
|
13244
|
+
answerId?: string;
|
|
13245
|
+
/** The mode switched to (chart or table). */
|
|
13246
|
+
chartType?: string;
|
|
13247
|
+
}
|
|
13248
|
+
export interface CopyToClipboardPayload extends ConversationScope {
|
|
13249
|
+
answerId?: string;
|
|
13250
|
+
}
|
|
13251
|
+
export interface PinEventPayload extends VizScope {
|
|
13252
|
+
liveboardId?: string;
|
|
13253
|
+
containerId?: string;
|
|
13254
|
+
answerId?: string;
|
|
13255
|
+
}
|
|
13256
|
+
export interface CopyLinkPayload extends LiveboardScope {
|
|
13257
|
+
vizId?: string;
|
|
13258
|
+
metricId?: any;
|
|
13259
|
+
}
|
|
13260
|
+
export interface FavoritePayload extends LiveboardScope {
|
|
13261
|
+
isFavorite?: boolean;
|
|
13262
|
+
}
|
|
13263
|
+
export interface TestScheduleEmailPayload extends LiveboardScope {
|
|
13264
|
+
sendToSelf?: boolean;
|
|
13265
|
+
}
|
|
13266
|
+
/** Note: the app sends `liveboardID` (capital ID) for this event. */
|
|
13267
|
+
export interface RenamePayload extends EmbedEventPayloadBase {
|
|
13268
|
+
liveboardID?: string;
|
|
13269
|
+
vizId?: string;
|
|
13270
|
+
title?: string;
|
|
13271
|
+
description?: string;
|
|
13272
|
+
}
|
|
13273
|
+
export interface PersonalisedViewPayload extends LiveboardScope {
|
|
13274
|
+
viewName?: string;
|
|
13275
|
+
viewId?: string;
|
|
13276
|
+
isPublic?: boolean;
|
|
13277
|
+
}
|
|
13278
|
+
export interface ExitPresentModePayload extends EmbedEventPayloadBase {
|
|
13279
|
+
type?: string;
|
|
13280
|
+
data?: any;
|
|
13281
|
+
}
|
|
13282
|
+
/** {@link EmbedEvent.AuthInit}. */
|
|
13283
|
+
export interface AuthInitPayload extends EmbedEventPayloadBase {
|
|
13284
|
+
/** Whether authentication was successful. */
|
|
13285
|
+
isLoggedIn?: boolean;
|
|
13286
|
+
}
|
|
13287
|
+
/**
|
|
13288
|
+
* Typed `data` field per embed event. Events not listed resolve to `any`.
|
|
13289
|
+
*/
|
|
13290
|
+
export interface EmbedEventDataExtension {
|
|
13291
|
+
[EmbedEvent.AuthInit]: AuthInitPayload;
|
|
12754
13292
|
[EmbedEvent.EmbedListenerReady]: Record<string, any>;
|
|
13293
|
+
[EmbedEvent.Error]: EmbedErrorPayload | string;
|
|
12755
13294
|
/**
|
|
12756
13295
|
* Fired when a callback-type custom action is triggered. Use
|
|
12757
|
-
* `payload.data.id` to identify which action fired
|
|
13296
|
+
* `payload.data.id` to identify which action fired; see also
|
|
13297
|
+
* {@link CustomActionEventPayload} for the `answerService` enrichment.
|
|
12758
13298
|
*/
|
|
12759
13299
|
[EmbedEvent.CustomAction]: CustomActionPayload;
|
|
13300
|
+
[EmbedEvent.FilterChanged]: FilterChangedPayload;
|
|
13301
|
+
[EmbedEvent.CrossFilterChanged]: CrossFilterChangedPayload;
|
|
13302
|
+
[EmbedEvent.ParameterChanged]: ParameterChangedPayload;
|
|
13303
|
+
[EmbedEvent.VizPointClick]: VizInteractionPayload;
|
|
13304
|
+
[EmbedEvent.VizPointDoubleClick]: VizInteractionPayload;
|
|
13305
|
+
[EmbedEvent.VizPointRightClick]: VizInteractionPayload;
|
|
13306
|
+
[EmbedEvent.Drilldown]: DrilldownPayload;
|
|
13307
|
+
[EmbedEvent.TableVizRendered]: TableVizRenderedPayload;
|
|
13308
|
+
[EmbedEvent.Data]: DataEventPayload;
|
|
13309
|
+
[EmbedEvent.QueryChanged]: string | QueryChangedPayload;
|
|
13310
|
+
[EmbedEvent.Save]: SaveEventPayload;
|
|
13311
|
+
[EmbedEvent.Edit]: LiveboardVizScope;
|
|
13312
|
+
[EmbedEvent.Present]: LiveboardVizScope;
|
|
13313
|
+
[EmbedEvent.Explore]: LiveboardVizScope;
|
|
13314
|
+
[EmbedEvent.MakeACopy]: MakeACopyPayload;
|
|
13315
|
+
[EmbedEvent.AnswerDelete]: AnswerScope;
|
|
13316
|
+
[EmbedEvent.AnswerChartSwitcher]: AnswerChartSwitcherPayload;
|
|
13317
|
+
[EmbedEvent.CopyToClipboard]: CopyToClipboardPayload;
|
|
13318
|
+
[EmbedEvent.SpotIQAnalyze]: AnswerScope;
|
|
13319
|
+
[EmbedEvent.ShowUnderlyingData]: AnswerScope;
|
|
13320
|
+
[EmbedEvent.AddToCoaching]: VizScope;
|
|
13321
|
+
[EmbedEvent.Pin]: PinEventPayload;
|
|
13322
|
+
[EmbedEvent.Download]: VizScope;
|
|
13323
|
+
[EmbedEvent.DownloadAsPng]: DownloadEventPayload;
|
|
13324
|
+
[EmbedEvent.DownloadAsCsv]: DownloadEventPayload;
|
|
13325
|
+
[EmbedEvent.DownloadAsXlsx]: DownloadEventPayload;
|
|
13326
|
+
[EmbedEvent.DownloadAsPdf]: DownloadEventPayload;
|
|
13327
|
+
[EmbedEvent.DownloadLiveboardAsContinuousPDF]: LiveboardScope;
|
|
13328
|
+
[EmbedEvent.ExportTML]: TmlEventPayload;
|
|
13329
|
+
[EmbedEvent.EditTML]: TmlEventPayload;
|
|
13330
|
+
[EmbedEvent.UpdateTML]: TmlEventPayload;
|
|
13331
|
+
[EmbedEvent.Cancel]: LiveboardScope;
|
|
13332
|
+
[EmbedEvent.Delete]: LiveboardScope;
|
|
13333
|
+
[EmbedEvent.Schedule]: LiveboardScope;
|
|
13334
|
+
[EmbedEvent.SchedulesList]: LiveboardScope;
|
|
13335
|
+
[EmbedEvent.SendTestScheduleEmail]: TestScheduleEmailPayload;
|
|
13336
|
+
[EmbedEvent.LiveboardInfo]: LiveboardScope;
|
|
13337
|
+
[EmbedEvent.AIHighlights]: LiveboardScope;
|
|
13338
|
+
[EmbedEvent.Rename]: RenamePayload;
|
|
13339
|
+
[EmbedEvent.AddToFavorites]: FavoritePayload;
|
|
13340
|
+
[EmbedEvent.CopyLink]: CopyLinkPayload;
|
|
13341
|
+
[EmbedEvent.ExitPresentMode]: ExitPresentModePayload;
|
|
13342
|
+
[EmbedEvent.SavePersonalisedView]: PersonalisedViewPayload;
|
|
13343
|
+
[EmbedEvent.UpdatePersonalisedView]: PersonalisedViewPayload;
|
|
13344
|
+
[EmbedEvent.AddRemoveColumns]: string[];
|
|
13345
|
+
[EmbedEvent.DataSourceSelected]: string[] | DataSourceSelectedPayload;
|
|
13346
|
+
[EmbedEvent.DialogOpen]: EmptyPayload;
|
|
13347
|
+
[EmbedEvent.DialogClose]: EmptyPayload;
|
|
13348
|
+
[EmbedEvent.LiveboardRendered]: EmptyPayload;
|
|
13349
|
+
[EmbedEvent.RequestVisibleEmbedCoordinates]: EmptyPayload;
|
|
13350
|
+
[EmbedEvent.EmbedIframeCenter]: EmptyPayload;
|
|
12760
13351
|
}
|
|
12761
13352
|
/**
|
|
12762
13353
|
* Resolves the typed `data` payload for an embed event; `any` when the
|
|
@@ -12889,7 +13480,7 @@ class TsEmbed {
|
|
|
12889
13480
|
private defaultHiddenActions;
|
|
12890
13481
|
private resizeObserver;
|
|
12891
13482
|
private preRenderContainerEl;
|
|
12892
|
-
|
|
13483
|
+
/** Last height the embedded app reported, once fullHeight has measured one. */
|
|
12893
13484
|
protected hostEventClient: HostEventClient;
|
|
12894
13485
|
protected isReadyForRenderPromise: Promise<void>;
|
|
12895
13486
|
protected shouldWaitForRenderPromise: boolean;
|
|
@@ -13069,12 +13660,6 @@ class TsEmbed {
|
|
|
13069
13660
|
isThisPeriodInDateFiltersEnabled?: boolean;
|
|
13070
13661
|
hideLiveboardHeader?: boolean;
|
|
13071
13662
|
showLiveboardTitle?: boolean;
|
|
13072
|
-
/**
|
|
13073
|
-
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
13074
|
-
* host app URL.
|
|
13075
|
-
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
13076
|
-
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
13077
|
-
*/
|
|
13078
13663
|
showLiveboardDescription?: boolean;
|
|
13079
13664
|
isLiveboardHeaderSticky?: boolean;
|
|
13080
13665
|
enable2ColumnLayout?: boolean;
|
|
@@ -13154,10 +13739,12 @@ class TsEmbed {
|
|
|
13154
13739
|
*/
|
|
13155
13740
|
private createPreRenderPlaceholder;
|
|
13156
13741
|
/**
|
|
13157
|
-
* Resolves the configured preRenderContainer
|
|
13158
|
-
*
|
|
13159
|
-
*
|
|
13160
|
-
*
|
|
13742
|
+
* Resolves the configured preRenderContainer, or defaults to the host's
|
|
13743
|
+
* nearest scrolling ancestor (document.body if none). The absolutely
|
|
13744
|
+
* positioned wrapper only follows the page while it sits inside what
|
|
13745
|
+
* scrolls, so body is right only when the document itself scrolls — an inner
|
|
13746
|
+
* scroller left the frame pinned to the viewport (SCAL-338563). A string
|
|
13747
|
+
* selector is re-queried each call so a remounted container resolves fresh.
|
|
13161
13748
|
*/
|
|
13162
13749
|
private resolvePreRenderContainerTarget;
|
|
13163
13750
|
private inheritPreRenderContainer;
|
|
@@ -13174,8 +13761,9 @@ class TsEmbed {
|
|
|
13174
13761
|
* Re-attaches the wrapper to a live container when the previously resolved
|
|
13175
13762
|
* one has been detached or no longer holds the wrapper — e.g. the host app
|
|
13176
13763
|
* remounted a custom preRenderContainer, which would otherwise leave a stale
|
|
13177
|
-
* reference and collapse the wrapper.
|
|
13178
|
-
* re-resolved; a container passed as an element
|
|
13764
|
+
* reference and collapse the wrapper. Selectors and the auto-resolved
|
|
13765
|
+
* scrolling ancestor are both re-resolved; a container passed as an element
|
|
13766
|
+
* is left untouched, as there is nothing to re-query.
|
|
13179
13767
|
*/
|
|
13180
13768
|
private reconcilePreRenderContainer;
|
|
13181
13769
|
protected insertIntoDOMForPreRender(child: string | Node): void;
|
|
@@ -13391,9 +13979,17 @@ class TsEmbed {
|
|
|
13391
13979
|
*/
|
|
13392
13980
|
private restorePreRenderContainerPosition;
|
|
13393
13981
|
/**
|
|
13394
|
-
*
|
|
13982
|
+
* Re-sizes the wrapper when its placeholder changes size.
|
|
13983
|
+
*
|
|
13984
|
+
* Position deliberately has no equivalent. An absolutely positioned wrapper
|
|
13985
|
+
* follows its containing block for free, so a correctly placed frame is the
|
|
13986
|
+
* browser's job and costs nothing; repositioning it on scroll would mean a
|
|
13987
|
+
* layout read and a style write per frame to compensate for placing it in
|
|
13988
|
+
* the wrong box. Size is the one thing the browser will not do for us: the
|
|
13989
|
+
* placeholder grows when the embedded app reports a new height, and the
|
|
13990
|
+
* wrapper has to be told.
|
|
13395
13991
|
*/
|
|
13396
|
-
private
|
|
13992
|
+
private observePreRenderSize;
|
|
13397
13993
|
/**
|
|
13398
13994
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
13399
13995
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
@@ -13647,6 +14243,19 @@ export interface SpotterSidebarViewConfig {
|
|
|
13647
14243
|
* @default Analysts
|
|
13648
14244
|
*/
|
|
13649
14245
|
spotterAnalystsLabel?: string;
|
|
14246
|
+
/**
|
|
14247
|
+
* Shows the connector marketplace option in the settings menu of the
|
|
14248
|
+
* Spotter sidebar footer. When not set, the cluster setting applies.
|
|
14249
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
14250
|
+
*/
|
|
14251
|
+
enableConnectorMarketplace?: boolean;
|
|
14252
|
+
/**
|
|
14253
|
+
* Shows the Spotter instructions and more settings options in the
|
|
14254
|
+
* settings menu of the Spotter sidebar footer.
|
|
14255
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
14256
|
+
* @default false
|
|
14257
|
+
*/
|
|
14258
|
+
enableSpotterInstructionAndMoreSettings?: boolean;
|
|
13650
14259
|
}
|
|
13651
14260
|
/**
|
|
13652
14261
|
* Configuration for the Spotter conversation sharing feature.
|
|
@@ -14307,6 +14916,7 @@ export interface SpotterAppInitData extends DefaultAppInitData {
|
|
|
14307
14916
|
visualOverridesParams?: VisualizationOverrides | null;
|
|
14308
14917
|
starterPrompts?: StarterPromptsConfig;
|
|
14309
14918
|
spotterAnalystConfig?: SpotterAnalystConfig;
|
|
14919
|
+
enableSpotterInstructionAndMoreSettings?: boolean;
|
|
14310
14920
|
};
|
|
14311
14921
|
}
|
|
14312
14922
|
/**
|
|
@@ -15416,6 +16026,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
|
15416
16026
|
spotterVizConfig?: SpotterVizConfig;
|
|
15417
16027
|
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
15418
16028
|
starterPrompts?: StarterPromptsConfig;
|
|
16029
|
+
enableSpotterInstructionAndMoreSettings?: boolean;
|
|
15419
16030
|
};
|
|
15420
16031
|
}
|
|
15421
16032
|
/**
|
|
@@ -16356,21 +16967,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, FullHeightViewConfi
|
|
|
16356
16967
|
*/
|
|
16357
16968
|
spotterExperienceVersion?: SpotterExperienceVersion;
|
|
16358
16969
|
}
|
|
16359
|
-
/**
|
|
16360
|
-
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
16361
|
-
* waits for the authentication to complete, so you need not wait for
|
|
16362
|
-
* `AuthStatus.SUCCESS`.
|
|
16363
|
-
* @group Embed components
|
|
16364
|
-
* @example
|
|
16365
|
-
* ```js
|
|
16366
|
-
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
16367
|
-
* init({ ... });
|
|
16368
|
-
* const embed = new LiveboardEmbed("#container", {
|
|
16369
|
-
* liveboardId: <your-id-here>,
|
|
16370
|
-
* // .. other params here.
|
|
16371
|
-
* })
|
|
16372
|
-
* ```
|
|
16373
|
-
*/
|
|
16374
16970
|
export class LiveboardEmbed extends V1Embed {
|
|
16375
16971
|
protected viewConfig: LiveboardViewConfig;
|
|
16376
16972
|
private readonly fullHeightController?;
|
|
@@ -16402,7 +16998,8 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
16402
16998
|
personalizedViewId: string;
|
|
16403
16999
|
};
|
|
16404
17000
|
protected beforePrerenderVisible(): void;
|
|
16405
|
-
private
|
|
17001
|
+
private isSameEmbedConfig;
|
|
17002
|
+
private isAlreadyOnSameRoute;
|
|
16406
17003
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
16407
17004
|
/**
|
|
16408
17005
|
* Triggers an event to the embedded app
|
|
@@ -17229,7 +17826,7 @@ export interface FilterChangedFilterGroup {
|
|
|
17229
17826
|
/**
|
|
17230
17827
|
* Shape of the payload received via `LiveboardEmbed.on(EmbedEvent.FilterChanged, ...)`.
|
|
17231
17828
|
*/
|
|
17232
|
-
|
|
17829
|
+
interface FilterChangedPayload$1 {
|
|
17233
17830
|
liveboardFilters?: FilterChangedFilterGroup[];
|
|
17234
17831
|
runtimeFilters?: RuntimeFilter[];
|
|
17235
17832
|
}
|
|
@@ -17277,7 +17874,7 @@ export interface UpdateFiltersPayload {
|
|
|
17277
17874
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, savedFilters);
|
|
17278
17875
|
* ```
|
|
17279
17876
|
*/
|
|
17280
|
-
export function convertFilterChangedToUpdateFiltersPayload(filterChangedPayload: FilterChangedPayload): UpdateFiltersPayload;
|
|
17877
|
+
export function convertFilterChangedToUpdateFiltersPayload(filterChangedPayload: FilterChangedPayload$1): UpdateFiltersPayload;
|
|
17281
17878
|
/**
|
|
17282
17879
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
17283
17880
|
* @example
|
|
@@ -17329,6 +17926,7 @@ export const resetCachedAuthToken: () => void;
|
|
|
17329
17926
|
export function startAutoMCPFrameRenderer(viewConfig?: AutoMCPFrameRendererViewConfig): MutationObserver;
|
|
17330
17927
|
|
|
17331
17928
|
export {
|
|
17929
|
+
FilterChangedPayload$1 as FilterChangedPayload,
|
|
17332
17930
|
getEmbedConfig as getInitConfig,
|
|
17333
17931
|
};
|
|
17334
17932
|
|