@sisense/sdk-ui 2.9.0 → 2.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.
- package/dist/ai.cjs +32 -32
- package/dist/ai.js +426 -419
- package/dist/analytics-composer/node.cjs +3 -1
- package/dist/analytics-composer/node.js +521 -385
- package/dist/analytics-composer.cjs +1 -1
- package/dist/analytics-composer.js +6 -6
- package/dist/derive-chart-family-BauaWEEc.cjs +170 -0
- package/dist/derive-chart-family-BhAFg8OE.js +29535 -0
- package/dist/{dimensions-B2jz151s.js → dimensions-Bk74slQe.js} +1 -1
- package/dist/{dimensions-CVJeJ8mi.cjs → dimensions-DCxjxuyH.cjs} +1 -1
- package/dist/{execute-query-agpyzZz6.js → execute-query-CxMSGp-J.js} +292 -269
- package/dist/execute-query-uQ2s1ZNz.cjs +1 -0
- package/dist/index.cjs +25 -26
- package/dist/index.js +12805 -11832
- package/dist/index.umd.js +384 -374
- package/dist/packages/sdk-ui/src/ai/chart/nlq-chart-widget.d.ts +7 -1
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/common.d.ts +14 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-dimensions.d.ts +2 -2
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-filters.d.ts +5 -5
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-measures.d.ts +3 -3
- package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/app/client-application.d.ts +2 -2
- package/dist/packages/sdk-ui/src/calendar-heatmap-chart.d.ts +26 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/calendar-heatmap-chart-builder.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/constants.d.ts +118 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data-options/data-options.d.ts +56 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data-options/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data.d.ts +34 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/design-options.d.ts +22 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/highcharts-options-builder.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/axes-options.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/chart-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/extras-options.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/legend-options.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/plot-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/calendar-data-generator.d.ts +42 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/series-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/tooltip-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-heatmap-charts-grid.d.ts +34 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-heatmap.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/calendar-pagination.d.ts +31 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/helpers.d.ts +3 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/data-helpers.d.ts +4 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/sizing-helpers.d.ts +14 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/view-helpers.d.ts +16 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/index.d.ts +4 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/use-calendar-heatmap-chart-options.d.ts +55 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/use-calendar-heatmap-navigation.d.ts +33 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/types.d.ts +13 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/calendar-utils.d.ts +33 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/with-calendar-heatmap-data-coloring.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/data-options.d.ts +5 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/highchart-options/legend.d.ts +3 -2
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/alerts/index.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/data/index.d.ts +21 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/data-options/index.d.ts +32 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/design-options/index.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/funnel-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/helpers/data-options.d.ts +22 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/helpers/data.d.ts +13 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/alerts/index.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/data/index.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/data-options/index.d.ts +32 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/design-options/index.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/pie-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/alerts/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/data/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/data-options/index.d.ts +11 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/design-options/index.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/sunburst-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/alerts/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/data/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/data-options/index.d.ts +11 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/design-options/index.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/treemap-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer.d.ts +2 -4
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/use-extra-config.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/types.d.ts +12 -10
- package/dist/packages/sdk-ui/src/chart-data/types.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-data-options/translate-data-options.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-data-options/types.d.ts +19 -2
- package/dist/packages/sdk-ui/src/chart-data-options/utils.d.ts +4 -4
- package/dist/packages/sdk-ui/src/chart-data-options/validate-data-options/validate-categorical-data-options.d.ts +14 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/series-processor.d.ts +23 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/{category-chart-options.d.ts → category-chart-options/category-chart-options.d.ts} +9 -5
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/funnel-chart-options.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/pie-chart-options.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/sunburst-chart-options.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/treemap-chart-options.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/chart-options-service.d.ts +29 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/scatter-chart-options.d.ts +3 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/series-labels.d.ts +19 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/style-to-design-options-translator/translate-to-highcharts-options.d.ts +1 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/axis-section.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/boxplot/boxplot-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/design-options.d.ts +43 -7
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/funnel-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/funnel-series.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/legend-section.d.ts +28 -14
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-series.d.ts +34 -6
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/scatter-series.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/sunburst/sunburst-options.d.ts +78 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/tooltip-utils.d.ts +10 -4
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/translations-to-highcharts.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/types.d.ts +50 -6
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/value-label-section.d.ts +14 -11
- package/dist/packages/sdk-ui/src/common/components/modal/modal-context.d.ts +1 -2
- package/dist/packages/sdk-ui/src/common/formatters/create-date-formatter.d.ts +10 -0
- package/dist/packages/sdk-ui/src/common/hooks/useDateFormatter.d.ts +7 -0
- package/dist/packages/sdk-ui/src/common/icons/double-arrow-end-icon.d.ts +6 -0
- package/dist/packages/sdk-ui/src/dashboard/components/editable-layout/utils.d.ts +0 -19
- package/dist/packages/sdk-ui/src/dashboard/components/jtd-dashboard.d.ts +5 -4
- package/dist/packages/sdk-ui/src/dashboard/dashboard-helpers.d.ts +109 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/index.d.ts +20 -5
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-config-transformers.d.ts +85 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-filters.d.ts +15 -3
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-formatters.d.ts +80 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-handlers.d.ts +26 -4
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-menu.d.ts +1 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-types.d.ts +260 -5
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-widget-transforms.d.ts +29 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-dashboard-header-toolbar.d.ts +7 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-edit-mode-toolbar.d.ts +3 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-jtd-widget.d.ts +68 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-jtd.d.ts +33 -7
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-tabber.d.ts +13 -0
- package/dist/packages/sdk-ui/src/dashboard/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/utils.d.ts +1 -3
- package/dist/packages/sdk-ui/src/index.d.ts +10 -1
- package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts +26 -2
- package/dist/packages/sdk-ui/src/models/dashboard/types.d.ts +8 -4
- package/dist/packages/sdk-ui/src/pivot-table/formatters/header-cell-formatters/header-cell-value-formatter.d.ts +2 -1
- package/dist/packages/sdk-ui/src/pivot-table/formatters/types.d.ts +0 -1
- package/dist/packages/sdk-ui/src/polar-chart.d.ts +1 -1
- package/dist/packages/sdk-ui/src/props.d.ts +66 -7
- package/dist/packages/sdk-ui/src/sisense-chart/types.d.ts +2 -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 +11 -0
- package/dist/packages/sdk-ui/src/translation/resources/index.d.ts +22 -0
- package/dist/packages/sdk-ui/src/types.d.ts +444 -32
- package/dist/packages/sdk-ui/src/utils/combine-handlers.d.ts +19 -0
- package/dist/packages/sdk-ui/src/utils/create-level-attribute.d.ts +11 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/transformer.d.ts +8 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts +45 -74
- package/dist/{types-QUSMO7gF.cjs → types-DhvOgfXa.cjs} +1 -1
- package/dist/{types-BYUVZb6u.js → types-Dxieyr4A.js} +1 -1
- package/dist/use-common-filters-DJyYvdev.js +91688 -0
- package/dist/use-common-filters-Qj9249s0.cjs +845 -0
- package/dist/{widget-composer-BG4HonVl.js → widget-composer-azihIMsw.js} +3 -3
- package/dist/{widget-composer-CGp5yOny.cjs → widget-composer-omIEhWNL.cjs} +1 -1
- package/package.json +13 -18
- package/dist/derive-chart-family-BLG1sO1D.js +0 -86946
- package/dist/derive-chart-family-QPmz5DJ3.cjs +0 -656
- package/dist/execute-query-Cp3se7Yb.cjs +0 -1
- package/dist/packages/sdk-ui/src/utils/__development-utils__/highcharts-options-builder-collector.d.ts +0 -61
- package/dist/packages/sdk-ui/src/utils/__development-utils__/input-output-collector.d.ts +0 -125
- package/dist/use-common-filters-DmdADAhl.cjs +0 -350
- package/dist/use-common-filters-wo5IRF5u.js +0 -31972
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { WidgetsPanelLayout } from '../../models';
|
|
2
2
|
/**
|
|
3
3
|
* Props for the useEditModeToolbar hook
|
|
4
|
+
* @internal
|
|
4
5
|
*/
|
|
5
6
|
export interface UseEditModeToolbarProps {
|
|
6
7
|
/**
|
|
@@ -23,6 +24,7 @@ export interface UseEditModeToolbarProps {
|
|
|
23
24
|
}
|
|
24
25
|
/**
|
|
25
26
|
* Return type for the useEditModeToolbar hook
|
|
27
|
+
* @internal
|
|
26
28
|
*/
|
|
27
29
|
export interface UseEditModeToolbarResult {
|
|
28
30
|
/**
|
|
@@ -47,5 +49,6 @@ export interface UseEditModeToolbarResult {
|
|
|
47
49
|
*
|
|
48
50
|
* @param props Configuration options for the toolbar
|
|
49
51
|
* @returns Layout state and toolbar component
|
|
52
|
+
* @internal
|
|
50
53
|
*/
|
|
51
54
|
export declare function useEditModeToolbar({ initialLayout, onApply, onCancel, historyCapacity, }: UseEditModeToolbarProps): UseEditModeToolbarResult;
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { WidgetProps } from '../../props.js';
|
|
2
|
+
import { JumpToDashboardConfig } from './jtd/jtd-types';
|
|
3
|
+
import { JumpToDashboardConfigForPivot } from './use-jtd';
|
|
4
|
+
/**
|
|
5
|
+
* Hook to add Jump To Dashboard (JTD) functionality to individual Widget components.
|
|
6
|
+
*
|
|
7
|
+
* Jump To Dashboard (JTD) allows users to navigate from one dashboard to another when interacting with widgets,
|
|
8
|
+
* such as clicking on chart data points or using context menus. This hook is particularly useful when rendering
|
|
9
|
+
* Widget components directly (not through a Dashboard component), but you still want JTD navigation functionality.
|
|
10
|
+
*
|
|
11
|
+
* For widgets that are part of a dashboard, consider using `applyJtdConfig` or `applyJtdConfigs` instead,
|
|
12
|
+
* as they apply JTD configuration at the dashboard level rather than individual widget level.
|
|
13
|
+
*
|
|
14
|
+
* Note: dashboard-only 'includeDashboardFilters' is not supported and would just be ignored, since we do not have a dashboard in the current context.
|
|
15
|
+
*
|
|
16
|
+
* This hook enhances the provided widget props with JTD navigation capabilities, including:
|
|
17
|
+
* - Click and right-click event handlers for navigation
|
|
18
|
+
* - Hyperlink styling for actionable pivot cells (when applicable)
|
|
19
|
+
* - JTD icon display in widget headers
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* Basic JTD configuration with right-click navigation.
|
|
23
|
+
* ```typescript
|
|
24
|
+
* import { useJtdWidget } from '@sisense/sdk-ui';
|
|
25
|
+
*
|
|
26
|
+
* const jtdConfig: JumpToDashboardConfig = {
|
|
27
|
+
* targets: [{ id: 'dashboard-1', caption: 'Sales Dashboard' }],
|
|
28
|
+
* interaction: {
|
|
29
|
+
* triggerMethod: 'rightclick',
|
|
30
|
+
* captionPrefix: 'Jump to'
|
|
31
|
+
* }
|
|
32
|
+
* };
|
|
33
|
+
*
|
|
34
|
+
* const MyComponent = () => {
|
|
35
|
+
* const widgetWithJtd = useJtdWidget(myWidgetProps, jtdConfig);
|
|
36
|
+
*
|
|
37
|
+
* return <Widget {...widgetWithJtd} />;
|
|
38
|
+
* };
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* JTD configuration with multiple targets and custom styling.
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const jtdConfig: JumpToDashboardConfig = {
|
|
45
|
+
* enabled: true,
|
|
46
|
+
* targets: [
|
|
47
|
+
* { id: 'sales-dashboard', caption: 'Sales Analysis' },
|
|
48
|
+
* { id: 'marketing-dashboard', caption: 'Marketing Insights' }
|
|
49
|
+
* ],
|
|
50
|
+
* interaction: {
|
|
51
|
+
* triggerMethod: 'click',
|
|
52
|
+
* captionPrefix: 'Navigate to',
|
|
53
|
+
* showIcon: true
|
|
54
|
+
* },
|
|
55
|
+
* filtering: {
|
|
56
|
+
* mergeWithTargetFilters: true,
|
|
57
|
+
* includeWidgetFilters: true
|
|
58
|
+
* }
|
|
59
|
+
* };
|
|
60
|
+
*
|
|
61
|
+
* const widgetWithJtd = useJtdWidget(chartProps, jtdConfig);
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @returns Enhanced widget props with JTD navigation capabilities, menu combination, and styling applied
|
|
65
|
+
*
|
|
66
|
+
* @group Dashboards
|
|
67
|
+
*/
|
|
68
|
+
export declare const useJtdWidget: (widgetProps: WidgetProps | null, config: JumpToDashboardConfig | JumpToDashboardConfigForPivot) => WidgetProps | null;
|
|
@@ -1,22 +1,48 @@
|
|
|
1
1
|
import { type Filter } from '@sisense/sdk-data';
|
|
2
2
|
import { WidgetProps } from '../../props.js';
|
|
3
3
|
import { OpenMenuFn } from '../../common/components/menu/types.js';
|
|
4
|
-
import { WidgetsOptions } from '../../index-typedoc';
|
|
4
|
+
import { CompleteThemeSettings, WidgetsOptions } from '../../index-typedoc';
|
|
5
|
+
import { type JtdActions } from '../../dashboard/hooks/jtd/jtd-types';
|
|
6
|
+
import { JtdConfig } from '../../dashboard/hooks/jtd/jtd-types';
|
|
5
7
|
/**
|
|
6
|
-
*
|
|
8
|
+
* Shared function to apply JTD functionality to a widget.
|
|
9
|
+
* Extracted to avoid code duplication between use-jtd.ts and use-jtd-widget.ts
|
|
10
|
+
*
|
|
11
|
+
* @param widgetProps - The widget props to enhance
|
|
12
|
+
* @param config - JTD application configuration
|
|
13
|
+
* @returns Enhanced widget props with JTD functionality
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export declare const applyJtdToWidget: (widgetProps: WidgetProps, config: {
|
|
17
|
+
normalizedJtdConfig: JtdConfig;
|
|
18
|
+
dashboardFilters: Filter[];
|
|
19
|
+
originalWidgetFilters: Filter[];
|
|
20
|
+
extraFilters?: Filter[];
|
|
21
|
+
actions: JtdActions;
|
|
22
|
+
themeSettings: CompleteThemeSettings;
|
|
23
|
+
}) => WidgetProps;
|
|
24
|
+
/**
|
|
25
|
+
* Internal Jump To Dashboard (JTD) hook.
|
|
7
26
|
* Implements the JTD functionality for each widget with JTD config.
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* @param
|
|
11
|
-
* @param
|
|
27
|
+
* Supports both legacy JtdConfig and new JumpToDashboardConfig formats.
|
|
28
|
+
*
|
|
29
|
+
* @param config - The configuration object
|
|
30
|
+
* @param config.widgetOptions - The widget options of the dashboard
|
|
31
|
+
* @param config.dashboardFilters - The dashboard filters to use
|
|
32
|
+
* @param config.widgetFilters - The widget filters to use
|
|
33
|
+
* @param config.extraFilters - Extra filters to apply with highest priority
|
|
34
|
+
* @param config.openMenu - The open menu function to use
|
|
12
35
|
* @returns The connect to widget props function
|
|
36
|
+
* @internal
|
|
13
37
|
*/
|
|
14
|
-
export declare const
|
|
38
|
+
export declare const useJtdInternal: ({ widgetOptions, dashboardFilters, widgetFilters, openMenu, extraFilters, }: {
|
|
15
39
|
widgetOptions: WidgetsOptions;
|
|
16
40
|
dashboardFilters?: Filter[] | undefined;
|
|
17
41
|
widgetFilters?: Map<string, Filter[]> | undefined;
|
|
42
|
+
extraFilters?: Filter[] | undefined;
|
|
18
43
|
openMenu: OpenMenuFn;
|
|
19
44
|
}) => {
|
|
20
45
|
connectToWidgetProps: (widgetProps: WidgetProps) => WidgetProps;
|
|
21
46
|
};
|
|
22
47
|
export * from './jtd';
|
|
48
|
+
export { useJtdWidget } from './use-jtd-widget';
|
|
@@ -2,6 +2,9 @@ import { WidgetProps } from '../../props';
|
|
|
2
2
|
import { WidgetPanelLayoutManager } from '../../dashboard/hooks/use-widgets-layout';
|
|
3
3
|
import { TabberTab } from '../../types';
|
|
4
4
|
import { TabbersOptions, WidgetsPanelColumnLayout } from '../../models';
|
|
5
|
+
/**
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
5
8
|
export type UseTabber = ({ widgets, config, }: {
|
|
6
9
|
widgets: WidgetProps[];
|
|
7
10
|
config?: TabbersOptions | undefined;
|
|
@@ -9,10 +12,20 @@ export type UseTabber = ({ widgets, config, }: {
|
|
|
9
12
|
layoutManager: WidgetPanelLayoutManager;
|
|
10
13
|
widgets: WidgetProps[];
|
|
11
14
|
};
|
|
15
|
+
/**
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
12
18
|
export type SingleTabberConfig = {
|
|
13
19
|
tabs: TabberTab[];
|
|
14
20
|
activeTab: number;
|
|
15
21
|
};
|
|
16
22
|
export declare const isTabberWidget: (widget: WidgetProps) => boolean;
|
|
17
23
|
export declare const modifyLayout: (tabbersOptions: TabbersOptions, tabberState: Record<string, number>) => (layout: WidgetsPanelColumnLayout) => WidgetsPanelColumnLayout;
|
|
24
|
+
/**
|
|
25
|
+
* Hook that modifies widget properties so it became a tabber widget.
|
|
26
|
+
* Incapsulates logic for updating layout via navigating tabs
|
|
27
|
+
* @param widgets
|
|
28
|
+
* @param tabbersConfigs
|
|
29
|
+
* @internal
|
|
30
|
+
*/
|
|
18
31
|
export declare const useTabber: UseTabber;
|
|
@@ -2,4 +2,5 @@ export { DashboardById } from './dashboard-by-id';
|
|
|
2
2
|
export { Dashboard } from './dashboard';
|
|
3
3
|
export { useComposedDashboard, useComposedDashboardInternal, type ComposableDashboardProps, type UseComposedDashboardOptions, } from './use-composed-dashboard';
|
|
4
4
|
export { useDashboardTheme, type DashboardThemeParams } from './use-dashboard-theme';
|
|
5
|
+
export * from './hooks';
|
|
5
6
|
export type { DashboardByIdProps, DashboardProps, DashboardLayoutOptions, DashboardStyleOptions, DashboardConfig, DashboardByIdConfig, WidgetsPanelConfig, EditModeConfig, DashboardFiltersPanelConfig, } from './types';
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { Filter, MembersFilter, DimensionalLevelAttribute, RelativeDateFilter } from '@sisense/sdk-data';
|
|
1
|
+
import { Filter, MembersFilter, RelativeDateFilter } from '@sisense/sdk-data';
|
|
3
2
|
export declare function isSupportedByFilterEditor(filter: Filter): boolean;
|
|
4
3
|
export declare function isIncludeAllFilter(filter: Filter): filter is MembersFilter;
|
|
5
4
|
export declare function isIncludeMembersFilter(filter: Filter): filter is MembersFilter;
|
|
@@ -8,7 +7,6 @@ export declare function isConditionalFilter(filter: Filter): boolean;
|
|
|
8
7
|
export declare function isNumericBetweenFilter(filter: Filter): boolean;
|
|
9
8
|
export declare function isRelativeDateFilterWithAnchor(filter: Filter): filter is RelativeDateFilter;
|
|
10
9
|
export declare function isRelativeDateFilterWithoutAnchor(filter: Filter): filter is RelativeDateFilter;
|
|
11
|
-
export declare function createLevelAttribute(baseLevelAttribute: DimensionalLevelAttribute, granularity: string, t: TFunction): DimensionalLevelAttribute;
|
|
12
10
|
/**
|
|
13
11
|
* Formats a given Date object into a string in the format "YYYY-MM-DDT00:00:00".
|
|
14
12
|
*
|
|
@@ -37,6 +37,7 @@ export * from './boxplot-chart';
|
|
|
37
37
|
export * from './scattermap-chart';
|
|
38
38
|
export * from './areamap-chart';
|
|
39
39
|
export * from './area-range-chart';
|
|
40
|
+
export * from './calendar-heatmap-chart';
|
|
40
41
|
export * from './sisense-context/custom-sisense-context-provider';
|
|
41
42
|
export * from './theme-provider/custom-theme-provider';
|
|
42
43
|
export * from './custom-widgets-provider/custom-widgets-provider-adapter';
|
|
@@ -45,7 +46,7 @@ export { useCustomWidgets } from './custom-widgets-provider';
|
|
|
45
46
|
export { extractDimensionsAndMeasures, useExecuteCustomWidgetQuery, useExecuteCustomWidgetQueryInternal, type ExecuteCustomWidgetQueryParams, type CustomWidgetQueryState, } from './custom-widgets-provider';
|
|
46
47
|
export { getThemeSettingsByOid } from './themes/theme-loader';
|
|
47
48
|
export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
|
|
48
|
-
export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, useDashboardPersistence, 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 WidgetsPanelColumn, type WidgetsPanelRow, type WidgetsPanelCell, 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
|
+
export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, useDashboardPersistence, 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 WidgetsPanelColumn, type WidgetsPanelRow, type WidgetsPanelCell, type WidgetId, type DashboardId, 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
50
|
/**
|
|
50
51
|
* Utility functions to translate a Fusion widget model from and to other widget data structures
|
|
51
52
|
*
|
|
@@ -69,6 +70,13 @@ export * as dashboardModelTranslator from './models/dashboard/dashboard-model-tr
|
|
|
69
70
|
* @shortDescription Utility functions to manipulate dashboard elements
|
|
70
71
|
*/
|
|
71
72
|
export * as dashboardHelpers from './dashboard/dashboard-helpers';
|
|
73
|
+
/**
|
|
74
|
+
* Jump To Dashboard (JTD) configuration types
|
|
75
|
+
*
|
|
76
|
+
* @group Dashboards
|
|
77
|
+
* @shortDescription Configuration types for Jump To Dashboard functionality
|
|
78
|
+
*/
|
|
79
|
+
export type { JumpToDashboardConfig } from './dashboard/hooks/jtd';
|
|
72
80
|
export type { AutoZoomNavigatorScrollerLocation } from './widget-by-id/types';
|
|
73
81
|
export { boxWhiskerProcessResult } from './boxplot-utils';
|
|
74
82
|
export { queryStateReducer } from './query-execution/query-state-reducer';
|
|
@@ -89,6 +97,7 @@ export { LoadingIndicator } from './common/components/loading-indicator';
|
|
|
89
97
|
export { LoadingOverlay } from './common/components/loading-overlay';
|
|
90
98
|
export { useFetch, type RequestConfig, type UseQueryResult } from './common/hooks/use-fetch';
|
|
91
99
|
export { useGetDataSourceFields } from './common/hooks/fusion-endpoints/use-get-data-source-fields';
|
|
100
|
+
export { useJtdWidget } from './dashboard/hooks/use-jtd-widget';
|
|
92
101
|
export type { EmptyObject } from './utils/utility-types';
|
|
93
102
|
export { translateColumnToAttribute } from './chart-data-options/utils';
|
|
94
103
|
export { isSameAttribute } from './utils/filters';
|
|
@@ -1,10 +1,23 @@
|
|
|
1
1
|
import { type LayoutDto, type FilterDto, type CascadingFilterDto, DashboardDto } from '../../api/types/dashboard-dto';
|
|
2
2
|
import type { WidgetsPanelColumnLayout, WidgetsOptions, TabbersOptions } from './types';
|
|
3
|
-
import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode } from '@sisense/sdk-data';
|
|
4
|
-
import { WidgetDto } from '../../widget-by-id/types';
|
|
3
|
+
import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode, Measure, Dimension } from '@sisense/sdk-data';
|
|
4
|
+
import { Panel, WidgetDto } from '../../widget-by-id/types';
|
|
5
|
+
import { TriggerMethod, JtdTarget } from '../../dashboard/hooks/jtd/jtd-types';
|
|
5
6
|
import { RestApi } from '../../api/rest-api';
|
|
6
7
|
export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
|
|
7
8
|
export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsModel?: FilterRelationsModel | FilterRelationsModelNode): Filter[] | FilterRelations;
|
|
9
|
+
export declare const getJtdNavigateType: (widget: WidgetDto) => TriggerMethod;
|
|
10
|
+
export declare const convertDimensionsToDimIndexes: (widget: WidgetDto, dimensionIds: string[]) => string[];
|
|
11
|
+
/**
|
|
12
|
+
* Extract pivot targets configuration from widget DTO and build Map-based targets
|
|
13
|
+
* @param widget - Widget DTO with drillToDashboardConfig
|
|
14
|
+
* @returns Map of dimensions/measures to their targets or undefined if no targets found
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
export declare function extractPivotTargetsConfigFromWidgetDto(widget: WidgetDto): Map<Dimension | {
|
|
18
|
+
dimension: Dimension;
|
|
19
|
+
location: 'row' | 'column' | 'value';
|
|
20
|
+
} | Measure, JtdTarget[]> | undefined;
|
|
8
21
|
export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;
|
|
9
22
|
export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersOptions;
|
|
10
23
|
/**
|
|
@@ -16,3 +29,14 @@ export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersO
|
|
|
16
29
|
* @internal
|
|
17
30
|
*/
|
|
18
31
|
export declare function withSharedFormulas(dashboard: DashboardDto, api: RestApi): Promise<DashboardDto>;
|
|
32
|
+
/**
|
|
33
|
+
* Find dimension or measure by instanceId in widget panels and convert to proper type
|
|
34
|
+
* @param panels - Widget metadata panels to search
|
|
35
|
+
* @param pivotDimension - Instance ID to find, this is not a PivotDimId, it is the instanceId of the dimension or measure
|
|
36
|
+
* @returns Dimension/Measure object with optional location info or undefined if not found
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
export declare function findDimensionByInstanceId(panels: Panel[], pivotDimension: string): Dimension | Measure | {
|
|
40
|
+
dimension: Dimension;
|
|
41
|
+
location: 'row' | 'column' | 'value';
|
|
42
|
+
} | undefined;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CommonFiltersOptions } from '../../common-filters/types';
|
|
2
2
|
import { ColorPaletteTheme, TabberConfig } from '../../types';
|
|
3
|
-
import {
|
|
3
|
+
import type { JumpToDashboardConfig, JumpToDashboardConfigForPivot } from '../../dashboard/hooks/jtd/jtd-types';
|
|
4
4
|
export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
|
|
5
5
|
/**
|
|
6
6
|
* Part of Dashboard layout, which describes how widgets are arranged in a cell
|
|
@@ -59,6 +59,11 @@ export type WidgetsPanelLayout = WidgetsPanelColumnLayout;
|
|
|
59
59
|
* Widget ID
|
|
60
60
|
*/
|
|
61
61
|
export type WidgetId = string;
|
|
62
|
+
/**
|
|
63
|
+
* Dashboard ID
|
|
64
|
+
* @internal
|
|
65
|
+
*/
|
|
66
|
+
export type DashboardId = string;
|
|
62
67
|
/**
|
|
63
68
|
* Options for widgets in a dashboard
|
|
64
69
|
*
|
|
@@ -67,10 +72,9 @@ export type WidgetId = string;
|
|
|
67
72
|
export type WidgetsOptions = Record<WidgetId, {
|
|
68
73
|
filtersOptions?: CommonFiltersOptions;
|
|
69
74
|
/**
|
|
70
|
-
* Jump
|
|
71
|
-
@internal
|
|
75
|
+
* Jump To Dashboard config for widgets.
|
|
72
76
|
*/
|
|
73
|
-
jtdConfig?:
|
|
77
|
+
jtdConfig?: JumpToDashboardConfig | JumpToDashboardConfigForPivot;
|
|
74
78
|
}>;
|
|
75
79
|
/**
|
|
76
80
|
* Options for TabberWidets in a dashboard
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { PivotTableDataOptions } from '../../../chart-data-options/types.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { HeaderCellFormatter } from '../types.js';
|
|
3
|
+
import { DateFormatter } from '../../../common/formatters/create-date-formatter.js';
|
|
3
4
|
export declare const createHeaderCellValueFormatter: (dataOptions: PivotTableDataOptions, dateFormatter: DateFormatter) => HeaderCellFormatter;
|
|
4
5
|
/**
|
|
5
6
|
* Formats the date time string or Date object.
|
|
@@ -44,4 +44,3 @@ export type HeaderCellFormatter = (cell: PivotTreeNode, jaqlPanelItem: JaqlPanel
|
|
|
44
44
|
* @returns Formatting result object or void to skip formatting
|
|
45
45
|
*/
|
|
46
46
|
export type CustomHeaderCellFormatter = (cell: PivotTreeNode, jaqlPanelItem: JaqlPanel | undefined, dataOption?: AnyColumn, id?: string) => CellFormattingResult | void;
|
|
47
|
-
export type DateFormatter = (date: Date, format: string) => string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { PolarChartProps } from './props';
|
|
3
3
|
/**
|
|
4
|
-
* A React component comparing multiple categories/variables with a
|
|
4
|
+
* A React component comparing multiple categories/variables with a spatial perspective in a radial chart.
|
|
5
5
|
*
|
|
6
6
|
* ## Example
|
|
7
7
|
*
|
|
@@ -1,9 +1,9 @@
|
|
|
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, MenuAlignment, 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, IndicatorDataPoint, TextWidgetDataPoint, CustomWidgetStyleOptions, PivotTableDataPoint } from './types';
|
|
2
|
+
import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuAlignment, 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, IndicatorDataPoint, TextWidgetDataPoint, CustomWidgetStyleOptions, PivotTableDataPoint, CalendarHeatmapStyleOptions, CalendarHeatmapDataPoint } from './types';
|
|
3
3
|
import { type CustomDataCellFormatter, type CustomHeaderCellFormatter } from './pivot-table/formatters/types';
|
|
4
4
|
import { HighchartsOptions } from './chart-options-processor/chart-options-service';
|
|
5
5
|
import { ComponentType, PropsWithChildren, ReactNode } from 'react';
|
|
6
|
-
import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
|
|
6
|
+
import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions, CalendarHeatmapChartDataOptions } from './chart-data-options/types';
|
|
7
7
|
import { AppConfig } from './app/client-application';
|
|
8
8
|
import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
|
|
9
9
|
import { FiltersMergeStrategy } from './widget-by-id/types';
|
|
@@ -44,7 +44,7 @@ export interface SisenseContextProviderProps {
|
|
|
44
44
|
*/
|
|
45
45
|
ssoEnabled?: boolean;
|
|
46
46
|
/**
|
|
47
|
-
* Token for [bearer authentication](https://sisense.
|
|
47
|
+
* Token for [bearer authentication](https://developer.sisense.com/guides/restApi/using-rest-api.html).
|
|
48
48
|
*
|
|
49
49
|
* To signify that the token is pending (e.g., being generated), set the value to `null`. This is supported for React and Vue only.
|
|
50
50
|
*
|
|
@@ -297,6 +297,22 @@ export type IndicatorDataPointEventHandler = (
|
|
|
297
297
|
point: IndicatorDataPoint,
|
|
298
298
|
/** Native MouseEvent */
|
|
299
299
|
nativeEvent: MouseEvent) => void;
|
|
300
|
+
/**
|
|
301
|
+
* Click handler for when a calendar-heatmap data point is clicked
|
|
302
|
+
*/
|
|
303
|
+
export type CalendarHeatmapDataPointEventHandler = (
|
|
304
|
+
/** Data point that was clicked */
|
|
305
|
+
point: CalendarHeatmapDataPoint,
|
|
306
|
+
/** Native PointerEvent */
|
|
307
|
+
nativeEvent: PointerEvent) => void;
|
|
308
|
+
/**
|
|
309
|
+
* Click handler for when multiple calendar-heatmap data points are selected.
|
|
310
|
+
*/
|
|
311
|
+
export type CalendarHeatmapDataPointsEventHandler = (
|
|
312
|
+
/** Data points that were selected */
|
|
313
|
+
points: CalendarHeatmapDataPoint[],
|
|
314
|
+
/** Native MouseEvent */
|
|
315
|
+
nativeEvent: MouseEvent) => void;
|
|
300
316
|
/**
|
|
301
317
|
* Click handler for when text widget is clicked.
|
|
302
318
|
*
|
|
@@ -458,6 +474,32 @@ interface IndicatorChartEventProps extends BaseChartEventProps {
|
|
|
458
474
|
*/
|
|
459
475
|
onDataPointClick?: IndicatorDataPointEventHandler;
|
|
460
476
|
}
|
|
477
|
+
/**
|
|
478
|
+
* Event props for CalendarHeatmap chart which uses CalendarHeatmapDataPoint type
|
|
479
|
+
* to describe data points for events.
|
|
480
|
+
*
|
|
481
|
+
* @internal
|
|
482
|
+
*/
|
|
483
|
+
export interface CalendarHeatmapChartEventProps extends BaseChartEventProps, HighchartsBasedChartEventProps {
|
|
484
|
+
/**
|
|
485
|
+
* Click handler callback for a data point
|
|
486
|
+
*
|
|
487
|
+
* @category Callbacks
|
|
488
|
+
*/
|
|
489
|
+
onDataPointClick?: CalendarHeatmapDataPointEventHandler;
|
|
490
|
+
/**
|
|
491
|
+
* Context menu handler callback for a data point
|
|
492
|
+
*
|
|
493
|
+
* @category Callbacks
|
|
494
|
+
*/
|
|
495
|
+
onDataPointContextMenu?: CalendarHeatmapDataPointEventHandler;
|
|
496
|
+
/**
|
|
497
|
+
* Handler callback for selection of multiple data points
|
|
498
|
+
*
|
|
499
|
+
* @category Callbacks
|
|
500
|
+
*/
|
|
501
|
+
onDataPointsSelected?: CalendarHeatmapDataPointsEventHandler;
|
|
502
|
+
}
|
|
461
503
|
/**
|
|
462
504
|
* Base Chart Props to be extended by {@link ChartProps}
|
|
463
505
|
*
|
|
@@ -472,7 +514,7 @@ export interface BaseChartProps extends BaseChartEventProps {
|
|
|
472
514
|
*
|
|
473
515
|
* (1) Sisense data source name as a string. For example, `'Sample ECommerce'`. Typically, you
|
|
474
516
|
* retrieve the data source name from a data model you create using the `get-data-model`
|
|
475
|
-
* {@link https://sisense.
|
|
517
|
+
* {@link https://developer.sisense.com/guides/sdk/guides/cli.html | command} of the Compose SDK CLI. The chart
|
|
476
518
|
* connects to the data source, executes a query, and loads the data as specified in
|
|
477
519
|
* `dataOptions`, `filters`, and `highlights`.
|
|
478
520
|
*
|
|
@@ -565,19 +607,19 @@ interface ChartEventProps extends BaseChartEventProps {
|
|
|
565
607
|
*
|
|
566
608
|
* @category Callbacks
|
|
567
609
|
*/
|
|
568
|
-
onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler | AreamapDataPointEventHandler | BoxplotDataPointEventHandler | ScattermapDataPointEventHandler | IndicatorDataPointEventHandler;
|
|
610
|
+
onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler | AreamapDataPointEventHandler | BoxplotDataPointEventHandler | ScattermapDataPointEventHandler | IndicatorDataPointEventHandler | CalendarHeatmapDataPointEventHandler;
|
|
569
611
|
/**
|
|
570
612
|
* Context menu handler callback for a data point
|
|
571
613
|
*
|
|
572
614
|
* @category Callbacks
|
|
573
615
|
*/
|
|
574
|
-
onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler | BoxplotDataPointEventHandler;
|
|
616
|
+
onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler | BoxplotDataPointEventHandler | CalendarHeatmapDataPointEventHandler;
|
|
575
617
|
/**
|
|
576
618
|
* Handler callback for selection of multiple data points
|
|
577
619
|
*
|
|
578
620
|
* @category Callbacks
|
|
579
621
|
*/
|
|
580
|
-
onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler;
|
|
622
|
+
onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler | CalendarHeatmapDataPointsEventHandler;
|
|
581
623
|
/**
|
|
582
624
|
* A callback that allows you to customize the underlying chart element before it is rendered. The returned options are then used when rendering the chart.
|
|
583
625
|
*
|
|
@@ -1717,3 +1759,20 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
|
|
|
1717
1759
|
*/
|
|
1718
1760
|
dataSource?: DataSource;
|
|
1719
1761
|
}
|
|
1762
|
+
/**
|
|
1763
|
+
* Props of the {@link CalendarHeatmapChart} component.
|
|
1764
|
+
*/
|
|
1765
|
+
export interface CalendarHeatmapChartProps extends BaseChartProps, CalendarHeatmapChartEventProps {
|
|
1766
|
+
/**
|
|
1767
|
+
* Configurations for how to interpret and present the data passed to the chart
|
|
1768
|
+
*
|
|
1769
|
+
* @category Chart
|
|
1770
|
+
*/
|
|
1771
|
+
dataOptions: CalendarHeatmapChartDataOptions;
|
|
1772
|
+
/**
|
|
1773
|
+
* Configurations for how to style and present a chart's data.
|
|
1774
|
+
*
|
|
1775
|
+
* @category Chart
|
|
1776
|
+
*/
|
|
1777
|
+
styleOptions?: CalendarHeatmapStyleOptions;
|
|
1778
|
+
}
|
|
@@ -2,9 +2,9 @@ import { ChartDataOptionsInternal } from '../chart-data-options/types';
|
|
|
2
2
|
import { ChartData } from '../chart-data/types.js';
|
|
3
3
|
import { ChartDesignOptions } from '../chart-options-processor/translations/types.js';
|
|
4
4
|
import { BeforeRenderHandler } from '../props.js';
|
|
5
|
-
import { BoxplotChartType, BoxplotDataPoint, CartesianChartType, CategoricalChartType, DataPoint, ScatterChartType, ScatterDataPoint } from '../types.js';
|
|
5
|
+
import { BoxplotChartType, BoxplotDataPoint, CalendarHeatmapDataPoint, CartesianChartType, CategoricalChartType, DataPoint, ScatterChartType, ScatterDataPoint } from '../types.js';
|
|
6
6
|
export type SisenseChartDataPointsEventHandler = (points: SisenseChartDataPoint[], nativeEvent: MouseEvent) => void;
|
|
7
|
-
export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
|
|
7
|
+
export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | CalendarHeatmapDataPoint;
|
|
8
8
|
export type SisenseChartDataPointEventHandler = (point: SisenseChartDataPoint, nativeEvent: PointerEvent) => void;
|
|
9
9
|
export interface SisenseChartProps {
|
|
10
10
|
chartType: SisenseChartType;
|
|
@@ -10,6 +10,7 @@ export declare const DEFAULT_FILTER_PANEL_DIVIDER_LINE_WIDTH = 1;
|
|
|
10
10
|
export declare const DEFAULT_FILTER_PANEL_BORDER_COLOR = "#DADADA";
|
|
11
11
|
export declare const DEFAULT_FILTER_PANEL_BORDER_WIDTH = 1;
|
|
12
12
|
export declare const DEFAULT_TITLE_FONT_SIZE = 15;
|
|
13
|
+
export declare const DEFAULT_HYPERLINK_COLOR = "#1FAFF3";
|
|
13
14
|
/**
|
|
14
15
|
* Returns default theme settings, which can be used as base for custom theme options.
|
|
15
16
|
*
|
|
@@ -373,6 +373,17 @@ export declare const translation: {
|
|
|
373
373
|
jumpToDashboard: {
|
|
374
374
|
defaultCaption: string;
|
|
375
375
|
jumpableTooltip: string;
|
|
376
|
+
noDrillTargets: string;
|
|
377
|
+
};
|
|
378
|
+
calendarHeatmap: {
|
|
379
|
+
navigation: {
|
|
380
|
+
firstMonth: string;
|
|
381
|
+
lastMonth: string;
|
|
382
|
+
previousMonth: string;
|
|
383
|
+
nextMonth: string;
|
|
384
|
+
previousGroup: string;
|
|
385
|
+
nextGroup: string;
|
|
386
|
+
};
|
|
376
387
|
};
|
|
377
388
|
};
|
|
378
389
|
/**
|
|
@@ -383,6 +383,17 @@ export declare const resources: {
|
|
|
383
383
|
jumpToDashboard: {
|
|
384
384
|
defaultCaption: string;
|
|
385
385
|
jumpableTooltip: string;
|
|
386
|
+
noDrillTargets: string;
|
|
387
|
+
};
|
|
388
|
+
calendarHeatmap: {
|
|
389
|
+
navigation: {
|
|
390
|
+
firstMonth: string;
|
|
391
|
+
lastMonth: string;
|
|
392
|
+
previousMonth: string;
|
|
393
|
+
nextMonth: string;
|
|
394
|
+
previousGroup: string;
|
|
395
|
+
nextGroup: string;
|
|
396
|
+
};
|
|
386
397
|
};
|
|
387
398
|
};
|
|
388
399
|
uk: {
|
|
@@ -760,6 +771,17 @@ export declare const resources: {
|
|
|
760
771
|
jumpToDashboard: {
|
|
761
772
|
defaultCaption: string;
|
|
762
773
|
jumpableTooltip: string;
|
|
774
|
+
noDrillTargets: string;
|
|
775
|
+
};
|
|
776
|
+
calendarHeatmap: {
|
|
777
|
+
navigation: {
|
|
778
|
+
firstMonth: string;
|
|
779
|
+
lastMonth: string;
|
|
780
|
+
previousMonth: string;
|
|
781
|
+
nextMonth: string;
|
|
782
|
+
previousGroup: string;
|
|
783
|
+
nextGroup: string;
|
|
784
|
+
};
|
|
763
785
|
};
|
|
764
786
|
};
|
|
765
787
|
};
|