From 4d4f26b92c6b8a4ead7661e0a73a8d72146238fe Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Oct 2025 08:35:10 +0530 Subject: [PATCH 1/6] doc update for HostEvent.UpdateParameters and formatting fix --- src/types.ts | 21 +- static/typedoc/typedoc.json | 379 +++++++++++++++++++----------------- 2 files changed, 211 insertions(+), 189 deletions(-) diff --git a/src/types.ts b/src/types.ts index 7ba16718..18af13a9 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4036,13 +4036,19 @@ export enum HostEvent { ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView', /** * Triggers an action to update Parameter values on embedded - * Answers, Liveboard and Spotter answer in Edit mode. + * Answers, Liveboard, and Spotter answer in Edit mode. + * @param - `name` - Parameter name. + * @param `description` - Description text for the Answer. + * Optionally, to control the visibility of the Parameter chip + * when applying an override, set the `isVisibleToUser` + * attribute. * * @example * ```js * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{ - * name: "Color", - * value: "almond" + * name: "Integer Range Param", + * value: "10", + * isVisibleToUser: true * }]) * * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw @@ -4091,10 +4097,11 @@ export enum HostEvent { * If no parameters are specified, the save action is * triggered with a modal to prompt users to * add a name and description for the Answer. - * @param - optional attributes to set Answer properties. - * `name` - Name string for the Answer. - * `description` - Description text for the Answer. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * @param - `vizId` refers to the Answer ID in Spotter embed + * and is required in Spotter embed. + * Optional attributes to set Answer properties include: + * @param - `name` - Name string for the Answer. + * @param - `description` - Description text for the Answer. * @example * ```js * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, { diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 16536ae6..11e0f64e 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -48,7 +48,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5469, + "line": 5476, "character": 4 } ], @@ -76,7 +76,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4615, + "line": 4622, "character": 4 } ], @@ -104,7 +104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4544, + "line": 4551, "character": 4 } ], @@ -128,7 +128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4533, + "line": 4540, "character": 4 } ], @@ -152,7 +152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4596, + "line": 4603, "character": 4 } ], @@ -176,7 +176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4605, + "line": 4612, "character": 4 } ], @@ -204,7 +204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4625, + "line": 4632, "character": 4 } ], @@ -232,7 +232,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5263, + "line": 5270, "character": 4 } ], @@ -260,7 +260,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4985, + "line": 4992, "character": 4 } ], @@ -288,7 +288,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5436, + "line": 5443, "character": 4 } ], @@ -316,7 +316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4973, + "line": 4980, "character": 4 } ], @@ -344,7 +344,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4961, + "line": 4968, "character": 4 } ], @@ -373,7 +373,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5425, + "line": 5432, "character": 4 } ], @@ -401,7 +401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5098, + "line": 5105, "character": 4 } ], @@ -429,7 +429,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5132, + "line": 5139, "character": 4 } ], @@ -457,7 +457,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5187, + "line": 5194, "character": 4 } ], @@ -485,7 +485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5121, + "line": 5128, "character": 4 } ], @@ -513,7 +513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5155, + "line": 5162, "character": 4 } ], @@ -541,7 +541,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5197, + "line": 5204, "character": 4 } ], @@ -569,7 +569,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5166, + "line": 5173, "character": 4 } ], @@ -597,7 +597,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5219, + "line": 5226, "character": 4 } ], @@ -625,7 +625,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5176, + "line": 5183, "character": 4 } ], @@ -653,7 +653,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5143, + "line": 5150, "character": 4 } ], @@ -681,7 +681,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5207, + "line": 5214, "character": 4 } ], @@ -709,7 +709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5109, + "line": 5116, "character": 4 } ], @@ -737,7 +737,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5567, + "line": 5574, "character": 4 } ], @@ -761,7 +761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4587, + "line": 4594, "character": 4 } ], @@ -789,7 +789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4578, + "line": 4585, "character": 4 } ], @@ -817,7 +817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4566, + "line": 4573, "character": 4 } ], @@ -845,7 +845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5643, + "line": 5650, "character": 4 } ], @@ -869,7 +869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4555, + "line": 4562, "character": 4 } ], @@ -884,7 +884,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4912, + "line": 4919, "character": 4 } ], @@ -908,7 +908,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4492, + "line": 4499, "character": 4 } ], @@ -932,7 +932,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4911, + "line": 4918, "character": 4 } ], @@ -960,7 +960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5653, + "line": 5660, "character": 4 } ], @@ -988,7 +988,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5400, + "line": 5407, "character": 4 } ], @@ -1016,7 +1016,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5005, + "line": 5012, "character": 4 } ], @@ -1044,7 +1044,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5056, + "line": 5063, "character": 4 } ], @@ -1072,7 +1072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5624, + "line": 5631, "character": 4 } ], @@ -1100,7 +1100,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5536, + "line": 5543, "character": 4 } ], @@ -1128,7 +1128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5555, + "line": 5562, "character": 4 } ], @@ -1152,7 +1152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4675, + "line": 4682, "character": 4 } ], @@ -1176,7 +1176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4708, + "line": 4715, "character": 4 } ], @@ -1201,7 +1201,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4698, + "line": 4705, "character": 4 } ], @@ -1225,7 +1225,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4685, + "line": 4692, "character": 4 } ], @@ -1249,7 +1249,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4718, + "line": 4725, "character": 4 } ], @@ -1273,7 +1273,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4928, + "line": 4935, "character": 4 } ], @@ -1297,7 +1297,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4901, + "line": 4908, "character": 4 } ], @@ -1321,7 +1321,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4892, + "line": 4899, "character": 4 } ], @@ -1345,7 +1345,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4794, + "line": 4801, "character": 4 } ], @@ -1369,7 +1369,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4483, + "line": 4490, "character": 4 } ], @@ -1397,7 +1397,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4994, + "line": 5001, "character": 4 } ], @@ -1412,7 +1412,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4917, + "line": 4924, "character": 4 } ], @@ -1440,7 +1440,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5613, + "line": 5620, "character": 4 } ], @@ -1468,7 +1468,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5307, + "line": 5314, "character": 4 } ], @@ -1496,7 +1496,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5482, + "line": 5489, "character": 4 } ], @@ -1520,7 +1520,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4762, + "line": 4769, "character": 4 } ], @@ -1544,7 +1544,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4802, + "line": 4809, "character": 4 } ], @@ -1572,7 +1572,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5634, + "line": 5641, "character": 4 } ], @@ -1600,7 +1600,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5273, + "line": 5280, "character": 4 } ], @@ -1628,7 +1628,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5284, + "line": 5291, "character": 4 } ], @@ -1652,7 +1652,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4881, + "line": 4888, "character": 4 } ], @@ -1677,7 +1677,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4734, + "line": 4741, "character": 4 } ], @@ -1701,7 +1701,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4744, + "line": 4751, "character": 4 } ], @@ -1729,7 +1729,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5669, + "line": 5676, "character": 4 } ], @@ -1757,7 +1757,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5546, + "line": 5553, "character": 4 } ], @@ -1781,7 +1781,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4843, + "line": 4850, "character": 4 } ], @@ -1809,7 +1809,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5735, + "line": 5742, "character": 4 } ], @@ -1837,7 +1837,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5368, + "line": 5375, "character": 4 } ], @@ -1861,7 +1861,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4474, + "line": 4481, "character": 4 } ], @@ -1885,7 +1885,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5348, + "line": 5355, "character": 4 } ], @@ -1913,7 +1913,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5046, + "line": 5053, "character": 4 } ], @@ -1941,7 +1941,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5525, + "line": 5532, "character": 4 } ], @@ -1969,7 +1969,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5253, + "line": 5260, "character": 4 } ], @@ -1996,7 +1996,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5328, + "line": 5335, "character": 4 } ], @@ -2020,7 +2020,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5337, + "line": 5344, "character": 4 } ], @@ -2048,7 +2048,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5458, + "line": 5465, "character": 4 } ], @@ -2076,7 +2076,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5493, + "line": 5500, "character": 4 } ], @@ -2104,7 +2104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5358, + "line": 5365, "character": 4 } ], @@ -2128,7 +2128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4860, + "line": 4867, "character": 4 } ], @@ -2152,7 +2152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5713, + "line": 5720, "character": 4 } ], @@ -2176,7 +2176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4772, + "line": 4779, "character": 4 } ], @@ -2204,7 +2204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5579, + "line": 5586, "character": 4 } ], @@ -2229,7 +2229,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4951, + "line": 4958, "character": 4 } ], @@ -2253,7 +2253,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4812, + "line": 4819, "character": 4 } ], @@ -2281,7 +2281,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5725, + "line": 5732, "character": 4 } ], @@ -2309,7 +2309,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5087, + "line": 5094, "character": 4 } ], @@ -2337,7 +2337,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5447, + "line": 5454, "character": 4 } ], @@ -2365,7 +2365,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5233, + "line": 5240, "character": 4 } ], @@ -2396,7 +2396,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5015, + "line": 5022, "character": 4 } ], @@ -2420,7 +2420,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4937, + "line": 4944, "character": 4 } ], @@ -2448,7 +2448,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5243, + "line": 5250, "character": 4 } ], @@ -2476,7 +2476,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5591, + "line": 5598, "character": 4 } ], @@ -2504,7 +2504,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5319, + "line": 5326, "character": 4 } ], @@ -2528,7 +2528,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4443, + "line": 4450, "character": 4 } ], @@ -2552,7 +2552,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4461, + "line": 4468, "character": 4 } ], @@ -2576,7 +2576,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4506, + "line": 4513, "character": 4 } ], @@ -2600,7 +2600,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4515, + "line": 4522, "character": 4 } ], @@ -2615,7 +2615,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4918, + "line": 4925, "character": 4 } ], @@ -2639,7 +2639,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4524, + "line": 4531, "character": 4 } ], @@ -2657,7 +2657,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4650, + "line": 4657, "character": 4 } ], @@ -2685,7 +2685,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5294, + "line": 5301, "character": 4 } ], @@ -2709,7 +2709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4665, + "line": 4672, "character": 4 } ], @@ -2733,7 +2733,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4638, + "line": 4645, "character": 4 } ], @@ -2761,7 +2761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5602, + "line": 5609, "character": 4 } ], @@ -2789,7 +2789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5702, + "line": 5709, "character": 4 } ], @@ -2817,7 +2817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5680, + "line": 5687, "character": 4 } ], @@ -2845,7 +2845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5691, + "line": 5698, "character": 4 } ], @@ -2869,7 +2869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4873, + "line": 4880, "character": 4 } ], @@ -2897,7 +2897,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5036, + "line": 5043, "character": 4 } ], @@ -2925,7 +2925,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5025, + "line": 5032, "character": 4 } ], @@ -2953,7 +2953,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5066, + "line": 5073, "character": 4 } ], @@ -2981,7 +2981,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5076, + "line": 5083, "character": 4 } ], @@ -3013,7 +3013,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5387, + "line": 5394, "character": 4 } ], @@ -3037,7 +3037,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4784, + "line": 4791, "character": 4 } ], @@ -3065,7 +3065,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5515, + "line": 5522, "character": 4 } ], @@ -3089,7 +3089,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4753, + "line": 4760, "character": 4 } ], @@ -3117,7 +3117,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5411, + "line": 5418, "character": 4 } ], @@ -3145,7 +3145,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5504, + "line": 5511, "character": 4 } ], @@ -3282,7 +3282,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4434, + "line": 4441, "character": 12 } ] @@ -3855,7 +3855,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5756, + "line": 5763, "character": 4 } ], @@ -3870,7 +3870,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5754, + "line": 5761, "character": 4 } ], @@ -3885,7 +3885,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5755, + "line": 5762, "character": 4 } ], @@ -3906,7 +3906,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5753, + "line": 5760, "character": 12 } ] @@ -3930,7 +3930,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5841, + "line": 5848, "character": 4 } ], @@ -3945,7 +3945,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5839, + "line": 5846, "character": 4 } ], @@ -3960,7 +3960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5842, + "line": 5849, "character": 4 } ], @@ -3975,7 +3975,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5840, + "line": 5847, "character": 4 } ], @@ -3997,7 +3997,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5838, + "line": 5845, "character": 12 } ] @@ -4021,7 +4021,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5832, + "line": 5839, "character": 4 } ], @@ -4036,7 +4036,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5831, + "line": 5838, "character": 4 } ], @@ -4051,7 +4051,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5830, + "line": 5837, "character": 4 } ], @@ -4072,7 +4072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5829, + "line": 5836, "character": 12 } ] @@ -4183,7 +4183,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4265, + "line": 4272, "character": 4 } ], @@ -4201,7 +4201,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4269, + "line": 4276, "character": 4 } ], @@ -4219,7 +4219,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4261, + "line": 4268, "character": 4 } ], @@ -4240,7 +4240,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4257, + "line": 4264, "character": 12 } ] @@ -7332,7 +7332,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4204, + "line": 4211, "character": 4 } ], @@ -7393,7 +7393,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4238, + "line": 4245, "character": 4 } ], @@ -7524,7 +7524,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4192, + "line": 4199, "character": 4 } ], @@ -7829,7 +7829,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4165, + "line": 4172, "character": 4 } ], @@ -8036,7 +8036,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4068, + "line": 4074, "character": 4 } ], @@ -8445,7 +8445,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4174, + "line": 4181, "character": 4 } ], @@ -8594,7 +8594,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4183, + "line": 4190, "character": 4 } ], @@ -8644,12 +8644,17 @@ "tags": [ { "tag": "param", - "text": "optional attributes to set Answer properties.\n `name` - Name string for the Answer.\n `description` - Description text for the Answer.", + "text": "`vizId` refers to the Answer ID in Spotter embed\nand is required in Spotter embed.\nOptional attributes to set Answer properties include:", "param": "-" }, { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.", + "text": "`name` - Name string for the Answer.", + "param": "-" + }, + { + "tag": "param", + "text": "`description` - Description text for the Answer.", "param": "-" }, { @@ -8669,7 +8674,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4115, + "line": 4122, "character": 4 } ], @@ -9028,7 +9033,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4155, + "line": 4162, "character": 4 } ], @@ -9127,7 +9132,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4140, + "line": 4147, "character": 4 } ], @@ -9218,18 +9223,28 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Triggers an action to update Parameter values on embedded\nAnswers, Liveboard and Spotter answer in Edit mode.", + "shortText": "Triggers an action to update Parameter values on embedded\nAnswers, Liveboard, and Spotter answer in Edit mode.", "tags": [ + { + "tag": "param", + "text": "`name` - Parameter name.", + "param": "-" + }, + { + "tag": "param", + "text": "Description text for the Answer.\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", + "param": "`description`" + }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.UpdateParameters, [{\nname: \"Color\",\nvalue: \"almond\"\n}])\n\n@version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw\n" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.UpdateParameters, [{\n name: \"Integer Range Param\",\n value: \"10\",\n isVisibleToUser: true\n}])\n\n@version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 4050, + "line": 4056, "character": 4 } ], @@ -9253,7 +9268,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4076, + "line": 4082, "character": 4 } ], @@ -9702,7 +9717,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5916, + "line": 5923, "character": 4 } ], @@ -9730,7 +9745,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5877, + "line": 5884, "character": 4 } ], @@ -9758,7 +9773,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5902, + "line": 5909, "character": 4 } ], @@ -9786,7 +9801,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5865, + "line": 5872, "character": 4 } ], @@ -9814,7 +9829,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5928, + "line": 5935, "character": 4 } ], @@ -9842,7 +9857,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5889, + "line": 5896, "character": 4 } ], @@ -9866,7 +9881,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5852, + "line": 5859, "character": 12 } ] @@ -10047,7 +10062,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5743, + "line": 5750, "character": 4 } ], @@ -10062,7 +10077,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5745, + "line": 5752, "character": 4 } ], @@ -10077,7 +10092,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5744, + "line": 5751, "character": 4 } ], @@ -10092,7 +10107,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5746, + "line": 5753, "character": 4 } ], @@ -10114,7 +10129,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5742, + "line": 5749, "character": 12 } ] @@ -27617,7 +27632,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5787, + "line": 5794, "character": 4 } ], @@ -27639,7 +27654,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5788, + "line": 5795, "character": 8 } ], @@ -27658,7 +27673,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5789, + "line": 5796, "character": 8 } ], @@ -27694,7 +27709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5791, + "line": 5798, "character": 4 } ], @@ -27716,7 +27731,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5799, + "line": 5806, "character": 8 } ], @@ -27737,7 +27752,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5800, + "line": 5807, "character": 8 } ], @@ -27758,7 +27773,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5793, + "line": 5800, "character": 8 } ], @@ -27776,7 +27791,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5792, + "line": 5799, "character": 8 } ], @@ -27794,7 +27809,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5794, + "line": 5801, "character": 8 } ], @@ -27816,7 +27831,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5795, + "line": 5802, "character": 12 } ], @@ -27838,7 +27853,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5796, + "line": 5803, "character": 16 } ], @@ -27922,7 +27937,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5803, + "line": 5810, "character": 4 } ], @@ -27943,7 +27958,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5804, + "line": 5811, "character": 4 } ], @@ -27968,7 +27983,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5786, + "line": 5793, "character": 17 } ] @@ -43175,7 +43190,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5779, + "line": 5786, "character": 4 } ], @@ -43196,7 +43211,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5780, + "line": 5787, "character": 4 } ], @@ -43222,7 +43237,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5778, + "line": 5785, "character": 17 } ] From 79d9b6cd5810fda82fb611f85391febd5cac27f4 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Oct 2025 08:39:47 +0530 Subject: [PATCH 2/6] typo fix --- src/types.ts | 2 +- static/typedoc/typedoc.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/types.ts b/src/types.ts index 18af13a9..6951a128 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4038,7 +4038,7 @@ export enum HostEvent { * Triggers an action to update Parameter values on embedded * Answers, Liveboard, and Spotter answer in Edit mode. * @param - `name` - Parameter name. - * @param `description` - Description text for the Answer. + * @param `value` - Description text for the Answer. * Optionally, to control the visibility of the Parameter chip * when applying an override, set the `isVisibleToUser` * attribute. diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 11e0f64e..4901627c 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -9233,7 +9233,7 @@ { "tag": "param", "text": "Description text for the Answer.\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", - "param": "`description`" + "param": "`value`" }, { "tag": "example", From 1df44421d85870c0de7a3a5ce981cbfac7e39f17 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Oct 2025 09:12:36 +0530 Subject: [PATCH 3/6] text update --- src/types.ts | 3 +- static/typedoc/typedoc.json | 358 ++++++++++++++++++------------------ 2 files changed, 181 insertions(+), 180 deletions(-) diff --git a/src/types.ts b/src/types.ts index 6951a128..4ee0e5a4 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4038,7 +4038,8 @@ export enum HostEvent { * Triggers an action to update Parameter values on embedded * Answers, Liveboard, and Spotter answer in Edit mode. * @param - `name` - Parameter name. - * @param `value` - Description text for the Answer. + * @param `value` - Parameter value. + * * Optionally, to control the visibility of the Parameter chip * when applying an override, set the `isVisibleToUser` * attribute. diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 4901627c..c3a4a54d 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -48,7 +48,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5476, + "line": 5477, "character": 4 } ], @@ -76,7 +76,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4622, + "line": 4623, "character": 4 } ], @@ -104,7 +104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4551, + "line": 4552, "character": 4 } ], @@ -128,7 +128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4540, + "line": 4541, "character": 4 } ], @@ -152,7 +152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4603, + "line": 4604, "character": 4 } ], @@ -176,7 +176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4612, + "line": 4613, "character": 4 } ], @@ -204,7 +204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4632, + "line": 4633, "character": 4 } ], @@ -232,7 +232,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5270, + "line": 5271, "character": 4 } ], @@ -260,7 +260,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4992, + "line": 4993, "character": 4 } ], @@ -288,7 +288,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5443, + "line": 5444, "character": 4 } ], @@ -316,7 +316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4980, + "line": 4981, "character": 4 } ], @@ -344,7 +344,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4968, + "line": 4969, "character": 4 } ], @@ -373,7 +373,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5432, + "line": 5433, "character": 4 } ], @@ -401,7 +401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5105, + "line": 5106, "character": 4 } ], @@ -429,7 +429,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5139, + "line": 5140, "character": 4 } ], @@ -457,7 +457,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5194, + "line": 5195, "character": 4 } ], @@ -485,7 +485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5128, + "line": 5129, "character": 4 } ], @@ -513,7 +513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5162, + "line": 5163, "character": 4 } ], @@ -541,7 +541,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5204, + "line": 5205, "character": 4 } ], @@ -569,7 +569,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5173, + "line": 5174, "character": 4 } ], @@ -597,7 +597,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5226, + "line": 5227, "character": 4 } ], @@ -625,7 +625,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5183, + "line": 5184, "character": 4 } ], @@ -653,7 +653,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5150, + "line": 5151, "character": 4 } ], @@ -681,7 +681,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5214, + "line": 5215, "character": 4 } ], @@ -709,7 +709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5116, + "line": 5117, "character": 4 } ], @@ -737,7 +737,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5574, + "line": 5575, "character": 4 } ], @@ -761,7 +761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4594, + "line": 4595, "character": 4 } ], @@ -789,7 +789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4585, + "line": 4586, "character": 4 } ], @@ -817,7 +817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4573, + "line": 4574, "character": 4 } ], @@ -845,7 +845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5650, + "line": 5651, "character": 4 } ], @@ -869,7 +869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4562, + "line": 4563, "character": 4 } ], @@ -884,7 +884,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4919, + "line": 4920, "character": 4 } ], @@ -908,7 +908,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4499, + "line": 4500, "character": 4 } ], @@ -932,7 +932,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4918, + "line": 4919, "character": 4 } ], @@ -960,7 +960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5660, + "line": 5661, "character": 4 } ], @@ -988,7 +988,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5407, + "line": 5408, "character": 4 } ], @@ -1016,7 +1016,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5012, + "line": 5013, "character": 4 } ], @@ -1044,7 +1044,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5063, + "line": 5064, "character": 4 } ], @@ -1072,7 +1072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5631, + "line": 5632, "character": 4 } ], @@ -1100,7 +1100,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5543, + "line": 5544, "character": 4 } ], @@ -1128,7 +1128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5562, + "line": 5563, "character": 4 } ], @@ -1152,7 +1152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4682, + "line": 4683, "character": 4 } ], @@ -1176,7 +1176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4715, + "line": 4716, "character": 4 } ], @@ -1201,7 +1201,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4705, + "line": 4706, "character": 4 } ], @@ -1225,7 +1225,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4692, + "line": 4693, "character": 4 } ], @@ -1249,7 +1249,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4725, + "line": 4726, "character": 4 } ], @@ -1273,7 +1273,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4935, + "line": 4936, "character": 4 } ], @@ -1297,7 +1297,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4908, + "line": 4909, "character": 4 } ], @@ -1321,7 +1321,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4899, + "line": 4900, "character": 4 } ], @@ -1345,7 +1345,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4801, + "line": 4802, "character": 4 } ], @@ -1369,7 +1369,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4490, + "line": 4491, "character": 4 } ], @@ -1397,7 +1397,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5001, + "line": 5002, "character": 4 } ], @@ -1412,7 +1412,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4924, + "line": 4925, "character": 4 } ], @@ -1440,7 +1440,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5620, + "line": 5621, "character": 4 } ], @@ -1468,7 +1468,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5314, + "line": 5315, "character": 4 } ], @@ -1496,7 +1496,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5489, + "line": 5490, "character": 4 } ], @@ -1520,7 +1520,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4769, + "line": 4770, "character": 4 } ], @@ -1544,7 +1544,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4809, + "line": 4810, "character": 4 } ], @@ -1572,7 +1572,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5641, + "line": 5642, "character": 4 } ], @@ -1600,7 +1600,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5280, + "line": 5281, "character": 4 } ], @@ -1628,7 +1628,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5291, + "line": 5292, "character": 4 } ], @@ -1652,7 +1652,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4888, + "line": 4889, "character": 4 } ], @@ -1677,7 +1677,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4741, + "line": 4742, "character": 4 } ], @@ -1701,7 +1701,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4751, + "line": 4752, "character": 4 } ], @@ -1729,7 +1729,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5676, + "line": 5677, "character": 4 } ], @@ -1757,7 +1757,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5553, + "line": 5554, "character": 4 } ], @@ -1781,7 +1781,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4850, + "line": 4851, "character": 4 } ], @@ -1809,7 +1809,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5742, + "line": 5743, "character": 4 } ], @@ -1837,7 +1837,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5375, + "line": 5376, "character": 4 } ], @@ -1861,7 +1861,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4481, + "line": 4482, "character": 4 } ], @@ -1885,7 +1885,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5355, + "line": 5356, "character": 4 } ], @@ -1913,7 +1913,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5053, + "line": 5054, "character": 4 } ], @@ -1941,7 +1941,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5532, + "line": 5533, "character": 4 } ], @@ -1969,7 +1969,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5260, + "line": 5261, "character": 4 } ], @@ -1996,7 +1996,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5335, + "line": 5336, "character": 4 } ], @@ -2020,7 +2020,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5344, + "line": 5345, "character": 4 } ], @@ -2048,7 +2048,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5465, + "line": 5466, "character": 4 } ], @@ -2076,7 +2076,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5500, + "line": 5501, "character": 4 } ], @@ -2104,7 +2104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5365, + "line": 5366, "character": 4 } ], @@ -2128,7 +2128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4867, + "line": 4868, "character": 4 } ], @@ -2152,7 +2152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5720, + "line": 5721, "character": 4 } ], @@ -2176,7 +2176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4779, + "line": 4780, "character": 4 } ], @@ -2204,7 +2204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5586, + "line": 5587, "character": 4 } ], @@ -2229,7 +2229,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4958, + "line": 4959, "character": 4 } ], @@ -2253,7 +2253,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4819, + "line": 4820, "character": 4 } ], @@ -2281,7 +2281,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5732, + "line": 5733, "character": 4 } ], @@ -2309,7 +2309,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5094, + "line": 5095, "character": 4 } ], @@ -2337,7 +2337,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5454, + "line": 5455, "character": 4 } ], @@ -2365,7 +2365,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5240, + "line": 5241, "character": 4 } ], @@ -2396,7 +2396,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5022, + "line": 5023, "character": 4 } ], @@ -2420,7 +2420,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4944, + "line": 4945, "character": 4 } ], @@ -2448,7 +2448,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5250, + "line": 5251, "character": 4 } ], @@ -2476,7 +2476,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5598, + "line": 5599, "character": 4 } ], @@ -2504,7 +2504,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5326, + "line": 5327, "character": 4 } ], @@ -2528,7 +2528,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4450, + "line": 4451, "character": 4 } ], @@ -2552,7 +2552,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4468, + "line": 4469, "character": 4 } ], @@ -2576,7 +2576,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4513, + "line": 4514, "character": 4 } ], @@ -2600,7 +2600,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4522, + "line": 4523, "character": 4 } ], @@ -2615,7 +2615,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4925, + "line": 4926, "character": 4 } ], @@ -2639,7 +2639,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4531, + "line": 4532, "character": 4 } ], @@ -2657,7 +2657,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4657, + "line": 4658, "character": 4 } ], @@ -2685,7 +2685,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5301, + "line": 5302, "character": 4 } ], @@ -2709,7 +2709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4672, + "line": 4673, "character": 4 } ], @@ -2733,7 +2733,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4645, + "line": 4646, "character": 4 } ], @@ -2761,7 +2761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5609, + "line": 5610, "character": 4 } ], @@ -2789,7 +2789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5709, + "line": 5710, "character": 4 } ], @@ -2817,7 +2817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5687, + "line": 5688, "character": 4 } ], @@ -2845,7 +2845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5698, + "line": 5699, "character": 4 } ], @@ -2869,7 +2869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4880, + "line": 4881, "character": 4 } ], @@ -2897,7 +2897,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5043, + "line": 5044, "character": 4 } ], @@ -2925,7 +2925,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5032, + "line": 5033, "character": 4 } ], @@ -2953,7 +2953,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5073, + "line": 5074, "character": 4 } ], @@ -2981,7 +2981,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5083, + "line": 5084, "character": 4 } ], @@ -3013,7 +3013,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5394, + "line": 5395, "character": 4 } ], @@ -3037,7 +3037,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4791, + "line": 4792, "character": 4 } ], @@ -3065,7 +3065,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5522, + "line": 5523, "character": 4 } ], @@ -3089,7 +3089,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4760, + "line": 4761, "character": 4 } ], @@ -3117,7 +3117,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5418, + "line": 5419, "character": 4 } ], @@ -3145,7 +3145,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5511, + "line": 5512, "character": 4 } ], @@ -3282,7 +3282,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4441, + "line": 4442, "character": 12 } ] @@ -3855,7 +3855,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5763, + "line": 5764, "character": 4 } ], @@ -3870,7 +3870,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5761, + "line": 5762, "character": 4 } ], @@ -3885,7 +3885,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5762, + "line": 5763, "character": 4 } ], @@ -3906,7 +3906,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5760, + "line": 5761, "character": 12 } ] @@ -3930,7 +3930,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5848, + "line": 5849, "character": 4 } ], @@ -3945,7 +3945,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5846, + "line": 5847, "character": 4 } ], @@ -3960,7 +3960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5849, + "line": 5850, "character": 4 } ], @@ -3975,7 +3975,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5847, + "line": 5848, "character": 4 } ], @@ -3997,7 +3997,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5845, + "line": 5846, "character": 12 } ] @@ -4021,7 +4021,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5839, + "line": 5840, "character": 4 } ], @@ -4036,7 +4036,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5838, + "line": 5839, "character": 4 } ], @@ -4051,7 +4051,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5837, + "line": 5838, "character": 4 } ], @@ -4072,7 +4072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5836, + "line": 5837, "character": 12 } ] @@ -4183,7 +4183,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4272, + "line": 4273, "character": 4 } ], @@ -4201,7 +4201,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4276, + "line": 4277, "character": 4 } ], @@ -4219,7 +4219,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4268, + "line": 4269, "character": 4 } ], @@ -4240,7 +4240,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4264, + "line": 4265, "character": 12 } ] @@ -7332,7 +7332,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4211, + "line": 4212, "character": 4 } ], @@ -7393,7 +7393,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4245, + "line": 4246, "character": 4 } ], @@ -7524,7 +7524,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4199, + "line": 4200, "character": 4 } ], @@ -7829,7 +7829,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4172, + "line": 4173, "character": 4 } ], @@ -8036,7 +8036,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4074, + "line": 4075, "character": 4 } ], @@ -8445,7 +8445,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4181, + "line": 4182, "character": 4 } ], @@ -8594,7 +8594,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4190, + "line": 4191, "character": 4 } ], @@ -8674,7 +8674,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4122, + "line": 4123, "character": 4 } ], @@ -9033,7 +9033,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4162, + "line": 4163, "character": 4 } ], @@ -9132,7 +9132,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4147, + "line": 4148, "character": 4 } ], @@ -9232,7 +9232,7 @@ }, { "tag": "param", - "text": "Description text for the Answer.\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", + "text": "Parameter value.\n\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", "param": "`value`" }, { @@ -9244,7 +9244,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4056, + "line": 4057, "character": 4 } ], @@ -9268,7 +9268,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4082, + "line": 4083, "character": 4 } ], @@ -9717,7 +9717,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5923, + "line": 5924, "character": 4 } ], @@ -9745,7 +9745,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5884, + "line": 5885, "character": 4 } ], @@ -9773,7 +9773,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5909, + "line": 5910, "character": 4 } ], @@ -9801,7 +9801,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5872, + "line": 5873, "character": 4 } ], @@ -9829,7 +9829,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5935, + "line": 5936, "character": 4 } ], @@ -9857,7 +9857,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5896, + "line": 5897, "character": 4 } ], @@ -9881,7 +9881,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5859, + "line": 5860, "character": 12 } ] @@ -10062,7 +10062,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5750, + "line": 5751, "character": 4 } ], @@ -10077,7 +10077,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5752, + "line": 5753, "character": 4 } ], @@ -10092,7 +10092,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5751, + "line": 5752, "character": 4 } ], @@ -10107,7 +10107,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5753, + "line": 5754, "character": 4 } ], @@ -10129,7 +10129,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5749, + "line": 5750, "character": 12 } ] @@ -27632,7 +27632,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5794, + "line": 5795, "character": 4 } ], @@ -27654,7 +27654,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5795, + "line": 5796, "character": 8 } ], @@ -27673,7 +27673,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5796, + "line": 5797, "character": 8 } ], @@ -27709,7 +27709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5798, + "line": 5799, "character": 4 } ], @@ -27731,7 +27731,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5806, + "line": 5807, "character": 8 } ], @@ -27752,7 +27752,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5807, + "line": 5808, "character": 8 } ], @@ -27773,7 +27773,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5800, + "line": 5801, "character": 8 } ], @@ -27791,7 +27791,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5799, + "line": 5800, "character": 8 } ], @@ -27809,7 +27809,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5801, + "line": 5802, "character": 8 } ], @@ -27831,7 +27831,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5802, + "line": 5803, "character": 12 } ], @@ -27853,7 +27853,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5803, + "line": 5804, "character": 16 } ], @@ -27937,7 +27937,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5810, + "line": 5811, "character": 4 } ], @@ -27958,7 +27958,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5811, + "line": 5812, "character": 4 } ], @@ -27983,7 +27983,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5793, + "line": 5794, "character": 17 } ] @@ -43190,7 +43190,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5786, + "line": 5787, "character": 4 } ], @@ -43211,7 +43211,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5787, + "line": 5788, "character": 4 } ], @@ -43237,7 +43237,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5785, + "line": 5786, "character": 17 } ] From c89d29ba04674c04ab2cccf664ba39cdea1ea532 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Oct 2025 09:33:12 +0530 Subject: [PATCH 4/6] typo fix --- src/types.ts | 4 ++-- static/typedoc/typedoc.json | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/types.ts b/src/types.ts index 4ee0e5a4..fca2297a 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4037,8 +4037,8 @@ export enum HostEvent { /** * Triggers an action to update Parameter values on embedded * Answers, Liveboard, and Spotter answer in Edit mode. - * @param - `name` - Parameter name. - * @param `value` - Parameter value. + * @param - `name` - Parameter name + * @param - `value` - Parameter value * * Optionally, to control the visibility of the Parameter chip * when applying an override, set the `isVisibleToUser` diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index c3a4a54d..d7cf7a22 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -9227,13 +9227,13 @@ "tags": [ { "tag": "param", - "text": "`name` - Parameter name.", + "text": "`name` - Parameter name", "param": "-" }, { "tag": "param", - "text": "Parameter value.\n\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", - "param": "`value`" + "text": "`value` - Parameter value\n\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", + "param": "-" }, { "tag": "example", From 06cf41df7fb69c21f09e167b2d6acee917a39dfd Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Oct 2025 10:38:30 +0530 Subject: [PATCH 5/6] edits --- src/types.ts | 6 +++--- static/typedoc/typedoc.json | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/types.ts b/src/types.ts index fca2297a..f3c0c253 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4037,8 +4037,8 @@ export enum HostEvent { /** * Triggers an action to update Parameter values on embedded * Answers, Liveboard, and Spotter answer in Edit mode. - * @param - `name` - Parameter name - * @param - `value` - Parameter value + * @param - `name` - Name of the Parameter + * @param - `value` - The value to set for the Parameter. * * Optionally, to control the visibility of the Parameter chip * when applying an override, set the `isVisibleToUser` @@ -4048,7 +4048,7 @@ export enum HostEvent { * ```js * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{ * name: "Integer Range Param", - * value: "10", + * value: 10, * isVisibleToUser: true * }]) * diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index d7cf7a22..3765d978 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -9227,17 +9227,17 @@ "tags": [ { "tag": "param", - "text": "`name` - Parameter name", + "text": "`name` - Name of the Parameter", "param": "-" }, { "tag": "param", - "text": "`value` - Parameter value\n\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", + "text": "`value` - The value to set for the Parameter.\n\nOptionally, to control the visibility of the Parameter chip\nwhen applying an override, set the `isVisibleToUser`\nattribute.\n", "param": "-" }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.UpdateParameters, [{\n name: \"Integer Range Param\",\n value: \"10\",\n isVisibleToUser: true\n}])\n\n@version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw\n" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.UpdateParameters, [{\n name: \"Integer Range Param\",\n value: 10,\n isVisibleToUser: true\n}])\n\n@version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw\n" } ] }, From 3aa6853d3a114c8b90e4311c8e50bb6635a5e305 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Oct 2025 12:26:42 +0530 Subject: [PATCH 6/6] format issue fix --- src/types.ts | 2 +- static/typedoc/typedoc.json | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/types.ts b/src/types.ts index f3c0c253..398910fd 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4051,7 +4051,7 @@ export enum HostEvent { * value: 10, * isVisibleToUser: true * }]) - * + * ``` * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw */ UpdateParameters = 'UpdateParameters', diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 3765d978..c70cd505 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -9237,7 +9237,11 @@ }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.UpdateParameters, [{\n name: \"Integer Range Param\",\n value: 10,\n isVisibleToUser: true\n}])\n\n@version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw\n" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.UpdateParameters, [{\n name: \"Integer Range Param\",\n value: 10,\n isVisibleToUser: true\n}])\n```" + }, + { + "tag": "version", + "text": "SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw\n" } ] },