@sisense/sdk-ui-vue 1.32.0 → 1.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/ai.cjs +388 -0
  2. package/dist/ai.d.ts +1 -0
  3. package/dist/ai.js +3838 -0
  4. package/dist/index.cjs +1 -1063
  5. package/dist/index.js +1277 -105403
  6. package/dist/packages/sdk-ui-vue/src/ai/components/chatbot.d.ts +73 -0
  7. package/dist/packages/sdk-ui-vue/src/ai/components/get-nlg-insights.d.ts +90 -0
  8. package/dist/packages/sdk-ui-vue/src/ai/components/index.d.ts +2 -0
  9. package/dist/packages/sdk-ui-vue/src/ai/composables/index.d.ts +3 -0
  10. package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlg-insights.d.ts +45 -0
  11. package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlq-result.d.ts +42 -0
  12. package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-query-recommendations.d.ts +50 -0
  13. package/dist/packages/sdk-ui-vue/src/ai/index.d.ts +4 -0
  14. package/dist/packages/sdk-ui-vue/src/ai/providers/ai-context-provider.d.ts +60 -0
  15. package/dist/packages/sdk-ui-vue/src/ai/providers/index.d.ts +1 -0
  16. package/dist/packages/sdk-ui-vue/src/ai/sdk-ui-core-exports.d.ts +1 -0
  17. package/dist/packages/sdk-ui-vue/src/components/charts/chart.d.ts +4 -4
  18. package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard-by-id.d.ts +9 -8
  19. package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard.d.ts +13 -8
  20. package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts +4 -4
  21. package/dist/packages/sdk-ui-vue/src/components/widgets/dashboard-widget.d.ts +4 -4
  22. package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts +4 -4
  23. package/dist/packages/sdk-ui-vue/src/composables/use-tracking.d.ts +15 -15
  24. package/dist/packages/sdk-ui-vue/src/lib.d.ts +1 -0
  25. package/dist/packages/sdk-ui-vue/src/providers/plugins-provider.d.ts +6 -2
  26. package/dist/packages/sdk-ui-vue/src/providers/sisense-context-provider.d.ts +2 -5
  27. package/dist/packages/sdk-ui-vue/src/providers/theme-provider.d.ts +2 -11
  28. package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts +2 -2
  29. package/dist/packages/sdk-ui-vue/src/setup-helper.d.ts +13 -1
  30. package/dist/packages/sdk-ui-vue/src/types/dashboard-config.d.ts +24 -0
  31. package/dist/packages/sdk-ui-vue/src/types/index.d.ts +2 -0
  32. package/dist/packages/sdk-ui-vue/src/types/maybe-ref.d.ts +14 -0
  33. package/dist/packages/sdk-ui-vue/src/utilities/dashboard-helpers.d.ts +105 -0
  34. package/dist/packages/sdk-ui-vue/src/utilities/dashboard-model-translator.d.ts +37 -0
  35. package/dist/packages/sdk-ui-vue/src/utilities/index.d.ts +23 -0
  36. package/dist/packages/sdk-ui-vue/src/utilities/widget-model-translator.d.ts +247 -0
  37. package/dist/use-tracking-2d715e05.js +105710 -0
  38. package/dist/use-tracking-bc424435.cjs +1066 -0
  39. package/package.json +15 -2
  40. package/dist/packages/sdk-ui-vue/src/types.d.ts +0 -6
