@sisense/sdk-ui 1.7.2 → 1.9.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.
- package/dist/ai/ai-disclaimer.d.ts +5 -0
- package/dist/ai/chat-config.d.ts +26 -0
- package/dist/ai/chat-dropup.d.ts +12 -0
- package/dist/ai/chat-frame.d.ts +7 -4
- package/dist/ai/chat-input.d.ts +4 -1
- package/dist/ai/chatbot.d.ts +0 -7
- package/dist/ai/common/dropup-section.d.ts +8 -0
- package/dist/ai/common/icon-button.d.ts +12 -0
- package/dist/ai/{toolbar.d.ts → common/toolbar.d.ts} +5 -0
- package/dist/ai/common/tooltip.d.ts +1 -1
- package/dist/ai/icons/arrow-left-icon.d.ts +5 -1
- package/dist/ai/icons/clear-chat-icon.d.ts +2 -1
- package/dist/ai/icons/expand-icon.d.ts +3 -1
- package/dist/ai/icons/info-icon.d.ts +3 -1
- package/dist/ai/icons/light-bulb-icon.d.ts +3 -1
- package/dist/ai/icons/message-icon.d.ts +2 -1
- package/dist/ai/icons/sisense-logo.d.ts +5 -1
- package/dist/ai/icons/three-dots-icon.d.ts +3 -1
- package/dist/ai/icons/thumbs-down-hovered-icon.d.ts +2 -1
- package/dist/ai/icons/thumbs-down-icon.d.ts +2 -1
- package/dist/ai/icons/thumbs-up-hovered-icon.d.ts +2 -1
- package/dist/ai/icons/thumbs-up-icon.d.ts +2 -1
- package/dist/ai/messages/chat-welcome-message.d.ts +1 -1
- package/dist/ai/messages/clickable-message.d.ts +11 -0
- package/dist/ai/messages/feedback-wrapper.d.ts +2 -2
- package/dist/ai/messages/insights-message.d.ts +3 -3
- package/dist/ai/messages/jaql-element.d.ts +5 -2
- package/dist/ai/messages/message-resolver.d.ts +2 -1
- package/dist/ai/messages/nlq-message-group.d.ts +6 -3
- package/dist/ai/messages/text-message.d.ts +4 -6
- package/dist/ai/nav-back-button.d.ts +6 -3
- package/dist/ai/translators/model-translator.d.ts +1 -0
- package/dist/ai/translators/query-translator.d.ts +16 -1
- package/dist/ai/translators/translate-filters-to-code.d.ts +2 -0
- package/dist/ai/translators/translate-props-to-code.d.ts +1 -1
- package/dist/ai/translators/utils.d.ts +10 -0
- package/dist/ai.js +2981 -2592
- package/dist/api/types/dashboard-dto.d.ts +16 -0
- package/dist/app/client-application.d.ts +6 -2
- package/dist/area-chart.d.ts +14 -18
- package/dist/areamap-chart.d.ts +13 -15
- package/dist/bar-chart.d.ts +13 -18
- package/dist/boxplot-chart.d.ts +11 -25
- package/dist/chart/chart.d.ts +8 -66
- package/dist/chart-data/cartesian-data.d.ts +1 -1
- package/dist/chart-data/chart-data-service.d.ts +1 -2
- package/dist/chart-data/data-coloring/types.d.ts +1 -7
- package/dist/chart-data-options/types.d.ts +5 -3
- package/dist/chart-data-options/utils.d.ts +10 -0
- package/dist/chart-options-processor/theme-option-service.d.ts +0 -8
- package/dist/column-chart.d.ts +15 -18
- package/dist/common/components/loading-indicator.d.ts +82 -0
- package/dist/dashboard-widget/dashboard-widget.d.ts +10 -7
- package/dist/dashboard-widget/translate-widget-data-options.d.ts +1 -1
- package/dist/dashboard-widget/translate-widget-filters.d.ts +22 -14
- package/dist/dashboard-widget/translate-widget-style-options.d.ts +3 -2
- package/dist/dashboard-widget/types.d.ts +24 -4
- package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts +1 -0
- package/dist/dashboard-widget/utils.d.ts +4 -2
- package/dist/debounce-Cc9bQD5m.js +76199 -0
- package/dist/dynamic-size-container/default-size.d.ts +5 -1
- package/dist/dynamic-size-container/dynamic-size-container.d.ts +12 -3
- package/dist/filters/components/common/dropdown.d.ts +1 -1
- package/dist/filters/components/common/switch.d.ts +3 -1
- package/dist/formulas/use-get-shared-formula.d.ts +3 -3
- package/dist/funnel-chart.d.ts +9 -36
- package/dist/index.d.ts +1 -2
- package/dist/index.js +46556 -7127
- package/dist/indicator-chart.d.ts +0 -1
- package/dist/line-chart.d.ts +14 -17
- package/dist/models/dashboard/translate-dashboard.d.ts +3 -2
- package/dist/models/dashboard/types.d.ts +6 -8
- package/dist/models/widget/use-get-widget-model.d.ts +16 -21
- package/dist/models/widget/widget-model.d.ts +50 -6
- package/dist/pie-chart.d.ts +14 -16
- package/dist/pivot-table/helpers/prepare-pivot-styling-props.d.ts +20 -0
- package/dist/pivot-table/pivot-table.d.ts +43 -3
- package/dist/pivot-table/sorting-utils.d.ts +11 -55
- package/dist/pivot-table/use-get-pivot-table-query.d.ts +10 -2
- package/dist/pivot-table/use-pivot-table-data-options-internal.d.ts +15 -0
- package/dist/polar-chart.d.ts +14 -17
- package/dist/props.d.ts +72 -13
- package/dist/query-execution/use-execute-pivot-query.d.ts +11 -29
- package/dist/query-execution/use-execute-query.d.ts +19 -26
- package/dist/scatter-chart.d.ts +11 -49
- package/dist/scattermap-chart.d.ts +9 -22
- package/dist/sunburst-chart.d.ts +10 -15
- package/dist/table/table.d.ts +7 -37
- package/dist/theme-provider/default-theme-settings.d.ts +9 -0
- package/dist/theme-provider/types.d.ts +7 -0
- package/dist/translation/resources/en.d.ts +4 -1
- package/dist/translation/resources/index.d.ts +8 -2
- package/dist/treemap-chart.d.ts +10 -21
- package/dist/types.d.ts +172 -4
- package/dist/widgets/common/drilldown-breadcrumbs/styled-buttons.d.ts +2 -2
- package/dist/widgets/common/drilldown.d.ts +1 -20
- package/dist/widgets/common/widget-container.d.ts +15 -0
- package/dist/widgets/drilldown-widget.d.ts +21 -33
- package/dist/widgets/pivot-table-widget.d.ts +22 -0
- package/package.json +10 -9
- package/dist/ai/chat-style-provider.d.ts +0 -22
- package/dist/ai/icons/magic-wand-icon.d.ts +0 -2
- package/dist/ai/magic-wand-dropdown.d.ts +0 -7
- package/dist/ai/suggestions/suggestion-dropdown-item.d.ts +0 -7
- package/dist/ai/suggestions/suggestion-dropdown-list.d.ts +0 -7
- package/dist/useQuery-76ecbd20.js +0 -121360
|
@@ -3,35 +3,17 @@ import { ExecutePivotQueryParams, PivotQueryState } from './types';
|
|
|
3
3
|
* React hook that executes a data query for a pivot table.
|
|
4
4
|
* This approach is similar to React Query's `useQuery` hook.
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* { measure: measures.sum(DM.Commerce.Revenue, 'Total Revenue'), totalsCalculation: 'sum' },
|
|
18
|
-
* { measure: measures.sum(DM.Commerce.Quantity, 'Total Quantity'), totalsCalculation: 'min' },
|
|
19
|
-
* ],
|
|
20
|
-
* grandTotals: {title: 'Grand Totals', rows: true, columns: true},
|
|
21
|
-
* filters: [filters.members(DM.Commerce.Gender, ['Female', 'Male'])],
|
|
22
|
-
* });
|
|
23
|
-
* if (isLoading) {
|
|
24
|
-
* return <div>Loading...</div>;
|
|
25
|
-
* }
|
|
26
|
-
* if (isError) {
|
|
27
|
-
* return <div>Error</div>;
|
|
28
|
-
* }
|
|
29
|
-
* if (data) {
|
|
30
|
-
* return <div>[Render pivot table with returned data]</div>;
|
|
31
|
-
* }
|
|
32
|
-
* return null;
|
|
33
|
-
* ```
|
|
34
|
-
* See also hook {@link useExecuteQuery}, which execute a generic data query.
|
|
6
|
+
* ## Example
|
|
7
|
+
*
|
|
8
|
+
* Execute a pivot query on the Sample ECommerce data model and display the results in a table.
|
|
9
|
+
*
|
|
10
|
+
* <iframe
|
|
11
|
+
* src='https://csdk-playground.sisense.com/?example=queries%2Fuse-execute-pivot-query&mode=docs'
|
|
12
|
+
* width=800
|
|
13
|
+
* height=870
|
|
14
|
+
* style='border:none;'
|
|
15
|
+
* />
|
|
16
|
+
*
|
|
35
17
|
* @param params - Parameters of the query
|
|
36
18
|
* @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
|
|
37
19
|
* @group Queries
|
|
@@ -1,32 +1,25 @@
|
|
|
1
1
|
import { ExecuteQueryParams, ExecuteQueryResult } from './types';
|
|
2
2
|
/**
|
|
3
3
|
* React hook that executes a data query.
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
return null;
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
* See also hook {@link useExecuteQueryByWidgetId}, which extracts data from an existing widget in the Sisense instance.
|
|
27
|
-
*
|
|
28
|
-
* See [this blog post]( https://www.sisense.com/blog/take-control-of-your-data-visualizations/) for examples
|
|
29
|
-
* of using the hook to fetch data from Sisense for third-party charts.
|
|
4
|
+
*
|
|
5
|
+
* This approach, which offers an alternative to the {@link ExecuteQuery} component, is similar to React Query's `useQuery` hook.
|
|
6
|
+
*
|
|
7
|
+
* ## Example
|
|
8
|
+
*
|
|
9
|
+
* Execute a query to retrieve revenue per country per year from the Sample ECommerce data model. Then display the data in a table and column chart.
|
|
10
|
+
*
|
|
11
|
+
* <iframe
|
|
12
|
+
* src='https://csdk-playground.sisense.com/?example=queries%2Fuse-execute-query-sorting&mode=docs'
|
|
13
|
+
* width=800
|
|
14
|
+
* height=870
|
|
15
|
+
* style='border:none;'
|
|
16
|
+
* />
|
|
17
|
+
*
|
|
18
|
+
* Additional `useExecuteQuery()` examples:
|
|
19
|
+
*
|
|
20
|
+
* - [Query with Sorting](https://www.sisense.com/platform/compose-sdk/playground/?example=queries%2Fuse-execute-query-sorting)
|
|
21
|
+
* - [Take Control of Your Data Visualizations]( https://www.sisense.com/blog/take-control-of-your-data-visualizations/) blog post with examples of using the hook to fetch data to display in third-party charts.
|
|
22
|
+
*
|
|
30
23
|
* @param params - Parameters of the query
|
|
31
24
|
* @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
|
|
32
25
|
* @group Queries
|
package/dist/scatter-chart.d.ts
CHANGED
|
@@ -9,59 +9,21 @@ import { ScatterChartProps } from './props';
|
|
|
9
9
|
* **Size**: An optional field represented by the size of the circles.
|
|
10
10
|
* If omitted, all scatter points are equal in size. If used, the circle sizes are relative to their values.
|
|
11
11
|
*
|
|
12
|
-
*
|
|
12
|
+
* ## Example
|
|
13
13
|
*
|
|
14
|
-
*
|
|
15
|
-
* An example of using the component to visualize the `Sample ECommerce` data source.
|
|
14
|
+
* Scatter chart displaying total revenue per category, broken down by gender, from the Sample ECommerce data model.
|
|
16
15
|
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 10)]}
|
|
23
|
-
* dataOptions={{
|
|
24
|
-
* x: measureFactory.sum(DM.Commerce.Revenue),
|
|
25
|
-
* y: measureFactory.sum(DM.Commerce.Quantity),
|
|
26
|
-
* breakByPoint: DM.Category.Category,
|
|
27
|
-
* breakByColor: DM.Commerce.Gender,
|
|
28
|
-
* size: measureFactory.sum(DM.Commerce.Cost),
|
|
29
|
-
* }}
|
|
30
|
-
* styleOptions={{
|
|
31
|
-
* xAxis: {
|
|
32
|
-
* enabled: true,
|
|
33
|
-
* gridLines: true,
|
|
34
|
-
* isIntervalEnabled: false,
|
|
35
|
-
* labels: {
|
|
36
|
-
* enabled: true,
|
|
37
|
-
* },
|
|
38
|
-
* logarithmic: true,
|
|
39
|
-
* title: {
|
|
40
|
-
* enabled: true,
|
|
41
|
-
* text: 'Total Revenue',
|
|
42
|
-
* },
|
|
43
|
-
* },
|
|
44
|
-
* yAxis: {
|
|
45
|
-
* enabled: true,
|
|
46
|
-
* gridLines: true,
|
|
47
|
-
* isIntervalEnabled: false,
|
|
48
|
-
* labels: {
|
|
49
|
-
* enabled: true,
|
|
50
|
-
* },
|
|
51
|
-
* logarithmic: true,
|
|
52
|
-
* title: {
|
|
53
|
-
* enabled: true,
|
|
54
|
-
* text: 'Total Quantity',
|
|
55
|
-
* },
|
|
56
|
-
* },
|
|
57
|
-
* }}
|
|
58
|
-
* onDataPointClick={(point, nativeEvent) => {
|
|
59
|
-
* console.log('clicked', point, nativeEvent);
|
|
60
|
-
* }}
|
|
16
|
+
* <iframe
|
|
17
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fscatter-chart&mode=docs'
|
|
18
|
+
* width=800
|
|
19
|
+
* height=870
|
|
20
|
+
* style='border:none;'
|
|
61
21
|
* />
|
|
62
|
-
* ```
|
|
63
22
|
*
|
|
64
|
-
*
|
|
23
|
+
* Additional Scatter Chart examples:
|
|
24
|
+
*
|
|
25
|
+
* - [Bubble Scatter Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts/scatter-chart-bubble)
|
|
26
|
+
*
|
|
65
27
|
* @param props - Scatter chart properties
|
|
66
28
|
* @returns Scatter Chart component
|
|
67
29
|
* @group Charts
|
|
@@ -2,31 +2,18 @@
|
|
|
2
2
|
import { ScattermapChartProps } from './props';
|
|
3
3
|
/**
|
|
4
4
|
* A React component that allows to visualize geographical data as data points on a map.
|
|
5
|
-
* See [Scattermap Chart](https://docs.sisense.com/main/SisenseLinux/scatter-map.htm) for more information.
|
|
6
5
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* column: measureFactory.sum(DM.Commerce.Revenue, 'Color by Revenue'),
|
|
17
|
-
* color: 'green'
|
|
18
|
-
* },
|
|
19
|
-
* details: DM.Category.Category,
|
|
20
|
-
* }}
|
|
21
|
-
* styleOptions={{
|
|
22
|
-
* markers: {
|
|
23
|
-
* fill: 'hollow-bold'
|
|
24
|
-
* }
|
|
25
|
-
* }}
|
|
6
|
+
* ## Example
|
|
7
|
+
*
|
|
8
|
+
* Scatter map chart displaying cost and revenue rank from the Sample ECommerce data model. The cost is indicated by size of each point and the revenue rank is indicated by the point's size.
|
|
9
|
+
*
|
|
10
|
+
* <iframe
|
|
11
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fmap-scatter&mode=docs'
|
|
12
|
+
* width=1000
|
|
13
|
+
* height=900
|
|
14
|
+
* style='border:none;'
|
|
26
15
|
* />
|
|
27
|
-
* ```
|
|
28
16
|
*
|
|
29
|
-
* <img src="media://scattermap-chart-example-1.png" width="600px" />
|
|
30
17
|
* @param props - Scattermap chart properties
|
|
31
18
|
* @returns Scattermap Chart component
|
|
32
19
|
* @group Charts
|
package/dist/sunburst-chart.d.ts
CHANGED
|
@@ -2,25 +2,20 @@
|
|
|
2
2
|
import { SunburstChartProps } from './props';
|
|
3
3
|
/**
|
|
4
4
|
* A React component displaying hierarchical data in the form of nested circle slices.
|
|
5
|
+
*
|
|
5
6
|
* This type of chart can be used in different scenarios, for example, to compare both categories and sub-categories.
|
|
6
|
-
* See [Sunburst Chart](https://docs.sisense.com/main/SisenseLinux/sunburst-widget.htm) for more information.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* ],
|
|
18
|
-
* value: [measureFactory.sum(DM.Commerce.Quantity)],
|
|
19
|
-
* }}
|
|
8
|
+
* ## Example
|
|
9
|
+
*
|
|
10
|
+
* Sunburst chart displaying total revenue, categorized by condition and age range, from the Sample ECommerce data model.
|
|
11
|
+
*
|
|
12
|
+
* <iframe
|
|
13
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fsunburst-chart&mode=docs'
|
|
14
|
+
* width=800
|
|
15
|
+
* height=870
|
|
16
|
+
* style='border:none;'
|
|
20
17
|
* />
|
|
21
|
-
* ```
|
|
22
18
|
*
|
|
23
|
-
* <img src="media://sunburst-chart-example-1.png" width="600px" />
|
|
24
19
|
* @param props - Sunburst chart properties
|
|
25
20
|
* @returns Sunburst Chart component
|
|
26
21
|
* @group Charts
|
package/dist/table/table.d.ts
CHANGED
|
@@ -3,47 +3,17 @@ import { TableProps } from '../props';
|
|
|
3
3
|
/**
|
|
4
4
|
* Table with aggregation and pagination.
|
|
5
5
|
*
|
|
6
|
-
*
|
|
7
|
-
* (1) Example of Table of raw data from the `Sample ECommerce` data model:
|
|
6
|
+
* ## Example
|
|
8
7
|
*
|
|
9
|
-
*
|
|
10
|
-
* <Table
|
|
11
|
-
* dataSet={DM.DataSource}
|
|
12
|
-
* dataOptions={{
|
|
13
|
-
* columns: [
|
|
14
|
-
* DM.Commerce.AgeRange,
|
|
15
|
-
* DM.Commerce.Revenue,
|
|
16
|
-
* DM.Commerce.Cost,
|
|
17
|
-
* DM.Commerce.Quantity,
|
|
18
|
-
* ],
|
|
19
|
-
* }}
|
|
20
|
-
* styleOptions={{ width: 600, height: 750 }}
|
|
21
|
-
* />
|
|
22
|
-
* ```
|
|
23
|
-
*
|
|
24
|
-
* <img src="media://table-example-1.png" width="800px" />
|
|
25
|
-
*
|
|
26
|
-
* (2) Example of Table of aggregated data from the same data model:
|
|
8
|
+
* Table displaying year, condition, and total revenue from the Sample ECommerce data model.
|
|
27
9
|
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* DM.Commerce.AgeRange,
|
|
34
|
-
* measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue'),
|
|
35
|
-
* measureFactory.sum(DM.Commerce.Cost, 'Total Cost'),
|
|
36
|
-
* ],
|
|
37
|
-
* }}
|
|
38
|
-
* styleOptions={{
|
|
39
|
-
* headersColor: true,
|
|
40
|
-
* alternatingColumnsColor: false,
|
|
41
|
-
* alternatingRowsColor: true,
|
|
42
|
-
* }}
|
|
10
|
+
* <iframe
|
|
11
|
+
* src='https://csdk-playground.sisense.com/?example=tables%2Faggregated-table&mode=docs'
|
|
12
|
+
* width=800
|
|
13
|
+
* height=870
|
|
14
|
+
* style='border:none;'
|
|
43
15
|
* />
|
|
44
|
-
* ```
|
|
45
16
|
*
|
|
46
|
-
* <img src="media://table-example-2.png" width="800px" />
|
|
47
17
|
* @param props - Table properties
|
|
48
18
|
* @returns Table component
|
|
49
19
|
* @group Data Grids
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { CompleteThemeSettings } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Returns default theme settings, which can be used as base for custom theme options.
|
|
4
|
+
*
|
|
5
|
+
* @param isDarkMode - Boolean value whether to get theme settings for dark mode
|
|
6
|
+
* @returns Theme settings object
|
|
7
|
+
* @internal
|
|
8
|
+
*/
|
|
9
|
+
export declare const getDefaultThemeSettings: (isDarkMode?: boolean) => CompleteThemeSettings;
|
|
@@ -29,9 +29,12 @@ export declare const translation: {
|
|
|
29
29
|
};
|
|
30
30
|
widgetModel: {
|
|
31
31
|
tabularWidgetNotSupported: string;
|
|
32
|
-
|
|
32
|
+
pivotWidgetNotSupported: string;
|
|
33
|
+
onlyTableWidgetSupported: string;
|
|
34
|
+
onlyPivotWidgetSupported: string;
|
|
33
35
|
};
|
|
34
36
|
unknownFilterInFilterRelations: string;
|
|
37
|
+
filterRelationsNotSupported: string;
|
|
35
38
|
};
|
|
36
39
|
errorBoxText: string;
|
|
37
40
|
chartNoData: string;
|
|
@@ -33,9 +33,12 @@ export declare const resources: {
|
|
|
33
33
|
};
|
|
34
34
|
widgetModel: {
|
|
35
35
|
tabularWidgetNotSupported: string;
|
|
36
|
-
|
|
36
|
+
pivotWidgetNotSupported: string;
|
|
37
|
+
onlyTableWidgetSupported: string;
|
|
38
|
+
onlyPivotWidgetSupported: string;
|
|
37
39
|
};
|
|
38
40
|
unknownFilterInFilterRelations: string;
|
|
41
|
+
filterRelationsNotSupported: string;
|
|
39
42
|
};
|
|
40
43
|
errorBoxText: string;
|
|
41
44
|
chartNoData: string;
|
|
@@ -118,9 +121,12 @@ export declare const resources: {
|
|
|
118
121
|
};
|
|
119
122
|
widgetModel: {
|
|
120
123
|
tabularWidgetNotSupported: string;
|
|
121
|
-
|
|
124
|
+
pivotWidgetNotSupported: string;
|
|
125
|
+
onlyTableWidgetSupported: string;
|
|
126
|
+
onlyPivotWidgetSupported: string;
|
|
122
127
|
};
|
|
123
128
|
unknownFilterInFilterRelations: string;
|
|
129
|
+
filterRelationsNotSupported: string;
|
|
124
130
|
};
|
|
125
131
|
errorBoxText: string;
|
|
126
132
|
chartNoData: string;
|
package/dist/treemap-chart.d.ts
CHANGED
|
@@ -2,31 +2,20 @@
|
|
|
2
2
|
import { TreemapChartProps } from './props';
|
|
3
3
|
/**
|
|
4
4
|
* A React component displaying hierarchical data in the form of nested rectangles.
|
|
5
|
+
*
|
|
5
6
|
* This type of chart can be used instead of a column chart for comparing a large number of categories and sub-categories.
|
|
6
|
-
* See [Treemap Chart](https://docs.sisense.com/main/SisenseLinux/treemap.htm) for more information.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* isColored: true,
|
|
18
|
-
* },
|
|
19
|
-
* DM.Commerce.Date.Years
|
|
20
|
-
* ],
|
|
21
|
-
* value: [measureFactory.sum(DM.Commerce.Quantity)],
|
|
22
|
-
* }}
|
|
23
|
-
* onDataPointClick= {(point, nativeEvent) => {
|
|
24
|
-
* console.log('clicked', point, nativeEvent);
|
|
25
|
-
* }}
|
|
8
|
+
* ## Example
|
|
9
|
+
*
|
|
10
|
+
* Tree map chart displaying total revenue, categorized by condition and age range, from the Sample ECommerce data model.
|
|
11
|
+
*
|
|
12
|
+
* <iframe
|
|
13
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Ftreemap-chart&mode=docs'
|
|
14
|
+
* width=800
|
|
15
|
+
* height=870
|
|
16
|
+
* style='border:none;'
|
|
26
17
|
* />
|
|
27
|
-
* ```
|
|
28
18
|
*
|
|
29
|
-
* <img src="media://treemap-chart-example-1.png" width="600px" />
|
|
30
19
|
* @param props - Treemap chart properties
|
|
31
20
|
* @returns Treemap Chart component
|
|
32
21
|
* @group Charts
|
package/dist/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import { Attribute, MembersFilter } from '@sisense/sdk-data';
|
|
2
|
+
import type { Attribute, MembersFilter } from '@sisense/sdk-data';
|
|
3
3
|
import { DeepRequired } from 'ts-essentials';
|
|
4
4
|
import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype } from './chart-options-processor/subtype-to-design-options';
|
|
5
5
|
import { IndicatorComponents } from './chart-options-processor/translations/design-options';
|
|
@@ -10,6 +10,7 @@ import { DataPointsEventHandler } from './props';
|
|
|
10
10
|
import { LegendPosition } from './chart-options-processor/translations/legend-section';
|
|
11
11
|
import { GeoDataElement, RawGeoDataElement } from './chart-data/types';
|
|
12
12
|
import { Coordinates } from './charts/map-charts/scattermap/types';
|
|
13
|
+
export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
|
|
13
14
|
export type { AppConfig } from './app/client-application';
|
|
14
15
|
export type { DateConfig } from './query/date-formats';
|
|
15
16
|
export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
|
|
@@ -327,6 +328,14 @@ export interface PivotTableStyleOptions {
|
|
|
327
328
|
* Boolean flag whether to apply background color to alternate columns
|
|
328
329
|
*/
|
|
329
330
|
alternatingColumnsColor?: boolean;
|
|
331
|
+
/**
|
|
332
|
+
* Boolean flag whether to fill row members cells with background color
|
|
333
|
+
*/
|
|
334
|
+
membersColor?: boolean;
|
|
335
|
+
/**
|
|
336
|
+
* Boolean flag whether to fill totals and subtotals cells with background color
|
|
337
|
+
*/
|
|
338
|
+
totalsColor?: boolean;
|
|
330
339
|
/**
|
|
331
340
|
* Number of rows per page
|
|
332
341
|
*
|
|
@@ -355,6 +364,10 @@ export interface PivotTableStyleOptions {
|
|
|
355
364
|
* Boolean flag whether the height of the component should be automatically adjusted to fit the content
|
|
356
365
|
*/
|
|
357
366
|
isAutoHeight?: boolean;
|
|
367
|
+
/**
|
|
368
|
+
* Manual height of each row (default is 25px)
|
|
369
|
+
*/
|
|
370
|
+
rowHeight?: number;
|
|
358
371
|
}
|
|
359
372
|
/**
|
|
360
373
|
* Common part of IndicatorStyleOptions for all types of indicator
|
|
@@ -482,8 +495,6 @@ export type ChartType = CartesianChartType | CategoricalChartType | ScatterChart
|
|
|
482
495
|
export type SeriesChartType = 'auto' | 'line' | 'spline' | 'areaspline' | 'bar' | 'area' | 'column' | 'scatter';
|
|
483
496
|
/** The number of decimal places */
|
|
484
497
|
export type DecimalScale = number | 'auto';
|
|
485
|
-
/** Sorting direction, either by Ascending order, Descending order, or None */
|
|
486
|
-
export type SortDirection = 'sortAsc' | 'sortDesc' | 'sortNone';
|
|
487
498
|
/**
|
|
488
499
|
* Configuration for number formatting.
|
|
489
500
|
*/
|
|
@@ -562,7 +573,9 @@ export interface ThemeSettings {
|
|
|
562
573
|
typography?: {
|
|
563
574
|
/** Font family name to style component text */
|
|
564
575
|
fontFamily?: string;
|
|
576
|
+
/** Primary text color */
|
|
565
577
|
primaryTextColor?: string;
|
|
578
|
+
/** Secondary text color */
|
|
566
579
|
secondaryTextColor?: string;
|
|
567
580
|
};
|
|
568
581
|
/** General theme settings */
|
|
@@ -576,6 +589,155 @@ export interface ThemeSettings {
|
|
|
576
589
|
/** Hover color for primary buttons */
|
|
577
590
|
primaryButtonHoverColor?: string;
|
|
578
591
|
};
|
|
592
|
+
/**
|
|
593
|
+
* Theme settings specific to the AI Chatbot component
|
|
594
|
+
*
|
|
595
|
+
* @internal
|
|
596
|
+
*/
|
|
597
|
+
aiChat?: {
|
|
598
|
+
/** Background color of the chatbot */
|
|
599
|
+
backgroundColor?: string;
|
|
600
|
+
/** Text color of the chatbot */
|
|
601
|
+
primaryTextColor?: string;
|
|
602
|
+
/** Secondary text color of the chatbot */
|
|
603
|
+
secondaryTextColor?: string;
|
|
604
|
+
/** Primary font size for text in the chatbot */
|
|
605
|
+
primaryFontSize?: [fontSize: string, lineHeight: string];
|
|
606
|
+
/** Border of the chatbot */
|
|
607
|
+
border?: false | string;
|
|
608
|
+
/** Border radius of the chatbot */
|
|
609
|
+
borderRadius?: false | string;
|
|
610
|
+
/** Settings for the main chat body */
|
|
611
|
+
body?: {
|
|
612
|
+
/** Left padding of the chat body */
|
|
613
|
+
paddingLeft?: string;
|
|
614
|
+
/** Right padding of the chat body */
|
|
615
|
+
paddingRight?: string;
|
|
616
|
+
/** Top padding of the chat body */
|
|
617
|
+
paddingTop?: string;
|
|
618
|
+
/** Bottom padding of the chat body */
|
|
619
|
+
paddingBottom?: string;
|
|
620
|
+
/** Gap size between each message in the chat body */
|
|
621
|
+
gapBetweenMessages?: string;
|
|
622
|
+
};
|
|
623
|
+
/** Settings for the chat footer */
|
|
624
|
+
footer?: {
|
|
625
|
+
/** Left padding of the chat footer */
|
|
626
|
+
paddingLeft?: string;
|
|
627
|
+
/** Right padding of the chat footer */
|
|
628
|
+
paddingRight?: string;
|
|
629
|
+
/** Top padding of the chat footer */
|
|
630
|
+
paddingTop?: string;
|
|
631
|
+
/** Bottom padding of the chat footer */
|
|
632
|
+
paddingBottom?: string;
|
|
633
|
+
};
|
|
634
|
+
/** Settings for user chat messages */
|
|
635
|
+
userMessages?: {
|
|
636
|
+
/** Background color of user chat messages */
|
|
637
|
+
backgroundColor?: string;
|
|
638
|
+
};
|
|
639
|
+
/** Settings for system chat messages */
|
|
640
|
+
systemMessages?: {
|
|
641
|
+
/** Background color of system chat messages */
|
|
642
|
+
backgroundColor?: string;
|
|
643
|
+
};
|
|
644
|
+
/** Settings for the chatbot input */
|
|
645
|
+
input?: {
|
|
646
|
+
/** Background color of the input */
|
|
647
|
+
backgroundColor?: string;
|
|
648
|
+
/** Settings to be applied on input focus */
|
|
649
|
+
focus?: {
|
|
650
|
+
/** Outline color of the input */
|
|
651
|
+
outlineColor?: string;
|
|
652
|
+
};
|
|
653
|
+
};
|
|
654
|
+
/** Settings for the chatbot header */
|
|
655
|
+
header?: {
|
|
656
|
+
/** Background color of the chatbot header */
|
|
657
|
+
backgroundColor?: string;
|
|
658
|
+
/** Text color of the chatbot header */
|
|
659
|
+
textColor?: string;
|
|
660
|
+
};
|
|
661
|
+
/** Settings for chatbot dropup */
|
|
662
|
+
dropup?: {
|
|
663
|
+
/** Background color of the dropup */
|
|
664
|
+
backgroundColor?: string;
|
|
665
|
+
/** Box shadow of the dropup */
|
|
666
|
+
boxShadow?: string;
|
|
667
|
+
/** Border radius of the dropup */
|
|
668
|
+
borderRadius?: string;
|
|
669
|
+
/** Settings for the section headers of the dropup */
|
|
670
|
+
headers?: {
|
|
671
|
+
/** Text color of headers */
|
|
672
|
+
textColor?: string;
|
|
673
|
+
/** Settings to be applied on hover of the headers */
|
|
674
|
+
hover?: {
|
|
675
|
+
/** Background color of headers on hover */
|
|
676
|
+
backgroundColor?: string;
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
/** Settings for the dropup items */
|
|
680
|
+
items?: {
|
|
681
|
+
/** Text color of the dropup items */
|
|
682
|
+
textColor?: string;
|
|
683
|
+
/** Settings to be applied on hover of dropup items */
|
|
684
|
+
hover?: {
|
|
685
|
+
/** Background color of dropup items on hover */
|
|
686
|
+
backgroundColor?: string;
|
|
687
|
+
};
|
|
688
|
+
};
|
|
689
|
+
};
|
|
690
|
+
/** Settings for the chatbot suggestions */
|
|
691
|
+
suggestions?: {
|
|
692
|
+
/** Text color of the chatbot suggestions */
|
|
693
|
+
textColor?: string;
|
|
694
|
+
/** Background color of the chatbot suggestions */
|
|
695
|
+
backgroundColor?: string;
|
|
696
|
+
/** Border of the chatbot suggestions */
|
|
697
|
+
border?: string;
|
|
698
|
+
/** 2-color gradient to be applied on the border */
|
|
699
|
+
borderGradient?: [string, string] | null;
|
|
700
|
+
/** Border radius of the chatbot suggestions */
|
|
701
|
+
borderRadius?: string;
|
|
702
|
+
/** Setting to be applied on hover */
|
|
703
|
+
hover?: {
|
|
704
|
+
/** Background color of the chatbot suggestions on hover */
|
|
705
|
+
backgroundColor?: string;
|
|
706
|
+
/** Text color of the chatbot suggestions on hover */
|
|
707
|
+
textColor?: string;
|
|
708
|
+
};
|
|
709
|
+
/** 2-color gradient to be applied on suggestions loading animation */
|
|
710
|
+
loadingGradient?: [string, string];
|
|
711
|
+
/** Gap size between each suggestion item */
|
|
712
|
+
gap?: string;
|
|
713
|
+
};
|
|
714
|
+
/** Settings for the chatbot clickable messages */
|
|
715
|
+
clickableMessages?: {
|
|
716
|
+
/** Background color of the chatbot clickable messages */
|
|
717
|
+
backgroundColor?: string;
|
|
718
|
+
/** Text color of the chatbot clickable messages */
|
|
719
|
+
textColor?: string;
|
|
720
|
+
/** Border of the chatbot clickable messages */
|
|
721
|
+
border?: false | string;
|
|
722
|
+
/** Setting to be applied on hover */
|
|
723
|
+
hover?: {
|
|
724
|
+
/** Text color of the chatbot clickable messages on hover */
|
|
725
|
+
textColor?: string;
|
|
726
|
+
/** Background color of the chatbot clickable messages on hover */
|
|
727
|
+
backgroundColor?: string;
|
|
728
|
+
};
|
|
729
|
+
};
|
|
730
|
+
/** Settings for the chatbot icons */
|
|
731
|
+
icons?: {
|
|
732
|
+
/** Color of the chatbot icons */
|
|
733
|
+
color?: string;
|
|
734
|
+
/** Setting to be applied on hover */
|
|
735
|
+
hover?: {
|
|
736
|
+
/** Color of the chatbot icons on hover */
|
|
737
|
+
color?: string;
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
};
|
|
579
741
|
}
|
|
580
742
|
/**
|
|
581
743
|
* Complete set of theme settings defining the look and feel of components.
|
|
@@ -650,11 +812,17 @@ export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
|
|
|
650
812
|
/** Style settings defining the look and feel of ChartWidget */
|
|
651
813
|
export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetStyleOptions;
|
|
652
814
|
/**
|
|
653
|
-
* Style settings defining the look and feel of TableWidget
|
|
815
|
+
* Style settings defining the look and feel of TableWidget
|
|
654
816
|
*
|
|
655
817
|
* @internal
|
|
656
818
|
*/
|
|
657
819
|
export type TableWidgetStyleOptions = TableStyleOptions & WidgetStyleOptions;
|
|
820
|
+
/**
|
|
821
|
+
* Style settings defining the look and feel of TableWidget
|
|
822
|
+
*
|
|
823
|
+
* @internal
|
|
824
|
+
*/
|
|
825
|
+
export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetStyleOptions;
|
|
658
826
|
/**
|
|
659
827
|
* Runs type guard check for ThemeOid.
|
|
660
828
|
*
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
export declare const StyledPrevButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
|
|
3
3
|
ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
|
|
4
|
-
}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "
|
|
4
|
+
}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "sx" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
|
|
5
5
|
theme?: import("@emotion/react").Theme | undefined;
|
|
6
6
|
}, {}, {}>;
|
|
7
7
|
export declare const StyledNextButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
|
|
8
8
|
ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
|
|
9
|
-
}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "
|
|
9
|
+
}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "sx" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
|
|
10
10
|
theme?: import("@emotion/react").Theme | undefined;
|
|
11
11
|
}, {}, {}>;
|