Skip to content

Commit cc0b5c2

Browse files
typo fixes in filter examples
1 parent 09f8aa0 commit cc0b5c2

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

src/types.ts

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2679,9 +2679,12 @@ export enum HostEvent {
26792679
* @example
26802680
* ```js
26812681
* searchEmbed.trigger(HostEvent.OpenFilter,
2682-
* { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
2682+
* {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
2683+
* ```
2684+
* @example
2685+
* ```js
26832686
* LiveboardEmbed.trigger(HostEvent.OpenFilter,
2684-
* { columnId: '<column-GUID>'})
2687+
* { column: {columnId: '<column-GUID>'}})
26852688
* ```
26862689
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
26872690
*/
@@ -3290,6 +3293,25 @@ export enum HostEvent {
32903293
* }]
32913294
* });
32923295
* ```
3296+
* If there are multiple columns with the same name, consider
3297+
* using `WORKSHEET_NAME::COLUMN_NAME` format.
3298+
*
3299+
* @example
3300+
*
3301+
* ```js
3302+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
3303+
* filters: [{
3304+
* column: "(Sample) Retail - Apparel::city",
3305+
* oper: 'IN',
3306+
* values: ["atlanta"]
3307+
* },
3308+
* {
3309+
* column: "(Sample) Retail - Apparel::Region",
3310+
* oper: 'IN',
3311+
* values: ["West","Midwest"]
3312+
* }]
3313+
* });
3314+
* ```
32933315
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
32943316
*/
32953317
UpdateFilters = 'updateFilters',

0 commit comments

Comments
 (0)