@sisense/sdk-ui 1.4.1 → 1.6.0

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.
Files changed (97) hide show
  1. package/dist/ai/ai-context-provider.d.ts +1 -0
  2. package/dist/ai/api/chat-rest-api.d.ts +3 -0
  3. package/dist/ai/api/errors.d.ts +2 -1
  4. package/dist/ai/api/types.d.ts +10 -11
  5. package/dist/ai/chat-config.d.ts +10 -3
  6. package/dist/ai/chat-intro-blurb.d.ts +4 -0
  7. package/dist/ai/chatbot.d.ts +3 -2
  8. package/dist/ai/common/collapsible.d.ts +11 -0
  9. package/dist/ai/get-nlg-query-result.d.ts +12 -52
  10. package/dist/ai/icons/loading-dots-gif-base64.d.ts +2 -0
  11. package/dist/ai/index.d.ts +4 -2
  12. package/dist/ai/messages/feedback-wrapper.d.ts +2 -1
  13. package/dist/ai/messages/insights-message.d.ts +6 -4
  14. package/dist/ai/messages/message-list-resolver.d.ts +1 -2
  15. package/dist/ai/messages/message-resolver.d.ts +1 -3
  16. package/dist/ai/messages/nlq-message-group.d.ts +10 -0
  17. package/dist/ai/suggestions/index.d.ts +1 -1
  18. package/dist/ai/suggestions/suggestion-list.d.ts +1 -1
  19. package/dist/ai/suggestions/suggestions-with-intro.d.ts +2 -2
  20. package/dist/ai/translators/code-templates.d.ts +11 -0
  21. package/dist/ai/translators/generate-code.d.ts +9 -0
  22. package/dist/ai/translators/index.d.ts +4 -0
  23. package/dist/ai/translators/model-translator.d.ts +50 -0
  24. package/dist/ai/translators/query-translator.d.ts +122 -0
  25. package/dist/ai/translators/translate-props-to-code.d.ts +8 -0
  26. package/dist/ai/translators/types.d.ts +105 -0
  27. package/dist/ai/translators/use-get-data-source.d.ts +12 -0
  28. package/dist/ai/translators/utils.d.ts +2 -0
  29. package/dist/ai/use-chat-session.d.ts +9 -3
  30. package/dist/ai/use-get-nlg-query-result.d.ts +42 -66
  31. package/dist/ai/use-get-query-recommendations.d.ts +32 -34
  32. package/dist/ai.js +7101 -1729
  33. package/dist/area-chart.d.ts +1 -0
  34. package/dist/areamap-chart.d.ts +1 -0
  35. package/dist/bar-chart.d.ts +3 -0
  36. package/dist/boxplot-chart.d.ts +1 -0
  37. package/dist/boxplot-utils.d.ts +2 -1
  38. package/dist/chart/chart.d.ts +1 -0
  39. package/dist/chart-data-options/types.d.ts +3 -3
  40. package/dist/chart-options-processor/subtype-to-design-options.d.ts +6 -6
  41. package/dist/chart-options-processor/translations/tooltip-utils.d.ts +1 -0
  42. package/dist/charts/table/helpers/calc-column-widths.d.ts +1 -1
  43. package/dist/charts/table/styles/style-constants.d.ts +2 -2
  44. package/dist/column-chart.d.ts +4 -0
  45. package/dist/common/components/loading-indicator.d.ts +2 -0
  46. package/dist/common/components/loading-spinner.d.ts +5 -0
  47. package/dist/dashboard-widget/dashboard-widget.d.ts +5 -1
  48. package/dist/dashboard-widget/translate-widget-data-options.d.ts +5 -0
  49. package/dist/dashboard-widget/translate-widget-filters.d.ts +1 -0
  50. package/dist/dashboard-widget/types.d.ts +4 -3
  51. package/dist/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts +1 -0
  52. package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts +1 -0
  53. package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-tile.d.ts +1 -0
  54. package/dist/filters/components/member-filter-tile/member-filter-tile.d.ts +1 -0
  55. package/dist/formulas/fetch-formula.d.ts +2 -2
  56. package/dist/formulas/use-get-shared-formula.d.ts +1 -0
  57. package/dist/funnel-chart.d.ts +1 -0
  58. package/dist/index.d.ts +4 -0
  59. package/dist/index.js +6728 -37696
  60. package/dist/indicator-chart.d.ts +1 -0
  61. package/dist/line-chart.d.ts +1 -0
  62. package/dist/models/dashboard/get-dashboard-models.d.ts +1 -3
  63. package/dist/models/dashboard/translate-dashboard.d.ts +1 -1
  64. package/dist/models/dashboard/types.d.ts +17 -0
  65. package/dist/models/dashboard/use-get-dashboard-model.d.ts +1 -0
  66. package/dist/models/dashboard/use-get-dashboard-models.d.ts +1 -0
  67. package/dist/models/widget/use-get-widget-model.d.ts +1 -0
  68. package/dist/models/widget/widget-model.d.ts +10 -1
  69. package/dist/pie-chart.d.ts +1 -0
  70. package/dist/pivot-table/pivot-table.d.ts +1 -0
  71. package/dist/polar-chart.d.ts +1 -0
  72. package/dist/props.d.ts +197 -120
  73. package/dist/query-execution/execute-query-by-widget-id.d.ts +1 -0
  74. package/dist/query-execution/execute-query.d.ts +1 -0
  75. package/dist/query-execution/types.d.ts +46 -16
  76. package/dist/query-execution/use-execute-csv-query.d.ts +1 -0
  77. package/dist/query-execution/use-execute-pivot-query.d.ts +1 -0
  78. package/dist/query-execution/use-execute-query-by-widget-id.d.ts +1 -0
  79. package/dist/query-execution/use-execute-query.d.ts +1 -0
  80. package/dist/scatter-chart.d.ts +1 -0
  81. package/dist/scattermap-chart.d.ts +1 -0
  82. package/dist/sisense-context/sisense-context-provider.d.ts +1 -0
  83. package/dist/sisense-context/sisense-context.d.ts +4 -1
  84. package/dist/sunburst-chart.d.ts +1 -0
  85. package/dist/table/table.d.ts +1 -0
  86. package/dist/theme-provider/theme-provider.d.ts +8 -1
  87. package/dist/treemap-chart.d.ts +1 -0
  88. package/dist/types.d.ts +32 -32
  89. package/dist/widgets/chart-widget.d.ts +1 -0
  90. package/dist/widgets/common/context-menu.d.ts +5 -0
  91. package/dist/widgets/common/drilldown-breadcrumbs/drilldown-breadcrumbs.d.ts +5 -0
  92. package/dist/widgets/drilldown-widget.d.ts +1 -0
  93. package/dist/widgets/table-widget.d.ts +1 -1
  94. package/dist/with-tracking-e2a077f9.js +109112 -0
  95. package/package.json +19 -14
  96. package/dist/ai/loading-page.d.ts +0 -2
  97. package/dist/with-tracking-d12a4632.js +0 -78010
