@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
|
@@ -1,6 +1,21 @@
|
|
|
1
1
|
import { WidgetDto, Datasource } from '../../dashboard-widget/types';
|
|
2
2
|
import { FilterJaql, FilterRelationsModel } from '@sisense/sdk-data';
|
|
3
3
|
import { AnyObject } from '../../utils/utility-types';
|
|
4
|
+
/** @internal */
|
|
5
|
+
export type Layout = {
|
|
6
|
+
columns: {
|
|
7
|
+
width: number;
|
|
8
|
+
cells: {
|
|
9
|
+
subcells: {
|
|
10
|
+
width: number;
|
|
11
|
+
elements: {
|
|
12
|
+
height: number | string;
|
|
13
|
+
widgetid: string;
|
|
14
|
+
}[];
|
|
15
|
+
}[];
|
|
16
|
+
}[];
|
|
17
|
+
}[];
|
|
18
|
+
};
|
|
4
19
|
export type Filter = {
|
|
5
20
|
isCascading?: false;
|
|
6
21
|
jaql: FilterJaql & AnyObject;
|
|
@@ -22,4 +37,5 @@ export type DashboardDto = {
|
|
|
22
37
|
filterRelations?: {
|
|
23
38
|
filterRelations: FilterRelationsModel;
|
|
24
39
|
}[];
|
|
40
|
+
layout?: Layout;
|
|
25
41
|
} & AnyObject;
|
|
@@ -47,9 +47,13 @@ export type AppConfig = {
|
|
|
47
47
|
*/
|
|
48
48
|
queryLimit?: number;
|
|
49
49
|
/**
|
|
50
|
-
* Accessibility configuration
|
|
50
|
+
* Accessibility configuration. Set the `accessibilityConfig.enabled` property to `true` to enable accessibility features for charts built with Highcharts.
|
|
51
51
|
*
|
|
52
|
-
*
|
|
52
|
+
* Once the accessibility configuration in enabled, you can use the default descriptions or choose to create custom configurations for the descriptions of a chart, its axes, its series, and values description formatting. To create custom configurations, use the `highchartsOptions` object that is passed to the {@link BeforeRenderHandler} of the chart's `onBeforeRender` callback. Modify the object using the accessibility options as described in the [Accessibility module documentation](https://www.highcharts.com/docs/accessibility/accessibility-module).
|
|
53
|
+
*
|
|
54
|
+
* Note that enabling accessibility also causes markers to appear in charts even if they are disabled using the chart's `styleOptions`.
|
|
55
|
+
*
|
|
56
|
+
* This feature is in alpha.
|
|
53
57
|
*/
|
|
54
58
|
accessibilityConfig?: {
|
|
55
59
|
/**
|
package/dist/area-chart.d.ts
CHANGED
|
@@ -3,27 +3,23 @@ import { AreaChartProps } from './props';
|
|
|
3
3
|
/**
|
|
4
4
|
* A React component similar to a {@link LineChart},
|
|
5
5
|
* but with filled in areas under each line and an option to display them as stacked.
|
|
6
|
-
* More info on [Sisense Documentation page](https://docs.sisense.com/main/SisenseLinux/area-chart.htm).
|
|
7
6
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* }}
|
|
18
|
-
* styleOptions={{ subtype: 'area/stacked' }}
|
|
19
|
-
* filters={[filterFactory.members(DM.Commerce.Gender, ['Female', 'Male'])]}
|
|
20
|
-
* onDataPointClick={(point, nativeEvent) => {
|
|
21
|
-
* console.log('clicked', point, nativeEvent);
|
|
22
|
-
* }}
|
|
7
|
+
* ## Example
|
|
8
|
+
*
|
|
9
|
+
* Area chart displaying total revenue per quarter from the Sample ECommerce data model.
|
|
10
|
+
*
|
|
11
|
+
* <iframe
|
|
12
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Farea-chart&mode=docs'
|
|
13
|
+
* width=800
|
|
14
|
+
* height=870
|
|
15
|
+
* style='border:none;'
|
|
23
16
|
* />
|
|
24
|
-
* ```
|
|
25
17
|
*
|
|
26
|
-
*
|
|
18
|
+
* Additional Area Chart examples:
|
|
19
|
+
*
|
|
20
|
+
* - [Stacked Area Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Farea-chart-stacked)
|
|
21
|
+
* - [Stacked Percentage Area Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Farea-chart-stacked100)
|
|
22
|
+
*
|
|
27
23
|
* @param props - Area chart properties
|
|
28
24
|
* @returns Area Chart component
|
|
29
25
|
* @group Charts
|
package/dist/areamap-chart.d.ts
CHANGED
|
@@ -1,23 +1,21 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { AreamapChartProps } from './props';
|
|
3
3
|
/**
|
|
4
|
-
* A React component for visualizing geographical data as polygons on a map.
|
|
5
|
-
* See [Areamap Chart](https://docs.sisense.com/main/SisenseLinux/area-map.htm) for more information.
|
|
4
|
+
* A React component for visualizing geographical data as colored polygons on a map.
|
|
6
5
|
*
|
|
7
|
-
* @
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* }}
|
|
6
|
+
* For another way do display data on a map, see {@link ScattermapChart}.
|
|
7
|
+
*
|
|
8
|
+
* ## Example
|
|
9
|
+
*
|
|
10
|
+
* Areamap chart displaying total revenue per country from the Sample ECommerce data model. The total revenue amount is indicated by the colors on the map.
|
|
11
|
+
*
|
|
12
|
+
* <iframe
|
|
13
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fmap-area&mode=docs'
|
|
14
|
+
* width=800
|
|
15
|
+
* height=870
|
|
16
|
+
* style='border:none;'
|
|
19
17
|
* />
|
|
20
|
-
*
|
|
18
|
+
*
|
|
21
19
|
* @param props - Areamap chart properties
|
|
22
20
|
* @returns Areamap Chart component
|
|
23
21
|
* @group Charts
|
package/dist/bar-chart.d.ts
CHANGED
|
@@ -3,28 +3,23 @@ import { BarChartProps } from './props';
|
|
|
3
3
|
/**
|
|
4
4
|
* A React component representing categorical data with horizontal rectangular bars,
|
|
5
5
|
* whose lengths are proportional to the values that they represent.
|
|
6
|
-
* You can also break up the values by another category or groups.
|
|
7
6
|
*
|
|
8
|
-
*
|
|
7
|
+
* ## Example
|
|
9
8
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* value: [measureFactory.sum(DM.Commerce.Revenue)],
|
|
18
|
-
* breakBy: [DM.Commerce.Gender],
|
|
19
|
-
* }}
|
|
20
|
-
* filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
|
|
21
|
-
* onDataPointClick={(point, nativeEvent) => {
|
|
22
|
-
* console.log('clicked', point, nativeEvent);
|
|
23
|
-
* }}
|
|
9
|
+
* Bar chart displaying total revenue per year from the Sample ECommerce data model.
|
|
10
|
+
*
|
|
11
|
+
* <iframe
|
|
12
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fbar-chart&mode=docs'
|
|
13
|
+
* width=800
|
|
14
|
+
* height=870
|
|
15
|
+
* style='border:none;'
|
|
24
16
|
* />
|
|
25
|
-
* ```
|
|
26
17
|
*
|
|
27
|
-
*
|
|
18
|
+
* Additional Bar Chart examples:
|
|
19
|
+
*
|
|
20
|
+
* - [Stacked Bar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fbar-chart-stacked)
|
|
21
|
+
* - [Stacked Percentage Bar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fbar-chart-stacked100)
|
|
22
|
+
*
|
|
28
23
|
* @param props - Bar chart properties
|
|
29
24
|
* @returns Bar Chart component
|
|
30
25
|
* @group Charts
|
package/dist/boxplot-chart.d.ts
CHANGED
|
@@ -1,34 +1,20 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { BoxplotChartProps } from './props';
|
|
3
3
|
/**
|
|
4
|
-
* A React component representing data in a way that visually describes the distribution,
|
|
5
|
-
* and center of a data set along an axis.
|
|
6
|
-
* See [Boxplot Chart](https://docs.sisense.com/main/SisenseLinux/box-and-whisker-plot.htm) for more information.
|
|
4
|
+
* A React component representing data in a way that visually describes the distribution,
|
|
5
|
+
* variability, and center of a data set along an axis.
|
|
7
6
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* outliersEnabled: true,
|
|
18
|
-
* }}
|
|
19
|
-
* filters={[
|
|
20
|
-
* filterFactory.members(DM.Category.Category, ['Calculators', 'DVD Players', 'Routers']),
|
|
21
|
-
* filterFactory.members(DM.Commerce.AgeRange, ['19-24']),
|
|
22
|
-
* ]}
|
|
23
|
-
* styleOptions={{
|
|
24
|
-
* seriesLabels: {
|
|
25
|
-
* enabled: true,
|
|
26
|
-
* }
|
|
27
|
-
* }}
|
|
7
|
+
* ## Example
|
|
8
|
+
*
|
|
9
|
+
* Boxplot chart displaying data from the Sample ECommerce data model.
|
|
10
|
+
*
|
|
11
|
+
* <iframe
|
|
12
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fboxplot-chart&mode=docs'
|
|
13
|
+
* width=800
|
|
14
|
+
* height=870
|
|
15
|
+
* style='border:none;'
|
|
28
16
|
* />
|
|
29
|
-
* ```
|
|
30
17
|
*
|
|
31
|
-
* <img src="media://boxplot-chart-example-1.png" width="600px" />
|
|
32
18
|
* @param props - Boxplot chart properties
|
|
33
19
|
* @returns Boxplot Chart component
|
|
34
20
|
* @group Charts
|
package/dist/chart/chart.d.ts
CHANGED
|
@@ -5,75 +5,17 @@ export declare const shouldSkipSisenseContextWaiting: (props: ChartProps) => boo
|
|
|
5
5
|
/**
|
|
6
6
|
* A React component used for easily switching chart types or rendering multiple series of different chart types.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
* (1) An example of using the `Chart` component to
|
|
10
|
-
* plot a column chart of the Sample ECommerce data source hosted in a Sisense instance:
|
|
11
|
-
* ```tsx
|
|
12
|
-
* <Chart
|
|
13
|
-
* chartType={'column'}
|
|
14
|
-
* dataSet={DM.DataSource}
|
|
15
|
-
* dataOptions={{
|
|
16
|
-
* category: [DM.Commerce.AgeRange],
|
|
17
|
-
* value: [measureFactory.sum(DM.Commerce.Revenue)],
|
|
18
|
-
* breakBy: [DM.Commerce.Gender],
|
|
19
|
-
* }}
|
|
20
|
-
* filters={[filterFactory.members(DM.Commerce.Gender,['Female', 'Male'])]}
|
|
21
|
-
* onDataPointClick= {(point, nativeEvent) => { console.log('clicked', point, nativeEvent); }}
|
|
22
|
-
* />
|
|
23
|
-
* ```
|
|
8
|
+
* ## Example
|
|
24
9
|
*
|
|
25
|
-
*
|
|
10
|
+
* A chart component displaying total revenue per quarter from the Sample ECommerce data model. The component is currently set to show the data in a column chart.
|
|
26
11
|
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* columns: [
|
|
34
|
-
* { name: 'Years', type: 'date' },
|
|
35
|
-
* { name: 'Group', type: 'string' },
|
|
36
|
-
* { name: 'Quantity', type: 'number' },
|
|
37
|
-
* { name: 'Units', type: 'number' },
|
|
38
|
-
* ],
|
|
39
|
-
* rows: [
|
|
40
|
-
* ['2009', 'A', 6781, 10],
|
|
41
|
-
* ['2009', 'B', 5500, 15],
|
|
42
|
-
* ['2010', 'A', 4471, 70],
|
|
43
|
-
* ['2011', 'B', 1812, 50],
|
|
44
|
-
* ['2012', 'B', 5001, 60],
|
|
45
|
-
* ['2013', 'A', 2045, 40],
|
|
46
|
-
* ['2014', 'B', 3010, 90],
|
|
47
|
-
* ['2015', 'A', 5447, 80],
|
|
48
|
-
* ['2016', 'B', 4242, 70],
|
|
49
|
-
* ['2017', 'B', 936, 20],
|
|
50
|
-
* ],
|
|
51
|
-
* }}
|
|
52
|
-
* dataOptions={{
|
|
53
|
-
* category: [
|
|
54
|
-
* {
|
|
55
|
-
* name: 'Years',
|
|
56
|
-
* type: 'date',
|
|
57
|
-
* },
|
|
58
|
-
* ],
|
|
59
|
-
* value: [
|
|
60
|
-
* {
|
|
61
|
-
* name: 'Quantity',
|
|
62
|
-
* aggregation: 'sum',
|
|
63
|
-
* title: 'Total Quantity',
|
|
64
|
-
* },
|
|
65
|
-
* ],
|
|
66
|
-
* }}
|
|
67
|
-
* styleOptions={{
|
|
68
|
-
* legend: {
|
|
69
|
-
* enabled: true,
|
|
70
|
-
* position: 'bottom',
|
|
71
|
-
* },
|
|
72
|
-
* }}
|
|
73
|
-
* />
|
|
74
|
-
* ```
|
|
12
|
+
* <iframe
|
|
13
|
+
* src='https://csdk-playground.sisense.com/?example=charts/chart&mode=docs'
|
|
14
|
+
* width=800
|
|
15
|
+
* height=870
|
|
16
|
+
* style='border:none;'
|
|
17
|
+
* />
|
|
75
18
|
*
|
|
76
|
-
* <img src="media://chart-local-data-example-1.png" width="800px" />
|
|
77
19
|
* @param props - Chart properties
|
|
78
20
|
* @returns Chart component representing a chart type as specified in `ChartProps.`{@link ChartProps.chartType | chartType}
|
|
79
21
|
* @group Charts
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
+
import { type SortDirection } from '../types';
|
|
1
2
|
import { Column, DataTable } from '../chart-data-processor/table-processor';
|
|
2
3
|
import { CartesianChartData, CategoricalXValues } from './types';
|
|
3
4
|
import { CartesianChartDataOptionsInternal, Value } from '../chart-data-options/types';
|
|
4
|
-
import { SortDirection } from '../types';
|
|
5
5
|
export declare const validateCartesianChartDataOptions: (chartDataOptions: CartesianChartDataOptionsInternal) => CartesianChartDataOptionsInternal;
|
|
6
6
|
export declare const cartesianData: (chartDataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable) => CartesianChartData;
|
|
7
7
|
export declare const sortDirection: (sortType: SortDirection | undefined) => 1 | -1 | 0;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ChartDataOptionsInternal } from '../chart-data-options/types';
|
|
2
2
|
import { DataTable } from '../chart-data-processor/table-processor';
|
|
3
|
-
import { ChartType, NumberFormatConfig, SeriesChartType } from '../types';
|
|
3
|
+
import type { ChartType, NumberFormatConfig, SeriesChartType, SortDirection } from '../types';
|
|
4
4
|
import { ChartData } from './types';
|
|
5
5
|
export declare const chartDataService: (chartType: ChartType, chartDataOptions: ChartDataOptionsInternal, dataTable: DataTable) => ChartData;
|
|
6
6
|
export type ValueColumn = {
|
|
@@ -15,4 +15,3 @@ export type ValueColumn = {
|
|
|
15
15
|
color?: string;
|
|
16
16
|
legacyInstanceId?: string;
|
|
17
17
|
};
|
|
18
|
-
export type SortDirection = 'sortAsc' | 'sortDesc' | 'sortNone';
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* All possible color options for data.
|
|
3
|
-
*
|
|
4
|
-
* @see {@link https://docs.sisense.com/main/SisenseLinux/selecting-colors-in-widgets.htm | Selecting Colors in Widgets}
|
|
5
3
|
*/
|
|
6
4
|
export type DataColorOptions = string | UniformDataColorOptions | RangeDataColorOptions | ConditionalDataColorOptions;
|
|
7
5
|
/**
|
|
@@ -16,7 +14,6 @@ export type DataColorOptions = string | UniformDataColorOptions | RangeDataColor
|
|
|
16
14
|
* color: 'red',
|
|
17
15
|
* }
|
|
18
16
|
* ```
|
|
19
|
-
* @see {@link https://docs.sisense.com/main/SisenseLinux/selecting-colors-in-widgets.htm | Selecting Colors in Widgets}
|
|
20
17
|
*/
|
|
21
18
|
export type UniformDataColorOptions = {
|
|
22
19
|
/**
|
|
@@ -51,7 +48,6 @@ export type UniformDataColorOptions = {
|
|
|
51
48
|
* maxColor: 'blue',
|
|
52
49
|
* }
|
|
53
50
|
* ```
|
|
54
|
-
* @see {@link https://docs.sisense.com/main/SisenseLinux/selecting-colors-in-widgets.htm | Selecting Colors in Widgets}
|
|
55
51
|
*/
|
|
56
52
|
export type RangeDataColorOptions = {
|
|
57
53
|
/**
|
|
@@ -104,7 +100,6 @@ export type RangeDataColorOptions = {
|
|
|
104
100
|
* defaultColor: 'red',
|
|
105
101
|
* }
|
|
106
102
|
* ```
|
|
107
|
-
* @see {@link https://docs.sisense.com/main/SisenseLinux/selecting-colors-in-widgets.htm | Selecting Colors in Widgets}
|
|
108
103
|
*/
|
|
109
104
|
export type ConditionalDataColorOptions = {
|
|
110
105
|
/**
|
|
@@ -123,9 +118,8 @@ export type ConditionalDataColorOptions = {
|
|
|
123
118
|
/**
|
|
124
119
|
* Color condition for {@link ConditionalDataColorOptions} represented as a logical expression.
|
|
125
120
|
*
|
|
126
|
-
* See {@link ConditionalDataColorOptions} for examples.
|
|
121
|
+
* See {@link ConditionalDataColorOptions} for usage examples.
|
|
127
122
|
*
|
|
128
|
-
* @see {@link https://docs.sisense.com/main/SisenseLinux/selecting-colors-in-widgets.htm | Selecting Colors in Widgets}
|
|
129
123
|
*/
|
|
130
124
|
export type DataColorCondition = {
|
|
131
125
|
/**
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DataColorOptions } from '../chart-data/data-coloring';
|
|
2
|
-
import type { NumberFormatConfig, SeriesChartType,
|
|
2
|
+
import type { NumberFormatConfig, SeriesChartType, ValueToColorMap, MultiColumnValueToColorMap, LineWidth, Markers, SortDirection, PivotRowsSort } from '../types';
|
|
3
3
|
import { Column, MeasureColumn, CalculatedMeasureColumn, PivotGrandTotals, TotalsCalculation } from '@sisense/sdk-data';
|
|
4
4
|
/**
|
|
5
5
|
* Styles for a category/column when visualized in a chart
|
|
@@ -33,8 +33,10 @@ export interface CategoryStyle {
|
|
|
33
33
|
* @internal
|
|
34
34
|
*/
|
|
35
35
|
enabled?: boolean;
|
|
36
|
-
/**
|
|
37
|
-
|
|
36
|
+
/**
|
|
37
|
+
* Sorting configuration that represents either {@link SortDirection} or {@link PivotRowsSort} for the pivot table
|
|
38
|
+
*/
|
|
39
|
+
sortType?: SortDirection | PivotRowsSort;
|
|
38
40
|
isColored?: boolean;
|
|
39
41
|
/**
|
|
40
42
|
* Boolean flag whether to render category/column value as HTML in the Table component.
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
import { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn } from '@sisense/sdk-data';
|
|
2
2
|
import { Category, Value, StyledColumn, StyledMeasureColumn, AnyColumn, CategoryStyle } from './types';
|
|
3
|
+
type AnyObject = Record<string, any>;
|
|
4
|
+
/**
|
|
5
|
+
* Combines two objects into a single one with saving prototype inheritance of "sourceWithInheritance" argument
|
|
6
|
+
*
|
|
7
|
+
* @param sourceWithInheritance - The object that has own and inherited properties.
|
|
8
|
+
* @param sourceToAbsorb - The object whose properties will be copied as own properties.
|
|
9
|
+
* @returns - A new object that combines the properties of the two input objects.
|
|
10
|
+
*/
|
|
11
|
+
export declare const safeCombine: <T extends AnyObject>(sourceWithInheritance: T, sourceToAbsorb: AnyObject) => T;
|
|
3
12
|
export declare const splitColumn: (c: StyledColumn | Column) => {
|
|
4
13
|
column: Column;
|
|
5
14
|
style: CategoryStyle | undefined;
|
|
@@ -14,3 +23,4 @@ export declare const translateCategoryToAttribute: (category: Category) => Attri
|
|
|
14
23
|
export declare const getDataOptionTitle: (option: Category | Value) => string;
|
|
15
24
|
export declare const translateColumnToAttribure: (c: StyledColumn | Column) => Attribute;
|
|
16
25
|
export declare const translateColumnToMeasure: (c: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn) => Measure;
|
|
26
|
+
export {};
|
|
@@ -1,11 +1,3 @@
|
|
|
1
1
|
import { CompleteThemeSettings } from '../types';
|
|
2
2
|
import { HighchartsOptionsInternal } from './chart-options-service';
|
|
3
3
|
export declare const applyThemeToChart: (chartOptions: HighchartsOptionsInternal, themeSettings?: CompleteThemeSettings) => HighchartsOptionsInternal;
|
|
4
|
-
/**
|
|
5
|
-
* Returns default theme settings, which can be used as base for custom theme options.
|
|
6
|
-
*
|
|
7
|
-
* @param isDarkMode - Boolean value whether to get theme settings for dark mode
|
|
8
|
-
* @returns Theme settings object
|
|
9
|
-
* @internal
|
|
10
|
-
*/
|
|
11
|
-
export declare const getDefaultThemeSettings: (isDarkMode?: boolean) => CompleteThemeSettings;
|
package/dist/column-chart.d.ts
CHANGED
|
@@ -6,26 +6,23 @@ import { ColumnChartProps } from './props';
|
|
|
6
6
|
*
|
|
7
7
|
* The chart can include multiple values on both the X and Y-axis, as well as a break down by categories displayed on the Y-axis.
|
|
8
8
|
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* value: [measureFactory.sum(DM.Commerce.Revenue)],
|
|
19
|
-
* breakBy: [DM.Commerce.Gender],
|
|
20
|
-
* }}
|
|
21
|
-
* filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
|
|
22
|
-
* onDataPointClick={(point, nativeEvent) => {
|
|
23
|
-
* console.log('clicked', point, nativeEvent);
|
|
24
|
-
* }}
|
|
9
|
+
* ## Example
|
|
10
|
+
*
|
|
11
|
+
* Column chart displaying total revenue per year, broken down by condition, from the Sample ECommerce data model.
|
|
12
|
+
*
|
|
13
|
+
* <iframe
|
|
14
|
+
* src='https://csdk-playground.sisense.com/?example=charts%2Fcolumn-chart&mode=docs'
|
|
15
|
+
* width=800
|
|
16
|
+
* height=870
|
|
17
|
+
* style='border:none;'
|
|
25
18
|
* />
|
|
26
|
-
* ```
|
|
27
19
|
*
|
|
28
|
-
*
|
|
20
|
+
*
|
|
21
|
+
* Additional Column Chart examples:
|
|
22
|
+
*
|
|
23
|
+
* - [Stacked Column Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fcolumn-chart-stacked)
|
|
24
|
+
* - [Stacked Percentage Column Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fcolumn-chart-stacked100)
|
|
25
|
+
*
|
|
29
26
|
* @param props - Column chart properties
|
|
30
27
|
* @returns Column Chart component
|
|
31
28
|
* @group Charts
|
|
@@ -30,6 +30,88 @@ export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
|
|
|
30
30
|
primaryButtonTextColor: string;
|
|
31
31
|
primaryButtonHoverColor: string;
|
|
32
32
|
};
|
|
33
|
+
aiChat: {
|
|
34
|
+
backgroundColor: string;
|
|
35
|
+
primaryTextColor: string;
|
|
36
|
+
secondaryTextColor: string;
|
|
37
|
+
primaryFontSize: [fontSize: string, lineHeight: string];
|
|
38
|
+
border: string | false;
|
|
39
|
+
borderRadius: string | false;
|
|
40
|
+
body: {
|
|
41
|
+
paddingLeft: string;
|
|
42
|
+
paddingRight: string;
|
|
43
|
+
paddingTop: string;
|
|
44
|
+
paddingBottom: string;
|
|
45
|
+
gapBetweenMessages: string;
|
|
46
|
+
};
|
|
47
|
+
footer: {
|
|
48
|
+
paddingLeft: string;
|
|
49
|
+
paddingRight: string;
|
|
50
|
+
paddingTop: string;
|
|
51
|
+
paddingBottom: string;
|
|
52
|
+
};
|
|
53
|
+
userMessages: {
|
|
54
|
+
backgroundColor: string;
|
|
55
|
+
};
|
|
56
|
+
systemMessages: {
|
|
57
|
+
backgroundColor: string;
|
|
58
|
+
};
|
|
59
|
+
input: {
|
|
60
|
+
backgroundColor: string;
|
|
61
|
+
focus: {
|
|
62
|
+
outlineColor: string;
|
|
63
|
+
};
|
|
64
|
+
};
|
|
65
|
+
header: {
|
|
66
|
+
backgroundColor: string;
|
|
67
|
+
textColor: string;
|
|
68
|
+
};
|
|
69
|
+
dropup: {
|
|
70
|
+
backgroundColor: string;
|
|
71
|
+
boxShadow: string;
|
|
72
|
+
borderRadius: string;
|
|
73
|
+
headers: {
|
|
74
|
+
textColor: string;
|
|
75
|
+
hover: {
|
|
76
|
+
backgroundColor: string;
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
items: {
|
|
80
|
+
textColor: string;
|
|
81
|
+
hover: {
|
|
82
|
+
backgroundColor: string;
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
suggestions: {
|
|
87
|
+
textColor: string;
|
|
88
|
+
backgroundColor: string;
|
|
89
|
+
border: string;
|
|
90
|
+
borderGradient: [string, string] | null;
|
|
91
|
+
borderRadius: string;
|
|
92
|
+
hover: {
|
|
93
|
+
backgroundColor: string;
|
|
94
|
+
textColor: string;
|
|
95
|
+
};
|
|
96
|
+
loadingGradient: [string, string];
|
|
97
|
+
gap: string;
|
|
98
|
+
};
|
|
99
|
+
clickableMessages: {
|
|
100
|
+
backgroundColor: string;
|
|
101
|
+
textColor: string;
|
|
102
|
+
border: string | false;
|
|
103
|
+
hover: {
|
|
104
|
+
textColor: string;
|
|
105
|
+
backgroundColor: string;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
icons: {
|
|
109
|
+
color: string;
|
|
110
|
+
hover: {
|
|
111
|
+
color: string;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
};
|
|
33
115
|
} | undefined;
|
|
34
116
|
onCancel?: (() => void) | undefined;
|
|
35
117
|
}) => JSX.Element;
|
|
@@ -7,14 +7,17 @@ import { DashboardWidgetProps } from '../props';
|
|
|
7
7
|
* To learn more about using Sisense Fusion Widgets in Compose SDK,
|
|
8
8
|
* see [Sisense Fusion Widgets](/guides/sdk/guides/charts/guide-fusion-widgets.html).
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* ## Example
|
|
11
|
+
*
|
|
12
|
+
* Display two dashboard widgets from a Fusion Embed instance.
|
|
13
|
+
*
|
|
14
|
+
* <iframe
|
|
15
|
+
* src='https://csdk-playground.sisense.com/?example=fusion-assets%2Ffusion-widgets&mode=docs'
|
|
16
|
+
* width=800
|
|
17
|
+
* height=870
|
|
18
|
+
* style='border:none;'
|
|
16
19
|
* />
|
|
17
|
-
*
|
|
20
|
+
*
|
|
18
21
|
* @group Fusion Embed
|
|
19
22
|
* @fusionEmbed
|
|
20
23
|
*/
|
|
@@ -8,6 +8,6 @@ export declare function createDataColumn(item: PanelItem, customPaletteColors?:
|
|
|
8
8
|
export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {
|
|
9
9
|
[key: string]: any[];
|
|
10
10
|
};
|
|
11
|
-
export declare function createColumnsFromPanelItems(panels: Panel[], panelName: string, customPaletteColors?: Color[]):
|
|
11
|
+
export declare function createColumnsFromPanelItems<ColumnType = StyledColumn | StyledMeasureColumn>(panels: Panel[], panelName: string, customPaletteColors?: Color[]): ColumnType[];
|
|
12
12
|
export declare function extractBoxplotBoxType(style: BoxplotWidgetStyle): "iqr" | "extremums" | "standardDeviation";
|
|
13
13
|
export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { FilterJaql } from '@sisense/sdk-data';
|
|
2
2
|
import { Panel } from './types';
|
|
3
3
|
/**
|
|
4
4
|
* Extracts filter model components from a FilterJaql object.
|
|
5
5
|
*
|
|
6
|
-
* @param
|
|
7
|
-
* @returns
|
|
6
|
+
* @param jaql - The FilterJaql object.
|
|
7
|
+
* @returns An object containing the extracted filter model components, including filter, backgroundFilter, and turnOffMembersFilter.
|
|
8
8
|
*/
|
|
9
9
|
export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
|
|
10
10
|
filter: {
|
|
@@ -15,22 +15,30 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
|
|
|
15
15
|
exclude: {
|
|
16
16
|
members: string[];
|
|
17
17
|
};
|
|
18
|
+
} | {
|
|
19
|
+
equals?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
20
|
+
doesntEqual?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
21
|
+
toNotEqual?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
22
|
+
to?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
23
|
+
fromNotEqual?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
24
|
+
from?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
25
|
+
'='?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
26
|
+
'<'?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
27
|
+
'>'?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
28
|
+
'>='?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
29
|
+
'<='?: (number | import("@sisense/sdk-data").FormulaJaql) | undefined;
|
|
30
|
+
} | {
|
|
31
|
+
and: import("@sisense/sdk-data").JaqlNumericFilter[];
|
|
32
|
+
} | {
|
|
33
|
+
or: import("@sisense/sdk-data").JaqlNumericFilter[];
|
|
18
34
|
};
|
|
19
35
|
backgroundFilter: import("@sisense/sdk-data").BackgroundFilter | import("@sisense/sdk-data").TurnOffMembersFilter | undefined;
|
|
20
36
|
turnOffMembersFilter: import("@sisense/sdk-data").TurnOffMembersFilter | undefined;
|
|
21
37
|
};
|
|
22
|
-
/**
|
|
23
|
-
* Creates a Filter from a FilterJaql object.
|
|
24
|
-
*
|
|
25
|
-
* @param jaql - The filter JAQL object.
|
|
26
|
-
* @returns - The created Filter object.
|
|
27
|
-
* @internal
|
|
28
|
-
*/
|
|
29
|
-
export declare function createFilterFromJaql(jaql: FilterJaql, instanceid?: string): Filter;
|
|
30
38
|
/**
|
|
31
39
|
* Extracts filters from the widget panel.
|
|
32
40
|
*
|
|
33
|
-
* @param
|
|
34
|
-
* @returns
|
|
41
|
+
* @param panels - The array of panels.
|
|
42
|
+
* @returns The extracted filters.
|
|
35
43
|
*/
|
|
36
|
-
export declare function extractFilters(panels: Panel[]): Filter[];
|
|
44
|
+
export declare function extractFilters(panels: Panel[]): import("@sisense/sdk-data").Filter[];
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions } from '../types';
|
|
2
|
-
import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle } from './types';
|
|
1
|
+
import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions } from '../types';
|
|
2
|
+
import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle } from './types';
|
|
3
3
|
export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
|
|
4
4
|
export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
|
|
5
|
+
export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
|
|
5
6
|
export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widgetSubtype: WidgetSubtype, style: WidgetStyle, panels: Panel[]): ChartStyleOptions | TableStyleOptions;
|