@sisense/sdk-ui 1.7.2 → 1.8.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 (53) hide show
  1. package/dist/ai/ai-disclaimer.d.ts +2 -0
  2. package/dist/ai/chat-config.d.ts +6 -0
  3. package/dist/ai/messages/chat-welcome-message.d.ts +1 -1
  4. package/dist/ai/messages/clickable-message.d.ts +9 -0
  5. package/dist/ai/messages/feedback-wrapper.d.ts +2 -2
  6. package/dist/ai/messages/insights-message.d.ts +5 -5
  7. package/dist/ai/messages/text-message.d.ts +1 -2
  8. package/dist/ai/translators/model-translator.d.ts +1 -0
  9. package/dist/ai/translators/query-translator.d.ts +16 -1
  10. package/dist/ai/translators/translate-filters-to-code.d.ts +2 -0
  11. package/dist/ai/translators/translate-props-to-code.d.ts +1 -1
  12. package/dist/ai/translators/utils.d.ts +10 -0
  13. package/dist/ai.js +1723 -1612
  14. package/dist/area-chart.d.ts +14 -18
  15. package/dist/areamap-chart.d.ts +13 -15
  16. package/dist/bar-chart.d.ts +13 -18
  17. package/dist/boxplot-chart.d.ts +11 -25
  18. package/dist/chart/chart.d.ts +8 -66
  19. package/dist/chart-data/cartesian-data.d.ts +1 -1
  20. package/dist/chart-data/chart-data-service.d.ts +1 -2
  21. package/dist/chart-data/data-coloring/types.d.ts +1 -7
  22. package/dist/chart-data-options/types.d.ts +5 -3
  23. package/dist/column-chart.d.ts +15 -18
  24. package/dist/dashboard-widget/dashboard-widget.d.ts +10 -7
  25. package/dist/dashboard-widget/translate-widget-data-options.d.ts +1 -1
  26. package/dist/dashboard-widget/translate-widget-filters.d.ts +22 -14
  27. package/dist/dashboard-widget/types.d.ts +2 -2
  28. package/dist/dashboard-widget/utils.d.ts +2 -2
  29. package/dist/formulas/use-get-shared-formula.d.ts +3 -3
  30. package/dist/funnel-chart.d.ts +9 -36
  31. package/dist/index.d.ts +0 -1
  32. package/dist/index.js +1619 -1620
  33. package/dist/indicator-chart.d.ts +0 -1
  34. package/dist/line-chart.d.ts +14 -17
  35. package/dist/models/widget/use-get-widget-model.d.ts +16 -21
  36. package/dist/pie-chart.d.ts +14 -16
  37. package/dist/pivot-table/pivot-table.d.ts +43 -3
  38. package/dist/polar-chart.d.ts +14 -17
  39. package/dist/props.d.ts +12 -12
  40. package/dist/query-execution/use-execute-pivot-query.d.ts +11 -29
  41. package/dist/query-execution/use-execute-query.d.ts +19 -26
  42. package/dist/scatter-chart.d.ts +11 -49
  43. package/dist/scattermap-chart.d.ts +9 -22
  44. package/dist/sunburst-chart.d.ts +10 -15
  45. package/dist/table/table.d.ts +7 -37
  46. package/dist/translation/resources/en.d.ts +1 -0
  47. package/dist/translation/resources/index.d.ts +2 -0
  48. package/dist/treemap-chart.d.ts +10 -21
  49. package/dist/types.d.ts +2 -3
  50. package/dist/{useQuery-76ecbd20.js → useQuery-cb11e76c.js} +18866 -18607
  51. package/dist/widgets/common/drilldown.d.ts +1 -20
  52. package/dist/widgets/drilldown-widget.d.ts +21 -33
  53. package/package.json +7 -7
@@ -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
- * @example
9
- * An example of using the component to visualize the `Sample ECommerce` data source:
10
- * ```tsx
11
- * <AreaChart
12
- * dataSet={DM.DataSource}
13
- * dataOptions={{
14
- * category: [DM.Commerce.Date.Years],
15
- * value: [measureFactory.sum(DM.Commerce.Revenue)],
16
- * breakBy: [DM.Commerce.Gender],
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://dhoavm6pu1cvg.cloudfront.net/?example=charts%2Farea-chart&mode=docs'
13
+ * width=800
14
+ * height=870
15
+ * style='border:none;'
23
16
  * />
24
- * ```
25
17
  *