package/dist/props.d.ts CHANGED
@@ -77,49 +77,32 @@ export interface SisenseContextProviderProps {
77
77
  }
78
78
  /**
79
79
  * Props for {@link ExecuteQuery} component.
80
+ *
81
+ * @privateRemarks
82
+ * ExecuteQueryProps should inherit docs from ExecuteQueryParams,
83
+ * instead of the other way around because sdk-ui-angular and sdk-ui-vue
84
+ * can inherit docs from ExecuteQueryParams but not from ExecuteQueryProps.
80
85
  */
81
86
  export interface ExecuteQueryProps {
82
- /**
83
- * Data source the query is run against - e.g. `Sample ECommerce`
84
- *
85
- * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
86
- */
87
+ /** {@inheritDoc ExecuteQueryParams.dataSource} */
87
88
  dataSource?: DataSource;
88
- /** Dimensions of the query */
89
+ /** {@inheritDoc ExecuteQueryParams.dimensions} */
89
90
  dimensions?: Attribute[];
90
- /** Measures of the query */
91
+ /** {@inheritDoc ExecuteQueryParams.measures} */
91
92
  measures?: Measure[];
92
- /** Filters that will slice query results */
93
+ /** {@inheritDoc ExecuteQueryParams.filters} */
93
94
  filters?: Filter[] | FilterRelations;
94
- /** Highlight filters that will highlight results that pass filter criteria */
95
+ /** {@inheritDoc ExecuteQueryParams.highlights} */
95
96
  highlights?: Filter[];
96
- /**
97
- * Number of rows to return in the query result
98
- *
99
- * If not specified, the default value is `20000`
100
- */
97
+ /** {@inheritDoc ExecuteQueryParams.count} */
101
98
  count?: number;
102
- /**
103
- * Offset of the first row to return
104
- *
105
- * If not specified, the default value is `0`
106
- */
99
+ /** {@inheritDoc ExecuteQueryParams.offset} */
107
100
  offset?: number;
108
101
  /** Function as child component that is called to render the query results */
109
102
  children?: (queryState: QueryState) => ReactNode;
110
103
  /** Callback function that is evaluated when query results are ready */
111
104
  onDataChanged?: (data: QueryResultData) => void;
112
- /**
113
- * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
114
- *
115
- * **Note:** wrap this function in `useCallback` hook to avoid triggering query execution on each render.
116
- * ```tsx
117
- * const onBeforeQuery = useCallback((jaql) => {
118
- * // modify jaql here
119
- * return jaql;
120
- * }, []);
121
- * ```
122
- */
105
+ /** {@inheritDoc ExecuteQueryParams.onBeforeQuery} */
123
106
  onBeforeQuery?: (jaql: any) => any | Promise<any>;
124
107
  }
