@sisense/sdk-ui 2.27.0 → 2.28.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 +1 -1
- package/dist/ai.js +5 -5
- package/dist/analytics-composer/node.cjs +1 -1
- package/dist/analytics-composer/node.js +1322 -1021
- package/dist/analytics-composer.cjs +73 -73
- package/dist/analytics-composer.js +22 -17
- package/dist/{apply-styled-options-to-query-k10gkPCG.cjs → apply-styled-options-to-query-23D9br-S.cjs} +1 -1
- package/dist/{apply-styled-options-to-query-BzMAmDnD.js → apply-styled-options-to-query-BagjzMqm.js} +835 -822
- package/dist/{dimensions-C3WSSE5j.js → dimensions-Bn1EaWiP.js} +1 -1
- package/dist/{dimensions-huCJK0y6.cjs → dimensions-D8r34WRI.cjs} +1 -1
- package/dist/{index-D7mHzfx0.js → index-C77YCBVd.js} +4 -1
- package/dist/{index-BX9p-XrU.cjs → index-C9G8giSk.cjs} +1 -1
- package/dist/index.cjs +298 -298
- package/dist/index.js +11807 -11687
- package/dist/index.umd.js +663 -664
- package/dist/packages/sdk-ui/src/domains/dashboarding/components/editable-layout/const.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/dashboard-model-translator.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/get-dashboard-model.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/get-dashboard-models.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/persist-dashboard-model-middleware.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-excel-download.d.ts +23 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/types.d.ts +13 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/excel-export/build-jaql-excel-export.d.ts +48 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/excel-export/build-xlsx-export-payload.d.ts +33 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/excel-query-state-reducer.d.ts +2 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/use-excel-query-params-changed.d.ts +8 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-excel-query/use-execute-excel-query.d.ts +8 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/index.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/query-execution/types.d.ts +97 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/scattermap/utils/map.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/with-calendar-heatmap-data-coloring.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/build-highchart-options.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/formatters/data-cell-formatters/data-cell-color-formatter.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/helpers/prepare-pivot-styling-props.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/hooks/use-render-pivot.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/table/pure-table/helpers/get-cell-styles.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/table/pure-table/types.d.ts +3 -3
- package/dist/packages/sdk-ui/src/domains/visualizations/components/table/styles/get-custom-pagination-styles.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/boxplot-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/cartesian/cartesian-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/cartesian/utils/axis/axis-builders.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/cartesian/utils/axis/axis-settings.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/cartesian/utils/axis/axis-transformers.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/cartesian/utils/series-processor.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/category-chart-options/category-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/category-chart-options/funnel-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/category-chart-options/pie-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/category-chart-options/sunburst-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/category-chart-options/treemap-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/chart-options-service.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/common-highcharts-option-service.d.ts +3 -3
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/range-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/scatter-chart-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/theme-option-service.d.ts +3 -3
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/funnel-series.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/pie-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/pie-series.d.ts +4 -4
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/scatter-series.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/sunburst/sunburst-levels.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/sunburst/sunburst-options.d.ts +3 -3
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/sunburst/sunburst-series.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/treemap/treemap-labels.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/treemap/treemap-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/treemap/treemap-series.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/types.d.ts +9 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/use-chart-widget-excel-download.d.ts +18 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/custom-widget/types.d.ts +9 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/custom-widget/use-custom-widget-excel-download.d.ts +16 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/pivot-table-widget.d.ts +0 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/types.d.ts +9 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/use-pivot-widget-excel-download.d.ts +18 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget/types.d.ts +13 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/to-widget-dto-style.d.ts +3 -3
- package/dist/packages/sdk-ui/src/domains/widgets/helpers/download-blob-as-file.d.ts +14 -0
- package/dist/packages/sdk-ui/src/domains/widgets/helpers/excel-export-map-dimensions-measures.d.ts +18 -0
- package/dist/packages/sdk-ui/src/domains/widgets/helpers/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-excel-query-file-loader.d.ts +13 -0
- package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-with-excel-download-menu-item.d.ts +21 -0
- package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-style-utils.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/widgets/widget-model/get-widget-model.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/widgets/widget-model/widget-model-translator/widget-model-translator.d.ts +3 -3
- package/dist/packages/sdk-ui/src/infra/api/rest-api.d.ts +7 -0
- package/dist/packages/sdk-ui/src/infra/app/settings/settings.d.ts +25 -6
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/custom-theme-provider.d.ts +2 -2
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/default-theme-settings.d.ts +2 -2
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/theme-context.d.ts +3 -3
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/use-theme-settings.d.ts +2 -2
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/use-theme.d.ts +14 -0
- package/dist/packages/sdk-ui/src/infra/themes/legacy-design-settings.d.ts +4 -4
- package/dist/packages/sdk-ui/src/infra/themes/theme-loader.d.ts +4 -4
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/de-de.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/en-us.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-ar.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-es.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/fr-fr.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/it-it.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ja-jp.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ko-kr.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/nl-nl.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/pt-br.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ru-ru.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/tr-tr.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/zh-cn.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/en.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/index.d.ts +6 -0
- package/dist/packages/sdk-ui/src/modules/ai/ai-disclaimer.d.ts +2 -2
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/dashboard/translate-dashboard-from-json.d.ts +17 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/dashboard/translate-dashboard-to-json.d.ts +15 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/index.d.ts +5 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/adapters.d.ts +0 -3
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/custom-formula/process-custom-formula.d.ts +2 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/factory-function-processors.d.ts +0 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/filter-processors.d.ts +8 -4
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/error-path.d.ts +37 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/translation-helpers.d.ts +36 -3
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/types.d.ts +131 -2
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/helpers/index.d.ts +6 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/helpers/to-widget-props.d.ts +27 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/helpers/translate-custom-widget-filters-from-json.d.ts +12 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/helpers/translate-envelope-widget-from-json.d.ts +20 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/helpers/validate-widget-json.d.ts +8 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/helpers/widget-id.d.ts +17 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/translate-widget-from-json.d.ts +19 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/widget/translate-widget-to-json.d.ts +18 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/types.d.ts +6 -5
- package/dist/packages/sdk-ui/src/modules/analytics-composer/widget/chart-options/get-widget-options.d.ts +12 -0
- package/dist/packages/sdk-ui/src/props.d.ts +11 -2
- package/dist/packages/sdk-ui/src/public-api/internal.d.ts +1 -1
- package/dist/packages/sdk-ui/src/public-api/public.d.ts +2 -1
- package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts +1 -1
- package/dist/packages/sdk-ui/src/shared/components/loading-indicator.d.ts +2 -2
- package/dist/packages/sdk-ui/src/types.d.ts +217 -1
- package/dist/translations/de-de.cjs +1 -1
- package/dist/translations/de-de.js +5 -2
- package/dist/translations/en-us.cjs +1 -1
- package/dist/translations/en-us.js +1 -1
- package/dist/translations/es-ar.cjs +1 -1
- package/dist/translations/es-ar.js +5 -2
- package/dist/translations/es-es.cjs +1 -1
- package/dist/translations/es-es.js +5 -2
- package/dist/translations/fr-fr.cjs +1 -1
- package/dist/translations/fr-fr.js +5 -2
- package/dist/translations/it-it.cjs +1 -1
- package/dist/translations/it-it.js +5 -2
- package/dist/translations/ja-jp.cjs +1 -1
- package/dist/translations/ja-jp.js +5 -2
- package/dist/translations/ko-kr.cjs +1 -1
- package/dist/translations/ko-kr.js +5 -2
- package/dist/translations/nl-nl.cjs +1 -1
- package/dist/translations/nl-nl.js +5 -2
- package/dist/translations/pt-br.cjs +1 -1
- package/dist/translations/pt-br.js +5 -2
- package/dist/translations/ru-ru.cjs +1 -1
- package/dist/translations/ru-ru.js +5 -2
- package/dist/translations/tr-tr.cjs +1 -1
- package/dist/translations/tr-tr.js +5 -2
- package/dist/translations/zh-cn.cjs +1 -1
- package/dist/translations/zh-cn.js +5 -2
- package/dist/{types-Cq47e5cy.cjs → types-CzgBH2kL.cjs} +1 -1
- package/dist/{types-CzqDZ83C.js → types-D3fPN43o.js} +1 -1
- package/dist/{use-hover-CkmV6eu9.js → use-hover-B6VmMb06.js} +10428 -10063
- package/dist/{use-hover-D_mBUhp9.cjs → use-hover-CaSOzp0i.cjs} +128 -129
- package/dist/{utils-DM5vp1gw.cjs → utils-BwGnDoB0.cjs} +3 -3
- package/dist/{utils-Db3U6oHa.js → utils-CsV-iYtb.js} +3 -3
- package/dist/{widget-composer-BiGVKN49.js → widget-composer-Bv_OVu1o.js} +258 -206
- package/dist/{widget-composer-CZ0_bPXK.cjs → widget-composer-C72Io-3c.cjs} +7 -7
- package/package.json +10 -8
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal, OptionsWithAlerts } from '../../../../../types';
|
|
2
2
|
import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
3
3
|
import { CategoricalChartData } from '../../chart-data/types';
|
|
4
4
|
import { HighchartsOptionsInternal } from '../chart-options-service';
|
|
@@ -12,4 +12,4 @@ import { FunnelChartDesignOptions } from '../translations/design-options';
|
|
|
12
12
|
* @param dataOptions - chart data options
|
|
13
13
|
* @param themeSettings - theme settings
|
|
14
14
|
*/
|
|
15
|
-
export declare const getFunnelChartOptions: (chartData: CategoricalChartData, chartDesignOptions: FunnelChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?:
|
|
15
|
+
export declare const getFunnelChartOptions: (chartData: CategoricalChartData, chartDesignOptions: FunnelChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?: CompleteThemeSettingsInternal) => OptionsWithAlerts<HighchartsOptionsInternal>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal, OptionsWithAlerts } from '../../../../../types';
|
|
2
2
|
import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
3
3
|
import { CategoricalChartData } from '../../chart-data/types';
|
|
4
4
|
import { HighchartsOptionsInternal } from '../chart-options-service';
|
|
@@ -12,4 +12,4 @@ import { PieChartDesignOptions } from '../translations/design-options';
|
|
|
12
12
|
* @param dataOptions - chart data options
|
|
13
13
|
* @param themeSettings - theme settings
|
|
14
14
|
*/
|
|
15
|
-
export declare const getPieChartOptions: (chartData: CategoricalChartData, chartDesignOptions: PieChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?:
|
|
15
|
+
export declare const getPieChartOptions: (chartData: CategoricalChartData, chartDesignOptions: PieChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?: CompleteThemeSettingsInternal) => OptionsWithAlerts<HighchartsOptionsInternal>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TFunction } from '@sisense/sdk-common';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal, OptionsWithAlerts } from '../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
4
4
|
import { CategoricalChartData } from '../../chart-data/types';
|
|
5
5
|
import { HighchartsOptionsInternal } from '../chart-options-service';
|
|
@@ -14,4 +14,4 @@ import { SunburstChartDesignOptions } from '../translations/design-options';
|
|
|
14
14
|
* @param translate - translation function
|
|
15
15
|
* @param themeSettings - theme settings
|
|
16
16
|
*/
|
|
17
|
-
export declare const getSunburstChartOptions: (chartData: CategoricalChartData, chartDesignOptions: SunburstChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, translate: TFunction, themeSettings?:
|
|
17
|
+
export declare const getSunburstChartOptions: (chartData: CategoricalChartData, chartDesignOptions: SunburstChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, translate: TFunction, themeSettings?: CompleteThemeSettingsInternal) => OptionsWithAlerts<HighchartsOptionsInternal>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TFunction } from '@sisense/sdk-common';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal, OptionsWithAlerts } from '../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
4
4
|
import { CategoricalChartData } from '../../chart-data/types';
|
|
5
5
|
import { HighchartsOptionsInternal } from '../chart-options-service';
|
|
@@ -14,4 +14,4 @@ import { TreemapChartDesignOptions } from '../translations/design-options';
|
|
|
14
14
|
* @param translate - translation function
|
|
15
15
|
* @param themeSettings - theme settings
|
|
16
16
|
*/
|
|
17
|
-
export declare const getTreemapChartOptions: (chartData: CategoricalChartData, chartDesignOptions: TreemapChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, translate: TFunction, themeSettings?:
|
|
17
|
+
export declare const getTreemapChartOptions: (chartData: CategoricalChartData, chartDesignOptions: TreemapChartDesignOptions, dataOptions: CategoricalChartDataOptionsInternal, translate: TFunction, themeSettings?: CompleteThemeSettingsInternal) => OptionsWithAlerts<HighchartsOptionsInternal>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { TFunction } from '@sisense/sdk-common';
|
|
2
2
|
import type { DrilldownOptions, Options, SeriesLegendItemClickCallbackFunction } from '@sisense/sisense-charts';
|
|
3
|
-
import { ChartStyleOptions, ChartType,
|
|
3
|
+
import { ChartStyleOptions, ChartType, CompleteThemeSettingsInternal, HighchartsSelectEvent, OptionsWithAlerts } from '../../../../types';
|
|
4
4
|
import { ChartDataOptionsInternal } from '../chart-data-options/types';
|
|
5
5
|
import { ChartData } from '../chart-data/types';
|
|
6
6
|
import { TooltipSettings } from './tooltip';
|
|
@@ -31,7 +31,7 @@ export type HighchartsOptions = Pick<Options, keyof Options>;
|
|
|
31
31
|
* @param themeSettings -
|
|
32
32
|
* @param dateFormatter
|
|
33
33
|
*/
|
|
34
|
-
export declare const highchartsOptionsService: (chartData: ChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, translate: TFunction, themeSettings?:
|
|
34
|
+
export declare const highchartsOptionsService: (chartData: ChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, translate: TFunction, themeSettings?: CompleteThemeSettingsInternal, dateFormatter?: ((date: Date, format: string) => string) | undefined) => OptionsWithAlerts<HighchartsOptionsInternal>;
|
|
35
35
|
export type SeriesType = HighchartsSeriesValues & {
|
|
36
36
|
/**
|
|
37
37
|
* Name of the series that this series is related to.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal } from '../../../..';
|
|
2
2
|
import { HighchartsOptionsInternal } from './chart-options-service';
|
|
3
3
|
export declare const DEFAULT_ANIMATION_DURATION_MS_INIT = 600;
|
|
4
4
|
export declare const DEFAULT_ANIMATION_DURATION_MS_UPDATE = 300;
|
|
5
|
-
export declare const applyCommonHighchartsOptions: (chartOptions: HighchartsOptionsInternal, themeSettings:
|
|
5
|
+
export declare const applyCommonHighchartsOptions: (chartOptions: HighchartsOptionsInternal, themeSettings: CompleteThemeSettingsInternal, accessibilityEnabled: boolean) => HighchartsOptionsInternal;
|
|
6
6
|
/**
|
|
7
7
|
* Composable variant of applyCommonHighchartsOptions.
|
|
8
8
|
* Returns a function that applies common highcharts options to the chart options.
|
|
@@ -11,4 +11,4 @@ export declare const applyCommonHighchartsOptions: (chartOptions: HighchartsOpti
|
|
|
11
11
|
* @param accessibilityEnabled - Whether accessibility is enabled.
|
|
12
12
|
* @returns A function that applies common highcharts options to the chart.
|
|
13
13
|
*/
|
|
14
|
-
export declare function withCommonHighchartsOptions(themeSettings:
|
|
14
|
+
export declare function withCommonHighchartsOptions(themeSettings: CompleteThemeSettingsInternal, accessibilityEnabled: boolean): (chartOptions: HighchartsOptionsInternal) => HighchartsOptionsInternal;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TFunction } from '@sisense/sdk-common';
|
|
2
|
-
import { ChartType,
|
|
2
|
+
import { ChartType, CompleteThemeSettingsInternal } from '../../../../types';
|
|
3
3
|
import { RangeChartDataOptionsInternal } from '../chart-data-options/types';
|
|
4
4
|
import { RangeChartData } from '../chart-data/types';
|
|
5
5
|
import { ChartDesignOptions } from './translations/types';
|
|
@@ -14,4 +14,4 @@ import { ChartDesignOptions } from './translations/types';
|
|
|
14
14
|
* @param themeSettings -
|
|
15
15
|
* @param dateFormatter
|
|
16
16
|
*/
|
|
17
|
-
export declare const getRangeChartOptions: (chartData: RangeChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: RangeChartDataOptionsInternal, translate: TFunction, themeSettings?:
|
|
17
|
+
export declare const getRangeChartOptions: (chartData: RangeChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: RangeChartDataOptionsInternal, translate: TFunction, themeSettings?: CompleteThemeSettingsInternal, dateFormatter?: ((date: Date, format: string) => string) | undefined) => import("../../../../types").OptionsWithAlerts<import("./chart-options-service").HighchartsOptionsInternal>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ChartType,
|
|
1
|
+
import { ChartType, CompleteThemeSettingsInternal, LegendOptions, OptionsWithAlerts } from '../../../../types';
|
|
2
2
|
import { ChartDataOptionsInternal } from '../chart-data-options/types';
|
|
3
3
|
import { ScatterChartData } from '../chart-data/types';
|
|
4
4
|
import { HighchartsOptionsInternal } from './chart-options-service';
|
|
@@ -19,4 +19,4 @@ export declare const getScatterLegendSettings: (legend?: LegendOptions) => Legen
|
|
|
19
19
|
* @param dataOptions -
|
|
20
20
|
* @param themeSettings -
|
|
21
21
|
*/
|
|
22
|
-
export declare const getScatterChartOptions: (chartData: ScatterChartData, chartType: ChartType, designOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, themeSettings?:
|
|
22
|
+
export declare const getScatterChartOptions: (chartData: ScatterChartData, chartType: ChartType, designOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettingsInternal) => OptionsWithAlerts<HighchartsOptionsInternal>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal } from '../../../../types';
|
|
2
2
|
import { HighchartsOptionsInternal } from './chart-options-service';
|
|
3
|
-
export declare const applyThemeToChart: (chartOptions: HighchartsOptionsInternal, themeSettings?:
|
|
3
|
+
export declare const applyThemeToChart: (chartOptions: HighchartsOptionsInternal, themeSettings?: CompleteThemeSettingsInternal) => HighchartsOptionsInternal;
|
|
4
4
|
/**
|
|
5
5
|
* Composable variant of applyThemeToChart.
|
|
6
6
|
* Returns a function that applies theme options to the chart options.
|
|
@@ -8,4 +8,4 @@ export declare const applyThemeToChart: (chartOptions: HighchartsOptionsInternal
|
|
|
8
8
|
* @param themeSettings - The theme settings to use.
|
|
9
9
|
* @returns A function that applies theme options to the chart options.
|
|
10
10
|
*/
|
|
11
|
-
export declare function withThemeOptions(themeSettings?:
|
|
11
|
+
export declare function withThemeOptions(themeSettings?: CompleteThemeSettingsInternal): (chartOptions: HighchartsOptionsInternal) => HighchartsOptionsInternal;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal, SeriesWithAlerts } from '../../../../../types';
|
|
2
2
|
import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
3
3
|
import { CategoricalChartData } from '../../chart-data/types';
|
|
4
4
|
import { SeriesType } from '../chart-options-service';
|
|
@@ -11,7 +11,7 @@ import { FunnelChartDesignOptions } from './design-options';
|
|
|
11
11
|
* @param designOptions
|
|
12
12
|
* @param themeSettings
|
|
13
13
|
*/
|
|
14
|
-
export declare const formatFunnelChartData: (chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: FunnelChartDesignOptions, themeSettings?:
|
|
14
|
+
export declare const formatFunnelChartData: (chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: FunnelChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal) => SeriesWithAlerts<SeriesType[]>;
|
|
15
15
|
/**
|
|
16
16
|
* Calculate alerts for funnel chart based on data limits.
|
|
17
17
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal, PieSeriesLabels } from '../../../../../types';
|
|
2
2
|
import { ChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
3
3
|
import { PlotOptions } from '../chart-options-service.js';
|
|
4
4
|
import { DataLabelsSettings } from './value-label-section.js';
|
|
@@ -33,7 +33,7 @@ export type GetPiePlotOptionsParams = {
|
|
|
33
33
|
pieType?: PieType;
|
|
34
34
|
seriesLabels?: PieSeriesLabels;
|
|
35
35
|
chartDataOptions: ChartDataOptionsInternal;
|
|
36
|
-
themeSettings?:
|
|
36
|
+
themeSettings?: CompleteThemeSettingsInternal;
|
|
37
37
|
semiCircle?: boolean;
|
|
38
38
|
};
|
|
39
39
|
export declare const getPiePlotOptions: ({ pieType, seriesLabels, chartDataOptions, themeSettings, semiCircle, }: GetPiePlotOptionsParams) => PlotOptions;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SeriesPieOptions } from '@sisense/sisense-charts';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal, Convolution, SeriesWithAlerts } from '../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
4
4
|
import { CategoricalChartData } from '../../chart-data/types';
|
|
5
5
|
import { SeriesType } from '../chart-options-service';
|
|
@@ -20,7 +20,7 @@ export declare const getPieSeries: ({ chartData, dataOptions, seriesCapacity, co
|
|
|
20
20
|
dataOptions: CategoricalChartDataOptionsInternal;
|
|
21
21
|
seriesCapacity: number;
|
|
22
22
|
convolution?: Convolution | undefined;
|
|
23
|
-
themeSettings?:
|
|
23
|
+
themeSettings?: CompleteThemeSettingsInternal | undefined;
|
|
24
24
|
}) => SeriesType[];
|
|
25
25
|
/**
|
|
26
26
|
* Returns only the convolution series (breakdown of "Others" slice).
|
|
@@ -31,7 +31,7 @@ export declare const getPieConvolutionSeries: ({ chartData, dataOptions, seriesC
|
|
|
31
31
|
dataOptions: CategoricalChartDataOptionsInternal;
|
|
32
32
|
seriesCapacity: number;
|
|
33
33
|
convolution?: Convolution | undefined;
|
|
34
|
-
themeSettings?:
|
|
34
|
+
themeSettings?: CompleteThemeSettingsInternal | undefined;
|
|
35
35
|
}) => SeriesPieOptions[];
|
|
36
36
|
/**
|
|
37
37
|
* Convert categorical chart data into renderable highcharts pie series.
|
|
@@ -42,5 +42,5 @@ export declare const getPieConvolutionSeries: ({ chartData, dataOptions, seriesC
|
|
|
42
42
|
* @param themeSettings - Theme configuration for colors and styling
|
|
43
43
|
* @returns Formatted pie chart data with series, alerts, and convolution series
|
|
44
44
|
*/
|
|
45
|
-
export declare const formatCategoricalChartData: (chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: PieChartDesignOptions, themeSettings?:
|
|
45
|
+
export declare const formatCategoricalChartData: (chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: PieChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal) => FormattedPieChartData;
|
|
46
46
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal, SeriesWithAlerts } from '../../../../../types';
|
|
2
2
|
import { ScatterChartDataOptionsInternal } from '../../chart-data-options/types';
|
|
3
3
|
import { ComparableData } from '../../chart-data-processor/table-processor';
|
|
4
4
|
import { ScatterAxisCategoriesMap, ScatterDataTable } from '../../chart-data/types';
|
|
@@ -22,4 +22,4 @@ export interface AxisComputedProperties {
|
|
|
22
22
|
selected?: boolean;
|
|
23
23
|
}
|
|
24
24
|
export declare const handleNumberValue: (cell: ComparableData) => number | null;
|
|
25
|
-
export declare const buildScatterSeries: (data: ScatterDataTable, categoriesMap: ScatterAxisCategoriesMap, dataOptions?: ScatterChartDataOptionsInternal, designOptions?: ChartDesignOptions, themeSettings?:
|
|
25
|
+
export declare const buildScatterSeries: (data: ScatterDataTable, categoriesMap: ScatterAxisCategoriesMap, dataOptions?: ScatterChartDataOptionsInternal, designOptions?: ChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal, seriesCapacity?: number) => SeriesWithAlerts<SeriesType[]>;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { PointLabelObject } from '@sisense/sisense-charts';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal } from '../../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
|
|
4
4
|
import { CategoricalChartData } from '../../../chart-data/types';
|
|
5
5
|
import { SunburstChartDesignOptions } from '../design-options';
|
|
6
|
-
export declare function prepareSunburstLevels(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?:
|
|
6
|
+
export declare function prepareSunburstLevels(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal): ({
|
|
7
7
|
level: number;
|
|
8
8
|
color: string;
|
|
9
9
|
dataLabels: {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { TFunction } from '@sisense/sdk-common';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal } from '../../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
|
|
4
4
|
import { CategoricalChartData } from '../../../chart-data/types';
|
|
5
5
|
import { HighchartsOptionsInternal } from '../../chart-options-service';
|
|
@@ -7,7 +7,7 @@ import { SunburstChartDesignOptions } from '../design-options';
|
|
|
7
7
|
/**
|
|
8
8
|
* Prepares the series configuration for sunburst chart
|
|
9
9
|
*/
|
|
10
|
-
export declare function prepareSunburstSeries(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?:
|
|
10
|
+
export declare function prepareSunburstSeries(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal): ({
|
|
11
11
|
name: string;
|
|
12
12
|
showInLegend: boolean;
|
|
13
13
|
color: string;
|
|
@@ -108,4 +108,4 @@ export declare function prepareSunburstSeries(chartData: CategoricalChartData, d
|
|
|
108
108
|
* Prepares the tooltip configuration for sunburst chart
|
|
109
109
|
*/
|
|
110
110
|
export declare function prepareSunburstTooltip(dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, translate: TFunction): import("../tooltip-utils").TooltipSettings;
|
|
111
|
-
export declare function prepareSunburstOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, translate: TFunction, themeSettings?:
|
|
111
|
+
export declare function prepareSunburstOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, translate: TFunction, themeSettings?: CompleteThemeSettingsInternal): HighchartsOptionsInternal;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal } from '../../../../../../types';
|
|
2
2
|
import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
|
|
3
3
|
import { CategoricalChartData } from '../../../chart-data/types';
|
|
4
4
|
export declare const SUNBURST_ROOT_PARENT_ID = "SUNBURST_ROOT_PARENT_ID";
|
|
5
|
-
export declare function prepareSunburstDataItems(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?:
|
|
5
|
+
export declare function prepareSunburstDataItems(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?: CompleteThemeSettingsInternal): ({
|
|
6
6
|
id: string;
|
|
7
7
|
name: string;
|
|
8
8
|
custom: {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import Highcharts, { PointLabelObject } from '@sisense/sisense-charts';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal, TreemapSeriesLabels } from '../../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
|
|
4
4
|
import { TreemapChartDesignOptions } from '../design-options';
|
|
5
|
-
export declare function prepareTreemapLevels(dataOptions: CategoricalChartDataOptionsInternal, chartDesignOptions: TreemapChartDesignOptions, themeSettings?:
|
|
5
|
+
export declare function prepareTreemapLevels(dataOptions: CategoricalChartDataOptionsInternal, chartDesignOptions: TreemapChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal): Highcharts.PlotTreegraphLevelsOptions[];
|
|
6
6
|
export declare function prepareTreemapLabelFormatter(level: number, seriesLabels: TreemapSeriesLabels): (this: PointLabelObject) => string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { TFunction } from '@sisense/sdk-common';
|
|
2
|
-
import {
|
|
2
|
+
import { CompleteThemeSettingsInternal } from '../../../../../../types';
|
|
3
3
|
import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
|
|
4
4
|
import { CategoricalChartData } from '../../../chart-data/types';
|
|
5
5
|
import { HighchartsOptionsInternal } from '../../chart-options-service';
|
|
6
6
|
import { TreemapChartDesignOptions } from '../design-options';
|
|
7
|
-
export declare function prepareTreemapOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, themeSettings?:
|
|
7
|
+
export declare function prepareTreemapOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, themeSettings?: CompleteThemeSettingsInternal): HighchartsOptionsInternal;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal } from '../../../../../../types';
|
|
2
2
|
import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
|
|
3
3
|
import { CategoricalChartData } from '../../../chart-data/types';
|
|
4
4
|
import { SeriesPointStructure } from '../translations-to-highcharts';
|
|
5
|
-
export declare function prepareTreemapDataItems(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?:
|
|
5
|
+
export declare function prepareTreemapDataItems(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?: CompleteThemeSettingsInternal): SeriesPointStructure[];
|
|
@@ -97,6 +97,15 @@ export interface ChartWidgetProps extends ChartEventProps {
|
|
|
97
97
|
* @category Widget
|
|
98
98
|
*/
|
|
99
99
|
highlightSelectionDisabled?: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* Widget identifier
|
|
102
|
+
*
|
|
103
|
+
* The optional property which is only meaningful for some internal features (for example Excel export).
|
|
104
|
+
*
|
|
105
|
+
* @category Widget
|
|
106
|
+
* @internal
|
|
107
|
+
*/
|
|
108
|
+
id?: string;
|
|
100
109
|
/**
|
|
101
110
|
* Callback to receive widget change events.
|
|
102
111
|
*
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
|
|
2
|
+
import type { ChartWidgetProps } from './types.js';
|
|
3
|
+
export type UseChartWidgetExcelDownloadParams = Pick<ChartWidgetProps, 'title' | 'dataOptions' | 'chartType' | 'config' | 'dataSource' | 'id'> & {
|
|
4
|
+
baseHeaderConfig: WidgetHeaderConfig;
|
|
5
|
+
};
|
|
6
|
+
export type UseChartWidgetExcelDownloadResult = {
|
|
7
|
+
headerConfig: WidgetHeaderConfig;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Enhances a chart widget header with Excel download menu items (placeholder).
|
|
11
|
+
* Excel menu is shown only when the widget/dashboard allows download **and**
|
|
12
|
+
* the Sisense server feature **`exportingXlsxV2`** is active (`api/globals` → `features`).
|
|
13
|
+
* **Repeat rows** sets `mergeRows: false`; **Merge rows** sets `mergeRows: true`).
|
|
14
|
+
*
|
|
15
|
+
* @param props - Chart data/config plus `baseHeaderConfig`. `id` is optional; when present it is forwarded as `widgetId` without validation.
|
|
16
|
+
* @returns Header config for {@link WidgetContainer}
|
|
17
|
+
*/
|
|
18
|
+
export declare function useChartWidgetExcelDownload(props: UseChartWidgetExcelDownloadParams): UseChartWidgetExcelDownloadResult;
|
|
@@ -56,6 +56,15 @@ export interface CustomWidgetProps extends CustomWidgetEventProps {
|
|
|
56
56
|
* @category Widget
|
|
57
57
|
*/
|
|
58
58
|
title?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Widget identifier
|
|
61
|
+
*
|
|
62
|
+
* The optional property which is only meaningful for some internal features (for example Excel export).
|
|
63
|
+
*
|
|
64
|
+
* @category Widget
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
id?: string;
|
|
59
68
|
/**
|
|
60
69
|
* Description of the widget
|
|
61
70
|
*
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
|
|
2
|
+
import type { CustomWidgetProps } from './types.js';
|
|
3
|
+
export type UseCustomWidgetExcelDownloadParams = Pick<CustomWidgetProps, 'title' | 'dataOptions' | 'filters' | 'highlights' | 'config' | 'dataSource' | 'customWidgetType' | 'id'> & {
|
|
4
|
+
baseHeaderConfig: WidgetHeaderConfig;
|
|
5
|
+
};
|
|
6
|
+
export type UseCustomWidgetExcelDownloadResult = {
|
|
7
|
+
headerConfig: WidgetHeaderConfig;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Enhances a custom widget header with Excel download menu items when the server feature
|
|
11
|
+
* **`exportingXlsxV2`** is active. **Repeat rows** sets `mergeRows: false`; **Merge rows** sets `mergeRows: true`.
|
|
12
|
+
*
|
|
13
|
+
* @param props - Custom widget data plus `baseHeaderConfig` (typically from {@link useCustomWidgetCsvDownload}).
|
|
14
|
+
* @returns Header config for {@link WidgetContainer}
|
|
15
|
+
*/
|
|
16
|
+
export declare function useCustomWidgetExcelDownload(props: UseCustomWidgetExcelDownloadParams): UseCustomWidgetExcelDownloadResult;
|
|
@@ -33,7 +33,6 @@ import { PivotTableWidgetProps } from './types';
|
|
|
33
33
|
* />
|
|
34
34
|
* ```
|
|
35
35
|
* <img src="media://pivot-widget-example.png" width="800px" />
|
|
36
|
-
*
|
|
37
36
|
* @param props - Pivot Table Widget properties
|
|
38
37
|
* @returns Widget component representing a pivot table
|
|
39
38
|
* @group Dashboards
|
|
@@ -70,6 +70,15 @@ export interface PivotTableWidgetProps {
|
|
|
70
70
|
* @category Widget
|
|
71
71
|
*/
|
|
72
72
|
title?: string;
|
|
73
|
+
/**
|
|
74
|
+
* Widget identifier
|
|
75
|
+
*
|
|
76
|
+
* The optional property which is only meaningful for some internal features (for example Excel export).
|
|
77
|
+
*
|
|
78
|
+
* @category Widget
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
id?: string;
|
|
73
82
|
/**
|
|
74
83
|
* Description of the widget
|
|
75
84
|
*
|
|
@@ -112,7 +121,6 @@ export interface PivotTableWidgetProps {
|
|
|
112
121
|
* }
|
|
113
122
|
* };
|
|
114
123
|
* ```
|
|
115
|
-
*
|
|
116
124
|
* @internal
|
|
117
125
|
*/
|
|
118
126
|
onDataCellFormat?: CustomDataCellFormatter;
|
|
@@ -134,7 +142,6 @@ export interface PivotTableWidgetProps {
|
|
|
134
142
|
* }
|
|
135
143
|
* };
|
|
136
144
|
* ```
|
|
137
|
-
*
|
|
138
145
|
* @internal
|
|
139
146
|
*/
|
|
140
147
|
onHeaderCellFormat?: CustomHeaderCellFormatter;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
|
|
2
|
+
import type { PivotTableWidgetProps } from './types.js';
|
|
3
|
+
export type UsePivotWidgetExcelDownloadParams = Pick<PivotTableWidgetProps, 'title' | 'dataOptions' | 'config' | 'dataSource' | 'filters' | 'highlights' | 'id'> & {
|
|
4
|
+
baseHeaderConfig: WidgetHeaderConfig;
|
|
5
|
+
};
|
|
6
|
+
export type UsePivotWidgetExcelDownloadResult = {
|
|
7
|
+
headerConfig: WidgetHeaderConfig;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Enhances a pivot table widget header with Excel download menu items.
|
|
11
|
+
* Excel menu is shown only when the widget/dashboard allows download **and**
|
|
12
|
+
* the Sisense server feature **`exportingXlsxV2`** is active (`api/globals` → `features`).
|
|
13
|
+
* **Repeat rows** sets `mergeRows: false`; **Merge rows** sets `mergeRows: true`).
|
|
14
|
+
*
|
|
15
|
+
* @param props - Pivot data/config plus `baseHeaderConfig`. `id` is optional; when present it is forwarded as `widgetId` without validation.
|
|
16
|
+
* @returns Header config for {@link WidgetContainer}
|
|
17
|
+
*/
|
|
18
|
+
export declare function usePivotWidgetExcelDownload(props: UsePivotWidgetExcelDownloadParams): UsePivotWidgetExcelDownloadResult;
|
|
@@ -32,6 +32,19 @@ export type WidgetConfig = {
|
|
|
32
32
|
*/
|
|
33
33
|
enabled?: boolean;
|
|
34
34
|
};
|
|
35
|
+
/**
|
|
36
|
+
* Configuration for downloading an Excel file.
|
|
37
|
+
*
|
|
38
|
+
* @sisenseInternal
|
|
39
|
+
*/
|
|
40
|
+
downloadExcel?: {
|
|
41
|
+
/**
|
|
42
|
+
* Determines whether the possibility to download Excel is enabled.
|
|
43
|
+
*
|
|
44
|
+
* If not specified, the default value is `false`.
|
|
45
|
+
*/
|
|
46
|
+
enabled?: boolean;
|
|
47
|
+
};
|
|
35
48
|
};
|
|
36
49
|
};
|
|
37
50
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { PivotGrandTotals } from '@sisense/sdk-data';
|
|
2
2
|
import { AppSettings } from '../../../../../infra/app/settings/settings.js';
|
|
3
|
-
import type { AreamapType, AreaStyleOptions, AxisLabel,
|
|
3
|
+
import type { AreamapType, AreaStyleOptions, AxisLabel, CompleteThemeSettingsInternal, DataLimits, FunnelStyleOptions, IndicatorStyleOptions, LegendOptions, LineStyleOptions, LineWidth, Markers, Navigator, PieStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, ScattermapStyleOptions, ScatterStyleOptions, SeriesLabels, StackableStyleOptions, SunburstStyleOptions, TableStyleOptions, TreemapStyleOptions, WidgetStyleOptions } from '../../../../../types.js';
|
|
4
4
|
import type { AxisStyle, CartesianWidgetStyle, FunnelWidgetStyle, PivotWidgetStyle, PolarWidgetStyle, ScattermapWidgetStyle, ScatterWidgetStyle, SunburstWidgetStyle, TableWidgetStyle, TreemapWidgetStyle, WidgetDesign, WidgetStyle, WidgetSubtype } from '../types.js';
|
|
5
5
|
/**
|
|
6
6
|
* Maps SDK legend options to Fusion DTO legend style.
|
|
@@ -69,7 +69,7 @@ export declare function hasWidgetContainerStyleFields(styleOptions: WidgetStyleO
|
|
|
69
69
|
*
|
|
70
70
|
* @internal
|
|
71
71
|
*/
|
|
72
|
-
export declare function toWidgetDesign(styleOptions: WidgetStyleOptions, widgetTheme:
|
|
72
|
+
export declare function toWidgetDesign(styleOptions: WidgetStyleOptions, widgetTheme: CompleteThemeSettingsInternal['widget']): WidgetDesign | undefined;
|
|
73
73
|
/**
|
|
74
74
|
* Attaches `style.widgetDesign` built from widget container fields in `styleOptions`.
|
|
75
75
|
* When the feature flag is off, or when `styleOptions` carries no container fields, the
|
|
@@ -81,7 +81,7 @@ export declare function toWidgetDesign(styleOptions: WidgetStyleOptions, widgetT
|
|
|
81
81
|
* @param appSettings - The application settings to be used for the widget design
|
|
82
82
|
* @returns The widget style with the widget design
|
|
83
83
|
*/
|
|
84
|
-
export declare function withWidgetDesign(baseStyle: WidgetStyle, styleOptions: WidgetStyleOptions, themeSettings:
|
|
84
|
+
export declare function withWidgetDesign(baseStyle: WidgetStyle, styleOptions: WidgetStyleOptions, themeSettings: CompleteThemeSettingsInternal, appSettings?: AppSettings): WidgetStyle;
|
|
85
85
|
/**
|
|
86
86
|
* Maps SDK pie chart style options to Fusion PieWidgetStyle (DTO).
|
|
87
87
|
* Inverse of {@link extractPieChartStyleOptions}.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Triggers a browser file download from a Blob.
|
|
3
|
+
*
|
|
4
|
+
* @param blob - Blob to download
|
|
5
|
+
* @param filename - Suggested file name
|
|
6
|
+
*/
|
|
7
|
+
export declare function downloadBlobAsFile(blob: Blob, filename: string): void;
|
|
8
|
+
/**
|
|
9
|
+
* Normalizes a file name by removing invalid characters and keeping the extension.
|
|
10
|
+
*
|
|
11
|
+
* @param rawFileName - Raw file name
|
|
12
|
+
* @returns Normalized file name
|
|
13
|
+
*/
|
|
14
|
+
export declare function normalizeFileName(rawFileName: string): string;
|
package/dist/packages/sdk-ui/src/domains/widgets/helpers/excel-export-map-dimensions-measures.d.ts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { type Attribute, type Measure } from '@sisense/sdk-data';
|
|
2
|
+
/**
|
|
3
|
+
* Returns attributes prepared for Excel JAQL export: dimensional level attributes without an
|
|
4
|
+
* explicit display format receive a level-appropriate default so the backend renders human-readable
|
|
5
|
+
* date strings (e.g. "2009" for Years) instead of raw datetime values.
|
|
6
|
+
* Attributes that already carry a display format are returned unchanged.
|
|
7
|
+
*
|
|
8
|
+
* @param attributes - Raw attributes from chart or pivot translation
|
|
9
|
+
* @returns New array of attributes safe to pass as export dimensions
|
|
10
|
+
*/
|
|
11
|
+
export declare function mapAttributesForExcelExport(attributes: readonly Attribute[]): Attribute[];
|
|
12
|
+
/**
|
|
13
|
+
* Returns measures prepared for Excel JAQL export: applies a default number format when none is set.
|
|
14
|
+
*
|
|
15
|
+
* @param measures - Raw measures from chart or pivot translation
|
|
16
|
+
* @returns New array of measures safe to pass as export measures
|
|
17
|
+
*/
|
|
18
|
+
export declare function mapMeasuresForExcelExport(measures: readonly Measure[]): Measure[];
|
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
* @internal
|
|
4
4
|
*/
|
|
5
5
|
export declare const widgetHelpers: {
|
|
6
|
+
downloadBlobAsFile(blob: Blob, filename: string): void;
|
|
7
|
+
normalizeFileName(rawFileName: string): string;
|
|
6
8
|
withMenuItemInHeaderConfig(menuItem: import("../../../shared/types/menu-item").MenuItem): (headerConfig: import("../shared/widget-header/types").WidgetHeaderConfig) => import("../shared/widget-header/types").WidgetHeaderConfig;
|
|
7
9
|
withHeaderMenuItem(menuItem: import("../../../shared/types/menu-item").MenuItem): (widget: import("../components/widget").WidgetProps) => import("../components/widget").WidgetProps;
|
|
8
10
|
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { ExecuteExcelQueryParams } from '../../../domains/query-execution/types.js';
|
|
2
|
+
export type ExcelExecuteParams = Omit<ExecuteExcelQueryParams, 'enabled' | 'exportRunId'>;
|
|
3
|
+
export type UseExcelQueryLoaderResult = {
|
|
4
|
+
/** Triggers Excel export and browser file download with the given params. */
|
|
5
|
+
execute: (params: ExcelExecuteParams) => void;
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* Hook that runs an Excel JAQL export on demand and triggers a browser file download.
|
|
9
|
+
* Uses {@link useExecuteExcelQueryInternal} for loading and error state (mirrors {@link useCsvQueryFileLoader}).
|
|
10
|
+
*
|
|
11
|
+
* @returns `execute` callback
|
|
12
|
+
*/
|
|
13
|
+
export declare function useExcelQueryFileLoader(): UseExcelQueryLoaderResult;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { WidgetHeaderConfig } from '../../../domains/widgets/shared/widget-header/types.js';
|
|
2
|
+
export type UseWithExcelDownloadMenuParams = {
|
|
3
|
+
/** Base header config. */
|
|
4
|
+
baseHeaderConfig: WidgetHeaderConfig;
|
|
5
|
+
/** Whether Excel download menu items are shown. */
|
|
6
|
+
enabled: boolean;
|
|
7
|
+
/** Triggers Excel download; receives `mergeRows` flag (Angular: `buildRequest(..., mergeRows)`). */
|
|
8
|
+
onDownloadExcel: (mergeRows: boolean) => void;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Appends **Download → Excel File → (Repeat rows | Merge rows)** to the widget header menu when enabled.
|
|
12
|
+
*
|
|
13
|
+
* If a **Download** group (`widget-download`) already exists (e.g. after CSV), the **Excel File** branch is appended to its `items` (any prior `excelFileMenuItem` entry is removed first so it is not duplicated).
|
|
14
|
+
* Otherwise a new **Download** group containing only the Excel subtree is appended.
|
|
15
|
+
*
|
|
16
|
+
* @param params.baseHeaderConfig - Base header config.
|
|
17
|
+
* @param params.enabled - When false, returns `baseHeaderConfig` unchanged.
|
|
18
|
+
* @param params.onDownloadExcel - Invoked with `mergeRows` false for "Repeat rows", true for "Merge rows".
|
|
19
|
+
* @returns Header config to pass to {@link WidgetContainer}
|
|
20
|
+
*/
|
|
21
|
+
export declare function useWithExcelDownloadMenuItem({ baseHeaderConfig, enabled, onDownloadExcel, }: UseWithExcelDownloadMenuParams): WidgetHeaderConfig;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CompleteThemeSettingsInternal, WidgetContainerStyleOptions } from '../../../types';
|
|
2
2
|
export declare enum WidgetCornerRadius {
|
|
3
3
|
'None' = "",
|
|
4
4
|
'Large' = "30px",
|
|
@@ -11,4 +11,4 @@ export declare enum WidgetSpaceAround {
|
|
|
11
11
|
'Medium' = "10px",
|
|
12
12
|
'Small' = "5px"
|
|
13
13
|
}
|
|
14
|
-
export declare const getShadowValue: (styleOptions: WidgetContainerStyleOptions | undefined, themeSettings:
|
|
14
|
+
export declare const getShadowValue: (styleOptions: WidgetContainerStyleOptions | undefined, themeSettings: CompleteThemeSettingsInternal) => string;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient } from '@sisense/sdk-rest-client';
|
|
2
2
|
import { AppSettings } from '../../../infra/app/settings/settings';
|
|
3
|
-
import {
|
|
3
|
+
import { CompleteThemeSettingsInternal } from '../../../types';
|
|
4
4
|
import { WidgetModel } from './widget-model';
|
|
5
5
|
/**
|
|
6
6
|
* Retrieves a widget model by its OID.
|
|
@@ -13,4 +13,4 @@ import { WidgetModel } from './widget-model';
|
|
|
13
13
|
* @returns The widget model
|
|
14
14
|
* @internal
|
|
15
15
|
*/
|
|
16
|
-
export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string, themeSettings?:
|
|
16
|
+
export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string, themeSettings?: CompleteThemeSettingsInternal, appSettings?: AppSettings): Promise<WidgetModel>;
|