26
- * <img src="media://area-chart-example-1.png" width="800"/>
18
+ * Additional Area Chart examples:
19
+ *
20
+ * - [Stacked Area Chart](https://csdk-playground.sisense.com/?example=charts%2Farea-chart-stacked)
21
+ * - [Stacked Percentage Area Chart](https://csdk-playground.sisense.com/?example=charts%2Farea-chart-stacked100)
22
+ *
27
23
  * @param props - Area chart properties
28
24
  * @returns Area Chart component
29
25
  * @group Charts
@@ -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
- * @example
8
- * An example of using the component to visualize the `Sample ECommerce` data source:
9
- * ```tsx
10
- * <AreamapChart
11
- * dataSet={DM.DataSource}
12
- * dataOptions={{
13
- * geo: [DM.Country.Country],
14
- * color: measureFactory.sum(DM.Commerce.Cost, 'Total Cost'),
15
- * }}
16
- * styleOptions={{
17
- * mapType: 'world',
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
@@ -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
- * See [Bar Chart](https://docs.sisense.com/main/SisenseLinux/bar-chart.htm) for more information.
7
+ * ## Example
9
8
  *
10
- * @example
11
- * An example of using the component to visualize the `Sample ECommerce` data source:
12
- * ```tsx
13
- * <BarChart
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.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
- * <img src="media://bar-chart-example-1.png" width="800"/>
18
+ * Additional Bar Chart examples:
19
+ *
20
+ * - [Stacked Bar Chart](https://csdk-playground.sisense.com/?example=charts%2Fbar-chart-stacked)
21
+ * - [Stacked Percentage Bar Chart](https://csdk-playground.sisense.com/?example=charts%2Fbar-chart-stacked100)
22
+ *
28
23
  * @param props - Bar chart properties
29
24
  * @returns Bar Chart component
30
25
  * @group Charts
@@ -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, variability,
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
- * @example
9
- * An example of using the component to visualize the `Sample ECommerce` data source:
10
- * ```tsx
11
- * <BoxplotChart
12
- * dataSet={DM.DataSource}
13
- * dataOptions={{
14
- * category: [DM.Category.Category],
15
- * value: [DM.Commerce.Cost],
16
- * boxType: 'iqr',
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
@@ -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
- * @example
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
- * <img src="media://chart-data-source-example-1.png" width="800px" />
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
- * (2) An example of using the `Chart` component to
28
- * plot a pie chart of static data provided in code:
29
- * ```tsx
30
- * <Chart
31
- * chartType={'pie'}
32
- * dataSet={{
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, SortDirection, ValueToColorMap, MultiColumnValueToColorMap, LineWidth, Markers } from '../types';
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
- /** {@inheritDoc SortDirection} */
37
- sortType?: SortDirection;
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.
@@ -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
- * See [Column Chart](https://docs.sisense.com/main/SisenseLinux/column-chart.htm) for more information.
10
- *
11
- * @example
12
- * An example of using the component to visualize the `Sample ECommerce` data source:
13
- * ```tsx
14
- * <ColumnChart
15
- * dataSet={DM.DataSource}
16
- * dataOptions={{
17
- * category: [DM.Commerce.AgeRange],
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
- * <img src="media://column-chart-example-1.png" width="800"/>
20
+ *
21
+ * Additional Column Chart examples:
22
+ *
23
+ * - [Stacked Column Chart](https://csdk-playground.sisense.com/?example=charts%2Fcolumn-chart-stacked)
24
+ * - [Stacked Percentage Column Chart](https://csdk-playground.sisense.com/?example=charts%2Fcolumn-chart-stacked100)
25
+ *
29
26
  * @param props - Column chart properties
30
27
  * @returns Column Chart component
31
28
  * @group Charts
@@ -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
- * @example
11
- * The example below renders a dashboard widget with the specified widget and dashboard OIDs.
12
- * ```tsx
13
- * <DashboardWidget
14
- * widgetOid={'64473e07dac1920034bce77f'}
15
- * dashboardOid={'6441e728dac1920034bce737'}
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[]): (StyledMeasureColumn | StyledColumn)[];
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 { Filter, FilterJaql } from '@sisense/sdk-data';
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 {FilterJaql} jaql - The FilterJaql object.
7
- * @returns {object} - An object containing the extracted filter model components, including filter, backgroundFilter, and turnOffMembersFilter.
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 {Panel[]} panels - The array of panels.
34
- * @returns {Filter[]} - The extracted filters.
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,4 +1,4 @@
1
- import { Jaql, SortDirection } from '@sisense/sdk-data';
1
+ import { Jaql, JaqlSortDirection } from '@sisense/sdk-data';
2
2
  /**
3
3
  * The type of a widget on a dashboard that is a variant of Cartesian widget.
4
4
  */
@@ -109,7 +109,7 @@ export type PanelItem = {
109
109
  parent?: PanelItem;
110
110
  through?: PanelItem;
111
111
  singleSeriesType?: SeriesType;
112
- categoriesSorting?: SortDirection;
112
+ categoriesSorting?: JaqlSortDirection;
113
113
  isColored?: boolean;
114
114
  geoLevel?: 'country' | 'state' | 'city';
115
115
  };
@@ -1,6 +1,6 @@
1
- import { type Filter, SortDirection as JaqlSortDirection, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
1
+ import { type Filter, JaqlSortDirection, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
2
2
  import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options';
3
- import { ChartType, SortDirection } from '../types';
3
+ import { ChartType, type SortDirection } from '../types';
4
4
  import { FiltersMergeStrategy, Panel, PanelItem, WidgetSubtype, WidgetType } from './types';
5
5
  export declare function getChartType(widgetType: WidgetType): ChartType;
6
6
  export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
@@ -67,11 +67,11 @@ export type SharedFormulaSuccessState = {
67
67
  status: 'success';
68
68
  };
69
69
  /**
70
- * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from the Sisense instance
70
+ * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from the a Fusion Embed instance.
71
71
  *
72
- * Formula can be identified either by `oid` or by name and data source pair
72
+ * The formula can be identified either by `oid` or by name and data source pair.
73
73
  *
74
- * When the retrieval is successful but the shared formula is not found, the result is altered from being `undefined` to `null`
74
+ * When the retrieval is successful but the shared formula is not found, the resulting `formula` is `null`. When the retrieval is not successful the resulting `formula` is `undefined`.
75
75
  *
76
76
  * @example
77
77
  * An example of retrieving a shared formula by oid:
@@ -2,45 +2,18 @@
2
2
  import { FunnelChartProps } from './props';
3
3
  /**
4
4
  * A React component representing data progressively decreasing in size or quantity through a funnel shape.
5
- * See [Funnel Chart](https://docs.sisense.com/main/SisenseLinux/funnel-chart.htm) for more information.
6
5
  *
7
- * @example
8
- * An example of visualizing sales funnel data:
9
- * ```tsx
10
- * <FunnelChart
11
- * dataSet={{
12
- * columns: [
13
- * { name: 'Stage', type: 'string' },
14
- * { name: 'Unique Users', type: 'number' },
15
- * ],
16
- * rows: [
17
- * ['Website visits', 15654],
18
- * ['Downloads', 4064],
19
- * ['Requested price list', 1987],
20
- * ['Invoice sent', 976],
21
- * ['Finalized', 846],
22
- * ],
23
- * }}
24
- * dataOptions={{
25
- * category: [
26
- * {
27
- * name: 'Stage',
28
- * type: 'string',
29
- * },
30
- * ],
31
- * value: [
32
- * {
33
- * name: 'Unique Users',
34
- * aggregation: 'sum',
35
- * },
36
- * ],
37
- * }}
38
- * />
39
- * ```
6
+ * ## Example
7
+ *
8
+ * Funnel chart displaying data from the Sample ECommerce data model.
40
9
  *
41
- * <img src="media://funnel-chart-example-1.png" width="800"/>
10
+ * <iframe
11
+ * src='https://csdk-playground.sisense.com/?example=charts%2Ffunnel-chart&mode=docs'
12
+ * width=800
13
+ * height=870
14
+ * style='border:none;'
15
+ * />
42
16
  *
43
- * Note that the chart sorts the measure, `Unique Users`, in descending order by default.
44
17
  * @param props - Funnel chart properties
45
18
  * @returns Funnel Chart component
46
19
  * @group Charts
package/dist/index.d.ts CHANGED
@@ -43,7 +43,6 @@ export * from './formulas';
43
43
  export { trackHook } from './decorators/hook-decorators';
44
44
  export * from './common/hooks/data-load-state-reducer';
45
45
  export { createDataOptionsFromPanels } from './dashboard-widget/translate-widget-data-options';
46
- export { createFilterFromJaql } from './dashboard-widget/translate-widget-filters';
47
46
  export { useThemeContext } from './theme-provider';
48
47
  export { LoadingIndicator } from './common/components/loading-indicator';
49
48
  export { useFetch, type RequestConfig, type UseQueryResult } from './common/hooks/use-fetch';