@sisense/sdk-ui 1.10.1 → 1.11.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 (75) hide show
  1. package/dist/ai/ai-context-provider.d.ts +1 -1
  2. package/dist/ai/chatbot.d.ts +1 -1
  3. package/dist/ai/common/beta-label.d.ts +1 -0
  4. package/dist/ai/get-nlg-query-result.d.ts +1 -1
  5. package/dist/ai/messages/get-widget-options.d.ts +6 -1
  6. package/dist/ai/use-get-nlg-query-result.d.ts +1 -1
  7. package/dist/ai/use-get-query-recommendations.d.ts +1 -1
  8. package/dist/ai.js +531 -483
  9. package/dist/api/types/dashboard-dto.d.ts +3 -3
  10. package/dist/area-range-chart.d.ts +67 -0
  11. package/dist/areamap-chart.d.ts +0 -1
  12. package/dist/boxplot-chart.d.ts +0 -1
  13. package/dist/chart/chart.d.ts +0 -2
  14. package/dist/chart/helpers/should-skip-sisense-context-waiting.d.ts +3 -0
  15. package/dist/chart/helpers/use-chart-renderer-props.d.ts +27 -0
  16. package/dist/chart/regular-chart.d.ts +7 -0
  17. package/dist/chart/types.d.ts +21 -0
  18. package/dist/chart-data/range-data.d.ts +11 -0
  19. package/dist/chart-data/types.d.ts +15 -1
  20. package/dist/chart-data-options/translate-range-data-options.d.ts +2 -0
  21. package/dist/chart-data-options/types.d.ts +56 -4
  22. package/dist/chart-data-processor/data-table-date-period.d.ts +0 -1
  23. package/dist/chart-options-processor/chart-options-service.d.ts +5 -0
  24. package/dist/chart-options-processor/range-chart-options.d.ts +17 -0
  25. package/dist/chart-options-processor/translations/design-options.d.ts +55 -7
  26. package/dist/chart-options-processor/translations/range/tooltip-range.d.ts +4 -0
  27. package/dist/chart-options-processor/translations/tooltip-utils.d.ts +3 -0
  28. package/dist/chart-options-processor/translations/types.d.ts +12 -6
  29. package/dist/charts/map-charts/areamap/areamap.d.ts +2 -3
  30. package/dist/charts/map-charts/scattermap/scattermap.d.ts +2 -1
  31. package/dist/charts/table/helpers/calc-column-widths.d.ts +1 -0
  32. package/dist/charts/table/styles/style-constants.d.ts +1 -0
  33. package/dist/charts/table/types.d.ts +13 -4
  34. package/dist/dashboard-widget/translate-widget-filters.d.ts +664 -4
  35. package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts +1 -1
  36. package/dist/dashboard-widget/utils.d.ts +2 -2
  37. package/dist/{debounce-CVvJ1016.js → debounce-BbwkW3DX.js} +34680 -34541
  38. package/dist/decorators/component-decorators/as-sisense-component.d.ts +6 -2
  39. package/dist/decorators/component-decorators/with-tracking/use-track-component-init.d.ts +2 -1
  40. package/dist/decorators/component-decorators/with-tracking/with-tracking.d.ts +4 -1
  41. package/dist/filters/components/common/basic-input.d.ts +0 -1
  42. package/dist/filters/components/filters-panel/filters-panel-tile.d.ts +18 -0
  43. package/dist/filters/components/filters-panel/filters-panel.d.ts +18 -0
  44. package/dist/filters/components/filters-panel/index.d.ts +2 -0
  45. package/dist/filters/components/member-filter-tile/basic-member-filter-tile.d.ts +3 -1
  46. package/dist/filters/components/member-filter-tile/use-members.d.ts +1 -1
  47. package/dist/filters/index.d.ts +1 -0
  48. package/dist/index.d.ts +1 -0
  49. package/dist/index.js +16387 -17876
  50. package/dist/indicator-canvas.d.ts +2 -3
  51. package/dist/models/dashboard/get-dashboard-model.d.ts +8 -0
  52. package/dist/models/dashboard/translate-dashboard.d.ts +1 -1
  53. package/dist/models/dashboard/types.d.ts +3 -1
  54. package/dist/models/widget/widget-model.d.ts +3 -3
  55. package/dist/pivot-table/formatters/header-cell-formatters/header-cell-highlight-formatter.d.ts +2 -0
  56. package/dist/pivot-table/formatters/types.d.ts +2 -2
  57. package/dist/pivot-table/helpers/prepare-pivot-styling-props.d.ts +1 -0
  58. package/dist/pivot-table/pivot-table.d.ts +1 -1
  59. package/dist/pivot-table/use-get-pivot-table-query.d.ts +2 -1
  60. package/dist/props.d.ts +57 -2
  61. package/dist/query/date-formats/apply-date-format.d.ts +0 -1
  62. package/dist/query/query-result-date-formatting.d.ts +0 -1
  63. package/dist/query-execution/types.d.ts +11 -1
  64. package/dist/query-execution/use-execute-pivot-query.d.ts +1 -1
  65. package/dist/scattermap-chart.d.ts +0 -1
  66. package/dist/sisense-chart/sisense-chart.d.ts +8 -5
  67. package/dist/table/table-component.d.ts +8 -0
  68. package/dist/table/table.d.ts +2 -2
  69. package/dist/table/translations/design-options.d.ts +3 -0
  70. package/dist/translation/resources/en.d.ts +11 -1
  71. package/dist/translation/resources/index.d.ts +22 -2
  72. package/dist/types.d.ts +72 -7
  73. package/dist/utils/check-and-notify-about-deprecated-prop.d.ts +1 -0
  74. package/dist/widgets/drilldown-widget.d.ts +2 -1
  75. package/package.json +7 -7
