@sisense/sdk-ui 0.15.0 → 1.0.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 (146) hide show
  1. package/dist/ai/messages/get-widget-options.d.ts +3 -3
  2. package/dist/ai.js +334 -308
  3. package/dist/api/types/dashboard-dto.d.ts +3 -2
  4. package/dist/area-chart.d.ts +2 -2
  5. package/dist/bar-chart.d.ts +2 -2
  6. package/dist/boxplot-chart.d.ts +38 -0
  7. package/dist/boxplot-utils.d.ts +30 -0
  8. package/dist/chart-data/boxplot-data.d.ts +11 -0
  9. package/dist/chart-data/cartesian-data.d.ts +6 -3
  10. package/dist/chart-data/data-coloring/create-data-coloring-function.d.ts +7 -0
  11. package/dist/chart-data/data-coloring/index.d.ts +3 -0
  12. package/dist/chart-data/{series-data-color-service → data-coloring}/legend-color.d.ts +1 -1
  13. package/dist/chart-data/data-coloring/series-data-coloring-function.d.ts +11 -0
  14. package/dist/chart-data/indicator-data.d.ts +2 -2
  15. package/dist/chart-data/scatter-data.d.ts +2 -2
  16. package/dist/chart-data/scattermap-data.d.ts +4 -0
  17. package/dist/chart-data/types.d.ts +46 -1
  18. package/dist/chart-data-options/coloring/consts.d.ts +3 -0
  19. package/dist/chart-data-options/coloring/utils.d.ts +6 -0
  20. package/dist/chart-data-options/get-translated-data-options.d.ts +6 -0
  21. package/dist/chart-data-options/translate-boxplot-data-options.d.ts +7 -0
  22. package/dist/chart-data-options/translate-scattermap-data-options.d.ts +3 -0
  23. package/dist/chart-data-options/types.d.ts +122 -10
  24. package/dist/chart-data-options/utils.d.ts +6 -1
  25. package/dist/chart-options-processor/boxplot-chart-options.d.ts +10 -0
  26. package/dist/chart-options-processor/chart-options-service.d.ts +21 -77
  27. package/dist/chart-options-processor/style-to-design-options-translator/translate-style-to-design-options.d.ts +2 -2
  28. package/dist/chart-options-processor/style-to-design-options-translator/translate-to-highcharts-options.d.ts +4 -2
  29. package/dist/chart-options-processor/subtype-to-design-options.d.ts +5 -2
  30. package/dist/chart-options-processor/theme-option-service.d.ts +0 -1
  31. package/dist/chart-options-processor/translations/axis-section.d.ts +4 -3
  32. package/dist/chart-options-processor/translations/boxplot/boxplot-axis.d.ts +10 -0
  33. package/dist/chart-options-processor/translations/boxplot/boxplot-plot-options.d.ts +3 -0
  34. package/dist/chart-options-processor/translations/boxplot/boxplot-series.d.ts +5 -0
  35. package/dist/chart-options-processor/translations/boxplot/boxplot-tooltip.d.ts +3 -0
  36. package/dist/chart-options-processor/translations/design-options.d.ts +9 -2
  37. package/dist/chart-options-processor/translations/funnel-series.d.ts +1 -2
  38. package/dist/chart-options-processor/translations/legend-section.d.ts +6 -4
  39. package/dist/chart-options-processor/translations/pie-series.d.ts +1 -2
  40. package/dist/chart-options-processor/translations/tooltip-utils.d.ts +5 -0
  41. package/dist/chart-options-processor/translations/translations-to-highcharts.d.ts +11 -3
  42. package/dist/chart-options-processor/translations/types.d.ts +10 -2
  43. package/dist/chart-options-processor/translations/value-label-section.d.ts +2 -1
  44. package/dist/chart.d.ts +2 -2
  45. package/dist/charts/indicator/indicator-legacy-chart-data-options.d.ts +2 -2
  46. package/dist/charts/indicator/indicator-legacy-chart-options/indicator-legacy-chart-options.d.ts +2 -2
  47. package/dist/charts/indicator/indicator-legacy-chart-options/override-with-value-color.d.ts +2 -2
  48. package/dist/charts/scattermap/hooks/use-locations.d.ts +3 -0
  49. package/dist/charts/scattermap/hooks/use-settings.d.ts +5 -0
  50. package/dist/charts/scattermap/hooks/use-tooltip-handler.d.ts +14 -0
  51. package/dist/charts/scattermap/scattermap.d.ts +13 -0
  52. package/dist/charts/scattermap/types.d.ts +16 -0
  53. package/dist/charts/scattermap/utils/color.d.ts +3 -0
  54. package/dist/charts/scattermap/utils/copyright.d.ts +2 -0
  55. package/dist/charts/scattermap/utils/location.d.ts +5 -0
  56. package/dist/charts/scattermap/utils/map.d.ts +2 -0
  57. package/dist/charts/scattermap/utils/markers.d.ts +28 -0
  58. package/dist/charts/scattermap/utils/size.d.ts +2 -0
  59. package/dist/charts/scattermap/utils/tooltip.d.ts +8 -0
  60. package/dist/charts/scattermap/utils/values.d.ts +4 -0
  61. package/dist/charts/table/types.d.ts +1 -1
  62. package/dist/column-chart.d.ts +2 -2
  63. package/dist/common/components/loading-dots.d.ts +4 -0
  64. package/dist/dashboard-widget/translate-dashboard-filters.d.ts +1 -1
  65. package/dist/dashboard-widget/translate-panel-color-format.d.ts +3 -3
  66. package/dist/dashboard-widget/translate-widget-data-options.d.ts +6 -5
  67. package/dist/dashboard-widget/translate-widget-style-options.d.ts +2 -2
  68. package/dist/dashboard-widget/types.d.ts +45 -19
  69. package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts +9 -5
  70. package/dist/dashboard-widget/utils.d.ts +1 -1
  71. package/dist/decorators/component-decorators/as-sisense-component.d.ts +1 -0
  72. package/dist/filters/components/common/basic-input.d.ts +1 -1
  73. package/dist/filters/components/common/date-range-field-button.d.ts +3 -2
  74. package/dist/filters/components/common/dropdown.d.ts +9 -0
  75. package/dist/filters/components/common/filter-utils.d.ts +13 -0
  76. package/dist/filters/components/common/index.d.ts +3 -1
  77. package/dist/filters/components/common/radio.d.ts +7 -0
  78. package/dist/filters/components/criteria-filter-tile/criteria-filter-display.d.ts +2 -2
  79. package/dist/filters/components/criteria-filter-tile/criteria-filter-menu.d.ts +6 -3
  80. package/dist/filters/components/criteria-filter-tile/criteria-filter-operations.d.ts +13 -8
  81. package/dist/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts +21 -4
  82. package/dist/filters/components/criteria-filter-tile/index.d.ts +0 -1
  83. package/dist/filters/components/date-filter/date-filter/calendar-date-selector.d.ts +10 -8
  84. package/dist/filters/components/date-filter/date-filter/quick-date-selection-buttons.d.ts +4 -4
  85. package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts +1 -1
  86. package/dist/filters/components/date-filter/index.d.ts +1 -0
  87. package/dist/filters/components/date-filter/relative-date-filter-tile/index.d.ts +1 -0
  88. package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-display.d.ts +14 -0
  89. package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-tile.d.ts +36 -0
  90. package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter.d.ts +26 -0
  91. package/dist/filters/components/filter-tile.d.ts +1 -1
  92. package/dist/filters/components/member-filter-tile/basic-member-filter-tile.d.ts +2 -0
  93. package/dist/filters/components/member-filter-tile/members-reducer.d.ts +9 -1
  94. package/dist/filters/components/member-filter-tile/pill-section.d.ts +0 -1
  95. package/dist/filters/index.d.ts +1 -0
  96. package/dist/highcharts-memorized.d.ts +4 -3
  97. package/dist/index.d.ts +5 -2
  98. package/dist/index.js +5585 -4933
  99. package/dist/indicator-canvas.d.ts +3 -3
  100. package/dist/indicator-chart.d.ts +4 -4
  101. package/dist/line-chart.d.ts +2 -2
  102. package/dist/models/dashboard/types.d.ts +1 -1
  103. package/dist/models/dashboard/use-get-dashboard-model.d.ts +1 -0
  104. package/dist/models/dashboard/use-get-dashboard-models.d.ts +2 -1
  105. package/dist/models/widget/get-widget-model.d.ts +4 -0
  106. package/dist/models/widget/index.d.ts +3 -1
  107. package/dist/models/widget/translate-widget.d.ts +1 -1
  108. package/dist/models/widget/use-get-widget-model.d.ts +103 -0
  109. package/dist/models/widget/widget-model.d.ts +123 -0
  110. package/dist/pie-chart.d.ts +2 -2
  111. package/dist/polar-chart.d.ts +2 -2
  112. package/dist/props.d.ts +67 -62
  113. package/dist/query/execute-query.d.ts +3 -1
  114. package/dist/query-execution/csv-query-state-reducer.d.ts +2 -0
  115. package/dist/query-execution/execute-query-by-widget-id.d.ts +10 -2
  116. package/dist/query-execution/execute-query.d.ts +11 -4
  117. package/dist/query-execution/index.d.ts +4 -3
  118. package/dist/query-execution/query-state-reducer.d.ts +1 -58
  119. package/dist/query-execution/types.d.ts +192 -0
  120. package/dist/query-execution/use-execute-csv-query.d.ts +80 -0
  121. package/dist/query-execution/use-execute-query-by-widget-id.d.ts +6 -37
  122. package/dist/query-execution/use-execute-query.d.ts +10 -35
  123. package/dist/scatter-chart.d.ts +4 -4
  124. package/dist/scattermap-chart.d.ts +36 -0
  125. package/dist/sunburst-chart.d.ts +1 -1
  126. package/dist/table/hooks/use-table-data.d.ts +7 -2
  127. package/dist/table/table.d.ts +5 -2
  128. package/dist/table-widget-7936746a.js +72481 -0
  129. package/dist/themes/theme-loader.d.ts +0 -1
  130. package/dist/translation/resources/en.d.ts +21 -0
  131. package/dist/translation/resources/index.d.ts +42 -0
  132. package/dist/treemap-chart.d.ts +2 -2
  133. package/dist/types.d.ts +76 -7
  134. package/dist/utils/utility-types.d.ts +4 -0
  135. package/dist/widgets/chart-widget-deprecated.d.ts +1 -1
  136. package/dist/widgets/chart-widget.d.ts +1 -1
  137. package/dist/widgets/common/drilldown-breadcrumbs/drilldown-breadcrumbs-navigation.d.ts +8 -0
  138. package/dist/widgets/common/drilldown-breadcrumbs/styled-buttons.d.ts +11 -0
  139. package/dist/widgets/common/drilldown.d.ts +12 -2
  140. package/dist/widgets/drilldown-widget.d.ts +2 -2
  141. package/package.json +28 -6
  142. package/dist/chart-data/series-data-color-service/index.d.ts +0 -3
  143. package/dist/chart-data/series-data-color-service/series-data-color-service.d.ts +0 -4
  144. package/dist/models/widget/types.d.ts +0 -6
  145. package/dist/table-widget-7b20ecf7.js +0 -64167
  146. /package/dist/chart-data/{series-data-color-service → data-coloring}/types.d.ts +0 -0
