@sisense/sdk-ui 2.25.0 → 2.26.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 +33 -33
- package/dist/ai.js +626 -639
- package/dist/analytics-composer/node.cjs +1 -1
- package/dist/analytics-composer/node.js +1010 -865
- package/dist/analytics-composer.cjs +1 -1
- package/dist/analytics-composer.js +6 -6
- package/dist/{apply-styled-options-to-query-BsBTwL6W.js → apply-styled-options-to-query-Bzt2GrgO.js} +1459 -1426
- package/dist/apply-styled-options-to-query-COD9fRYD.cjs +1 -0
- package/dist/dimensions-Ce2zWFrs.js +204 -0
- package/dist/dimensions-u3w5qNF0.cjs +1 -0
- package/dist/index.cjs +380 -380
- package/dist/index.js +17024 -16696
- package/dist/index.umd.js +649 -660
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/translate-dashboard-utils.d.ts +2 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/types.d.ts +11 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/utils.d.ts +5 -2
- package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-scroll-persistence.d.ts +16 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/use-composed-dashboard.d.ts +2 -3
- package/dist/packages/sdk-ui/src/domains/data-browser/data-source-dimensional-model/hooks/use-get-data-source-dimensions.d.ts +10 -0
- package/dist/packages/sdk-ui/src/domains/data-browser/data-source-dimensional-model/hooks/use-get-data-source-fields.d.ts +2 -0
- package/dist/packages/sdk-ui/src/domains/drilldown/components/drilldown-widget/drilldown-widget.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/narrative/core/widget-narrative-options.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/narrative/hooks/use-get-widget-narrative.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/narrative/hooks/use-widget-narrative-state.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/query-execution/core/date-formats/simple-date-format-replacers.d.ts +13 -0
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-pivot-query/use-execute-pivot-query.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-query/use-execute-query.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/area-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/areamap-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/bar-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/boxplot-chart/boxplot-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/cartesians/helpers/highchart-options/axis.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/column-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/funnel-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/line-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/pie-chart/pie-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/polar-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/scatter-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/scattermap-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/sunburst-chart/sunburst-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/table/table.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/components/treemap-chart/treemap-chart.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data-options/types.d.ts +6 -6
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/cartesian/utils/axis/axis-builders.d.ts +6 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/plot-bands.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/axis-section.d.ts +29 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/design-options.d.ts +1 -0
- package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/tooltip-utils.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/compose-code-to-readable.d.ts +24 -4
- package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/index.d.ts +3 -0
- package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/query-params-to-view-model.d.ts +6 -2
- package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/query-pill.d.ts +6 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/to-widget-dto-style.d.ts +118 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/types.d.ts +18 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/use-scroller-location-save.d.ts +8 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/utils.d.ts +9 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/widget-by-id.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/with-navigator-scroll-save.d.ts +10 -0
- package/dist/packages/sdk-ui/src/domains/widgets/widget-model/use-get-widget-model.d.ts +2 -2
- package/dist/packages/sdk-ui/src/domains/widgets/widget-model/widget-model-translator/to-widget-dto-panels.d.ts +170 -0
- package/dist/packages/sdk-ui/src/domains/widgets/widget-model/widget-model-translator/widget-model-translator.d.ts +8 -14
- package/dist/packages/sdk-ui/src/infra/api/narrative/narrative-endpoints.d.ts +3 -3
- package/dist/packages/sdk-ui/src/infra/api/rest-api.d.ts +12 -1
- package/dist/packages/sdk-ui/src/infra/app/settings/settings.d.ts +10 -2
- package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/use-custom-widgets.d.ts +10 -3
- package/dist/packages/sdk-ui/src/infra/plugins/plugin-context.d.ts +2 -2
- package/dist/packages/sdk-ui/src/infra/plugins/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/infra/plugins/widget-plugins/types.d.ts +9 -0
- package/dist/packages/sdk-ui/src/modules/ai/api/chat-rest-api.d.ts +3 -4
- package/dist/packages/sdk-ui/src/modules/ai/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/public-api/internal.d.ts +1 -1
- package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts +1 -1
- package/dist/packages/sdk-ui/src/shared/utils/filter-relations.d.ts +2 -0
- package/dist/packages/sdk-ui/src/types.d.ts +7 -7
- package/dist/{types-GFLaiax5.cjs → types-COBvZZm_.cjs} +1 -1
- package/dist/{types-BBp2sp_s.js → types-D6jCGncV.js} +1 -1
- package/dist/{use-hover-mptQLQ4S.js → use-hover-B1HPf4hF.js} +6190 -6093
- package/dist/{use-hover-DsnmY-p_.cjs → use-hover-CaQrW_gv.cjs} +112 -112
- package/dist/{utils-DTUC-wtI.js → utils-BQtueE3Z.js} +9591 -9422
- package/dist/utils-CAubp1g1.cjs +179 -0
- package/dist/{widget-composer-D0BZrLna.js → widget-composer-BAJFWk3t.js} +3 -3
- package/dist/{widget-composer-CDb2iOoS.cjs → widget-composer-C75b-E6W.cjs} +1 -1
- package/package.json +8 -8
- package/dist/apply-styled-options-to-query-mFJvsssw.cjs +0 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/table-widget/index.d.ts +0 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/table-widget/table-widget.d.ts +0 -22
- package/dist/packages/sdk-ui/src/domains/widgets/components/table-widget/types.d.ts +0 -61
- package/dist/parse-compose-code-DfZskSng.js +0 -352
- package/dist/parse-compose-code-v4J9BrUg.cjs +0 -1
- package/dist/utils-BlNqPAG8.cjs +0 -190
package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/translate-dashboard-utils.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export declare const getJtdNavigateType: (widget: WidgetDto) => TriggerMethod;
|
|
|
11
11
|
export declare const convertDimensionsToDimIndexes: (widget: WidgetDto, dimensionIds: string[]) => string[];
|
|
12
12
|
/**
|
|
13
13
|
* Extract pivot targets configuration from widget DTO and build Map-based targets
|
|
14
|
+
*
|
|
14
15
|
* @param widget - Widget DTO with drillToDashboardConfig
|
|
15
16
|
* @returns Map of dimensions/measures to their targets or undefined if no targets found
|
|
16
17
|
* @internal
|
|
@@ -39,6 +40,7 @@ export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersC
|
|
|
39
40
|
export declare function withSharedFormulas(dashboard: DashboardDto, api: RestApi): Promise<DashboardDto>;
|
|
40
41
|
/**
|
|
41
42
|
* Find dimension or measure by instanceId in widget panels and convert to proper type
|
|
43
|
+
*
|
|
42
44
|
* @param panels - Widget metadata panels to search
|
|
43
45
|
* @param pivotDimension - Instance ID to find, this is not a PivotDimId, it is the instanceId of the dimension or measure
|
|
44
46
|
* @returns Dimension/Measure object with optional location info or undefined if not found
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { CommonFiltersOptions } from '../../../domains/dashboarding/common-filters/types';
|
|
2
2
|
import type { JumpToDashboardConfig, JumpToDashboardConfigForPivot } from '../../../domains/dashboarding/hooks/jtd/jtd-types';
|
|
3
|
+
import type { WidgetDto } from '../../../domains/widgets/components/widget-by-id/types';
|
|
3
4
|
import { ColorPaletteTheme } from '../../../types';
|
|
4
5
|
export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../../domains/dashboarding/common-filters/types';
|
|
5
6
|
/**
|
|
@@ -8,6 +9,7 @@ export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules
|
|
|
8
9
|
export interface WidgetsPanelCell {
|
|
9
10
|
/**
|
|
10
11
|
* Flag that indicates if the cell is hidden
|
|
12
|
+
*
|
|
11
13
|
* @internal
|
|
12
14
|
*/
|
|
13
15
|
hidden?: boolean;
|
|
@@ -66,6 +68,7 @@ export type WidgetsPanelLayout = WidgetsPanelColumnLayout;
|
|
|
66
68
|
export type WidgetId = string;
|
|
67
69
|
/**
|
|
68
70
|
* Dashboard ID
|
|
71
|
+
*
|
|
69
72
|
* @internal
|
|
70
73
|
*/
|
|
71
74
|
export type DashboardId = string;
|
|
@@ -87,6 +90,14 @@ export type SpecificWidgetOptions = {
|
|
|
87
90
|
* Jump To Dashboard config for widgets.
|
|
88
91
|
*/
|
|
89
92
|
jtdConfig?: JumpToDashboardConfig | JumpToDashboardConfigForPivot;
|
|
93
|
+
/**
|
|
94
|
+
* Partial snapshot of raw DTO fields preserved from the server response.
|
|
95
|
+
* Required to include all existing options/style when PATCHing a single field (e.g. previousScrollerLocation),
|
|
96
|
+
* because the server replaces the entire object rather than merging.
|
|
97
|
+
*
|
|
98
|
+
* @internal
|
|
99
|
+
*/
|
|
100
|
+
partialDtoOptions?: Partial<Pick<WidgetDto, 'options' | 'style'>>;
|
|
90
101
|
};
|
|
91
102
|
/**
|
|
92
103
|
* Style options for the dashboard.
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Filter, FilterRelations } from '@sisense/sdk-data';
|
|
2
2
|
import { DashboardModel, SpecificWidgetOptions, WidgetsPanelLayout } from '../../../../../domains/dashboarding/dashboard-model';
|
|
3
|
+
import type { WidgetDto } from '../../../../../domains/widgets/components/widget-by-id/types';
|
|
3
4
|
import { WidgetModel } from '../../../../../domains/widgets/widget-model';
|
|
4
5
|
export type UseDashboardModelState = DashboardModel | null;
|
|
5
6
|
/**
|
|
@@ -34,6 +35,17 @@ export type WidgetPatch = {
|
|
|
34
35
|
* The title of the widget.
|
|
35
36
|
*/
|
|
36
37
|
title?: string;
|
|
38
|
+
/**
|
|
39
|
+
* Full widget options to send in the PATCH request.
|
|
40
|
+
* Must include all existing option fields alongside the changed ones, because
|
|
41
|
+
* the server replaces the entire options object rather than merging.
|
|
42
|
+
*/
|
|
43
|
+
options?: Partial<NonNullable<WidgetDto['options']>> & {
|
|
44
|
+
previousScrollerLocation: {
|
|
45
|
+
min: number;
|
|
46
|
+
max: number;
|
|
47
|
+
};
|
|
48
|
+
};
|
|
37
49
|
};
|
|
38
50
|
/**
|
|
39
51
|
* Internal actions for the dashboard model state used in {@link useDashboardModel}.
|
|
@@ -5,8 +5,11 @@ import { AddWidgetPayload } from './types.js';
|
|
|
5
5
|
/**
|
|
6
6
|
* Translates filters and relations to DTOs.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* `filterRelations[].datasource` is always a **string** (never `undefined`), so Fusion validation
|
|
9
|
+
* does not break. The value is derived from `filter.dataSource` / `filter.attribute.dataSource`
|
|
10
|
+
* when present; otherwise `''`.
|
|
11
|
+
*
|
|
12
|
+
* @param filtersOrFilterRelations - Flat filters or a filter-relations tree
|
|
10
13
|
*
|
|
11
14
|
* @sisenseInternal
|
|
12
15
|
*/
|
package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-scroll-persistence.d.ts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { WidgetsOptions } from '../../../domains/dashboarding/dashboard-model';
|
|
2
|
+
import type { DashboardPersistenceManager } from '../../../domains/dashboarding/persistence/types';
|
|
3
|
+
type ScrollerChangeHandler = (min: number, max: number) => void;
|
|
4
|
+
/**
|
|
5
|
+
* Returns a stable per-widget factory of debounced scroller-position savers.
|
|
6
|
+
* Each call with the same widgetOid reuses the same debounced function.
|
|
7
|
+
* All pending debouncers are cancelled on unmount.
|
|
8
|
+
*
|
|
9
|
+
* @param persistence - The dashboard persistence manager. When `undefined`, the returned factory is a no-op.
|
|
10
|
+
* @param widgetsOptions - Current widget DTO options map, used to include all existing options in the PATCH
|
|
11
|
+
* so the server does not discard other option fields when updating `previousScrollerLocation`.
|
|
12
|
+
* @returns Function that maps a widget OID to its debounced save handler.
|
|
13
|
+
* @internal
|
|
14
|
+
*/
|
|
15
|
+
export declare function useWidgetScrollPersistence(persistence: DashboardPersistenceManager | undefined, widgetsOptions?: WidgetsOptions): (widgetOid: string) => ScrollerChangeHandler;
|
|
16
|
+
export {};
|
|
@@ -10,14 +10,15 @@ export type UseComposedDashboardOptions = {
|
|
|
10
10
|
onFiltersChange?: (filters: Filter[] | FilterRelations) => void;
|
|
11
11
|
/**
|
|
12
12
|
* Persistence manager for the dashboard
|
|
13
|
+
*
|
|
13
14
|
* @sisenseInternal
|
|
14
15
|
*/
|
|
15
16
|
persistence?: DashboardPersistenceManager;
|
|
16
17
|
/**
|
|
17
18
|
* Runtime edit mode state. When provided (e.g. by Dashboard), used for duplicate-widget visibility
|
|
18
19
|
* instead of only config.widgetsPanel.editMode.isEditing.
|
|
19
|
-
* @internal
|
|
20
20
|
*
|
|
21
|
+
* @internal
|
|
21
22
|
* @deprecated Temporal workaround. Edit mode (with history management) should be managed by the `useComposedDashboard` hook instead of the Dashboard component.
|
|
22
23
|
*/
|
|
23
24
|
isEditing?: boolean;
|
|
@@ -78,11 +79,9 @@ export declare function useComposedDashboardInternal<D extends ComposableDashboa
|
|
|
78
79
|
* }
|
|
79
80
|
* export default CodeExample;
|
|
80
81
|
* ```
|
|
81
|
-
*
|
|
82
82
|
* @template {D extends ComposableDashboardProps | DashboardProps} D - The type parameter for a dashboard properties, restricted to ComposableDashboardProps or DashboardProps
|
|
83
83
|
* @param {D} initialDashboard - set of properties for the Dashboard component
|
|
84
84
|
* @param {UseComposedDashboardOptions} [options] - Options for the composable.
|
|
85
|
-
*
|
|
86
85
|
* @return {ComposedDashboardResult} An object containing the composed dashboard and APIs to interact with it.
|
|
87
86
|
* @group Dashboards
|
|
88
87
|
*/
|
|
@@ -69,10 +69,20 @@ export interface GetDataSourceDimensionsParams {
|
|
|
69
69
|
/** The search value to filter by */
|
|
70
70
|
searchValue?: string;
|
|
71
71
|
}
|
|
72
|
+
/**
|
|
73
|
+
* {@link useGetDataSourceDimensions} without tracking to be used inside other hooks or components.
|
|
74
|
+
*
|
|
75
|
+
* @param params - The parameters for getting the dimensions
|
|
76
|
+
* @returns The dimensions state
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
export declare function useGetDataSourceDimensionsInternal(params: GetDataSourceDimensionsParams): DataSourceDimensionsState;
|
|
72
80
|
/**
|
|
73
81
|
* Gets the dimensions of a data source.
|
|
74
82
|
*
|
|
75
83
|
* @param params - The parameters for getting the dimensions
|
|
76
84
|
* @returns The dimensions state
|
|
85
|
+
* @group Fusion Assets
|
|
86
|
+
* @fusionEmbed
|
|
77
87
|
*/
|
|
78
88
|
export declare const useGetDataSourceDimensions: (params: GetDataSourceDimensionsParams) => DataSourceDimensionsState;
|
|
@@ -9,6 +9,7 @@ import { RestApiHookState } from '../../../../shared/utils/utility-types';
|
|
|
9
9
|
* @param params.count - The number of items to return
|
|
10
10
|
* @param params.offset - The offset for pagination
|
|
11
11
|
* @param params.searchValue - The search value to filter by
|
|
12
|
+
* @param params.cacheTime - The cache time in milliseconds
|
|
12
13
|
* @returns The data source fields state
|
|
13
14
|
* @internal
|
|
14
15
|
*/
|
|
@@ -18,6 +19,7 @@ export declare const useGetDataSourceFields: (params: {
|
|
|
18
19
|
count?: number;
|
|
19
20
|
offset?: number;
|
|
20
21
|
searchValue?: string;
|
|
22
|
+
cacheTime?: number;
|
|
21
23
|
}) => DataSourceFieldsState;
|
|
22
24
|
type DataSourceFieldsState = RestApiHookState<'dataSourceFields', DataSourceField[]>;
|
|
23
25
|
export {};
|
package/dist/packages/sdk-ui/src/domains/drilldown/components/drilldown-widget/drilldown-widget.d.ts
CHANGED
|
@@ -22,8 +22,8 @@ import { DrilldownWidgetProps } from '../../../../props';
|
|
|
22
22
|
*
|
|
23
23
|
* <iframe
|
|
24
24
|
* src='https://csdk-playground.sisense.com/?example=use-cases%2Fdrilldown&mode=docs'
|
|
25
|
-
* width=800
|
|
26
|
-
* height=870
|
|
25
|
+
* width='800'
|
|
26
|
+
* height='870'
|
|
27
27
|
* style='border:none;'
|
|
28
28
|
* />
|
|
29
29
|
*
|
|
@@ -11,7 +11,8 @@ export interface WidgetNarrativeOptions {
|
|
|
11
11
|
/** The verbosity of the NLG summarization */
|
|
12
12
|
verbosity?: 'Low' | 'High';
|
|
13
13
|
/** When false, legacy narration endpoint only; when true or undefined, try unified then fallback. */
|
|
14
|
-
|
|
14
|
+
isUnified?: boolean;
|
|
15
|
+
/** Computed SDK flag from server settings (`app.settings.narrative.isSisenseAiEnabled`), not raw AI API. */
|
|
15
16
|
isSisenseAiEnabled?: boolean;
|
|
16
17
|
/**
|
|
17
18
|
* When `true`, trend and forecast companion measures are omitted from the narrative JAQL so
|
|
@@ -5,8 +5,8 @@ import { type WidgetNarrativeQueryState } from './use-widget-narrative-state.js'
|
|
|
5
5
|
* Options for {@link useGetWidgetNarrative}.
|
|
6
6
|
*
|
|
7
7
|
* @remarks
|
|
8
|
-
* Narration endpoints and flags default from `app.settings` on {@link useSisenseContext} when
|
|
9
|
-
* `
|
|
8
|
+
* Narration endpoints and flags default from `app.settings.narrative` on {@link useSisenseContext} when
|
|
9
|
+
* `isUnified` / `isSisenseAiEnabled` are omitted. Optional overrides match the
|
|
10
10
|
* imperative `getNlgInsightsFromWidget` helper for per-call behavior.
|
|
11
11
|
* @sisenseInternal
|
|
12
12
|
*/
|
|
@@ -36,4 +36,4 @@ export type UseWidgetNarrativeStateResult = WidgetNarrativeQueryState & {
|
|
|
36
36
|
*
|
|
37
37
|
* @internal
|
|
38
38
|
*/
|
|
39
|
-
export declare function useWidgetNarrativeState({ widgetProps, defaultDataSource, verbosity, enabled, ignoreTrendAndForecast,
|
|
39
|
+
export declare function useWidgetNarrativeState({ widgetProps, defaultDataSource, verbosity, enabled, ignoreTrendAndForecast, isUnified: optionsUnified, isSisenseAiEnabled: optionsSisenseAi, }: UseWidgetNarrativeStateParams): UseWidgetNarrativeStateResult;
|
|
@@ -1,4 +1,17 @@
|
|
|
1
1
|
import type { DateFormat } from './apply-date-format.js';
|
|
2
2
|
export declare function newDateFormatWithUnicodeMillisecondsMasks(oldFormat: DateFormat): DateFormat;
|
|
3
3
|
export declare function newDateFormatWithExpandedAMPM(oldFormat: DateFormat, date: Date, timeZone: string): DateFormat;
|
|
4
|
+
/**
|
|
5
|
+
* Escapes Latin letter sequences that are not recognized Fusion date format tokens
|
|
6
|
+
* by wrapping them in single quotes so that `date-fns` treats them as literal text.
|
|
7
|
+
*
|
|
8
|
+
* Handles cases like `WEEK-ww` where `WEEK-` is a literal text prefix, but `W`, `E`,
|
|
9
|
+
* and `K` would otherwise be misinterpreted as `date-fns` format tokens, causing a
|
|
10
|
+
* RangeError.
|
|
11
|
+
*
|
|
12
|
+
* Adjacent non-token sequences (separated only by non-letter characters) are merged
|
|
13
|
+
* into a single quoted region to avoid `''` being interpreted as an escaped single
|
|
14
|
+
* quote by `date-fns`.
|
|
15
|
+
*/
|
|
16
|
+
export declare function newDateFormatWithEscapedNonTokenChars(format: DateFormat): DateFormat;
|
|
4
17
|
export declare function newDateFormatWithExpandedTimezoneOffset(oldFormat: DateFormat, date: Date, timeZone: string, locale: Locale): DateFormat;
|
|
@@ -9,8 +9,8 @@ import { ExecutePivotQueryParams, PivotQueryState } from '../../types';
|
|
|
9
9
|
*
|
|
10
10
|
* <iframe
|
|
11
11
|
* src='https://csdk-playground.sisense.com/?example=queries%2Fuse-execute-pivot-query&mode=docs'
|
|
12
|
-
* width=800
|
|
13
|
-
* height=870
|
|
12
|
+
* width='800'
|
|
13
|
+
* height='870'
|
|
14
14
|
* style='border:none;'
|
|
15
15
|
* />
|
|
16
16
|
*
|
|
@@ -10,8 +10,8 @@ import { ExecuteQueryParams, ExecuteQueryResult } from '../../types';
|
|
|
10
10
|
*
|
|
11
11
|
* <iframe
|
|
12
12
|
* src='https://csdk-playground.sisense.com/?example=queries%2Fuse-execute-query-sorting&mode=docs'
|
|
13
|
-
* width=800
|
|
14
|
-
* height=870
|
|
13
|
+
* width='800'
|
|
14
|
+
* height='870'
|
|
15
15
|
* style='border:none;'
|
|
16
16
|
* />
|
|
17
17
|
*
|
|
@@ -10,8 +10,8 @@ import { AreaChartProps } from '../../../props';
|
|
|
10
10
|
*
|
|
11
11
|
* <iframe
|
|
12
12
|
* src='https://csdk-playground.sisense.com/?example=charts%2Farea-chart&mode=docs'
|
|
13
|
-
* width=800
|
|
14
|
-
* height=870
|
|
13
|
+
* width='800'
|
|
14
|
+
* height='870'
|
|
15
15
|
* style='border:none;'
|
|
16
16
|
* />
|
|
17
17
|
*
|
|
@@ -11,8 +11,8 @@ import { AreamapChartProps } from '../../../props';
|
|
|
11
11
|
*
|
|
12
12
|
* <iframe
|
|
13
13
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fmap-area&mode=docs'
|
|
14
|
-
* width=800
|
|
15
|
-
* height=870
|
|
14
|
+
* width='800'
|
|
15
|
+
* height='870'
|
|
16
16
|
* style='border:none;'
|
|
17
17
|
* />
|
|
18
18
|
*
|
package/dist/packages/sdk-ui/src/domains/visualizations/components/boxplot-chart/boxplot-chart.d.ts
CHANGED
|
@@ -10,8 +10,8 @@ import { BoxplotChartProps } from '../../../../props';
|
|
|
10
10
|
*
|
|
11
11
|
* <iframe
|
|
12
12
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fboxplot-chart&mode=docs'
|
|
13
|
-
* width=800
|
|
14
|
-
* height=870
|
|
13
|
+
* width='800'
|
|
14
|
+
* height='870'
|
|
15
15
|
* style='border:none;'
|
|
16
16
|
* />
|
|
17
17
|
*
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { XAxisOrientation } from '../../../../../../../../../domains/visualizations/core/chart-options-processor/cartesian/utils/axis/axis-builders.js';
|
|
2
|
-
import { AxisSettings } from '../../../../../../../../../domains/visualizations/core/chart-options-processor/translations/axis-section.js';
|
|
2
|
+
import { type AxisSettings } from '../../../../../../../../../domains/visualizations/core/chart-options-processor/translations/axis-section.js';
|
|
3
3
|
import { BuildContext } from '../../../types.js';
|
|
4
4
|
import { CartesianChartTypes } from '../../types.js';
|
|
5
5
|
export declare const getCartesianXAxis: (ctx: BuildContext<CartesianChartTypes>, orientation: XAxisOrientation) => AxisSettings[];
|
|
@@ -12,8 +12,8 @@ import { ColumnChartProps } from '../../../props';
|
|
|
12
12
|
*
|
|
13
13
|
* <iframe
|
|
14
14
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fcolumn-chart&mode=docs'
|
|
15
|
-
* width=800
|
|
16
|
-
* height=870
|
|
15
|
+
* width='800'
|
|
16
|
+
* height='870'
|
|
17
17
|
* style='border:none;'
|
|
18
18
|
* />
|
|
19
19
|
*
|
|
@@ -9,8 +9,8 @@ import { FunnelChartProps } from '../../../props';
|
|
|
9
9
|
*
|
|
10
10
|
* <iframe
|
|
11
11
|
* src='https://csdk-playground.sisense.com/?example=charts%2Ffunnel-chart&mode=docs'
|
|
12
|
-
* width=800
|
|
13
|
-
* height=870
|
|
12
|
+
* width='800'
|
|
13
|
+
* height='870'
|
|
14
14
|
* style='border:none;'
|
|
15
15
|
* />
|
|
16
16
|
*
|
|
@@ -10,8 +10,8 @@ import { PieChartProps } from '../../../../props';
|
|
|
10
10
|
*
|
|
11
11
|
* <iframe
|
|
12
12
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fpie-chart&mode=docs'
|
|
13
|
-
* width=800
|
|
14
|
-
* height=870
|
|
13
|
+
* width='800'
|
|
14
|
+
* height='870'
|
|
15
15
|
* style='border:none;'
|
|
16
16
|
* />
|
|
17
17
|
*
|
|
@@ -15,8 +15,8 @@ import { ScatterChartProps } from '../../../props';
|
|
|
15
15
|
*
|
|
16
16
|
* <iframe
|
|
17
17
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fscatter-chart&mode=docs'
|
|
18
|
-
* width=800
|
|
19
|
-
* height=870
|
|
18
|
+
* width='800'
|
|
19
|
+
* height='870'
|
|
20
20
|
* style='border:none;'
|
|
21
21
|
* />
|
|
22
22
|
*
|
|
@@ -9,8 +9,8 @@ import { ScattermapChartProps } from '../../../props';
|
|
|
9
9
|
*
|
|
10
10
|
* <iframe
|
|
11
11
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fmap-scatter&mode=docs'
|
|
12
|
-
* width=1000
|
|
13
|
-
* height=900
|
|
12
|
+
* width='1000'
|
|
13
|
+
* height='900'
|
|
14
14
|
* style='border:none;'
|
|
15
15
|
* />
|
|
16
16
|
*
|
|
@@ -11,8 +11,8 @@ import { SunburstChartProps } from '../../../../props';
|
|
|
11
11
|
*
|
|
12
12
|
* <iframe
|
|
13
13
|
* src='https://csdk-playground.sisense.com/?example=charts%2Fsunburst-chart&mode=docs'
|
|
14
|
-
* width=800
|
|
15
|
-
* height=870
|
|
14
|
+
* width='800'
|
|
15
|
+
* height='870'
|
|
16
16
|
* style='border:none;'
|
|
17
17
|
* />
|
|
18
18
|
*
|
|
@@ -9,8 +9,8 @@ import { TableProps } from '../../../../props';
|
|
|
9
9
|
*
|
|
10
10
|
* <iframe
|
|
11
11
|
* src='https://csdk-playground.sisense.com/?example=tables%2Faggregated-table&mode=docs'
|
|
12
|
-
* width=800
|
|
13
|
-
* height=870
|
|
12
|
+
* width='800'
|
|
13
|
+
* height='870'
|
|
14
14
|
* style='border:none;'
|
|
15
15
|
* />
|
|
16
16
|
*
|
package/dist/packages/sdk-ui/src/domains/visualizations/components/treemap-chart/treemap-chart.d.ts
CHANGED
|
@@ -11,8 +11,8 @@ import { TreemapChartProps } from '../../../../props';
|
|
|
11
11
|
*
|
|
12
12
|
* <iframe
|
|
13
13
|
* src='https://csdk-playground.sisense.com/?example=charts%2Ftreemap-chart&mode=docs'
|
|
14
|
-
* width=800
|
|
15
|
-
* height=870
|
|
14
|
+
* width='800'
|
|
15
|
+
* height='870'
|
|
16
16
|
* style='border:none;'
|
|
17
17
|
* />
|
|
18
18
|
*
|
|
@@ -652,12 +652,12 @@ export type IndicatorChartDataOptionsInternal = {
|
|
|
652
652
|
/** @internal */
|
|
653
653
|
export interface BoxplotChartDataOptionsInternal {
|
|
654
654
|
category?: StyledColumn;
|
|
655
|
-
boxMin
|
|
656
|
-
boxMedian
|
|
657
|
-
boxMax
|
|
658
|
-
whiskerMin
|
|
659
|
-
whiskerMax
|
|
660
|
-
outliersCount
|
|
655
|
+
boxMin?: StyledMeasureColumn;
|
|
656
|
+
boxMedian?: StyledMeasureColumn;
|
|
657
|
+
boxMax?: StyledMeasureColumn;
|
|
658
|
+
whiskerMin?: StyledMeasureColumn;
|
|
659
|
+
whiskerMax?: StyledMeasureColumn;
|
|
660
|
+
outliersCount?: StyledMeasureColumn;
|
|
661
661
|
outliers?: StyledColumn;
|
|
662
662
|
valueTitle: string;
|
|
663
663
|
}
|
|
@@ -62,6 +62,11 @@ export interface YAxisSettingsResult {
|
|
|
62
62
|
* @returns true if continuous datetime X-axis should be used
|
|
63
63
|
*/
|
|
64
64
|
export declare const isContinuousDatetimeXAxis: (xDataOptions: CartesianChartDataOptionsInternal['x']) => boolean;
|
|
65
|
+
/**
|
|
66
|
+
* Returns true when every X-axis dimension is a datetime column.
|
|
67
|
+
* Used to decide whether multi-granularity date charts can still show the navigator.
|
|
68
|
+
*/
|
|
69
|
+
export declare const areAllDatetimeXAxes: (xDataOptions: CartesianChartDataOptionsInternal['x']) => boolean;
|
|
65
70
|
/**
|
|
66
71
|
* Builds Y-axis metadata from chart data and options
|
|
67
72
|
*
|
|
@@ -87,7 +92,7 @@ export declare const getXAxisOrientation: (chartType: ChartType, yAxisChartTypes
|
|
|
87
92
|
* @param isContinuous - Whether X-axis is continuous
|
|
88
93
|
* @returns Categories metadata object
|
|
89
94
|
*/
|
|
90
|
-
export declare const buildCategoriesMeta: (chartData: CartesianChartData, dataOptions: CartesianChartDataOptionsInternal, designOptions: ChartDesignOptions, isContinuous: boolean) => CategoriesMeta;
|
|
95
|
+
export declare const buildCategoriesMeta: (chartData: CartesianChartData, dataOptions: CartesianChartDataOptionsInternal, designOptions: ChartDesignOptions, isContinuous: boolean, dateFormatter?: ((date: Date, format: string) => string) | undefined) => CategoriesMeta;
|
|
91
96
|
/**
|
|
92
97
|
* Builds X-axis settings based on whether it's continuous datetime or categorical
|
|
93
98
|
*
|
package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/plot-bands.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ export declare const applyNumberFormatToPlotBands: (dataOptions: ChartDataOption
|
|
|
18
18
|
* @param dataOptions -
|
|
19
19
|
* @param designOptions -
|
|
20
20
|
* @param continuousDatetimeXAxis -
|
|
21
|
+
* @param dateFormatter - When set, formats datetime x1/x2 labels from raw values (dual categorical axes)
|
|
21
22
|
*/
|
|
22
|
-
export declare const getCategoriesIndexMapAndPlotBands: (data: ChartData, dataOptions: CartesianChartDataOptionsInternal, designOptions: DesignOptions, continuousDatetimeXAxis: boolean) => CategoryIndexMapPlotBands;
|
|
23
|
+
export declare const getCategoriesIndexMapAndPlotBands: (data: ChartData, dataOptions: CartesianChartDataOptionsInternal, designOptions: DesignOptions, continuousDatetimeXAxis: boolean, dateFormatter?: ((date: Date, format: string) => string) | undefined) => CategoryIndexMapPlotBands;
|
|
23
24
|
export {};
|
|
@@ -23,6 +23,14 @@ export interface AxisLabelsFormatterContextObject {
|
|
|
23
23
|
categories: (string | number)[];
|
|
24
24
|
};
|
|
25
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* Subset of the Highcharts axis `afterSetExtremes` event payload used for navigator scroll persistence.
|
|
28
|
+
*/
|
|
29
|
+
export type NavigatorAxisSetExtremesEvent = {
|
|
30
|
+
min: number;
|
|
31
|
+
max: number;
|
|
32
|
+
trigger?: string;
|
|
33
|
+
};
|
|
26
34
|
export type AxisSettings = {
|
|
27
35
|
type?: 'linear' | 'logarithmic';
|
|
28
36
|
title?: {
|
|
@@ -74,6 +82,9 @@ export type AxisSettings = {
|
|
|
74
82
|
description?: string;
|
|
75
83
|
rangeDescription?: string;
|
|
76
84
|
};
|
|
85
|
+
events?: {
|
|
86
|
+
afterSetExtremes?: (e: NavigatorAxisSetExtremesEvent) => void;
|
|
87
|
+
};
|
|
77
88
|
};
|
|
78
89
|
export type StackLabel = {
|
|
79
90
|
style?: TextStyle;
|
|
@@ -118,4 +129,21 @@ export type AxisPlotBand = {
|
|
|
118
129
|
};
|
|
119
130
|
};
|
|
120
131
|
export declare const getCategoricalCompareValue: (value: CategoricalXValues) => number;
|
|
121
|
-
|
|
132
|
+
/**
|
|
133
|
+
* Merges a navigator scroll callback into the primary X-axis `afterSetExtremes` handler.
|
|
134
|
+
* Preserves any existing `events` and prior `afterSetExtremes` implementation.
|
|
135
|
+
*
|
|
136
|
+
* @param axes - Axis settings (first entry is treated as the primary X-axis).
|
|
137
|
+
* @param onScrollerChange - Invoked only when extremes change due to the navigator scroller.
|
|
138
|
+
* @returns New axis settings array with the merged handler on the first axis.
|
|
139
|
+
*/
|
|
140
|
+
export declare const attachNavigatorScrollerToPrimaryXAxis: (axes: readonly AxisSettings[], onScrollerChange: (min: number, max: number) => void) => AxisSettings[];
|
|
141
|
+
/**
|
|
142
|
+
* Transformer that merges a navigator scroll callback into the primary X-axis `afterSetExtremes` handler.
|
|
143
|
+
* No-ops when no callback is provided.
|
|
144
|
+
*
|
|
145
|
+
* @param onScrollerChange - Optional callback invoked when the navigator scroller changes extremes.
|
|
146
|
+
* @returns Transformer function over an axis settings array.
|
|
147
|
+
*/
|
|
148
|
+
export declare const withScrollerEvent: (onScrollerChange?: ((min: number, max: number) => void) | undefined) => (axes: readonly AxisSettings[]) => AxisSettings[];
|
|
149
|
+
export declare const getDefaultDateFormat: (granularity?: string) => "yyyy" | "MM/yyyy" | "ww yyyy" | "HH:mm" | "HH:mm:ss" | "M/d/yy" | "HH" | "yyyy Q" | "M/d/yy HH" | undefined;
|
|
@@ -1,12 +1,32 @@
|
|
|
1
|
-
import type { FunctionCall } from '@sisense/sdk-data';
|
|
2
1
|
import type { QueryPillItem } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Structured tooltip model produced by {@link getQueryPillTooltipModel}.
|
|
4
|
+
*
|
|
5
|
+
* @sisenseInternal
|
|
6
|
+
*/
|
|
3
7
|
export type TooltipModel = {
|
|
4
8
|
layoutText: string;
|
|
5
9
|
typeLabel: 'Measure' | 'Dimension' | 'Filter';
|
|
10
|
+
/** Resolved field path or display fallback; may duplicate {@link TooltipModel.formula}. */
|
|
6
11
|
column: string;
|
|
7
12
|
formula: string;
|
|
13
|
+
/** When false, the UI omits the "Column:" row (empty/`-` or same as the pill display name). */
|
|
14
|
+
showColumnInTooltip: boolean;
|
|
15
|
+
/** When false, the UI omits the "Formula:" row (identical to Column, e.g. plain DM dimensions). */
|
|
16
|
+
showFormulaInTooltip: boolean;
|
|
8
17
|
};
|
|
9
|
-
/**
|
|
10
|
-
|
|
11
|
-
|
|
18
|
+
/**
|
|
19
|
+
* Strips `measureFactory.`, `filterFactory.`, and `DM.` from compose code for tooltip display.
|
|
20
|
+
* Preserves the rest of the string (including quoted literals). Rare titles containing `DM.`
|
|
21
|
+
* inside quotes may be altered.
|
|
22
|
+
*
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
export declare function simplifyComposeCodeForTooltip(composeCode: string): string;
|
|
26
|
+
/**
|
|
27
|
+
* Builds the structured tooltip model rendered by {@link QueryPill} from a {@link QueryPillItem}.
|
|
28
|
+
* Returns `null` when the item has no tooltip-eligible data (e.g. operator pills or pills without `tooltipData`).
|
|
29
|
+
*
|
|
30
|
+
* @sisenseInternal
|
|
31
|
+
*/
|
|
12
32
|
export declare function getQueryPillTooltipModel(item: QueryPillItem): TooltipModel | null;
|
|
@@ -2,5 +2,8 @@ export { QueryDefinition } from './query-definition';
|
|
|
2
2
|
export type { QueryDefinitionProps } from './query-definition';
|
|
3
3
|
export { QueryPill } from './query-pill';
|
|
4
4
|
export type { QueryPillProps } from './query-pill';
|
|
5
|
+
export { baseQueryParamsToViewModel } from './query-params-to-view-model';
|
|
6
|
+
export { getQueryPillTooltipModel } from './compose-code-to-readable';
|
|
7
|
+
export type { TooltipModel } from './compose-code-to-readable';
|
|
5
8
|
export type { QueryPillCategory, QueryPillItem, ConnectorItem, QueryDefinitionViewModel, } from './types';
|
|
6
9
|
export { isConnectorItem, isPillItem } from './types';
|