@@ -2,15 +2,14 @@ import { IndicatorChartDataOptionsInternal } from './chart-data-options/types';
2
2
  import { type FunctionComponent } from 'react';
3
3
  import { IndicatorChartData } from './chart-data/types';
4
4
  import { IndicatorChartDesignOptions } from './chart-options-processor/translations/design-options';
5
- import { ThemeSettings } from './types';
5
+ import { ChartRendererProps } from './chart/types';
6
6
  export interface IndicatorCanvasProps {
7
7
  chartData: IndicatorChartData;
8
8
  dataOptions: IndicatorChartDataOptionsInternal;
9
9
  designOptions: IndicatorChartDesignOptions;
10
- themeSettings?: ThemeSettings;
11
10
  }
12
11
  /**
13
12
  * @internal
14
13
  */
15
14
  export declare const IndicatorCanvas: FunctionComponent<IndicatorCanvasProps>;
16
- export declare const isIndicatorCanvasProps: (chartData: IndicatorCanvasProps) => boolean;
15
+ export declare const isIndicatorCanvasProps: (props: ChartRendererProps) => props is IndicatorCanvasProps;
@@ -6,6 +6,14 @@ export interface GetDashboardModelOptions {
6
6
  * If not specified, the default value is `false`
7
7
  */
8
8
  includeWidgets?: boolean;
9
+ /**
10
+ * Boolean flag whether to include filters in the dashboard model
11
+ *
12
+ * If not specified, the default value is `false`
13
+ *
14
+ * @internal
15
+ */
16
+ includeFilters?: boolean;
9
17
  }
10
18
  /** @internal */
11
19
  export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions): Promise<import("./types").DashboardModel>;
@@ -1,4 +1,4 @@
1
1
  import type { DashboardDto, Layout as SisenseLayout } from '../../api/types/dashboard-dto';
2
2
  import type { Layout, DashboardModel } from './types';
3
3
  export declare const translateLayout: (layout: SisenseLayout) => Layout;
4
- export declare function translateDashboard({ oid, title, datasource, widgets, layout, }: DashboardDto): DashboardModel;
4
+ export declare function translateDashboard({ oid, title, datasource, widgets, layout, filters, }: DashboardDto): DashboardModel;
@@ -1,4 +1,4 @@
1
- import { type DataSource } from '@sisense/sdk-data';
1
+ import { type DataSource, Filter } from '@sisense/sdk-data';
2
2
  import { WidgetModel } from '../widget/widget-model';
3
3
  /** @internal */
4
4
  export interface Layout {
@@ -20,4 +20,6 @@ export type DashboardModel = {
20
20
  widgets?: WidgetModel[];
21
21
  /** @internal */
22
22
  layout?: Layout;
23
+ /** @internal */
24
+ filters?: Filter[];
23
25
  };
@@ -1,5 +1,5 @@
1
1
  import { Filter } from '@sisense/sdk-data';
2
- import { ChartDataOptions, PivotTableDataOptions, TableDataOptions } from '../../chart-data-options/types';
2
+ import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
3
3
  import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
4
4
  import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps } from '../../props';