125
108
  /**
@@ -150,9 +133,15 @@ export type ThemeProviderProps = PropsWithChildren<{
150
133
  skipTracking?: boolean;
151
134
  }>;
152
135
  /**
153
- * Before render handler where any custom adjustments can be made to the chart options
154
- * of [highcharts](https://api.highcharts.com/highcharts/),
155
- * which is an underlying charting library used by Sisense.
136
+ * A handler function that allows you to customize the underlying chart element before it is
137
+ * rendered. Use the `highchartsOptions` object that is passed to the callback to change
138
+ * [options values](https://api.highcharts.com/highcharts/) and then return the modified options
139
+ * object. The returned options are then used when rendering the chart.
140
+ *
141
+ * This callback is not supported for Indicator Chart, Areamap Chart, and Scattermap Chart.
142
+ *
143
+ * For an example of how the `BeforeRenderHandler` function can be used, see the
144
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
156
145
  *
157
146
  * @see {@link https://api.highcharts.com/highcharts/}
158
147
  */
@@ -173,7 +162,13 @@ export type DataPointsEventHandler = (
173
162
  points: DataPoint[],
174
163
  /** Native MouseEvent */
175
164
  nativeEvent: MouseEvent) => void;
176
- /** Click handler for when a data point is clicked. One parameter, `DataPoint`, is passed to the function. */
165
+ /**
166
+ * A handler function that allows you to customize what happens when certain events occur to
167
+ * a data point.
168
+ *
169
+ * For an example of how the `DataPointEventHandler` function can be used, see the
170
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
171
+ */
177
172
  export type DataPointEventHandler = (
178
173
  /** Data point that was clicked */
179
174
  point: DataPoint,
@@ -217,11 +212,16 @@ point: BoxplotDataPoint,
217
212
  nativeEvent: PointerEvent) => void;
