@sisense/sdk-ui 1.34.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai.cjs +9 -9
- package/dist/ai.js +556 -581
- package/dist/analytics-composer.cjs +120 -119
- package/dist/analytics-composer.js +3235 -2506
- package/dist/{derive-chart-family-5CbFzbpu.js → derive-chart-family-BNMFblR9.js} +33391 -32356
- package/dist/derive-chart-family-DjbiaKLQ.cjs +758 -0
- package/dist/dimensions-DcsEnPSY.cjs +1 -0
- package/dist/dimensions-DeTiL-EZ.js +200 -0
- package/dist/index.cjs +20 -16
- package/dist/index.js +7114 -6994
- package/dist/packages/sdk-ui/src/ai/ai-context-provider.d.ts +13 -6
- package/dist/packages/sdk-ui/src/ai/chat-config.d.ts +4 -2
- package/dist/packages/sdk-ui/src/ai/chatbot.d.ts +17 -7
- package/dist/packages/sdk-ui/src/ai/get-nlg-insights.d.ts +0 -21
- package/dist/packages/sdk-ui/src/ai/index.d.ts +4 -3
- package/dist/packages/sdk-ui/src/ai/use-get-nlg-insights.d.ts +0 -12
- package/dist/packages/sdk-ui/src/ai/use-get-nlq-result.d.ts +0 -4
- package/dist/packages/sdk-ui/src/ai/use-get-query-recommendations.d.ts +0 -4
- package/dist/packages/sdk-ui/src/analytics-composer/{common → code}/stringify-props.d.ts +10 -2
- package/dist/packages/sdk-ui/src/analytics-composer/common/custom-superjson.d.ts +16 -0
- package/dist/packages/sdk-ui/src/analytics-composer/dashboard/dashboard-composer.d.ts +8 -0
- package/dist/packages/sdk-ui/src/analytics-composer/dashboard/stringify-widgets.d.ts +3 -0
- package/dist/packages/sdk-ui/src/analytics-composer/dashboard/to-dashboard-code.d.ts +3 -0
- package/dist/packages/sdk-ui/src/analytics-composer/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/analytics-composer/query/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/analytics-composer/query/query-translator.d.ts +1 -0
- package/dist/packages/sdk-ui/src/analytics-composer/query/simplify-metadata-item.d.ts +9 -0
- package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts +78 -4
- package/dist/packages/sdk-ui/src/analytics-composer/widget/chart-options/get-widget-options.d.ts +1 -1
- package/dist/packages/sdk-ui/src/analytics-composer/widget/to-widget-code.d.ts +3 -1
- package/dist/packages/sdk-ui/src/app/client-application.d.ts +11 -62
- package/dist/packages/sdk-ui/src/area-range-chart.d.ts +0 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/legend-section.d.ts +1 -0
- package/dist/packages/sdk-ui/src/common/components/menu/types.d.ts +1 -0
- package/dist/packages/sdk-ui/src/dashboard/dashboard-helpers.d.ts +0 -11
- package/dist/packages/sdk-ui/src/dashboard/index.d.ts +1 -1
- package/dist/packages/sdk-ui/src/dashboard/types.d.ts +7 -3
- package/dist/packages/sdk-ui/src/dashboard/use-composed-dashboard.d.ts +1 -4
- package/dist/packages/sdk-ui/src/emotion-cache-provider/emotion-cache-provider.d.ts +10 -0
- package/dist/packages/sdk-ui/src/emotion-cache-provider/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/emotion-cache-provider/utils.d.ts +4 -0
- package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/index.d.ts +0 -1
- package/dist/packages/sdk-ui/src/filters/components/filter-tile.d.ts +0 -1
- package/dist/packages/sdk-ui/src/index-typedoc.d.ts +4 -1
- package/dist/packages/sdk-ui/src/index.d.ts +4 -3
- package/dist/packages/sdk-ui/src/models/dashboard/use-dashboard-model/use-dashboard-model-reducer.d.ts +15 -1
- package/dist/packages/sdk-ui/src/models/widget/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/models/widget/widget-model-translator.d.ts +2 -12
- package/dist/packages/sdk-ui/src/models/widget/widget-model.d.ts +1 -125
- package/dist/packages/sdk-ui/src/props.d.ts +31 -45
- package/dist/packages/sdk-ui/src/query-execution/types.d.ts +1 -3
- package/dist/packages/sdk-ui/src/query-execution/use-query-cache.d.ts +4 -2
- package/dist/packages/sdk-ui/src/theme-provider/default-theme-settings.d.ts +1 -0
- package/dist/packages/sdk-ui/src/translation/resources/en.d.ts +2 -1
- package/dist/packages/sdk-ui/src/translation/resources/index.d.ts +4 -2
- package/dist/packages/sdk-ui/src/types.d.ts +50 -41
- package/dist/packages/sdk-ui/src/utils/get-scrollbar-width.d.ts +1 -0
- package/dist/packages/sdk-ui/src/utils/{utility-types.d.ts → utility-types/basic-utility-types.d.ts} +0 -34
- package/dist/packages/sdk-ui/src/utils/utility-types/distributive-omit.d.ts +24 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/index.d.ts +4 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/rest-api-hook-state.d.ts +35 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/soft-union.d.ts +35 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-dashboard-filters.d.ts +0 -7
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-drilldown-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/utils.d.ts +23 -16
- package/dist/packages/sdk-ui/src/widgets/constants.d.ts +1 -0
- package/dist/packages/sdk-ui/src/widgets/widget.d.ts +0 -1
- package/dist/{use-common-filters-Bw15BNGn.js → use-common-filters-CJNwlbbh.js} +5944 -5617
- package/dist/use-common-filters-DcFu4qRs.cjs +271 -0
- package/dist/widget-composer-BEVCXjFv.js +959 -0
- package/dist/widget-composer-fYnr8SDo.cjs +428 -0
- package/package.json +13 -9
- package/dist/derive-chart-family-C3FH49ux.cjs +0 -758
- package/dist/packages/sdk-ui/src/ai/common/beta-label.d.ts +0 -1
- package/dist/packages/sdk-ui/src/analytics-composer/widget/stringify-props.d.ts +0 -8
- package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/types.d.ts +0 -8
- package/dist/packages/sdk-ui/src/utils/check-and-notify-about-deprecated-prop.d.ts +0 -1
- package/dist/packages/sdk-ui/src/widget-by-id/dashboard-widget.d.ts +0 -27
- package/dist/use-common-filters-CqGo6jp3.cjs +0 -271
- package/dist/widget-composer-C5_iIuZN.js +0 -742
- package/dist/widget-composer-D5_iKTui.cjs +0 -316
- /package/dist/packages/sdk-ui/src/analytics-composer/{widget → code}/stringify-filters.d.ts +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DashboardProps } from './types.js';
|
|
2
2
|
import { Filter, FilterRelations } from '@sisense/sdk-data';
|
|
3
3
|
import { WidgetsPanelLayout } from '../models';
|
|
4
4
|
export type ComposableDashboardProps = Pick<DashboardProps, 'filters' | 'widgets' | 'widgetsOptions' | 'layoutOptions' | 'tabbersOptions'>;
|
|
@@ -18,18 +18,15 @@ export declare function useComposedDashboardInternal<D extends ComposableDashboa
|
|
|
18
18
|
dashboard: D;
|
|
19
19
|
setFilters: (filters: Filter[] | FilterRelations) => void;
|
|
20
20
|
setWidgetsLayout: (newLayout: WidgetsPanelLayout) => void;
|
|
21
|
-
layoutOptions: DashboardLayoutOptions;
|
|
22
21
|
};
|
|
23
22
|
/**
|
|
24
23
|
* React hook that takes in separate dashboard elements and
|
|
25
24
|
* composes them into a coordinated dashboard with change detection, cross filtering, and drill down.
|
|
26
25
|
*
|
|
27
26
|
* @group Dashboards
|
|
28
|
-
* @alpha
|
|
29
27
|
*/
|
|
30
28
|
export declare const useComposedDashboard: <D extends DashboardProps | ComposableDashboardProps>(args_0: D, args_1?: UseComposedDashboardOptions | undefined) => {
|
|
31
29
|
dashboard: D;
|
|
32
30
|
setFilters: (filters: Filter[] | FilterRelations) => void;
|
|
33
31
|
setWidgetsLayout: (newLayout: WidgetsPanelLayout) => void;
|
|
34
|
-
layoutOptions: DashboardLayoutOptions;
|
|
35
32
|
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import React, { ReactNode } from 'react';
|
|
2
|
+
export interface EmotionCacheProviderProps {
|
|
3
|
+
children: ReactNode;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* A provider component that uses the Emotion cache, but only creates one if a nonce is found in the DOM.
|
|
7
|
+
* This ensures that styles are injected in a way that is compliant with CSP if necessary.
|
|
8
|
+
* If no nonce is found, it simply renders the children without the CacheProvider.
|
|
9
|
+
*/
|
|
10
|
+
export declare const EmotionCacheProvider: React.FC<EmotionCacheProviderProps>;
|
|
@@ -17,7 +17,10 @@
|
|
|
17
17
|
* @groupDescription Fusion Assets
|
|
18
18
|
* React components, hooks, and utilities for working with Fusion dashboards, widgets, queries, and formulas
|
|
19
19
|
* @groupDescription Generative AI
|
|
20
|
-
* React components and hooks for
|
|
20
|
+
* React components and hooks for working with Generative AI features provided by Sisense Fusion
|
|
21
|
+
* ::: tip Note
|
|
22
|
+
* For more information on requirements for enabling Generative AI features, please refer to the [Generative AI documentation](https://docs.sisense.com/main/SisenseLinux/genai.htm)
|
|
23
|
+
* :::
|
|
21
24
|
* @groupDescription Interfaces
|
|
22
25
|
* TypeScript interfaces for components and hooks listed above
|
|
23
26
|
* @groupDescription Type Aliases
|
|
@@ -3,10 +3,9 @@ export * from './chart-data-options/types';
|
|
|
3
3
|
export { Chart } from './chart';
|
|
4
4
|
export { ThemeProvider } from './theme-provider';
|
|
5
5
|
export * from './dashboard';
|
|
6
|
-
export { DashboardWidget } from './widget-by-id/dashboard-widget';
|
|
7
6
|
export { WidgetById } from './widget-by-id/widget-by-id';
|
|
8
7
|
export { isChartWidgetProps, isPivotTableWidgetProps, isTextWidgetProps, isPluginWidgetProps, } from './widget-by-id/utils';
|
|
9
|
-
export { type
|
|
8
|
+
export { type CartesianWidgetType, type CategoricalWidgetType, type TabularWidgetType, type TextWidgetType, } from './widget-by-id/types';
|
|
10
9
|
export { getChartType } from './widget-by-id/utils';
|
|
11
10
|
export * from './query-execution';
|
|
12
11
|
export { executeQuery, executePivotQuery } from './query/execute-query';
|
|
@@ -45,7 +44,7 @@ export { usePlugins } from './plugins-provider/plugins-provider';
|
|
|
45
44
|
export { extractDimensionsAndMeasures, useExecutePluginQuery, } from './plugins-provider/use-execute-plugin-query';
|
|
46
45
|
export { getThemeSettingsByOid } from './themes/theme-loader';
|
|
47
46
|
export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
|
|
48
|
-
export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
|
|
47
|
+
export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, translateFiltersAndRelationsToDto, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
|
|
49
48
|
/**
|
|
50
49
|
* Utility functions to translate a Fusion widget model from and to other widget data structures
|
|
51
50
|
*
|
|
@@ -74,6 +73,8 @@ export { boxWhiskerProcessResult } from './boxplot-utils';
|
|
|
74
73
|
export { queryStateReducer } from './query-execution/query-state-reducer';
|
|
75
74
|
export * from './props';
|
|
76
75
|
export * from './types';
|
|
76
|
+
export type { SoftUnion } from './utils/utility-types';
|
|
77
|
+
export type { BeforeMenuOpenHandler } from './common/components/menu/types';
|
|
77
78
|
export * from './filters';
|
|
78
79
|
export * from './formulas';
|
|
79
80
|
export { trackHook } from './decorators/hook-decorators';
|
|
@@ -61,6 +61,20 @@ export type UseDashboardModelAddWidgetAction = {
|
|
|
61
61
|
* @internal
|
|
62
62
|
*/
|
|
63
63
|
export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;
|
|
64
|
+
/**
|
|
65
|
+
* Translates filters and relations to DTOs.
|
|
66
|
+
*
|
|
67
|
+
* @param filtersOrFilterRelations - The filters or filter relations to translate
|
|
68
|
+
* @returns The translated filters and relations DTOs for Fusion
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
|
+
export declare function translateFiltersAndRelationsToDto(filtersOrFilterRelations: Filter[] | FilterRelations): {
|
|
72
|
+
filters: (import("../../../api/types/dashboard-dto").FilterDto | import("../../../api/types/dashboard-dto").CascadingFilterDto)[];
|
|
73
|
+
filterRelations: {
|
|
74
|
+
datasource: string;
|
|
75
|
+
filterRelations: import("@sisense/sdk-data").FilterRelationsModelNode;
|
|
76
|
+
}[] | undefined;
|
|
77
|
+
};
|
|
64
78
|
/**
|
|
65
79
|
* Middleware that persists the dashboard model changes to the Sisense server.
|
|
66
80
|
*
|
|
@@ -68,4 +82,4 @@ export declare function dashboardReducer(state: UseDashboardModelState, action:
|
|
|
68
82
|
* @param reducer - The dashboard model reducer
|
|
69
83
|
* @internal
|
|
70
84
|
*/
|
|
71
|
-
export declare function persistDashboardModelMiddleware(
|
|
85
|
+
export declare function persistDashboardModelMiddleware(dashboardOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi): Promise<UseDashboardModelInternalAction>;
|
|
@@ -2,7 +2,7 @@ import { ChartType } from '../../index';
|
|
|
2
2
|
/**
|
|
3
3
|
* Widget type
|
|
4
4
|
*
|
|
5
|
-
* todo: as a future refactoring need to replace
|
|
5
|
+
* todo: as a future refactoring need to replace this type by combination of WidgetType and ChartType
|
|
6
6
|
*
|
|
7
7
|
* @internal
|
|
8
8
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
|
|
2
2
|
import { WidgetModel } from './widget-model.js';
|
|
3
3
|
import { ChartProps, ChartWidgetProps, WidgetProps, PivotTableProps, PivotTableWidgetProps, PluginWidgetProps, TableProps, TableWidgetProps, TextWidgetProps, CommonWidgetProps } from '../../props';
|
|
4
|
-
import {
|
|
4
|
+
import { JaqlDataSourceForDto } from '@sisense/sdk-data';
|
|
5
5
|
import { CompleteThemeSettings } from '../../types.js';
|
|
6
6
|
import { WidgetDto } from '../../widget-by-id/types.js';
|
|
7
7
|
import { AppSettings } from '../../app/settings/settings.js';
|
|
@@ -160,16 +160,6 @@ export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps)
|
|
|
160
160
|
* @internal
|
|
161
161
|
*/
|
|
162
162
|
export declare function fromWidgetProps(widgetProps: WidgetProps): WidgetModel;
|
|
163
|
-
/**
|
|
164
|
-
* Data source as specified in the jaql
|
|
165
|
-
* but with required filelds
|
|
166
|
-
*
|
|
167
|
-
* @internal
|
|
168
|
-
*/
|
|
169
|
-
export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
|
|
170
|
-
id: string;
|
|
171
|
-
address?: string;
|
|
172
|
-
};
|
|
173
163
|
/**
|
|
174
164
|
* Translates a {@link WidgetModel} to {@link WidgetDto}.
|
|
175
165
|
*
|
|
@@ -178,4 +168,4 @@ export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
|
|
|
178
168
|
* @returns WidgetDto
|
|
179
169
|
* @internal
|
|
180
170
|
*/
|
|
181
|
-
export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?:
|
|
171
|
+
export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?: JaqlDataSourceForDto): WidgetDto;
|
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { DataSource, Filter } from '@sisense/sdk-data';
|
|
2
2
|
import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
|
|
3
|
-
import { WidgetType } from '../../
|
|
4
|
-
import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps, TextWidgetProps } from '../../props';
|
|
5
|
-
import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
|
|
3
|
+
import type { WidgetType } from '../../props';
|
|
6
4
|
import { ChartType, DrilldownOptions, WidgetStyleOptions } from '../../types';
|
|
7
5
|
import { EmptyObject } from '@sisense/sdk-query-client/src/helpers/utility-types';
|
|
8
6
|
/**
|
|
@@ -34,8 +32,6 @@ export interface WidgetModel {
|
|
|
34
32
|
dataSource: DataSource;
|
|
35
33
|
/**
|
|
36
34
|
* Widget type.
|
|
37
|
-
*
|
|
38
|
-
* @deprecated Use {@link widgetModelTranslator} methods instead
|
|
39
35
|
*/
|
|
40
36
|
widgetType: WidgetType;
|
|
41
37
|
/**
|
|
@@ -68,125 +64,5 @@ export interface WidgetModel {
|
|
|
68
64
|
* Widget drilldown options.
|
|
69
65
|
*/
|
|
70
66
|
drilldownOptions: DrilldownOptions;
|
|
71
|
-
/**
|
|
72
|
-
* Returns the parameters to be used for executing a query for the widget.
|
|
73
|
-
*
|
|
74
|
-
* @example
|
|
75
|
-
* ```tsx
|
|
76
|
-
* const {data, isLoading, isError} = useExecuteQuery(widget.getExecuteQueryParams());
|
|
77
|
-
* ```
|
|
78
|
-
*
|
|
79
|
-
* Note: this method is not supported for getting pivot query.
|
|
80
|
-
* Use {@link getExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
|
|
81
|
-
* @deprecated Use {@link widgetModelTranslator.toExecuteQueryParams} instead
|
|
82
|
-
*/
|
|
83
|
-
getExecuteQueryParams(): ExecuteQueryParams;
|
|
84
|
-
/**
|
|
85
|
-
* Returns the parameters to be used for executing a query for the pivot widget.
|
|
86
|
-
*
|
|
87
|
-
* @example
|
|
88
|
-
* ```tsx
|
|
89
|
-
* const {data, isLoading, isError} = useExecutePivotQuery(widget.getExecutePivotQueryParams());
|
|
90
|
-
* ```
|
|
91
|
-
*
|
|
92
|
-
* Note: this method is supported only for getting pivot query.
|
|
93
|
-
* Use {@link getExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
|
|
94
|
-
* @deprecated Use {@link widgetModelTranslator.toExecutePivotQueryParams} instead
|
|
95
|
-
*/
|
|
96
|
-
getExecutePivotQueryParams(): ExecutePivotQueryParams;
|
|
97
|
-
/**
|
|
98
|
-
* Returns the props to be used for rendering a chart.
|
|
99
|
-
*
|
|
100
|
-
* @example
|
|
101
|
-
* ```tsx
|
|
102
|
-
* <Chart {...widget.getChartProps()} />
|
|
103
|
-
* ```
|
|
104
|
-
*
|
|
105
|
-
* Note: this method is not supported for pivot table widgets.
|
|
106
|
-
* Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
|
|
107
|
-
* @deprecated Use {@link widgetModelTranslator.toChartProps} instead
|
|
108
|
-
*/
|
|
109
|
-
getChartProps(): ChartProps;
|
|
110
|
-
/**
|
|
111
|
-
* Returns the props to be used for rendering a table.
|
|
112
|
-
*
|
|
113
|
-
* @example
|
|
114
|
-
* ```tsx
|
|
115
|
-
* <Table {...widget.getTableProps()} />
|
|
116
|
-
* ```
|
|
117
|
-
*
|
|
118
|
-
* Note: this method is not supported for chart and pivot widgets.
|
|
119
|
-
* Use {@link getChartProps} instead for getting props for the <Chart> component.
|
|
120
|
-
* Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
|
|
121
|
-
* @deprecated Use {@link widgetModelTranslator.toTableProps} instead
|
|
122
|
-
*/
|
|
123
|
-
getTableProps(): TableProps;
|
|
124
|
-
/**
|
|
125
|
-
* Returns the props to be used for rendering a pivot table.
|
|
126
|
-
*
|
|
127
|
-
* @example
|
|
128
|
-
* ```tsx
|
|
129
|
-
* <PivotTable {...widget.getPivotTableProps()} />
|
|
130
|
-
* ```
|
|
131
|
-
*
|
|
132
|
-
* Note: this method is not supported for chart or table widgets.
|
|
133
|
-
* Use {@link getChartProps} instead for getting props for the <Chart> component.
|
|
134
|
-
* Use {@link getTableProps} instead for getting props for the <Table> component.
|
|
135
|
-
* @deprecated Use {@link widgetModelTranslator.toPivotTableProps} instead
|
|
136
|
-
*/
|
|
137
|
-
getPivotTableProps(): PivotTableProps;
|
|
138
|
-
/**
|
|
139
|
-
* Returns the props to be used for rendering a chart widget.
|
|
140
|
-
*
|
|
141
|
-
* @example
|
|
142
|
-
* ```tsx
|
|
143
|
-
* <ChartWidget {...widget.getChartWidgetProps()} />
|
|
144
|
-
* ```
|
|
145
|
-
*
|
|
146
|
-
* Note: this method is not supported for pivot widgets.
|
|
147
|
-
* @deprecated Use {@link widgetModelTranslator.toChartWidgetProps} instead
|
|
148
|
-
*/
|
|
149
|
-
getChartWidgetProps(): ChartWidgetProps;
|
|
150
|
-
/**
|
|
151
|
-
* Returns the props to be used for rendering a table widget.
|
|
152
|
-
*
|
|
153
|
-
* @example
|
|
154
|
-
* ```tsx
|
|
155
|
-
* <TableWidget {...widget.getTableWidgetProps()} />
|
|
156
|
-
* ```
|
|
157
|
-
*
|
|
158
|
-
* Note: this method is not supported for chart widgets.
|
|
159
|
-
* Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
|
|
160
|
-
* @deprecated Use {@link widgetModelTranslator.toTableWidgetProps} instead
|
|
161
|
-
* @internal
|
|
162
|
-
*/
|
|
163
|
-
getTableWidgetProps(): TableWidgetProps;
|
|
164
|
-
/**
|
|
165
|
-
* Returns the props to be used for rendering a pivot table widget.
|
|
166
|
-
*
|
|
167
|
-
* @example
|
|
168
|
-
* ```tsx
|
|
169
|
-
* <PivotTableWidget {...widget.getPivotTableWidgetProps()} />
|
|
170
|
-
* ```
|
|
171
|
-
|
|
172
|
-
* Note: this method is not supported for chart or table widgets.
|
|
173
|
-
* Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
|
|
174
|
-
* @deprecated Use {@link widgetModelTranslator.toPivotTableWidgetProps} instead
|
|
175
|
-
*/
|
|
176
|
-
getPivotTableWidgetProps(): PivotTableWidgetProps;
|
|
177
|
-
/**
|
|
178
|
-
* Returns the props to be used for rendering a text widget.
|
|
179
|
-
*
|
|
180
|
-
* @example
|
|
181
|
-
* ```tsx
|
|
182
|
-
* <TextWidget {...widget.getTextWidgetProps()} />
|
|
183
|
-
* ```
|
|
184
|
-
*
|
|
185
|
-
* Note: this method is not supported for chart or pivot widgets.
|
|
186
|
-
* Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
|
|
187
|
-
* Use {@link getPivotTableWidgetProps} instead for getting props for the <PivotTableWidget> component.
|
|
188
|
-
* @deprecated Use {@link widgetModelTranslator.toTextWidgetProps} instead
|
|
189
|
-
*/
|
|
190
|
-
getTextWidgetProps(): TextWidgetProps;
|
|
191
67
|
}
|
|
192
68
|
export declare const isWidgetModel: (widget: any) => widget is WidgetModel;
|
|
@@ -1,5 +1,5 @@
|
|
|
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, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions,
|
|
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, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps } from './types';
|
|
3
3
|
import { HighchartsOptions } from './chart-options-processor/chart-options-service';
|
|
4
4
|
import { ComponentType, PropsWithChildren, ReactNode } from 'react';
|
|
5
5
|
import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
|
|
@@ -10,6 +10,7 @@ import { HookEnableParam } from './common/hooks/types';
|
|
|
10
10
|
import { ExecuteQueryResult } from './query-execution/types';
|
|
11
11
|
import { Hierarchy } from './models';
|
|
12
12
|
import { BeforeMenuOpenHandler } from './common/components/menu/types';
|
|
13
|
+
import { DistributiveOmit } from './utils/utility-types/distributive-omit';
|
|
13
14
|
export type { MenuItemSection, HighchartsOptions };
|
|
14
15
|
/**
|
|
15
16
|
* Configurations and authentication for Sisense Context.
|
|
@@ -106,7 +107,8 @@ export interface SisenseContextProviderProps {
|
|
|
106
107
|
* Used only with SSO authentication.
|
|
107
108
|
* If not specified, the default value is `false`.
|
|
108
109
|
*
|
|
109
|
-
* @
|
|
110
|
+
* @category Sisense Authentication
|
|
111
|
+
*
|
|
110
112
|
*/
|
|
111
113
|
enableSilentPreAuth?: boolean;
|
|
112
114
|
}
|
|
@@ -133,11 +135,7 @@ export interface ExecuteQueryProps {
|
|
|
133
135
|
count?: number;
|
|
134
136
|
/** {@inheritDoc ExecuteQueryParams.offset} */
|
|
135
137
|
offset?: number;
|
|
136
|
-
/**
|
|
137
|
-
* {@inheritDoc ExecuteQueryParams.ungroup}
|
|
138
|
-
*
|
|
139
|
-
* @internal
|
|
140
|
-
*/
|
|
138
|
+
/** {@inheritDoc ExecuteQueryParams.ungroup} */
|
|
141
139
|
ungroup?: boolean;
|
|
142
140
|
/** Function as child component that is called to render the query results */
|
|
143
141
|
children?: (queryResult: ExecuteQueryResult) => ReactNode;
|
|
@@ -299,7 +297,6 @@ interface BaseChartEventProps {
|
|
|
299
297
|
* Can be used to inject modification of queried data.
|
|
300
298
|
*
|
|
301
299
|
* @category Callbacks
|
|
302
|
-
* @internal
|
|
303
300
|
*/
|
|
304
301
|
onDataReady?: (data: Data) => Data;
|
|
305
302
|
}
|
|
@@ -830,6 +827,12 @@ export interface PivotTableProps {
|
|
|
830
827
|
* @internal
|
|
831
828
|
*/
|
|
832
829
|
refreshCounter?: number;
|
|
830
|
+
/**
|
|
831
|
+
* Callback function that is called when the height of the pivot table changes
|
|
832
|
+
*
|
|
833
|
+
* @internal
|
|
834
|
+
*/
|
|
835
|
+
onHeightChange?: (height: number) => void;
|
|
833
836
|
}
|
|
834
837
|
/**
|
|
835
838
|
* Props of the {@link ScatterChart} component.
|
|
@@ -920,19 +923,6 @@ export interface WidgetByIdProps extends Omit<ChartWidgetProps, 'dataSource' | '
|
|
|
920
923
|
*/
|
|
921
924
|
drilldownOptions?: DrilldownOptions;
|
|
922
925
|
}
|
|
923
|
-
/**
|
|
924
|
-
* Props for the {@link DashboardWidget} component
|
|
925
|
-
*
|
|
926
|
-
* @deprecated Use {@link WidgetById} and {@link WidgetByIdProps} instead
|
|
927
|
-
*/
|
|
928
|
-
export interface DashboardWidgetProps extends WidgetByIdProps {
|
|
929
|
-
/**
|
|
930
|
-
* Style options for the widget including the widget container and the chart or table inside.
|
|
931
|
-
*
|
|
932
|
-
* @category Widget
|
|
933
|
-
*/
|
|
934
|
-
styleOptions?: DashboardWidgetStyleOptions;
|
|
935
|
-
}
|
|
936
926
|
/**
|
|
937
927
|
* Props for the {@link ChartWidget} component
|
|
938
928
|
*
|
|
@@ -1222,20 +1212,19 @@ export interface PluginWidgetProps {
|
|
|
1222
1212
|
description?: string;
|
|
1223
1213
|
}
|
|
1224
1214
|
/**
|
|
1225
|
-
* A utility type that combines widget-specific properties (`
|
|
1226
|
-
*
|
|
1227
|
-
* This is used to extend the props of a widget with its respective widget type.
|
|
1215
|
+
* A utility type that combines widget-specific properties (`BaseWidget`)
|
|
1216
|
+
* with a common widget props including corresponding widget type (`Type`).
|
|
1228
1217
|
*/
|
|
1229
|
-
export type
|
|
1218
|
+
export type WithCommonWidgetProps<BaseWidget, Type extends WidgetType> = BaseWidget & {
|
|
1219
|
+
/**
|
|
1220
|
+
* Unique identifier of the widget within the container component (dashboard)
|
|
1221
|
+
*
|
|
1222
|
+
*/
|
|
1223
|
+
readonly id: string;
|
|
1230
1224
|
/**
|
|
1231
1225
|
* Widget type
|
|
1232
1226
|
*/
|
|
1233
|
-
widgetType:
|
|
1234
|
-
};
|
|
1235
|
-
/**
|
|
1236
|
-
* Props for the facade widget component.
|
|
1237
|
-
*/
|
|
1238
|
-
export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | WithWidgetType<PivotTableWidgetProps, 'pivot'> | WithWidgetType<TextWidgetProps, 'text'> | WithWidgetType<PluginWidgetProps, 'plugin'>) & {
|
|
1227
|
+
widgetType: Type;
|
|
1239
1228
|
/**
|
|
1240
1229
|
* Optional handler function to process menu options before opening the context menu.
|
|
1241
1230
|
*
|
|
@@ -1243,16 +1232,20 @@ export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | Wit
|
|
|
1243
1232
|
*/
|
|
1244
1233
|
onBeforeMenuOpen?: BeforeMenuOpenHandler;
|
|
1245
1234
|
};
|
|
1235
|
+
/**
|
|
1236
|
+
* Type of the widget component.
|
|
1237
|
+
*/
|
|
1238
|
+
export type WidgetType = 'chart' | 'pivot' | 'text' | 'plugin';
|
|
1246
1239
|
/**
|
|
1247
1240
|
* Props for the widget component within a container component like dashboard.
|
|
1248
1241
|
*/
|
|
1249
|
-
export type WidgetProps =
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1242
|
+
export type WidgetProps = WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<PluginWidgetProps, 'plugin'>;
|
|
1243
|
+
/**
|
|
1244
|
+
* Props for the facade widget component.
|
|
1245
|
+
*
|
|
1246
|
+
* @internal
|
|
1247
|
+
*/
|
|
1248
|
+
export type CommonWidgetProps = DistributiveOmit<WidgetProps, 'id'>;
|
|
1256
1249
|
/**
|
|
1257
1250
|
* Props for {@link ExecuteQueryByWidgetId} component.
|
|
1258
1251
|
*
|
|
@@ -1476,13 +1469,6 @@ export type DrilldownWidgetConfig = {
|
|
|
1476
1469
|
* Props for the {@link DrilldownWidget} component
|
|
1477
1470
|
*/
|
|
1478
1471
|
export interface DrilldownWidgetProps {
|
|
1479
|
-
/**
|
|
1480
|
-
* List of dimensions to allow drilldowns on
|
|
1481
|
-
*
|
|
1482
|
-
* @category Widget
|
|
1483
|
-
* @deprecated Use {@link DrilldownWidgetProps.drilldownPaths} instead
|
|
1484
|
-
*/
|
|
1485
|
-
drilldownDimensions?: Attribute[];
|
|
1486
1472
|
/**
|
|
1487
1473
|
* Dimensions and hierarchies available for drilldown on.
|
|
1488
1474
|
*
|
|
@@ -209,11 +209,9 @@ export interface ExecuteQueryParams {
|
|
|
209
209
|
/**
|
|
210
210
|
* Boolean flag whether to include `ungroup: true` in non-aggregated JAQL queries.
|
|
211
211
|
*
|
|
212
|
-
* This improves computation and performance of querying
|
|
212
|
+
* This improves computation and performance of querying tables when no aggregation is needed
|
|
213
213
|
*
|
|
214
214
|
* If not specified, the default value is `false`
|
|
215
|
-
*
|
|
216
|
-
* @internal
|
|
217
215
|
*/
|
|
218
216
|
ungroup?: boolean;
|
|
219
217
|
/**
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* React hook that returns the instance to
|
|
2
|
+
* React hook that returns the QueryCacheClient module instance to control query cache.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
4
|
+
* How to enable query cache see in [Query Caching guide](/guides/sdk/guides/client-query-caching.html)
|
|
5
|
+
*
|
|
6
|
+
* @returns QueryCacheClient instance
|
|
5
7
|
* @group Queries
|
|
6
8
|
* @alpha
|
|
7
9
|
*/
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { CompleteThemeSettings } from '../types';
|
|
2
2
|
export declare const DEFAULT_DIVIDER_COLOR = "#F2F2F2";
|
|
3
3
|
export declare const DEFAULT_DIVIDER_WIDTH = 4;
|
|
4
|
+
export declare const DEFAULT_TITLE_FONT_SIZE = 15;
|
|
4
5
|
/**
|
|
5
6
|
* Returns default theme settings, which can be used as base for custom theme options.
|
|
6
7
|
*
|
|
@@ -41,6 +41,8 @@ export declare const translation: {
|
|
|
41
41
|
onlyPivotWidgetSupported: string;
|
|
42
42
|
onlyTextWidgetSupported: string;
|
|
43
43
|
onlyPluginWidgetSupported: string;
|
|
44
|
+
unsupportedWidgetType: string;
|
|
45
|
+
unsupportedFusionWidgetType: string;
|
|
44
46
|
};
|
|
45
47
|
unknownFilterInFilterRelations: string;
|
|
46
48
|
filterRelationsNotSupported: string;
|
|
@@ -226,7 +228,6 @@ export declare const translation: {
|
|
|
226
228
|
dataTopics: string;
|
|
227
229
|
chatbotDescription: string;
|
|
228
230
|
topicSelectPrompt: string;
|
|
229
|
-
betaLabel: string;
|
|
230
231
|
preview: string;
|
|
231
232
|
clearHistoryPrompt: string;
|
|
232
233
|
config: {
|
|
@@ -51,6 +51,8 @@ export declare const resources: {
|
|
|
51
51
|
onlyPivotWidgetSupported: string;
|
|
52
52
|
onlyTextWidgetSupported: string;
|
|
53
53
|
onlyPluginWidgetSupported: string;
|
|
54
|
+
unsupportedWidgetType: string;
|
|
55
|
+
unsupportedFusionWidgetType: string;
|
|
54
56
|
};
|
|
55
57
|
unknownFilterInFilterRelations: string;
|
|
56
58
|
filterRelationsNotSupported: string;
|
|
@@ -236,7 +238,6 @@ export declare const resources: {
|
|
|
236
238
|
dataTopics: string;
|
|
237
239
|
chatbotDescription: string;
|
|
238
240
|
topicSelectPrompt: string;
|
|
239
|
-
betaLabel: string;
|
|
240
241
|
preview: string;
|
|
241
242
|
clearHistoryPrompt: string;
|
|
242
243
|
config: {
|
|
@@ -405,6 +406,8 @@ export declare const resources: {
|
|
|
405
406
|
onlyPivotWidgetSupported: string;
|
|
406
407
|
onlyTextWidgetSupported: string;
|
|
407
408
|
onlyPluginWidgetSupported: string;
|
|
409
|
+
unsupportedWidgetType: string;
|
|
410
|
+
unsupportedFusionWidgetType: string;
|
|
408
411
|
};
|
|
409
412
|
unknownFilterInFilterRelations: string;
|
|
410
413
|
filterRelationsNotSupported: string;
|
|
@@ -590,7 +593,6 @@ export declare const resources: {
|
|
|
590
593
|
dataTopics: string;
|
|
591
594
|
chatbotDescription: string;
|
|
592
595
|
topicSelectPrompt: string;
|
|
593
|
-
betaLabel: string;
|
|
594
596
|
preview: string;
|
|
595
597
|
clearHistoryPrompt: string;
|
|
596
598
|
config: {
|