5
5
  import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
@@ -7,7 +7,7 @@ import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, Comp
7
7
  /**
8
8
  * Widget data options.
9
9
  */
10
- export type WidgetDataOptions = ChartDataOptions | TableDataOptions | PivotTableDataOptions;
10
+ export type WidgetDataOptions = ChartDataOptions | PivotTableDataOptions;
11
11
  /**
12
12
  * Model of Sisense widget defined in the abstractions of Compose SDK.
13
13
  *
@@ -144,7 +144,7 @@ export declare class WidgetModel {
144
144
  * <ChartWidget {...widget.getChartWidgetProps()} />
145
145
  * ```
146
146
  *
147
- * Note: this method is not supported for tabular widgets.
147
+ * Note: this method is not supported for pivot widgets.
148
148
  */
149
149
  getChartWidgetProps(): ChartWidgetProps;
150
150
  /**
@@ -0,0 +1,2 @@
1
+ import type { HeaderCellFormatter } from '../types.js';
2
+ export declare const createHeaderCellHighlightFormatter: () => HeaderCellFormatter;
@@ -1,4 +1,4 @@
1
- import type { JaqlPanel, PivotDataNode, PivotTreeNode } from '@sisense/sdk-pivot-client';
1
+ import type { JaqlPanel, JaqlRequest, PivotDataNode, PivotTreeNode } from '@sisense/sdk-pivot-client';
2
2
  export type DataCellFormatter = (cell: PivotDataNode, rowItem: PivotTreeNode, columnItem: PivotTreeNode, jaqlPanelItem: JaqlPanel) => void;
3
- export type HeaderCellFormatter = (cell: PivotTreeNode, jaqlPanelItem: JaqlPanel) => void;
3
+ export type HeaderCellFormatter = (cell: PivotTreeNode, jaqlPanelItem: JaqlPanel, jaql: JaqlRequest) => void;
4
4
  export type DateFormatter = (date: Date, format: string) => string;
@@ -17,4 +17,5 @@ export declare function preparePivotStylingProps(styleOptions?: PivotTableStyleO
17
17
  isAutoHeight: boolean;
18
18
  navigationPrimaryColor: string | undefined;
19
19
  navigationSecondaryColor: string | undefined;
20
+ selectionColor: string;
20
21
  };
@@ -78,6 +78,6 @@ import { PivotTableProps } from '../props';
78
78
  * @param props - Pivot Table properties
79
79
  * @returns Pivot Table component
80
80
  * @group Data Grids
81
- * @alpha
81
+ * @beta
82
82
  */
83
83
  export declare const PivotTable: React.FunctionComponent<PivotTableProps>;