@@ -9,7 +9,7 @@ import { HighchartsType, HighchartsSeriesValues } from './translations/translati
9
9
  import { TooltipSettings } from './tooltip';
10
10
  import { PieOptions } from './translations/pie-plot-options';
11
11
  import { FunnelOptions } from './translations/funnel-plot-options';
12
- import { ChartType, OptionsWithAlerts, CompleteThemeSettings } from '../types';
12
+ import { ChartType, OptionsWithAlerts, CompleteThemeSettings, ChartStyleOptions, HighchartsSelectEvent } from '../types';
13
13
  import { ChartDataOptionsInternal } from '../chart-data-options/types';
14
14
  import { ScatterBubbleOptions } from './translations/scatter-plot-options';
15
15
  /**
@@ -30,9 +30,6 @@ export type HighchartsOptions = Pick<Options, keyof Options>;
30
30
  * @param dateFormatter
31
31
  */
32
32
  export declare const highchartsOptionsService: (chartData: ChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettings, dateFormatter?: ((date: Date, format: string) => string) | undefined) => OptionsWithAlerts<HighchartsOptionsInternal>;
33
- export declare const colorChineseSilver = "#CCCCCC";
34
- export declare const colorWhite = "#FFFFFF";
35
- export declare const DEFAULT_SERIES_COLORS: string[];
36
33
  export type SeriesType = HighchartsSeriesValues & {
37
34
  index?: number;
38
35
  animation?: boolean;
@@ -46,6 +43,14 @@ export type SeriesType = HighchartsSeriesValues & {
46
43
  marker?: MarkerSettings;
47
44
  type?: string;
48
45
  id?: string;
46
+ medianWidth?: number;
47
+ maxPointWidth?: number;
48
+ minPointWidth?: number;
49
+ whiskerWidth?: number;
50
+ whiskerLength?: number | string;
51
+ fillOpacity?: number;
52
+ strokeOpacity?: number;
53
+ legendIndex?: number;
49
54
  };
50
55
  type ChartPlotOptions = {
51
56
  dataLabels?: ValueLabelSettings;
@@ -81,6 +86,7 @@ export type PlotOptions = {
81
86
  allowPointSelect?: boolean;
82
87
  boostThreshold?: number;
83
88
  turboThreshold?: number;
89
+ softThreshold?: boolean;
84
90
  fillOpacity?: number;
85
91
  connectNulls?: boolean;
86
92
  animation?: {
@@ -95,6 +101,8 @@ export type PlotOptions = {
95
101
  funnel?: FunnelOptions;
96
102
  bubble?: ScatterBubbleOptions;
97
103
  sunburst?: ChartPlotOptions;
104
+ boxplot?: ChartPlotOptions;
105
+ scatter?: ChartPlotOptions;
98
106
  };
99
107
  /**
100
108
  * Highcharts options internal
@@ -106,6 +114,7 @@ export type HighchartsOptionsInternal = {
106
114
  events?: {
107
115
  load?: () => void;
108
116
  redraw?: () => void;
117
+ selection?: (nativeEvent: HighchartsSelectEvent) => void;
109
118
  };
110
119
  spacing?: number[];
111
120
  marginTop?: number;
@@ -114,6 +123,9 @@ export type HighchartsOptionsInternal = {
114
123
  animation?: {
115
124
  duration?: number;
116
125
  };
126
+ zooming?: {
127
+ type: string;
128
+ };
117
129
  };
118
130
  title?: {
119
131
  text: string | null;
@@ -158,15 +170,16 @@ type Navigator = {
158
170
  dataGrouping: {
159
171
  enabled: boolean;
160
172
  };
173
+ color?: string;
161
174
  };
162
175
  enabled: boolean;
163
176
  margin: number;
164
177
  height: number;
165
178
  xAxis: AxisSettings;
166
179
  handles: {
167
- symbols: string[];
168
- backgroundColor: string;
169
- borderColor: string;
180
+ symbols?: string[];
181
+ backgroundColor?: string;
182
+ borderColor?: string;
170
183
  };
171
184
  maskInside: boolean;
172
185
  maskFill: string;
@@ -178,76 +191,7 @@ type Navigator = {
178
191
  right: string;
179
192
  };
180
193
  };
181
- declare const DEFAULT_STYLE_OPTIONS: {
182
- readonly legend: {
183
- readonly enabled: true;
184
- readonly position: "bottom";
185
- };
186
- readonly navigator: {
187
- readonly enabled: true;
188
- };
189
- readonly markers: {
190
- readonly enabled: true;
191
- readonly fill: "hollow";
192
- readonly size: "small";
193
- };
194
- readonly seriesLabels: {
195
- readonly enabled: false;
196
- readonly rotation: 0;
197
- };
198
- readonly xAxis: {
199
- readonly enabled: true;
200
- readonly gridLines: true;
201
- readonly isIntervalEnabled: false;
202
- readonly labels: {
203
- readonly enabled: true;
204
- };
205
- readonly logarithmic: false;
206
- readonly title: {
207
- readonly enabled: false;
208
- readonly text: "X Axis title";
209
- };
210
- };
211
- readonly yAxis: {
212
- readonly enabled: true;
213
- readonly gridLines: true;
214
- readonly isIntervalEnabled: false;
215
- readonly labels: {
216
- readonly enabled: true;
217
- };
218
- readonly logarithmic: false;
219
- readonly title: {
220
- readonly enabled: false;
221
- readonly text: "Y Axis title";
222
- };
223
- };
224
- readonly y2Axis: {
225
- readonly enabled: true;
226
- readonly gridLines: true;
227
- readonly isIntervalEnabled: false;
228
- readonly labels: {
229
- readonly enabled: true;
230
- };
231
- readonly logarithmic: false;
232
- readonly title: {
233
- readonly enabled: false;
234
- readonly text: "Y2 Axis title";
235
- };
236
- };
237
- readonly convolution: {
238
- readonly enabled: false;
239
- readonly selectedConvolutionType: "byPercentage";
240
- readonly minimalIndependentSlicePercentage: 3;
241
- readonly independentSlicesCount: 7;
242
- };
243
- readonly labels: {
244
- readonly categories: true;
245
- readonly enabled: true;
246
- readonly percent: true;
247
- readonly decimals: false;
248
- readonly value: false;
249
- };
250
- };
194
+ declare const DEFAULT_STYLE_OPTIONS: ChartStyleOptions;
251
195
  /**
252
196
  * Returns default style options, which can be used as base for custom style options.
253
197
  *
@@ -1,4 +1,4 @@
1
- import { ChartType, StyleOptions } from '../../types';
1
+ import { ChartType, ChartStyleOptions } from '../../types';
2
2
  import { ChartDesignOptions } from '../translations/types';
3
3
  import { ChartDataOptionsInternal } from '../../chart-data-options/types';
4
- export declare const translateStyleOptionsToDesignOptions: (chartType: ChartType, styleOptions: StyleOptions, dataOptions: ChartDataOptionsInternal) => ChartDesignOptions;
4
+ export declare const translateStyleOptionsToDesignOptions: (chartType: ChartType, styleOptions: ChartStyleOptions, dataOptions: ChartDataOptionsInternal) => ChartDesignOptions;
@@ -1,5 +1,5 @@
1
- import { Legend, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions } from '../../types';
2
- import { StackableChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, AreaChartDesignOptions, TreemapChartDesignOptions, SunburstChartDesignOptions } from '../translations/design-options';
1
+ import { Legend, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions } from '../../types';
2
+ import { StackableChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, AreaChartDesignOptions, TreemapChartDesignOptions, SunburstChartDesignOptions, BoxplotChartDesignOptions, ScattermapChartDesignOptions } from '../translations/design-options';
3
3
  import { LegendPosition } from '../translations/legend-section';
4
4
  import { StackType } from '../translations/translations-to-highcharts';
5
5
  export declare const getLegend: (legend?: Legend) => LegendPosition;
@@ -14,3 +14,5 @@ export declare const getTreemapChartDesignOptions: (styleOptions: TreemapStyleOp
14
14
  export declare const getSunburstChartDesignOptions: (styleOptions: SunburstStyleOptions) => SunburstChartDesignOptions;
15
15
  export declare const getPolarChartDesignOptions: (styleOptions: PolarStyleOptions) => PolarChartDesignOptions;
16
16
  export declare const getScatterChartDesignOptions: (styleOptions: ScatterStyleOptions) => ScatterChartDesignOptions;
17
+ export declare const getBoxplotChartDesignOptions: (styleOptions: BoxplotStyleOptions) => BoxplotChartDesignOptions;
18
+ export declare const getScattermapChartDesignOptions: (styleOptions: ScattermapStyleOptions) => ScattermapChartDesignOptions;
@@ -1,5 +1,5 @@
1
1
  import { LineType, StackType } from './translations/translations-to-highcharts';
2
- import { IndicatorStyleType, PolarType } from './translations/design-options';
2
+ import { IndicatorStyleType, PolarType, BoxplotType } from './translations/design-options';
3
3
  /**
4
4
  * Property of {@link LineStyleOptions}
5
5
  *
@@ -88,11 +88,14 @@ export type IndicatorSubtype = 'indicator/numeric' | 'indicator/gauge';
88
88
  */
89
89
  export type TreemapSubtype = 'treemap';
90
90
  export type SunburstSubtype = 'sunburst';
91
- export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype;
91
+ export type BoxplotSubtype = 'boxplot/full' | 'boxplot/hollow';
92
+ export type ScattermapSubtype = 'scattermap';
93
+ export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype;
92
94
  export declare const chartSubtypeToDesignOptions: Readonly<Record<ChartSubtype, {
93
95
  lineType?: LineType | undefined;
94
96
  stackType?: StackType | undefined;
95
97
  pieType?: "classic" | "donut" | "ring" | undefined;
96
98
  polarType?: PolarType | undefined;
97
99
  indicatorType?: IndicatorStyleType | undefined;
100
+ boxplotType?: BoxplotType | undefined;
98
101
  }>>;
@@ -5,7 +5,6 @@ export declare const applyThemeToChart: (chartOptions: HighchartsOptionsInternal
5
5
  * Returns default theme settings, which can be used as base for custom theme options.
6
6
  *
7
7
  * @returns Theme settings object
8
- *
9
8
  * @internal
10
9
  */
11
10
  export declare const getDefaultThemeSettings: () => CompleteThemeSettings;
@@ -2,6 +2,7 @@ import { Style } from '../chart-options-service';
2
2
  import { ChartDataOptionsInternal, Category } from '../../chart-data-options/types';
3
3
  import { ChartType } from '../../types';
4
4
  import { CategoricalXValues } from '../../chart-data/types';
5
+ import { AxisClipped } from './translations-to-highcharts';
5
6
  export type Axis = {
6
7
  enabled?: boolean;
7
8
  titleEnabled?: boolean;
@@ -18,7 +19,7 @@ export type AxisMinMax = {
18
19
  max: number;
19
20
  };
20
21
  export type AxisOrientation = 'horizontal' | 'vertical';
21
- interface AxisLabelsFormatterContextObject {
22
+ export interface AxisLabelsFormatterContextObject {
22
23
  value: string | number;
23
24
  axis: {
24
25
  categories: (string | number)[];
@@ -68,6 +69,7 @@ export type AxisSettings = {
68
69
  minorGridLineDashStyle?: string;
69
70
  stackLabels?: StackLabel;
70
71
  showLastLabel?: boolean;
72
+ visible?: boolean;
71
73
  };
72
74
  export type StackLabel = {
73
75
  style: Style;
@@ -102,5 +104,4 @@ export declare const getCategoricalCompareValue: (value: CategoricalXValues) =>
102
104
  export declare const getDateFormatter: (category: Category, dateFormatter?: ((date: Date, format: string) => string) | undefined) => (time: number) => string;
103
105
  export declare const getXAxisDatetimeSettings: (axis: Axis, category: Category, values: number[], dateFormatter?: ((date: Date, format: string) => string) | undefined) => AxisSettings[];
104
106
  export declare const getXAxisSettings: (axis: Axis, axis2: Axis | undefined, categories: string[], plotBands: PlotBand[], xAxisOrientation: AxisOrientation, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType) => AxisSettings[];
105
- export declare const getYAxisSettings: (axis: Axis, axis2: Axis | undefined, axisMinMax: AxisMinMax, axis2MinMax: AxisMinMax, showTotal: boolean, chartDataOptions: ChartDataOptionsInternal) => AxisSettings[];
106
- export {};
107
+ export declare const getYAxisSettings: (axis: Axis, axis2: Axis | undefined, axisMinMax: AxisMinMax, axis2MinMax: AxisMinMax | undefined, showTotal: boolean, chartDataOptions: ChartDataOptionsInternal) => [AxisSettings[], AxisClipped[]];
@@ -0,0 +1,10 @@
1
+ import { BoxplotChartData } from '../../../chart-data/types';
2
+ import { Axis, AxisSettings } from '../axis-section';
3
+ import { Value, type Category } from '../../../chart-data-options/types';
4
+ export declare const commonColor = "#d1d1d7";
5
+ export declare const calculateYAxisMinMax: (chartData: BoxplotChartData) => {
6
+ min: number;
7
+ max: number;
8
+ };
9
+ export declare const getBoxplotXAxisSettings: (axis: Axis, categories: string[], axisDataOption?: Category) => AxisSettings[];
10
+ export declare const getBoxplotYAxisSettings: (axis: Axis, chartData: BoxplotChartData, axisDataOption?: Value) => AxisSettings[];
@@ -0,0 +1,3 @@
1
+ import { PlotOptions } from '../../chart-options-service.js';
2
+ import { ValueLabel } from '../value-label-section.js';
3
+ export declare const getBoxplotPlotOptions: (valueLabel: ValueLabel) => PlotOptions;
@@ -0,0 +1,5 @@
1
+ import { SeriesType } from '../../chart-options-service.js';
2
+ import { BoxplotChartData } from '../../../chart-data/types.js';
3
+ import { SeriesWithAlerts } from '../../../types.js';
4
+ import { BoxplotChartDesignOptions } from '../design-options.js';
5
+ export declare const buildBoxplotSeries: (data: BoxplotChartData, chartDesignOptions: BoxplotChartDesignOptions) => SeriesWithAlerts<SeriesType[]>;
@@ -0,0 +1,3 @@
1
+ import { BoxplotChartDataOptionsInternal } from '../../../chart-data-options/types';
2
+ import { TooltipSettings } from '../tooltip-utils';
3
+ export declare const getBoxplotTooltipSettings: (dataOptions: BoxplotChartDataOptionsInternal) => TooltipSettings;
@@ -5,7 +5,7 @@ import { LegendPosition } from './legend-section';
5
5
  import { LineType, StackType } from './translations-to-highcharts';
6
6
  import { PieType, PieLabels } from './pie-plot-options';
7
7
  import { FunnelSize, FunnelType, FunnelDirection, FunnelLabels } from './funnel-plot-options';
8
- import { Convolution, SunburstStyleOptions, TreemapStyleOptions } from '../../types';
8
+ import { Convolution, ScattermapMarkers, SunburstStyleOptions, TreemapStyleOptions } from '../../types';
9
9
  import { ScatterMarkerSize } from './scatter-plot-options';
10
10
  type DataLimits = {
11
11
  seriesCapacity: number;
@@ -81,7 +81,7 @@ export type IndicatorComponents = {
81
81
  /** The text of the title */
82
82
  text?: string;
83
83
  };
84
- /** The secondary title of the indicator chart to be shown when `secondary` is specified in {@link IndicatorDataOptions} */
84
+ /** The secondary title of the indicator chart to be shown when `secondary` is specified in {@link IndicatorChartDataOptions} */
85
85
  secondaryTitle?: {
86
86
  /** The text of the secondary title */
87
87
  text?: string;
@@ -116,4 +116,11 @@ export type PolarType = 'line' | 'area' | 'column';
116
116
  export type PolarChartDesignOptions = BaseDesignOptionsType & {
117
117
  polarType: PolarType;
118
118
  };
119
+ export type BoxplotType = 'full' | 'hollow';
120
+ export type BoxplotChartDesignOptions = BaseDesignOptionsType & {
121
+ boxplotType: BoxplotType;
122
+ };
123
+ export type ScattermapChartDesignOptions = BaseDesignOptionsType & {
124
+ markers: Required<ScattermapMarkers>;
125
+ };
119
126
  export {};
@@ -1,9 +1,8 @@
1
- import { Color, SeriesWithAlerts, CompleteThemeSettings } from '../../types';
1
+ import { SeriesWithAlerts, CompleteThemeSettings } from '../../types';
2
2
  import { SeriesType } from '../chart-options-service';
3
3
  import { FunnelChartDesignOptions } from './design-options';
4
4
  import { CategoricalChartData } from '../../chart-data/types';
5
5
  import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
6
- export declare const getAPaletteColor: (colors: Color[] | undefined, index: number) => string;
7
6
  /**
8
7
  * Convert categorical chart data into renderable highcharts funnel series. *
9
8
  *
@@ -2,16 +2,16 @@ import { Style } from '../chart-options-service';
2
2
  export type LegendPosition = 'top' | 'left' | 'right' | 'bottom' | null;
3
3
  export type LegendSettings = {
4
4
  enabled: boolean;
5
- align: 'center' | 'left' | 'right';
6
- verticalAlign: 'top' | 'middle' | 'bottom';
7
- layout: 'horizontal' | 'vertical';
5
+ align?: 'center' | 'left' | 'right';
6
+ verticalAlign?: 'top' | 'middle' | 'bottom';
7
+ layout?: 'horizontal' | 'vertical';
8
8
  itemStyle?: Style & {
9
9
  cursor?: string;
10
10
  };
11
11
  symbolRadius?: number;
12
12
  symbolHeight?: number;
13
13
  symbolWidth?: number;
14
- borderWidth?: string;
14
+ borderWidth?: number;
15
15
  borderColor?: string;
16
16
  backgroundColor?: string;
17
17
  title?: {
@@ -19,5 +19,7 @@ export type LegendSettings = {
19
19
  [key: string]: string | number;
20
20
  };
21
21
  };
22
+ maxHeight?: number;
22
23
  };
24
+ export declare const legendItemStyleDefault: LegendSettings['itemStyle'];
23
25
  export declare const getLegendSettings: (position: LegendPosition) => LegendSettings;
@@ -1,9 +1,8 @@
1
- import { Color, SeriesWithAlerts, CompleteThemeSettings } from '../../types';
1
+ import { SeriesWithAlerts, CompleteThemeSettings } from '../../types';
2
2
  import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
3
3
  import { SeriesType } from '../chart-options-service';
4
4
  import { PieChartDesignOptions } from './design-options';
5
5
  import { CategoricalChartData } from '../../chart-data/types';
6
- export declare const getAPaletteColor: (colors: Color[] | undefined, index: number) => string;
7
6
  type FormattedPieChartData = SeriesWithAlerts<SeriesType[]> & {
8
7
  convolutionSeries: SeriesType[];
9
8
  };
@@ -26,6 +26,11 @@ export type InternalSeries = {
26
26
  x?: number | string;
27
27
  y?: number;
28
28
  z?: number;
29
+ high?: number;
30
+ low?: number;
31
+ q1?: number;
32
+ q3?: number;
33
+ median?: number;
29
34
  name: string;
30
35
  color: string;
31
36
  custom?: {
@@ -2,7 +2,7 @@ import { ChartType } from '../../types';
2
2
  import { ChartDataOptionsInternal, CategoricalChartDataOptionsInternal, CartesianChartDataOptionsInternal } from '../../chart-data-options/types';
3
3
  import { CategoricalSeriesValues, ChartData, CartesianChartData } from '../../chart-data/types';
4
4
  import { StackableChartDesignOptions } from './design-options';
5
- import { AxisMinMax } from './axis-section';
5
+ import { AxisMinMax, AxisSettings } from './axis-section';
6
6
  import { Stacking } from '../chart-options-service';
7
7
  import { ChartDesignOptions } from './types';
8
8
  export type LineType = 'straight' | 'smooth';
@@ -40,6 +40,10 @@ export type SeriesPointStructure = {
40
40
  drilldown?: string;
41
41
  parent?: string;
42
42
  };
43
+ export type AxisClipped = {
44
+ minClipped: boolean;
45
+ maxClipped: boolean;
46
+ };
43
47
  /**
44
48
  * Translate public-facing chart type and chart design options to internal highcharts chart type
45
49
  *
@@ -61,9 +65,13 @@ export declare const addStackingIfSpecified: (chartType: ChartType, designOption
61
65
  * @param categories -
62
66
  * @param index -
63
67
  */
64
- export declare const indexMapWhenOnlyY: (categories: string[], index: number) => (0 | -1)[];
65
- export declare const formatSeriesContinuousXAxis: (series: CategoricalSeriesValues, indexMap: number[], treatNullDataAsZeros: boolean, interval: number, maxCategories: number, dateFormatter: (time: number) => string) => HighchartsSeriesValues;
68
+ export declare const indexMapWhenOnlyY: (categories: string[], index: number) => (-1 | 0)[];
69
+ export declare const formatSeriesContinuousXAxis: (series: CategoricalSeriesValues, indexMap: number[], treatNullDataAsZeros: boolean, interval: number, maxCategories: number, dateFormatter: (time: number) => string, yAxisSettings: AxisSettings, axisClipped: AxisClipped) => HighchartsSeriesValues;
66
70
  export declare const formatSeries: (series: CategoricalSeriesValues, indexMap: number[], treatNullDataAsZeros: boolean, categories?: string[], categoryColors?: string[]) => HighchartsSeriesValues;
71
+ export declare const adjustMinMaxWhenInvalid: (explicitAxis: AxisMinMax, autoMinMax: AxisMinMax) => {
72
+ min: number;
73
+ max: number;
74
+ };
67
75
  export declare const adjustMinWhenColumnBar: (chartType: ChartType, autoMinMax: AxisMinMax) => {
68
76
  min: number;
69
77
  max: number;
@@ -1,6 +1,6 @@
1
1
  import { ChartDataOptionsInternal } from '../../chart-data-options/types';
2
2
  import { ChartType } from '../../types';
3
- import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions } from './design-options';
3
+ import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions, BoxplotChartDesignOptions, ScattermapChartDesignOptions } from './design-options';
4
4
  export declare const POLAR_CHART_TYPES: readonly ["polar"];
5
5
  export type PolarChartType = (typeof POLAR_CHART_TYPES)[number];
6
6
  export declare const CARTESIAN_CHART_TYPES: readonly ["line", "area", "bar", "column", "polar"];
@@ -18,10 +18,16 @@ export type TableType = (typeof TABLE_TYPES)[number];
18
18
  declare const INDICATOR_CHART_TYPES: readonly ["indicator"];
19
19
  /** Indicator chart types @expandType */
20
20
  export type IndicatorChartType = (typeof INDICATOR_CHART_TYPES)[number];
21
+ declare const BOXPLOT_CHART_TYPES: readonly ["boxplot"];
22
+ /** Boxplot chart types @expandType */
23
+ export type BoxplotChartType = (typeof BOXPLOT_CHART_TYPES)[number];
21
24
  declare const IMAGE_CHART_TYPES: readonly ["image"];
22
25
  export type ImageChartType = (typeof IMAGE_CHART_TYPES)[number];
26
+ export declare const SCATTERMAP_CHART_TYPES: readonly ["scattermap"];
27
+ /** Scattermap chart types @expandType */
28
+ export type ScattermapChartType = (typeof SCATTERMAP_CHART_TYPES)[number];
23
29
  export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' | 'indicator';
24
- export type ChartDesignOptions = LineChartDesignOptions | AreaChartDesignOptions | BarChartDesignOptions | ColumnChartDesignOptions | PieChartDesignOptions | FunnelChartDesignOptions | PolarChartDesignOptions | IndicatorChartDesignOptions | ScatterChartDesignOptions | TreemapChartDesignOptions;
30
+ export type ChartDesignOptions = LineChartDesignOptions | AreaChartDesignOptions | BarChartDesignOptions | ColumnChartDesignOptions | PieChartDesignOptions | FunnelChartDesignOptions | PolarChartDesignOptions | IndicatorChartDesignOptions | ScatterChartDesignOptions | TreemapChartDesignOptions | BoxplotChartDesignOptions | ScattermapChartDesignOptions;
25
31
  export type ChartConfig = {
26
32
  chartType: ChartType;
27
33
  dataOptions: ChartDataOptionsInternal;
@@ -30,7 +36,9 @@ export type ChartConfig = {
30
36
  export declare const isCartesian: (chartType: ChartType) => chartType is "area" | "line" | "bar" | "column" | "polar";
31
37
  export declare const isCategorical: (chartType: ChartType) => chartType is "pie" | "funnel" | "treemap" | "sunburst";
32
38
  export declare const isScatter: (chartType: ChartType) => chartType is "scatter";
39
+ export declare const isScattermap: (chartType: ChartType) => chartType is "scattermap";
33
40
  export declare const isIndicator: (chartType: ChartType) => chartType is "indicator";
34
41
  export declare const isPolar: (chartType: ChartType) => chartType is "polar";
35
42
  export declare const isTable: (chartType: ChartType | TableType) => chartType is "table";
43
+ export declare const isBoxplot: (chartType: ChartType) => chartType is "boxplot";
36
44
  export {};
@@ -1,3 +1,4 @@
1
+ import type { DataLabelsOptions } from '@sisense/sisense-charts';
1
2
  import { Style } from '../chart-options-service';
2
3
  import { NumberFormatConfig } from './number-format-config';
3
4
  import { AxisOrientation } from './axis-section';
@@ -21,7 +22,7 @@ export type ValueLabelSettings = {
21
22
  relative: boolean;
22
23
  totals: boolean;
23
24
  };
24
- formatter?: (this: InternalSeries) => string;
25
+ formatter?: (this: InternalSeries, options?: DataLabelsOptions, valuePropName?: string) => string;
25
26
  };
26
27
  export declare const createValueLabelFormatter: (numberFormatConfig?: NumberFormatConfig) => (this: InternalSeries) => string;
27
28
  export declare const getValueLabelSettings: (xAxisOrientation: AxisOrientation, valueLabel: ValueLabel, inside?: boolean) => ValueLabelSettings;
package/dist/chart.d.ts CHANGED
@@ -14,10 +14,10 @@ export declare const shouldSkipSisenseContextWaiting: (props: ChartProps) => boo
14
14
  * dataSet={DM.DataSource}
15
15
  * dataOptions={{
16
16
  * category: [DM.Commerce.AgeRange],
17
- * value: [measures.sum(DM.Commerce.Revenue)],
17
+ * value: [measureFactory.sum(DM.Commerce.Revenue)],
18
18
  * breakBy: [DM.Commerce.Gender],
19
19
  * }}
20
- * filters={[filters.members(DM.Commerce.Gender,['Female', 'Male'])]}
20
+ * filters={[filterFactory.members(DM.Commerce.Gender,['Female', 'Male'])]}
21
21
  * onDataPointClick= {(point, nativeEvent) => { console.log('clicked', point, nativeEvent); }}
22
22
  * />
23
23
  * ```
@@ -1,9 +1,9 @@
1
- import { IndicatorDataOptions } from '../../chart-data-options/types';
1
+ import { IndicatorChartDataOptions } from '../../chart-data-options/types';
2
2
  import { IndicatorChartDesignOptions } from '../../chart-options-processor/translations/design-options';
3
3
  import { IndicatorChartData } from '../../chart-data/types';
4
4
  import { LegacyIndicatorChartTypes } from './types';
5
5
  export type IndicatorLegacyChartDataOptions = ReturnType<typeof createLegacyChartDataOptions>;
6
- export declare const createLegacyChartDataOptions: (chartData: IndicatorChartData, chartDesignOptions: IndicatorChartDesignOptions, chartDataOptions: IndicatorDataOptions) => {
6
+ export declare const createLegacyChartDataOptions: (chartData: IndicatorChartData, chartDesignOptions: IndicatorChartDesignOptions, chartDataOptions: IndicatorChartDataOptions) => {
7
7
  type: LegacyIndicatorChartTypes;
8
8
  skin: 1 | 2 | "vertical" | "horizontal";
9
9
  title: {
@@ -1,10 +1,10 @@
1
1
  import { IndicatorStyleType, NumericIndicatorSubType } from '../../../chart-options-processor/translations/design-options';
2
- import { IndicatorDataOptions, ThemeSettings } from '../../../types';
2
+ import { IndicatorChartDataOptions, ThemeSettings } from '../../../types';
3
3
  import { LegacyIndicatorChartOptions } from '../types';
4
4
  import { IndicatorChartData } from '../../../chart-data/types';
5
5
  export type ChartRenderingOptions = {
6
6
  chartData: IndicatorChartData;
7
- dataOptions: IndicatorDataOptions;
7
+ dataOptions: IndicatorChartDataOptions;
8
8
  themeSettings?: ThemeSettings;
9
9
  };
10
10
  export type IndicatorTypeOptions = {
@@ -1,4 +1,4 @@
1
- import { IndicatorDataOptions, ConditionalDataColorOptions, DataColorOptions, UniformDataColorOptions } from '../../../types';
1
+ import { IndicatorChartDataOptions, ConditionalDataColorOptions, DataColorOptions, UniformDataColorOptions } from '../../../types';
2
2
  import { LegacyIndicatorChartOptions } from '../types';
3
3
  import { IndicatorTypeOptions } from './indicator-legacy-chart-options';
4
4
  /**
@@ -15,7 +15,7 @@ export type AllowedIndicatorColoringTypes = 'Static' | 'Absolute';
15
15
  * @param dataOptions - The indicator data options to extract the color options from.
16
16
  * @returns The color options from the indicator data options.
17
17
  */
18
- export declare function getValueColorOptions(dataOptions: IndicatorDataOptions): DataColorOptions | undefined;
18
+ export declare function getValueColorOptions(dataOptions: IndicatorChartDataOptions): DataColorOptions | undefined;
19
19
  /**
20
20
  * Overrides the value color in the legacy indicator chart options with the specified color.
21
21
  *
@@ -0,0 +1,3 @@
1
+ import { Location } from '../types.js';
2
+ import { ScattermapLocationLevel } from '../../../chart-data-options/types.js';
3
+ export declare const useLocations: (locationsNames: string[], locationLevel: ScattermapLocationLevel) => Location[] | null;
@@ -0,0 +1,5 @@
1
+ type GeoSettings = {
2
+ maps_api_provider: string;
3
+ };
4
+ export declare const useGeoSettings: () => GeoSettings | null;
5
+ export {};
@@ -0,0 +1,14 @@
1
+ import { ScattermapChartLocation } from '../../../chart-data/types';
2
+ import { ScattermapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
3
+ import { DataSource, Filter } from '@sisense/sdk-data';
4
+ export type TooltipOptions = {
5
+ content: string;
6
+ postponedContent?: Promise<string>;
7
+ };
8
+ type TooltipHandler = (location: ScattermapChartLocation) => TooltipOptions;
9
+ export declare const useTooltipHandler: ({ dataOptions, dataSource, filters, }: {
10
+ dataOptions: ScattermapChartDataOptionsInternal;
11
+ dataSource: DataSource | null;
12
+ filters?: Filter[] | undefined;
13
+ }) => TooltipHandler;
14
+ export {};
@@ -0,0 +1,13 @@
1
+ /// <reference types="react" />
2
+ import { ScattermapChartData } from '../../chart-data/types.js';
3
+ import { ScattermapChartDataOptionsInternal } from '../../chart-data-options/types.js';
4
+ import { ScattermapChartDesignOptions } from '../../chart-options-processor/translations/design-options.js';
5
+ import { DataSource, Filter, FilterRelation } from '@sisense/sdk-data';
6
+ export type ScattermapProps = {
7
+ chartData: ScattermapChartData;
8
+ dataOptions: ScattermapChartDataOptionsInternal;
9
+ designOptions: ScattermapChartDesignOptions;
10
+ dataSource: DataSource | null;
11
+ filters?: Filter[] | FilterRelation;
12
+ };
13
+ export declare const Scattermap: ({ chartData, dataOptions, dataSource, filters, designOptions, }: ScattermapProps) => JSX.Element;
@@ -0,0 +1,16 @@
1
+ export type Coordinates = {
2
+ lat: number;
3
+ lng: number;
4
+ };
5
+ export type Location = {
6
+ _id: string;
7
+ lookupKey: string;
8
+ placetype: null | string;
9
+ context: null | string;
10
+ err: null | string;
11
+ latLng: Coordinates;
12
+ name: string;
13
+ place_name: string;
14
+ text: string;
15
+ version: string;
16
+ };
@@ -0,0 +1,3 @@
1
+ import { ScattermapChartLocation } from '../../../chart-data/types.js';
2
+ import { DataColorOptions } from '../../../types.js';
3
+ export declare function getLocationsMarkerColors(locations: ScattermapChartLocation[], colorOptions?: DataColorOptions): string[];
@@ -0,0 +1,2 @@
1
+ import leaflet from 'leaflet';
2
+ export declare function addCopyright(map: leaflet.Map, mapUrl: string): leaflet.Control.Attribution;
@@ -0,0 +1,5 @@
1
+ import { ScattermapLocationLevel } from 'packages/sdk-ui/src/chart-data-options/types';
2
+ export declare const LOCATION_DELIMITER = ",";
3
+ export declare function combineLocationNames(names: string[]): string;
4
+ export declare function splitLocationName(combinedLocation: string): string[];
5
+ export declare function getLocationGeoLevel(level: ScattermapLocationLevel): "country" | "city" | "adm" | undefined;
@@ -0,0 +1,2 @@
1
+ import leaflet from 'leaflet';
2
+ export declare function fitMapToBounds(map: leaflet.Map, markers: leaflet.CircleMarker[]): void;
@@ -0,0 +1,28 @@
1
+ import leaflet from 'leaflet';
2
+ import { ScattermapMarkers } from 'packages/sdk-ui/src/types';
3
+ type PrepareMarkerOptionsProps = {
4
+ color: string;
5
+ size: number;
6
+ fill: Required<ScattermapMarkers>['fill'];
7
+ blur: boolean;
8
+ };
9
+ type CreateMarkerProps = {
10
+ coordinates: {
11
+ lat: number;
12
+ lng: number;
13
+ };
14
+ style: PrepareMarkerOptionsProps;
15
+ };
16
+ export declare function prepareMarkerOptions(style: PrepareMarkerOptionsProps): {
17
+ radius: number;
18
+ fillOpacity: number;
19
+ opacity: number;
20
+ fillColor: string;
21
+ color: string;
22
+ stroke: boolean;
23
+ weight: number;
24
+ customStyle: PrepareMarkerOptionsProps;
25
+ };
26
+ export declare function createMarker({ coordinates, style }: CreateMarkerProps): leaflet.CircleMarker<any>;
27
+ export declare function removeMarkers(markers: leaflet.CircleMarker[]): void;
28
+ export {};