@@ -0,0 +1,73 @@
1
+ import type { PropType } from 'vue';
2
+ import type { ChatbotProps as ChatbotPropsPreact } from '@sisense/sdk-ui-preact/ai';
3
+ /**
4
+ * Props of the {@link @sisense/sdk-ui-vue!Chatbot | `Chatbot`} component.
5
+ */
6
+ export interface ChatbotProps extends ChatbotPropsPreact {
7
+ }
8
+ /**
9
+ * An Vue component that renders a chatbot with data topic selection.
10
+ *
11
+ * ::: warning Note
12
+ * This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
13
+ * :::
14
+ *
15
+ * @example
16
+ * Here's how you can use the Chatbot component in a Vue application:
17
+ * ```vue
18
+ <script setup lang="ts">
19
+ import { Chatbot, type ChatbotProps } from '@sisense/sdk-ui-vue/ai';
20
+
21
+ const chatbotProps: ChatbotProps = {
22
+ width: 500,
23
+ height: 700,
24
+ config: {
25
+ numOfRecommendations: 5,
26
+ },
27
+ };
28
+ </script>
29
+
30
+ <template>
31
+ <Chatbot
32
+ :width="chatbotProps.width"
33
+ :height="chatbotProps.height"
34
+ :config="chatbotProps.config"
35
+ />
36
+ </template>
37
+ * ```
38
+ *
39
+ * <img src="media://vue-chatbot-example.png" width="500px" />
40
+ *
41
+ * @param props - {@link ChatbotProps}
42
+ * @group Generative AI
43
+ * @beta
44
+ */
45
+ export declare const Chatbot: import("vue").DefineComponent<{
46
+ /**
47
+ * {@inheritDoc @sisense/sdk-ui!ChatbotProps.width}
48
+ */
49
+ width: PropType<import("csstype").Property.Width<string | number> | undefined>;
50
+ /**
51
+ * {@inheritDoc @sisense/sdk-ui!ChatbotProps.height}
52
+ */
53
+ height: PropType<import("csstype").Property.Height<string | number> | undefined>;
54
+ /**
55
+ * {@inheritDoc @sisense/sdk-ui!ChatbotProps.config}
56
+ */
57
+ config: PropType<Partial<import("@sisense/sdk-ui-preact/ai").ChatConfig> | undefined>;
58
+ }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
59
+ [key: string]: any;
60
+ }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
61
+ /**
62
+ * {@inheritDoc @sisense/sdk-ui!ChatbotProps.width}
63
+ */
64
+ width: PropType<import("csstype").Property.Width<string | number> | undefined>;
65
+ /**
66
+ * {@inheritDoc @sisense/sdk-ui!ChatbotProps.height}
67
+ */
68
+ height: PropType<import("csstype").Property.Height<string | number> | undefined>;
69
+ /**
70
+ * {@inheritDoc @sisense/sdk-ui!ChatbotProps.config}
71
+ */
72
+ config: PropType<Partial<import("@sisense/sdk-ui-preact/ai").ChatConfig> | undefined>;
73
+ }>>, {}, {}>;
@@ -0,0 +1,90 @@
1
+ import type { PropType } from 'vue';
2
+ import type { GetNlgInsightsProps as GetNlgInsightsPropsPreact } from '@sisense/sdk-ui-preact/ai';
3
+ /**
4
+ * Props of the {@link @sisense/sdk-ui-vue!GetNlgInsights | `GetNlgInsights`} component.
5
+ */
6
+ export interface GetNlgInsightsProps extends GetNlgInsightsPropsPreact {
7
+ }
8
+ /**
9
+ * A Vue component that fetches and displays a collapsible analysis of the provided query using natural language generation (NLG).
10
+ * Specifying a query is similar to providing parameters to a {@link @sisense/sdk-ui-vue!useExecuteQuery | `useExecuteQuery`} composable, using dimensions, measures, and filters.
11
+ *
12
+ * ::: warning Note
13
+ * This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
14
+ * :::
15
+ *
16
+ * @example
17
+ * Here's how you can use the GetNlgInsights component in a Vue application:
18
+ * ```vue
19
+ <script setup lang="ts">
20
+ import { GetNlgInsights, type GetNlgInsightsProps } from '@sisense/sdk-ui-vue/ai';
21
+ import { measureFactory } from '@sisense/sdk-data';
22
+ import * as DM from '../assets/sample-retail-model';
23
+
24
+ const props: GetNlgInsightsProps = {
25
+ dataSource: DM.DataSource.title,
26
+ dimensions: [DM.DimProducts.CategoryName],
27
+ measures: [measureFactory.sum(DM.DimProducts.Price)],
28
+ };
29
+ </script>
30
+
31
+ <template>
32
+ <GetNlgInsights
33
+ :dataSource="props.dataSource"
34
+ :dimensions="props.dimensions"
35
+ :measures="props.measures"
36
+ />
37
+ </template>
38
+ * ```
39
+ * <img src="media://vue-get-nlg-insights-example.png" width="700"/>
40
+ *
41
+ * @param props - {@link GetNlgInsightsProps}
42
+ * @returns Collapsible container wrapping a text summary
43
+ * @group Generative AI
44
+ * @beta
45
+ */
46
+ export declare const GetNlgInsights: import("vue").DefineComponent<{
47
+ /**
48
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.dataSource}
49
+ */
50
+ dataSource: PropType<import("@sisense/sdk-data").DataSource>;
51
+ /**
52
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.dimensions}
53
+ */
54
+ dimensions: PropType<import("@sisense/sdk-data").Attribute[] | undefined>;
55
+ /**
56
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.measures}
57
+ */
58
+ measures: PropType<import("@sisense/sdk-data").Measure[] | undefined>;
59
+ /**
60
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.filters}
61
+ */
62
+ filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
63
+ /**
64
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.verbosity}
65
+ */
66
+ verbosity: PropType<"Low" | "High" | undefined>;
67
+ }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
68
+ [key: string]: any;
69
+ }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
70
+ /**
71
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.dataSource}
72
+ */
73
+ dataSource: PropType<import("@sisense/sdk-data").DataSource>;
74
+ /**
75
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.dimensions}
76
+ */
77
+ dimensions: PropType<import("@sisense/sdk-data").Attribute[] | undefined>;
78
+ /**
79
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.measures}
80
+ */
81
+ measures: PropType<import("@sisense/sdk-data").Measure[] | undefined>;
82
+ /**
83
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.filters}
84
+ */
85
+ filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
86
+ /**
87
+ * {@inheritDoc @sisense/sdk-ui!GetNlgInsightsProps.verbosity}
88
+ */
89
+ verbosity: PropType<"Low" | "High" | undefined>;
90
+ }>>, {}, {}>;
@@ -0,0 +1,2 @@
1
+ export * from './chatbot';
2
+ export * from './get-nlg-insights';
@@ -0,0 +1,3 @@
1
+ export * from './use-get-nlg-insights';
2
+ export * from './use-get-query-recommendations';
3
+ export * from './use-get-nlq-result';
@@ -0,0 +1,45 @@
1
+ import { type UseGetNlgInsightsParams as UseGetNlgInsightsParamsPreact, type UseGetNlgInsightsState as UseGetNlgInsightsStatePreact } from '@sisense/sdk-ui-preact/ai';
2
+ import type { MaybeRefOrWithRefs, ToRefsExceptFns } from '../../types';
3
+ /**
4
+ * Parameters of the {@link @sisense/sdk-ui-vue!useGetNlgInsights | `useGetNlgInsights`} composable.
5
+ */
6
+ export interface UseGetNlgInsightsParams extends UseGetNlgInsightsParamsPreact {
7
+ }
8
+ /**
9
+ * State for {@link @sisense/sdk-ui-vue!useGetNlgInsights | `useGetNlgInsights`} composable.
10
+ */
11
+ export interface UseGetNlgInsightsState extends ToRefsExceptFns<UseGetNlgInsightsStatePreact, 'refetch'> {
12
+ }
13
+ /**
14
+ * A Vue composable that fetches an analysis of the provided query using natural language generation (NLG).
15
+ * Specifying a query is similar to providing parameters to a {@link @sisense/sdk-ui-vue!useExecuteQuery | `useExecuteQuery`} composable, using dimensions, measures, and filters.
16
+ *
17
+ * ::: warning Note
18
+ * This composable is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
19
+ * :::
20
+ *
21
+ * @example
22
+ * ```vue
23
+ <script setup lang="ts">
24
+ import { useGetNlgInsights, type GetNlgInsightsProps } from '@sisense/sdk-ui-vue/ai';
25
+ import { measureFactory } from '@sisense/sdk-data';
26
+ import * as DM from '../assets/sample-retail-model';
27
+
28
+ const props: GetNlgInsightsProps = {
29
+ dataSource: DM.DataSource.title,
30
+ dimensions: [DM.DimProducts.CategoryName],
31
+ measures: [measureFactory.sum(DM.DimProducts.Price)],
32
+ };
33
+ const { data: nlgInsights } = useGetNlgInsights(props);
34
+ </script>
35
+
36
+ <template>
37
+ {{ nlgInsights }}
38
+ </template>
39
+ * ```
40
+ * @param params - {@link UseGetNlgInsightsParams}
41
+ * @returns The composable load state that contains the status of the execution and a text summary result (data)
42
+ * @group Generative AI
43
+ * @beta
44
+ */
45
+ export declare const useGetNlgInsights: (params: MaybeRefOrWithRefs<UseGetNlgInsightsParams>) => UseGetNlgInsightsState;
@@ -0,0 +1,42 @@
1
+ import { type UseGetNlqResultParams as UseGetNlqResultParamsPreact, type UseGetNlqResultState as UseGetNlqResultStatePreact } from '@sisense/sdk-ui-preact/ai';
2
+ import type { MaybeRefOrWithRefs, ToRefsExceptFns } from '../../types';
3
+ /**
4
+ * Parameters for {@link @sisense/sdk-ui-vue!useGetNlqResult | `useGetNlqResult`} composable.
5
+ */
6
+ export interface UseGetNlqResultParams extends UseGetNlqResultParamsPreact {
7
+ }
8
+ /**
9
+ * State for {@link @sisense/sdk-ui-vue!useGetNlqResult | `useGetNlqResult`} composable.
10
+ */
11
+ export interface UseGetNlqResultState extends ToRefsExceptFns<UseGetNlqResultStatePreact, 'refetch'> {
12
+ }
13
+ /**
14
+ * A Vue composable that enables natural language query (NLQ) against a data model or perspective.
15
+ *
16
+ * ::: warning Note
17
+ * This composable is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
18
+ * :::
19
+ *
20
+ * @example
21
+ * ```vue
22
+ <script setup lang="ts">
23
+ import { ChartWidget } from '@sisense/sdk-ui-vue';
24
+ import { useGetNlqResult, type UseGetNlqResultParams } from '@sisense/sdk-ui-vue/ai';
25
+
26
+ const params: UseGetNlqResultParams = {
27
+ dataSource: 'Sample Retail',
28
+ query: 'Show me the lowest product prices by country'
29
+ };
30
+ const { data: nlqResult } = useGetNlqResult(params);
31
+ </script>
32
+
33
+ <template>
34
+ <ChartWidget v-bind="nlqResult" />
35
+ </template>
36
+ * ```
37
+ * @param params - {@link UseGetNlqResultParams}
38
+ * @returns The composable NLQ load state that contains the status of the execution, the result (data) as WidgetProps
39
+ * @group Generative AI
40
+ * @beta
41
+ */
42
+ export declare const useGetNlqResult: (params: MaybeRefOrWithRefs<UseGetNlqResultParams>) => UseGetNlqResultState;
@@ -0,0 +1,50 @@
1
+ import { type UseGetQueryRecommendationsParams as UseGetQueryRecommendationsParamsPreact, type UseGetQueryRecommendationsState as UseGetQueryRecommendationsStatePreact } from '@sisense/sdk-ui-preact/ai';
2
+ import type { MaybeRefOrWithRefs, ToRefsExceptFns } from '../../types';
3
+ /**
4
+ * Parameters for {@link @sisense/sdk-ui-vue!useGetQueryRecommendations | `useGetQueryRecommendations`} composable.
5
+ */
6
+ export interface UseGetQueryRecommendationsParams extends UseGetQueryRecommendationsParamsPreact {
7
+ }
8
+ /**
9
+ * State for {@link @sisense/sdk-ui-vue!useGetQueryRecommendations | `useGetQueryRecommendations`} composable.
10
+ */
11
+ export interface UseGetQueryRecommendationsState extends ToRefsExceptFns<UseGetQueryRecommendationsStatePreact, 'refetch'> {
12
+ }
13
+ /**
14
+ * A Vue composable that fetches recommended questions for a data model or perspective.
15
+ *
16
+ * This composable includes the same code that fetches the initial suggested questions in the chatbot.
17
+ *
18
+ * ::: warning Note
19
+ * This composable is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
20
+ * :::
21
+ *
22
+ * @example
23
+ * ```vue
24
+ <script setup lang="ts">
25
+ import {
26
+ useGetQueryRecommendations,
27
+ type UseGetQueryRecommendationsParams,
28
+ } from '@sisense/sdk-ui-vue/ai';
29
+
30
+ const params: UseGetQueryRecommendationsParams = {
31
+ contextTitle: 'Sample Retail',
32
+ count: 3,
33
+ };
34
+ const { data: recommendations = [] } = useGetQueryRecommendations(params);
35
+ </script>
36
+
37
+ <template>
38
+ <ul>
39
+ <li v-for="r in recommendations" :key="r.nlqPrompt">
40
+ {{ r.nlqPrompt }}
41
+ </li>
42
+ </ul>
43
+ </template>
44
+ * ```
45
+ * @param params - {@link UseGetQueryRecommendationsParams}
46
+ * @returns The composable load state that contains the status of the execution and recommendations result (data) with recommended question text and its corresponding `widgetProps`
47
+ * @group Generative AI
48
+ * @beta
49
+ */
50
+ export declare const useGetQueryRecommendations: (params: MaybeRefOrWithRefs<UseGetQueryRecommendationsParams>) => UseGetQueryRecommendationsState;
@@ -0,0 +1,4 @@
1
+ export * from './components';
2
+ export * from './composables';
3
+ export { AiContextProvider, type AiContextProviderProps } from './providers';
4
+ export * from './sdk-ui-core-exports';
@@ -0,0 +1,60 @@
1
+ import type { PropType, Ref } from 'vue';
2
+ import type { AiContextProviderProps as AiContextProviderPropsPreact } from '@sisense/sdk-ui-preact/ai';
3
+ import { type CustomAiContext } from '@sisense/sdk-ui-preact/ai';
4
+ /**
5
+ * Props of the {@link @sisense/sdk-ui-vue!AiContextProvider | `AiContextProvider`} component.
6
+ */
7
+ export interface AiContextProviderProps extends Omit<AiContextProviderPropsPreact, 'children'> {
8
+ }
9
+ /**
10
+ * Gets AI context
11
+ * @internal
12
+ */
13
+ export declare const getAiContext: () => Ref<CustomAiContext>;
14
+ /**
15
+ * Creates AI context connector
16
+ * @internal
17
+ */
18
+ export declare const createAiContextConnector: () => {
19
+ prepareContext(): CustomAiContext;
20
+ renderContextProvider: (contextData: CustomAiContext | undefined, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
21
+ };
22
+ /**
23
+ * A Vue component that wraps all generative AI components and hooks.
24
+ *
25
+ * ::: warning Note
26
+ * This component is currently under beta release for our managed cloud customers on version L2024.2 or above. It is subject to changes as we make fixes and improvements.
27
+ * :::
28
+ *
29
+ * @example
30
+ * ```vue
31
+ <script setup lang="ts">
32
+ import { SisenseContextProvider } from '@sisense/sdk-ui-vue';
33
+ import { AiContextProvider, Chatbot } from '@sisense/sdk-ui-vue/ai';
34
+ </script>
35
+
36
+ <template>
37
+ <SisenseContextProvider v-bind="sisenseContextProps">
38
+ <AiContextProvider>
39
+ <Chatbot />
40
+ </AiContextProvider>
41
+ </SisenseContextProvider>
42
+ </template>
43
+ * ```
44
+ * @param props - {@link AiContextProviderProps}
45
+ * @group Generative AI
46
+ * @beta
47
+ */
48
+ export declare const AiContextProvider: import("vue").DefineComponent<{
49
+ /**
50
+ * {@inheritDoc @sisense/sdk-ui!AiContextProviderProps.volatile}
51
+ */
52
+ volatile: PropType<boolean | undefined>;
53
+ }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
54
+ [key: string]: any;
55
+ }>[] | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
56
+ /**
57
+ * {@inheritDoc @sisense/sdk-ui!AiContextProviderProps.volatile}
58
+ */
59
+ volatile: PropType<boolean | undefined>;
60
+ }>>, {}, {}>;
@@ -0,0 +1 @@
1
+ export * from './ai-context-provider';
@@ -0,0 +1 @@
1
+ export type { ChatConfig, QueryRecommendation } from '@sisense/sdk-ui-preact/ai';
@@ -110,13 +110,13 @@ export declare const Chart: import("vue").DefineComponent<{
110
110
  *
111
111
  * @category Callbacks
112
112
  */
113
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
113
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
114
114
  /**
115
115
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
116
116
  *
117
117
  * @category Callbacks
118
118
  */
119
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
119
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
120
120
  /**
121
121
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
122
122
  *
@@ -184,13 +184,13 @@ export declare const Chart: import("vue").DefineComponent<{
184
184
  *
185
185
  * @category Callbacks
186
186
  */
187
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
187
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
188
188
  /**
189
189
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
190
190
  *
191
191
  * @category Callbacks
192
192
  */
193
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
193
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
194
194
  /**
195
195
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
196
196
  *
@@ -1,9 +1,14 @@
1
1
  import type { PropType } from 'vue';
2
2
  import type { DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sdk-ui-preact';
3
+ import type { DashboardByIdConfig } from '../../types';
3
4
  /**
4
5
  * Props of the {@link @sisense/sdk-ui-vue!DashboardById | `DashboardById`} component.
5
6
  */
6
7
  export interface DashboardByIdProps extends DashboardByIdPropsPreact {
8
+ /**
9
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
10
+ */
11
+ config?: DashboardByIdConfig;
7
12
  }
8
13
  /**
9
14
  * A component used for easily rendering a dashboard by its ID in a Sisense Fusion instance.
@@ -37,11 +42,9 @@ export declare const DashboardById: import("vue").DefineComponent<{
37
42
  */
38
43
  dashboardOid: PropType<string>;
39
44
  /**
40
- * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.persist}
41
- *
42
- * @alpha
45
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
43
46
  */
44
- persist: PropType<boolean | undefined>;
47
+ config: PropType<DashboardByIdConfig | undefined>;
45
48
  }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