@@ -8,10 +8,11 @@ export declare const getPivotQueryOptions: (dataOptions: PivotTableDataOptionsIn
8
8
  *
9
9
  * @internal
10
10
  */
11
- export declare const useGetPivotTableQuery: ({ dataSet, dataOptionsInternal, filters, refreshCounter, }: {
11
+ export declare const useGetPivotTableQuery: ({ dataSet, dataOptionsInternal, filters, highlights, refreshCounter, }: {
12
12
  dataSet?: DataSource | undefined;
13
13
  dataOptionsInternal: PivotTableDataOptionsInternal;
14
14
  filters?: Filter[] | FilterRelations | undefined;
15
+ highlights?: Filter[] | undefined;
15
16
  refreshCounter?: number | undefined;
16
17
  }) => {
17
18
  isLoading: boolean;
package/dist/props.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
2
- import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions } from './types';
2
+ import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions } from './types';
3
3
  import { HighchartsOptions } from './chart-options-processor/chart-options-service';
4
4
  import { ComponentType, PropsWithChildren, ReactNode } from 'react';
5
- import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions } from './chart-data-options/types';
5
+ import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
6
6
  import { AppConfig } from './app/client-application';
7
7
  import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
8
8
  import { FiltersMergeStrategy } from './dashboard-widget/types';
@@ -100,6 +100,12 @@ export interface ExecuteQueryProps {
100
100
  count?: number;
101
101
  /** {@inheritDoc ExecuteQueryParams.offset} */
102
102
  offset?: number;
103
+ /**
104
+ * {@inheritDoc ExecuteQueryParams.ungroup}
105
+ *
106
+ * @internal
107
+ */
108
+ ungroup?: boolean;
103
109
  /** Function as child component that is called to render the query results */
104
110
  children?: (queryResult: ExecuteQueryResult) => ReactNode;
105
111
  /** Callback function that is evaluated when query results are ready */
@@ -486,6 +492,26 @@ export interface ChartProps extends BaseChartProps, ChartEventProps {
486
492
  */
487
493
  refreshCounter?: number;
488
494
  }
495
+ /**
496
+ * Props of the {@link RegularChart} component.
497
+ *
498
+ * @internal
499
+ */
500
+ export interface RegularChartProps extends ChartProps {
501
+ chartType: RegularChartType;
502
+ dataOptions: RegularChartDataOptions;
503
+ styleOptions?: RegularChartStyleOptions;
504
+ }
505
+ /**
506
+ * Props of the tabular charts ({@link TableComponent}).
507
+ *
508
+ * @internal
509
+ */
510
+ export interface TabularChartProps extends ChartProps {
511
+ chartType: 'table';
512
+ dataOptions: TabularChartDataOptions;
513
+ styleOptions?: TabularChartStyleOptions;
514
+ }
489
515
  /**
490
516
  * Props of the {@link AreaChart} component.
491
517
  */
@@ -698,6 +724,12 @@ export interface PivotTableProps {
698
724
  * @category Data
699
725
  */
700
726
  filters?: Filter[] | FilterRelations;
727
+ /**
728
+ * Filters that will highlight query results
729
+ *
730
+ * @category Data
731
+ */
732
+ highlights?: Filter[];
701
733
  /**
702
734
  * Configurations for how to style and present a pivot table's data.
703
735
  *
@@ -978,6 +1010,12 @@ export interface PivotTableWidgetProps {
978
1010
  * @category Data
979
1011
  */
980
1012
  filters?: Filter[] | FilterRelations;
1013
+ /**
1014
+ * Filters that will highlight query results
1015
+ *
1016
+ * @category Data
1017
+ */
1018
+ highlights?: Filter[];
981
1019
  /**
982
1020
  * Configurations for how to interpret and present the data passed to the table
983
1021
  *
@@ -1134,6 +1172,23 @@ export interface AreamapChartProps extends BaseChartProps, AreamapChartEventProp
1134
1172
  */
1135
1173
  styleOptions?: AreamapStyleOptions;
1136
1174
  }
1175
+ /**
1176
+ * Props of the {@link AreaRangeChart} component.
1177
+ */
1178
+ export interface AreaRangeChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
1179
+ /**
1180
+ * Configurations for how to interpret and present the data passed to the chart
1181
+ *
1182
+ * @category Chart
1183
+ */
1184
+ dataOptions: RangeChartDataOptions;
1185
+ /**
1186
+ * Configurations for how to style and present a chart's data.
1187
+ *
1188
+ * @category Chart
1189
+ */
1190
+ styleOptions?: AreaRangeStyleOptions;
1191
+ }
1137
1192
  /**
1138
1193
  * Props for ContextMenu component.
1139
1194
  */
@@ -1,4 +1,3 @@
1
- import type { Locale } from 'date-fns';
2
1
  export type DateFormat = string;
3
2
  declare const dateLevels: readonly ["years", "quarters", "months", "weeks", "days", "dateAndTime", "minutes"];
4
3
  /** @expandType */
@@ -1,4 +1,3 @@
1
- import type { Locale } from 'date-fns';
2
1
  import { Data } from '@sisense/sdk-data';
3
2
  import type { DateConfig } from './date-formats';
4
3
  import type { QueryResultData } from '@sisense/sdk-data';
@@ -194,6 +194,16 @@ export interface ExecuteQueryParams {
194
194
  * If not specified, the default value is `true`
195
195
  */
196
196
  enabled?: boolean;
197
+ /**
198
+ * Boolean flag whether to include `ungroup: true` in non-aggregated JAQL queries.
199
+ *
200
+ * This improves computation and performance of querying huge tables when no aggregation is needed
201
+ *
202
+ * If not specified, the default value is `false`
203
+ *
204
+ * @internal
205
+ */
206
+ ungroup?: boolean;
197
207
  /**
198
208
  * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
199
209
  *
@@ -326,7 +336,7 @@ export interface ExecutePivotQueryParams {
326
336
  */
327
337
  filters?: Filter[] | FilterRelations;
328
338
  /**
329
- * Highlight filters that will highlight results that pass filter criteria
339
+ * Filters that will highlight query results
330
340
  *
331
341
  * @category Filtering
332
342
  */
@@ -17,7 +17,7 @@ import { ExecutePivotQueryParams, PivotQueryState } from './types';
17
17
  * @param params - Parameters of the query
18
18
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
19
19
  * @group Queries
20
- * @alpha
20
+ * @beta
21
21
  */
22
22
  export declare const useExecutePivotQuery: (params: ExecutePivotQueryParams) => PivotQueryState;
23
23
  /**
@@ -17,6 +17,5 @@ import { ScattermapChartProps } from './props';
17
17
  * @param props - Scattermap chart properties
18
18
  * @returns Scattermap Chart component
19
19
  * @group Charts
20
- * @beta
21
20
  */
22
21
  export declare const ScattermapChart: import("react").FunctionComponent<ScattermapChartProps>;
@@ -1,15 +1,15 @@
1
1
  import { ChartDataOptionsInternal } from '../chart-data-options/types';
2
2
  import { ChartData } from '../chart-data/types';
3
3
  import { BeforeRenderHandler } from '../props';
4
- import { ChartDesignOptions } from '../chart-options-processor/translations/types';
5
- import { ChartType, CompleteThemeSettings } from '../types';
4
+ import { BoxplotChartType, CartesianChartType, CategoricalChartType, ChartDesignOptions, ScatterChartType } from '../chart-options-processor/translations/types';
5
+ import { ChartType } from '../types';
6
6
  import { SisenseChartDataPointEventHandler, SisenseChartDataPointsEventHandler } from './types';
7
+ import { ChartRendererProps } from '../chart/types';
7
8
  export interface SisenseChartProps {
8
- chartType: ChartType;
9
+ chartType: SisenseChartType;
9
10
  chartData: ChartData;
10
11
  dataOptions: ChartDataOptionsInternal;
11
12
  designOptions: ChartDesignOptions;
12
- themeSettings?: CompleteThemeSettings;
13
13
  onDataPointClick?: SisenseChartDataPointEventHandler;
14
14
  onDataPointContextMenu?: SisenseChartDataPointEventHandler;
15
15
  onDataPointsSelected?: SisenseChartDataPointsEventHandler;
@@ -18,4 +18,7 @@ export interface SisenseChartProps {
18
18
  /**
19
19
  * @internal
20
20
  */
21
- export declare const SisenseChart: ({ chartType, chartData, dataOptions, designOptions, themeSettings, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, }: SisenseChartProps) => import("react/jsx-runtime").JSX.Element | null;
21
+ export declare const SisenseChart: ({ chartType, chartData, dataOptions, designOptions, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, }: SisenseChartProps) => import("react/jsx-runtime").JSX.Element | null;
22
+ export declare const isSisenseChartType: (chartType: ChartType) => chartType is SisenseChartType;
23
+ export type SisenseChartType = CartesianChartType | CategoricalChartType | ScatterChartType | BoxplotChartType;
24
+ export declare const isSisenseChartProps: (props: ChartRendererProps) => props is SisenseChartProps;
@@ -0,0 +1,8 @@
1
+ import { TableProps } from '../props';
2
+ /**
3
+ * Component that renders a table with aggregation and pagination.
4
+ */
5
+ export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, refreshCounter, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;
6
+ export declare const DEFAULT_TABLE_ROWS_PER_PAGE: 25;
7
+ /** How many pages of data will be loaded in one query */
8
+ export declare const PAGES_BATCH_SIZE = 10;
@@ -1,4 +1,4 @@
1
- import React from 'react';
1
+ /// <reference types="react" />
2
2
  import { TableProps } from '../props';
3
3
  /**
4
4
  * Table with aggregation and pagination.
@@ -18,7 +18,7 @@ import { TableProps } from '../props';
18
18
  * @returns Table component
19
19
  * @group Data Grids
20
20
  */
21
- export declare const Table: React.FunctionComponent<TableProps>;
21
+ export declare const Table: import("react").FunctionComponent<TableProps>;
22
22
  export declare const DEFAULT_TABLE_ROWS_PER_PAGE: 25;
23
23
  /** How many pages of data will be loaded in one query */
24
24
  export declare const PAGES_BATCH_SIZE = 10;
@@ -0,0 +1,3 @@
1
+ import { TableStyleOptions } from '../../types';
2
+ import { TableDesignOptions } from '../../chart-options-processor/translations/design-options';
3
+ export declare const translateTableStyleOptionsToDesignOptions: (styleOptions: TableStyleOptions) => TableDesignOptions;
@@ -20,6 +20,7 @@ export declare const translation: {
20
20
  themeNotFound: string;
21
21
  paletteNotFound: string;
22
22
  chartTypeNotSupported: string;
23
+ chartInvalidProps: string;
23
24
  unsupportedWidgetType: string;
24
25
  sisenseContextNotFound: string;
25
26
  dashboardInvalidIdentifier: string;
@@ -28,7 +29,6 @@ export declare const translation: {
28
29
  failedToFetch: string;
29
30
  };
30
31
  widgetModel: {
31
- tabularWidgetNotSupported: string;
32
32
  pivotWidgetNotSupported: string;
33
33
  onlyTableWidgetSupported: string;
34
34
  onlyPivotWidgetSupported: string;
@@ -85,5 +85,15 @@ export declare const translation: {
85
85
  max: string;
86
86
  };
87
87
  };
88
+ arearange: {
89
+ tooltip: {
90
+ min: string;
91
+ max: string;
92
+ };
93
+ };
94
+ unsupportedFilter: {
95
+ title: string;
96
+ message: string;
97
+ };
88
98
  };
89
99
  export type TranslationDictionary = typeof translation;
@@ -24,6 +24,7 @@ export declare const resources: {
24
24
  themeNotFound: string;
25
25
  paletteNotFound: string;
26
26
  chartTypeNotSupported: string;
27
+ chartInvalidProps: string;
27
28
  unsupportedWidgetType: string;
28
29
  sisenseContextNotFound: string;
29
30
  dashboardInvalidIdentifier: string;
@@ -32,7 +33,6 @@ export declare const resources: {
32
33
  failedToFetch: string;
33
34
  };
34
35
  widgetModel: {
35
- tabularWidgetNotSupported: string;
36
36
  pivotWidgetNotSupported: string;
37
37
  onlyTableWidgetSupported: string;
38
38
  onlyPivotWidgetSupported: string;
@@ -89,6 +89,16 @@ export declare const resources: {
89
89
  max: string;
90
90
  };
91
91
  };
92
+ arearange: {
93
+ tooltip: {
94
+ min: string;
95
+ max: string;
96
+ };
97
+ };
98
+ unsupportedFilter: {
99
+ title: string;
100
+ message: string;
101
+ };
92
102
  };
93
103
  uk: {
94
104
  errors: {
@@ -112,6 +122,7 @@ export declare const resources: {
112
122
  themeNotFound: string;
113
123
  paletteNotFound: string;
114
124
  chartTypeNotSupported: string;
125
+ chartInvalidProps: string;
115
126
  unsupportedWidgetType: string;
116
127
  sisenseContextNotFound: string;
117
128
  dashboardInvalidIdentifier: string;
@@ -120,7 +131,6 @@ export declare const resources: {
120
131
  failedToFetch: string;
121
132
  };
122
133
  widgetModel: {
123
- tabularWidgetNotSupported: string;
124
134
  pivotWidgetNotSupported: string;
125
135
  onlyTableWidgetSupported: string;
126
136
  onlyPivotWidgetSupported: string;
@@ -177,5 +187,15 @@ export declare const resources: {
177
187
  max: string;
178
188
  };
179
189
  };
190
+ arearange: {
191
+ tooltip: {
192
+ min: string;
193
+ max: string;
194
+ };
195
+ };
196
+ unsupportedFilter: {
197
+ title: string;
198
+ message: string;
199
+ };
180
200
  };
181
201
  };
package/dist/types.d.ts CHANGED
@@ -2,10 +2,10 @@
2
2
  import type { Attribute, MembersFilter } from '@sisense/sdk-data';
3
3
  import { DeepRequired } from 'ts-essentials';
4
4
  import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype } from './chart-options-processor/subtype-to-design-options';
5
- import { IndicatorComponents } from './chart-options-processor/translations/design-options';
5
+ import { IndicatorComponents, TableColorOptions } from './chart-options-processor/translations/design-options';
6
6
  import { FunnelDirection, FunnelSize, FunnelType } from './chart-options-processor/translations/funnel-plot-options';
7
7
  import { ScatterMarkerSize } from './chart-options-processor/translations/scatter-plot-options';
8
- import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType } from './chart-options-processor/translations/types';
8
+ import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType, RangeChartType, TableChartType } from './chart-options-processor/translations/types';
9
9
  import { DataPointsEventHandler } from './props';
10
10
  import { LegendPosition } from './chart-options-processor/translations/legend-section';
11
11
  import { GeoDataElement, RawGeoDataElement } from './chart-data/types';
@@ -15,7 +15,7 @@ export type { AppConfig } from './app/client-application';
15
15
  export type { DateConfig } from './query/date-formats';
16
16
  export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
17
17
  export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
18
- export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, };
18
+ export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, TableChartType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, };
19
19
  export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