218
213
  interface HighchartsBasedChartEventProps {
219
214
  /**
220
- * Before render handler callback that allows adjusting
221
- * detail chart options prior to render
215
+ * A callback that allows you to customize the underlying chart element before it is rendered.
216
+ * Use the `highchartsOptions` object that is passed to the callback to change
217
+ * [options values](https://api.highcharts.com/highcharts/) and then return the modified options
218
+ * object. The returned options are then used when rendering the chart.
222
219
  *
223
220
  * This callback is not supported for Indicator Chart, Areamap Chart, and Scattermap Chart.
224
221
  *
222
+ * For an example of how the `onBeforeRender` callback can be used, see the
223
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
224
+ *
225
225
  * @category Callbacks
226
226
  */
227
227
  onBeforeRender?: BeforeRenderHandler;
@@ -232,19 +232,25 @@ interface HighchartsBasedChartEventProps {
232
232
  */
233
233
  interface RegularChartEventProps extends HighchartsBasedChartEventProps {
234
234
  /**
235
- * Click handler callback for a data point
235
+ * A callback that allows you to customize what happens when a data point is clicked.
236
+ *
237
+ * To learn more about callbacks, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
236
238
  *
237
239
  * @category Callbacks
238
240
  */
239
241
  onDataPointClick?: DataPointEventHandler;
240
242
  /**
241
- * Context menu handler callback for a data point
243
+ * A callback that allows you to customize what happens when a context menu is displayed for a data point.
244
+ *
245
+ * To learn more about callbacks, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
242
246
  *
243
247
  * @category Callbacks
244
248
  */
245
249
  onDataPointContextMenu?: DataPointEventHandler;
246
250
  /**
247
- * Handler callback for selection of multiple data points
251
+ * A callback that allows you to customize what happens when data points are selected.
252
+ *
253
+ * To learn more about callbacks, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#callbacks).
248
254
  *
249
255
  * @category Callbacks
250
256
  */
@@ -329,35 +335,92 @@ interface BoxplotChartEventProps extends HighchartsBasedChartEventProps {
329
335
  */
330
336
  export interface BaseChartProps {
331
337
  /**
332
- * Data set for this component, which supports two options:
338
+ * Data set for a chart using one of the following options. If neither option is specified, the chart
339
+ * will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider}
340
+ * component.
333
341
  *
334
- * (1) Data source name (as a `string`) - e.g. `Sample ECommerce`. Under the hood,
335
- * the chart will have an internal query connect to the data source
336
- * and load the data as specified in {@link dataOptions}, {@link filters}, and {@link highlights}.
337
342
  *
338
- * OR
343
+ * (1) Sisense data source name as a string. For example, `'Sample ECommerce'`. Typically, you
344
+ * retrieve the data source name from a data model you create using the `get-data-model`
345
+ * {@link @sisense/sdk-cli!Command | command} of the Compose SDK CLI. Under the hood, the chart
346
+ * connects to the data source, executes a query, and loads the data as specified in
347
+ * {@link dataOptions}, {@link filters}, and {@link highlights}.
339
348
  *
340
- * (2) Explicit {@link @sisense/sdk-data!Data | Data}, which is made up of
341
- * an array of {@link @sisense/sdk-data!Column | columns}
342
- * and a two-dimensional array of data {@link @sisense/sdk-data!Cell | cells}.
343
- * This allows the chart component to be used
344
- * with user-provided data.
349
+ * To learn more about using data from a Sisense data source, see the
350
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#sisense-data).
345
351
  *
346
- * If neither option is specified,
347
- * the chart will use the `defaultDataSource` specified in the parent Sisense Context.
352
+ * OR
348
353
  *
354
+ * (2) Explicit {@link @sisense/sdk-data!Data | `Data`}, which is made up of an array of
355
+ * {@link @sisense/sdk-data!Column | `Column` } objects and a two-dimensional array of row data. This approach
356
+ * allows the chart component to be used with any data you provide.
357
+ *
358
+ * To learn more about using data from an external data source, see the
359
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#explicit-data).
360
+ *
361
+ * Example data in the proper format:
362
+ *
363
+ * ```ts
364
+ * const sampleData = {
365
+ * columns: [
366
+ * { name: 'Years', type: 'date' },
367
+ * { name: 'Quantity', type: 'number' },
368
+ * { name: 'Units', type: 'number' },
369
+ * ],
370
+ * rows: [
371
+ * ['2019', 5500, 1500],
372
+ * ['2020', 4471, 7000],
373
+ * ['2021', 1812, 5000],
374
+ * ['2022', 5001, 6000],
375
+ * ['2023', 2045, 4000],
376
+ * ],
377
+ * };
378
+ * ```
349
379
  *
350
380
  * @category Data
351
381
  */
352
382
  dataSet?: DataSource | Data;
353
383
  /**
354
- * Filters that will slice query results
384
+ * Filters to apply to a chart’s data using one of the following options.
385
+ *
386
+ * (1) Array of filters returned from filter factory functions, such as
387
+ * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.
388
+ *
389
+ * Use this option for filters that do not require a UI to set them
390
+ * or for filters where you will supply your own UI using non-Sisense components.
391
+ *
392
+ * To learn more about using filter factory functions to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-functions).
393
+ *
394
+ * (2) Array of filters controlled by Sisense filter components.
395
+ *
396
+ * Use this option for filters that you want your users to set using Sisense UI components.
397
+ *
398
+ * To learn more about using filter components to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components).
355
399
  *
356
400
  * @category Data
357
401
  */
358
402
  filters?: Filter[] | FilterRelations;
359
403
  /**
360
- * Highlight filters that will highlight results that pass filter criteria
404
+ * Highlights based on filter criteria to apply to a chart using one of the following options.
405
+ *
406
+ * Note that the filter dimensions used in highlights must match those defined in the
407
+ * {@link dataOptions} of the chart.
408
+ *
409
+ * (1) Array of filters returned from filter factory functions, such as
410
+ * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.
411
+ *
412
+ * Use this option for highlights that do not require a UI to set them
413
+ * or for highlights where you will supply your own UI using non-Sisense components.
414
+ *
415
+ * To learn more about using filter factory functions to create highlights, see the
416
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-functions-for-highlighting).
417
+ *
418
+ * (2) Array of filters controlled by Sisense filter components.
419
+ *
420
+ * Use this option for highlights that you want your users to set using Sisense UI components.
421
+ *
422
+ * To learn more about using filter components to create highlights, see the
423
+ * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components-for-highlighting).
361
424
  *
362
425
  * @category Data
363
426
  */
@@ -397,13 +460,19 @@ export interface ChartProps extends BaseChartProps, ChartEventProps {
397
460
  */
398
461
  chartType: ChartType;
399
462
  /**
400
- * Configurations for how to interpret and present data passed to the chart.
463
+ * Configurations for how to interpret and present a chart's data.
464
+ *
465
+ * To learn more about using data options,
466
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#dataoptions).
401
467
  *
402
468
  * @category Chart
403
469
  */
404
470
  dataOptions: ChartDataOptions;
405
471
  /**
406
- * Style options union across chart types.
472
+ * Configurations for how to style and present a chart's data.
473
+ *
474
+ * To learn more about using style options,
475
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#styleoptions).
407
476
  *
408
477
  * @category Chart
409
478
  */
@@ -421,13 +490,16 @@ export interface ChartProps extends BaseChartProps, ChartEventProps {
421
490
  */
422
491
  export interface AreaChartProps extends BaseChartProps, RegularChartEventProps, HighchartsBasedChartEventProps {
423
492
  /**
424
- * Configurations for how to interpret and present data passed to the chart.
493
+ * Configurations for how to interpret and present a chart's data.
494
+ *
495
+ * To learn more about using data options,
496
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#dataoptions).
425
497
  *
426
498
  * @category Chart
427
499
  */
428
500
  dataOptions: CartesianChartDataOptions;
429
501
  /**
430
- * Configuration that defines the functional style of the various chart elements.
502
+ * Configurations for how to style and present a chart's data.
431
503
  *
432
504
  * @category Chart
433
505
  */
@@ -438,13 +510,16 @@ export interface AreaChartProps extends BaseChartProps, RegularChartEventProps,
438
510
  */
439
511
  export interface BarChartProps extends BaseChartProps, RegularChartEventProps, HighchartsBasedChartEventProps {
440
512
  /**
441
- * Configurations for how to interpret and present the data passed to the chart
513
+ * Configurations for how to interpret and present a chart's data.
514
+ *
515
+ * To learn more about using data options,
516
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#dataoptions).
442
517
  *
443
518
  * @category Chart
444
519
  */
445
520
  dataOptions: CartesianChartDataOptions;
446
521
  /**
447
- * Configuration that defines functional style of the various chart elements
522
+ * Configurations for how to style and present a chart's data.
448
523
  *
449
524
  * @category Chart
450
525
  */
@@ -455,13 +530,16 @@ export interface BarChartProps extends BaseChartProps, RegularChartEventProps, H
455
530
  */
456
531
  export interface ColumnChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
457
532
  /**
458
- * Configurations for how to interpret and present the data passed to the chart
533
+ * Configurations for how to interpret and present a chart's data.
534
+ *
535
+ * To learn more about using data options,
536
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#dataoptions).
459
537
  *
460
538
  * @category Chart
461
539
  */
462
540
  dataOptions: CartesianChartDataOptions;
463
541
  /**
464
- * Configuration that defines functional style of the various chart elements
542
+ * Configurations for how to style and present a chart's data.
465
543
  *
466
544
  * @category Chart
467
545
  */
@@ -478,7 +556,7 @@ export interface FunnelChartProps extends BaseChartProps, HighchartsBasedChartEv
478
556
  */
479
557
  dataOptions: CategoricalChartDataOptions;
480
558
  /**
481
- * Configuration that defines functional style of the various chart elements
559
+ * Configurations for how to style and present a chart's data.
482
560
  *
483
561
  * @category Chart
484
562
  */
@@ -489,13 +567,16 @@ export interface FunnelChartProps extends BaseChartProps, HighchartsBasedChartEv
489
567
  */
490
568
  export interface LineChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
491
569
  /**
492
- * Configurations for how to interpret and present data passed to the chart.
570
+ * Configurations for how to interpret and present a chart's data.
571
+ *
572
+ * To learn more about using data options,
573
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#dataoptions).
493
574
  *
494
575
  * @category Chart
495
576
  */
496
577
  dataOptions: CartesianChartDataOptions;
497
578
  /**
498
- * Configuration that defines the functional style of the various chart elements.
579
+ * Configurations for how to style and present a chart's data.
499
580
  *
500
581
  * @category Chart
501
582
  */
@@ -512,7 +593,7 @@ export interface PieChartProps extends BaseChartProps, HighchartsBasedChartEvent
512
593
  */
513
594
  dataOptions: CategoricalChartDataOptions;
514
595
  /**
515
- * Configuration that defines functional style of the various chart elements
596
+ * Configurations for how to style and present a chart's data.
516
597
  *
517
598
  * @category Chart
518
599
  */
@@ -522,18 +603,37 @@ export interface PieChartProps extends BaseChartProps, HighchartsBasedChartEvent
522
603
  * Props of the {@link PolarChart} component.
523
604
  */
524
605
  export interface PolarChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
525
- /** Configurations for how to interpret and present the data passed to the chart */
606
+ /**
607
+ * Configurations for how to interpret and present a chart's data.
608
+ *
609
+ * To learn more about using data options,
610
+ * see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#dataoptions).
611
+ *
612
+ * @category Chart
613
+ */
526
614
  dataOptions: CartesianChartDataOptions;
527
- /** Configuration that defines functional style of the various chart elements */
615
+ /**
616
+ * Configurations for how to style and present a chart's data.
617
+ *
618
+ * @category Chart
619
+ */
528
620
  styleOptions?: PolarStyleOptions;
529
621
  }
530
622
  /**
531
623
  * Props of the {@link IndicatorChart} component.
532
624
  */
533
625
  export interface IndicatorChartProps extends BaseChartProps {
534
- /** Configurations for how to interpret and present the data passed to the chart */
626
+ /**
627
+ * Configurations for how to interpret and present the data passed to the chart
628
+ *
629
+ * @category Chart
630
+ */
535
631
  dataOptions: IndicatorChartDataOptions;
536
- /** Configuration that defines functional style of the various chart elements */
632
+ /**
633
+ * Configurations for how to style and present a chart's data.
634
+ *
635
+ * @category Chart
636
+ */
537
637
  styleOptions?: IndicatorStyleOptions;
538
638
  }
539
639
  /**
@@ -560,7 +660,7 @@ export interface TableProps {
560
660
  */
561
661
  filters?: Filter[] | FilterRelations;
562
662
  /**
563
- * Configurations that define functional style of the various table elements
663
+ * Configurations for how to style and present a table's data.
564
664
  *
565
665
  * @category Representation
566
666
  */
@@ -598,7 +698,7 @@ export interface PivotTableProps {
598
698
  */
599
699
  filters?: Filter[] | FilterRelations;
600
700
  /**
601
- * Configurations that define functional style of the various table elements
701
+ * Configurations for how to style and present a pivot table's data.
602
702
  *
603
703
  * @category Representation
604
704
  */
@@ -622,7 +722,7 @@ export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProp
622
722
  */
623
723
  dataOptions: ScatterChartDataOptions;
624
724
  /**
625
- * Configuration that defines functional style of the various chart elements
725
+ * Configurations for how to style and present a chart's data.
626
726
  *
627
727
  * @category Chart
628
728
  */
@@ -630,7 +730,6 @@ export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProp
630
730
  }
631
731
  /**
632
732
  * Props for the {@link DashboardWidget} component
633
- *
634
733
  */
635
734
  export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'> {
636
735
  /**
@@ -660,13 +759,13 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
660
759
  */
661
760
  highlights?: Filter[];
662
761
  /**
663
- * {@inheritDoc ExecuteQueryByWidgetIdProps.filtersMergeStrategy}
762
+ * {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy}
664
763
  *
665
764
  * @category Data
666
765
  */
667
766
  filtersMergeStrategy?: FiltersMergeStrategy;
668
767
  /**
669
- * {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters}
768
+ * {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters}
670
769
  *
671
770
  * @category Data
672
771
  */
@@ -688,8 +787,7 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
688
787
  */
689
788
  description?: string;
690
789
  /**
691
- * Style options for the the widget including the widget container and the chart or table inside.
692
- *
790
+ * Style options for the widget including the widget container and the chart or table inside.
693
791
  *
694
792
  * @category Widget
695
793
  */
@@ -861,55 +959,34 @@ export interface TableWidgetProps {
861
959
  }
862
960
  /**
863
961
  * Props for {@link ExecuteQueryByWidgetId} component.
962
+ *
963
+ * @privateRemarks
964
+ * ExecuteQueryByWidgetIdProps should inherit docs from ExecuteQueryByWidgetIdParams,
965
+ * instead of the other way around because sdk-ui-angular and sdk-ui-vue
966
+ * can inherit docs from ExecuteQueryByWidgetIdParams but not from ExecuteQueryByWidgetIdProps.
864
967
  */
865
968
  export interface ExecuteQueryByWidgetIdProps {
866
- /** Identifier of the widget */
969
+ /** {@inheritDoc ExecuteQueryByWidgetIdParams.widgetOid} */
867
970
  widgetOid: string;
868
- /** Identifier of the dashboard that contains the widget */
971
+ /** {@inheritDoc ExecuteQueryByWidgetIdParams.dashboardOid} */
869
972
  dashboardOid: string;
870
- /**
871
- * Filters that will slice query results.
872
- *
873
- * The provided filters will be merged with the existing widget filters based on `filtersMergeStrategy`
874
- */
973
+ /** {@inheritDoc ExecuteQueryByWidgetIdParams.filters} */
875
974
  filters?: Filter[];
876
- /** Highlight filters that will highlight results that pass filter criteria */
975
+ /** {@inheritDoc ExecuteQueryByWidgetIdParams.highlights} */
877
976
  highlights?: Filter[];
878
- /** {@inheritDoc ExecuteQueryProps.count} */
977
+ /** {@inheritDoc ExecuteQueryParams.count} */
879
978
  count?: number;
880
- /** {@inheritDoc ExecuteQueryProps.offset} */
979
+ /** {@inheritDoc ExecuteQueryParams.offset} */
881
980
  offset?: number;
882
- /**
883
- * Strategy for merging the existing widget filters (including highlights) with the filters provided via the `filters` and `highlights` props:
884
- *
885
- * - `widgetFirst` - prioritizes the widget filters over the provided filters in case of filter conflicts by certain attributes.
886
- * - `codeFirst` - prioritizes the provided filters over the widget filters in case of filter conflicts by certain attributes.
887
- * - `codeOnly` - applies only the provided filters and completely ignores the widget filters.
888
- *
889
- * If not specified, the default strategy is `codeFirst`.
890
- */
981
+ /** {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy} */
891
982
  filtersMergeStrategy?: FiltersMergeStrategy;
892
- /**
893
- * Boolean flag whether to include dashboard filters in the widget's `filters` and `highlights`
894
- *
895
- * If not specified, the default value is `false`.
896
- */
983
+ /** {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters} */
897
984
  includeDashboardFilters?: boolean;
898
- /** Function as child component that is called to render the query results */
985
+ /** {@inheritDoc ExecuteQueryProps.children} */
899
986
  children?: (queryState: QueryByWidgetIdState) => ReactNode;
900
- /** Callback function that is evaluated when query results are ready */
987
+ /** {@inheritDoc ExecuteQueryProps.onDataChanged} */
901
988
  onDataChanged?: (data: QueryResultData, queryParams: ExecuteQueryParams) => void;
902
- /**
903
- * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
904
- *
905
- * **Note:** wrap this function in `useCallback` hook to avoid triggering query execution on each render.
906
- * ```tsx
907
- * const onBeforeQuery = useCallback((jaql) => {
908
- * // modify jaql here
909
- * return jaql;
910
- * }, []);
911
- * ```
912
- */
989
+ /** {@inheritDoc ExecuteQueryParams.onBeforeQuery} */
913
990
  onBeforeQuery?: (jaql: any) => any | Promise<any>;
914
991
  }
915
992
  /**
@@ -923,7 +1000,7 @@ export interface TreemapChartProps extends BaseChartProps, HighchartsBasedChartE
923
1000
  */
924
1001
  dataOptions: CategoricalChartDataOptions;
925
1002
  /**
926
- * Configuration that defines functional style of the various chart elements
1003
+ * Configurations for how to style and present a chart's data.
927
1004
  *
928
1005
  * @category Chart
929
1006
  */
@@ -940,7 +1017,7 @@ export interface SunburstChartProps extends BaseChartProps, RegularChartEventPro
940
1017
  */
941
1018
  dataOptions: CategoricalChartDataOptions;
942
1019
  /**
943
- * Configuration that defines functional style of the various chart elements
1020
+ * Configurations for how to style and present a chart's data.
944
1021
  *
945
1022
  * @category Chart
946
1023
  */
@@ -957,7 +1034,7 @@ export interface BoxplotChartProps extends BaseChartProps, BoxplotChartEventProp
957
1034
  */
958
1035
  dataOptions: BoxplotChartDataOptions | BoxplotChartCustomDataOptions;
959
1036
  /**
960
- * Configuration that defines functional style of the various chart elements
1037
+ * Configurations for how to style and present a chart's data.
961
1038
  *
962
1039
  * @category Chart
963
1040
  */
@@ -974,7 +1051,7 @@ export interface ScattermapChartProps extends BaseChartProps, ScattermapChartEve
974
1051
  */
975
1052
  dataOptions: ScattermapChartDataOptions;
976
1053
  /**
977
- * Configuration that defines functional style of the various chart elements
1054
+ * Configurations for how to style and present a chart's data.
978
1055
  *
979
1056
  * @category Chart
980
1057
  */
@@ -991,14 +1068,14 @@ export interface AreamapChartProps extends BaseChartProps, AreamapChartEventProp
991
1068
  */
992
1069
  dataOptions: AreamapChartDataOptions;
993
1070
  /**
994
- * Configuration that defines functional style of the various chart elements
1071
+ * Configurations for how to style and present a chart's data.
995
1072
  *
996
1073
  * @category Chart
997
1074
  */
998
1075
  styleOptions?: AreamapStyleOptions;
999
1076
  }
1000
1077
  /**
1001
- * Props for {@link ContextMenu} component.
1078
+ * Props for ContextMenu component.
1002
1079
  */
1003
1080
  export interface ContextMenuProps {
1004
1081
  /**
@@ -33,5 +33,6 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
33
33
  * ```
34
34
  * @param props - ExecuteQueryByWidgetId properties
35
35
  * @returns ExecuteQueryByWidgetId component
36
+ * @group Fusion Assets
36
37
  */
37
38
  export declare const ExecuteQueryByWidgetId: FunctionComponent<ExecuteQueryByWidgetIdProps>;
@@ -35,5 +35,6 @@ import { ExecuteQueryProps } from '../props';
35
35
  * ```
36
36
  * @param props - ExecuteQuery properties
37
37
  * @returns ExecuteQuery component
38
+ * @group Queries
38
39
  */
39
40
  export declare const ExecuteQuery: FunctionComponent<ExecuteQueryProps>;