46
49
  [key: string]: any;
47
50
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -50,9 +53,7 @@ export declare const DashboardById: import("vue").DefineComponent<{
50
53
  */
51
54
  dashboardOid: PropType<string>;
52
55
  /**
53
- * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.persist}
54
- *
55
- * @alpha
56
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
56
57
  */
57
- persist: PropType<boolean | undefined>;
58
+ config: PropType<DashboardByIdConfig | undefined>;
58
59
  }>>, {}, {}>;
@@ -1,6 +1,15 @@
1
1
  import type { PropType } from 'vue';
2
- import type { DashboardProps } from '@sisense/sdk-ui-preact';
3
- export { DashboardProps };
2
+ import type { DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
3
+ import type { DashboardConfig } from '../../types';
4
+ /**
5
+ * Props of the {@link @sisense/sdk-ui-vue!Dashboard | `Dashboard`} component.
6
+ */
7
+ export interface DashboardProps extends DashboardPropsPreact {
8
+ /**
9
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
10
+ */
11
+ config?: DashboardConfig;
12
+ }
4
13
  /**
5
14
  * A component used for easily rendering a dashboard.
6
15
  *
@@ -51,10 +60,8 @@ export declare const Dashboard: import("vue").DefineComponent<{
51
60
  layoutOptions: PropType<import("@sisense/sdk-ui-preact").DashboardLayoutOptions | undefined>;
52
61
  /**
53
62
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
54
- *
55
- * @internal
56
63
  */
57
- config: PropType<import("@sisense/sdk-ui-preact").DashboardConfig | undefined>;
64
+ config: PropType<DashboardConfig | undefined>;
58
65
  /**
59
66
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
60
67
  */
@@ -88,10 +95,8 @@ export declare const Dashboard: import("vue").DefineComponent<{
88
95
  layoutOptions: PropType<import("@sisense/sdk-ui-preact").DashboardLayoutOptions | undefined>;
89
96
  /**
90
97
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
91
- *
92
- * @internal
93
98
  */
94
- config: PropType<import("@sisense/sdk-ui-preact").DashboardConfig | undefined>;
99
+ config: PropType<DashboardConfig | undefined>;
95
100
  /**
96
101
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
97
102
  */
@@ -140,13 +140,13 @@ export declare const ChartWidget: import("vue").DefineComponent<{
140
140
  *
141
141
  * @category Callbacks
142
142
  */
143
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
143
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
144
144
  /**
145
145
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
146
146
  *
147
147
  * @category Callbacks
148
148
  */
149
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
149
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
150
150
  /**
151
151
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
152
152
  *
@@ -262,13 +262,13 @@ export declare const ChartWidget: import("vue").DefineComponent<{
262
262
  *
263
263
  * @category Callbacks
264
264
  */
265
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
265
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
266
266
  /**
267
267
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
268
268
  *
269
269
  * @category Callbacks
270
270
  */
271
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
271
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
272
272
  /**
273
273
  * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
274
274
  *
@@ -96,13 +96,13 @@ export declare const DashboardWidget: import("vue").DefineComponent<{
96
96
  *
97
97
  * @category Callbacks
98
98
  */
99
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
99
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
100
100
  /**
101
101
  * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointContextMenu}
102
102
  *
103
103
  * @category Callbacks
104
104
  */
105
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
105
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
106
106
  /**
107
107
  * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointsSelected}
108
108
  *
@@ -195,13 +195,13 @@ export declare const DashboardWidget: import("vue").DefineComponent<{
195
195
  *
196
196
  * @category Callbacks
197
197
  */
198
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
198
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
199
199
  /**
200
200
  * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointContextMenu}
201
201
  *
202
202
  * @category Callbacks
203
203
  */
204
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
204
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
205
205
  /**
206
206
  * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointsSelected}
207
207
  *
@@ -93,13 +93,13 @@ export declare const WidgetById: import("vue").DefineComponent<{
93
93
  *
94
94
  * @category Callbacks
95
95
  */
96
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
96
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
97
97
  /**
98
98
  * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
99
99
  *
100
100
  * @category Callbacks
101
101
  */
102
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
102
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
103
103
  /**
104
104
  * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
105
105
  *
@@ -192,13 +192,13 @@ export declare const WidgetById: import("vue").DefineComponent<{
192
192
  *
193
193
  * @category Callbacks
194
194
  */
195
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
195
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
196
196
  /**
197
197
  * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
198
198
  *
199
199
  * @category Callbacks
200
200
  */
201
- onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
201
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
202
202
  /**
203
203
  * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
204
204
  *