20
20
  /**
21
21
  * @internal
@@ -213,6 +213,10 @@ export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
213
213
  /** Subtype of LineChart */
214
214
  subtype?: LineSubtype;
215
215
  }
216
+ /** Configuration options that define functional style of the various elements of AreaRangeChart */
217
+ export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
218
+ lineWidth?: LineWidth;
219
+ }
216
220
  /** Configuration options that define functional style of the various elements of AreaChart */
217
221
  export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
218
222
  /** Configuration that defines line width */
@@ -279,16 +283,34 @@ export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | Numeri
279
283
  export interface TableStyleOptions {
280
284
  /**
281
285
  * Boolean flag whether to fill header cells with background color
286
+ *
287
+ * @deprecated Use {@link TableStyleOptions#header | TableStyleOptions.header.color} instead.
282
288
  */
283
289
  headersColor?: boolean;
284
290
  /**
285
291
  * Boolean flag whether to apply background color to alternate rows.
292
+ *
293
+ * @deprecated Use {@link TableStyleOptions#rows | TableStyleOptions.rows.alternatingColor} instead.
286
294
  */
287
295
  alternatingRowsColor?: boolean;
288
296
  /**
289
297
  * Boolean flag whether to apply background color to alternate columns
298
+ *
299
+ * @deprecated Use {@link TableStyleOptions#columns | TableStyleOptions.columns.alternatingColor} instead.
290
300
  */
291
301
  alternatingColumnsColor?: boolean;
302
+ /**
303
+ * Vertical padding around whole table
304
+ * Default value is 20px
305
+ *
306
+ */
307
+ paddingVertical?: number;
308
+ /**
309
+ * Horizontal padding around whole table
310
+ * Default value is 20px
311
+ *
312
+ */
313
+ paddingHorizontal?: number;
292
314
  /**
293
315
  * Number of rows per page
294
316
  *
@@ -313,8 +335,43 @@ export interface TableStyleOptions {
313
335
  * 3. Default value of 500px (for component without header) or 525px (for component with header).
314
336
  */
315
337
  height?: number;
338
+ /**
339
+ * Header options
340
+ */
341
+ header?: {
342
+ /**
343
+ * Color of header
344
+ */
345
+ color?: TableColorOptions;
346
+ };
347
+ /**
348
+ * Columns options
349
+ */
350
+ columns?: {
351
+ /**
352
+ * Alternating color for columns
353
+ */
354
+ alternatingColor?: TableColorOptions;
355
+ /**
356
+ * Modes of columns width
357
+ * 'auto' - all columns will have the same width and fit the table width (no horizontal scroll)
358
+ * 'content' - columns width will be based on content (default option)
359
+ */
360
+ width?: 'auto' | 'content';
361
+ };
362
+ /**
363
+ * Rows options
364
+ */
365
+ rows?: {
366
+ /**
367
+ * Alternating color for rows
368
+ */
369
+ alternatingColor?: TableColorOptions;
370
+ };
316
371
  }
317
- /** Configuration options that define functional style of the various elements of the PivotTable component */
372
+ /** Configuration options that define functional style of the various elements of the tabular charts. */
373
+ export type TabularChartStyleOptions = TableStyleOptions;
374
+ /** Configuration options that define functional style of the various elements of the PivotTable component. */
318
375
  export interface PivotTableStyleOptions {
319
376
  /**
320
377
  * Boolean flag whether to fill header cells with background color
@@ -368,6 +425,10 @@ export interface PivotTableStyleOptions {
368
425
  * Manual height of each row (default is 25px)
369
426
  */
370
427
  rowHeight?: number;
428
+ /**
429
+ * Color of highlighted cells. If not specified, default value is light yellow (`#ffff9c`).
430
+ */
431
+ highlightColor?: string;
371
432
  }
372
433
  /**
373
434
  * Common part of IndicatorStyleOptions for all types of indicator
@@ -475,7 +536,9 @@ export interface ScattermapStyleOptions extends Pick<BaseStyleOptions, 'width' |
475
536
  /**
476
537
  * Configuration options that define functional style of the various elements of chart.
477
538
  */
478
- export type ChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions;
539
+ export type ChartStyleOptions = RegularChartStyleOptions | TabularChartStyleOptions;
540
+ /** Style options for regular chart types */
541
+ export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions;
479
542
  /** Mapping of each of the chart value series to colors. */
480
543
  export type ValueToColorMap = {
481
544
  [value: string]: string;
@@ -487,12 +550,14 @@ export type MultiColumnValueToColorMap = {
487
550
  /**
488
551
  * Chart type of one of the supported chart families
489
552
  */
490
- export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType;
553
+ export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | RangeChartType | TableChartType;
554
+ /** Chart type of the regular charts */
555
+ export type RegularChartType = Exclude<ChartType, TableChartType>;
491
556
  /**
492
557
  * Series chart type, which is used with {@link StyledMeasureColumn} to customize
493
558
  * series in a mixed chart.
494
559
  */
495
- export type SeriesChartType = 'auto' | 'line' | 'spline' | 'areaspline' | 'bar' | 'area' | 'column' | 'scatter';
560
+ export type SeriesChartType = 'auto' | 'line' | 'spline' | 'areaspline' | 'bar' | 'area' | 'column' | 'scatter' | 'arearange';
496
561
  /** The number of decimal places */
497
562
  export type DecimalScale = number | 'auto';
498
563
  /**
@@ -0,0 +1 @@
1
+ export declare function checkAndNotifyAboutDeprecatedProp(props: any, deprecatedProps: string[]): void;
@@ -1,3 +1,4 @@
1
+ /// <reference types="react" />
1
2
  import { DrilldownWidgetProps } from '../props';
2
3
  /**
3
4
  * React component designed to add drilldown functionality to any type of chart.
@@ -34,4 +35,4 @@ import { DrilldownWidgetProps } from '../props';
34
35
  * @returns DrilldownWidget wrapper component
35
36
  * @group Drilldown
36
37
  */
37
- export declare const DrilldownWidget: ({ drilldownDimensions, initialDimension, config, children, }: DrilldownWidgetProps) => import("react/jsx-runtime").JSX.Element;
38
+ export declare const DrilldownWidget: import("react").FunctionComponent<DrilldownWidgetProps>;
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "Sisense",
12
12
  "Compose SDK"
13
13
  ],
14
- "version": "1.10.1",
14
+ "version": "1.11.0",
15
15
  "type": "module",
16
16
  "exports": {
17
17
  ".": {
@@ -40,12 +40,12 @@
40
40
  "@emotion/styled": "^11.10.5",
41
41
  "@mui/material": "^5.15.16",
42
42
  "@mui/system": "^5.15.15",
43
- "@sisense/sdk-common": "^1.10.1",
44
- "@sisense/sdk-data": "^1.10.1",
45
- "@sisense/sdk-pivot-client": "^1.10.1",
46
- "@sisense/sdk-query-client": "^1.10.1",
47
- "@sisense/sdk-rest-client": "^1.10.1",
48
- "@sisense/sdk-tracking": "^1.10.1",
43
+ "@sisense/sdk-common": "^1.11.0",
44
+ "@sisense/sdk-data": "^1.11.0",
45
+ "@sisense/sdk-pivot-client": "^1.11.0",
46
+ "@sisense/sdk-query-client": "^1.11.0",
47
+ "@sisense/sdk-rest-client": "^1.11.0",
48
+ "@sisense/sdk-tracking": "^1.11.0",
49
49
  "@sisense/sisense-charts": "5.1.1",
50
50
  "@tanstack/react-query": "4.36.1",
51
51
  "classnames": "^2.3.2",