@sisense/sdk-ui-vue 1.31.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.
- package/dist/ai.cjs +388 -0
- package/dist/ai.d.ts +1 -0
- package/dist/ai.js +3838 -0
- package/dist/index.cjs +1 -2052
- package/dist/index.js +1702 -106235
- package/dist/packages/sdk-ui-vue/src/ai/components/chatbot.d.ts +73 -0
- package/dist/packages/sdk-ui-vue/src/ai/components/get-nlg-insights.d.ts +90 -0
- package/dist/packages/sdk-ui-vue/src/ai/components/index.d.ts +2 -0
- package/dist/packages/sdk-ui-vue/src/ai/composables/index.d.ts +3 -0
- package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlg-insights.d.ts +45 -0
- package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlq-result.d.ts +42 -0
- package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-query-recommendations.d.ts +50 -0
- package/dist/packages/sdk-ui-vue/src/ai/index.d.ts +4 -0
- package/dist/packages/sdk-ui-vue/src/ai/providers/ai-context-provider.d.ts +60 -0
- package/dist/packages/sdk-ui-vue/src/ai/providers/index.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/ai/sdk-ui-core-exports.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/area-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/area-range-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/areamap-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/bar-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/boxplot-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/chart.d.ts +6 -4
- package/dist/packages/sdk-ui-vue/src/components/charts/column-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/funnel-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/index.d.ts +18 -18
- package/dist/packages/sdk-ui-vue/src/components/charts/indicator-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/line-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/pie-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/pivot-table.d.ts +2 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/polar-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/scatter-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/scattermap-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/sunburst-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/table.d.ts +2 -0
- package/dist/packages/sdk-ui-vue/src/components/charts/treemap-chart.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/context-menu.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard-by-id.d.ts +15 -8
- package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard.d.ts +13 -6
- package/dist/packages/sdk-ui-vue/src/components/dashboard/index.d.ts +2 -2
- package/dist/packages/sdk-ui-vue/src/components/drilldown-breadcrumbs.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/drilldown-widget.d.ts +13 -2
- package/dist/packages/sdk-ui-vue/src/components/filters/criteria-filter-tile.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/filters/date-range-filter-tile.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/filters/index.d.ts +4 -4
- package/dist/packages/sdk-ui-vue/src/components/filters/member-filter-tile.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/filters/relative-date-filter-tile.d.ts +6 -0
- package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts +6 -4
- package/dist/packages/sdk-ui-vue/src/components/widgets/dashboard-widget.d.ts +13 -4
- package/dist/packages/sdk-ui-vue/src/components/widgets/index.d.ts +4 -4
- package/dist/packages/sdk-ui-vue/src/components/widgets/table-widget.d.ts +2 -0
- package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts +10 -4
- package/dist/packages/sdk-ui-vue/src/composables/use-plugins.d.ts +3 -3
- package/dist/packages/sdk-ui-vue/src/composables/use-tracking.d.ts +15 -15
- package/dist/packages/sdk-ui-vue/src/lib.d.ts +3 -1
- package/dist/packages/sdk-ui-vue/src/providers/index.d.ts +2 -2
- package/dist/packages/sdk-ui-vue/src/providers/plugins-provider.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/providers/sisense-context-provider.d.ts +13 -4
- package/dist/packages/sdk-ui-vue/src/providers/theme-provider.d.ts +7 -11
- package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts +2 -6
- package/dist/packages/sdk-ui-vue/src/setup-helper.d.ts +13 -1
- package/dist/packages/sdk-ui-vue/src/types/dashboard-config.d.ts +24 -0
- package/dist/packages/sdk-ui-vue/src/types/index.d.ts +2 -0
- package/dist/packages/sdk-ui-vue/src/types/maybe-ref.d.ts +14 -0
- package/dist/packages/sdk-ui-vue/src/utilities/dashboard-helpers.d.ts +105 -0
- package/dist/packages/sdk-ui-vue/src/utilities/dashboard-model-translator.d.ts +37 -0
- package/dist/packages/sdk-ui-vue/src/utilities/index.d.ts +23 -0
- package/dist/packages/sdk-ui-vue/src/utilities/widget-model-translator.d.ts +247 -0
- package/dist/use-tracking-2d715e05.js +105710 -0
- package/dist/use-tracking-bc424435.cjs +1066 -0
- package/package.json +15 -2
- 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,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,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';
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { AreaChartProps as AreaChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!AreaChart | `AreaChart`} component.
|
5
|
+
*/
|
6
|
+
export interface AreaChartProps extends AreaChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component similar to a {@link LineChart},
|
4
10
|
* but with filled in areas under each line and an option to display them as stacked.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { AreaRangeChartProps as AreaRangeChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!AreaRangeChart | `AreaRangeChart`} component.
|
5
|
+
*/
|
6
|
+
export interface AreaRangeChartProps extends AreaRangeChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component that displays a range of data over a given time period
|
4
10
|
* or across multiple categories. It is particularly useful for visualizing
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { AreamapChartProps as AreamapChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!AreamapChart | `AreamapChart`} component.
|
5
|
+
*/
|
6
|
+
export interface AreamapChartProps extends AreamapChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component for visualizing geographical data as polygons on a map.
|
4
10
|
*
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { BarChartProps as BarChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!BarChart | `BarChart`} component.
|
5
|
+
*/
|
6
|
+
export interface BarChartProps extends BarChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component representing categorical data with horizontal rectangular bars,
|
4
10
|
* whose lengths are proportional to the values that they represent.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { BoxplotChartProps as BoxplotChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!BoxplotChart | `BoxplotChart`} component.
|
5
|
+
*/
|
6
|
+
export interface BoxplotChartProps extends BoxplotChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component representing data in a way that visually describes the distribution, variability,
|
4
10
|
* and center of a data set along an axis.
|
@@ -1,4 +1,6 @@
|
|
1
1
|
import { type PropType } from 'vue';
|
2
|
+
import { type ChartProps } from '@sisense/sdk-ui-preact';
|
3
|
+
export { ChartProps };
|
2
4
|
/**
|
3
5
|
* A Vue component used for easily switching chart types or rendering multiple series of different chart types.
|
4
6
|
*
|
@@ -108,13 +110,13 @@ export declare const Chart: import("vue").DefineComponent<{
|
|
108
110
|
*
|
109
111
|
* @category Callbacks
|
110
112
|
*/
|
111
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").
|
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>;
|
112
114
|
/**
|
113
115
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
114
116
|
*
|
115
117
|
* @category Callbacks
|
116
118
|
*/
|
117
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").
|
119
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
|
118
120
|
/**
|
119
121
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
|
120
122
|
*
|
@@ -182,13 +184,13 @@ export declare const Chart: import("vue").DefineComponent<{
|
|
182
184
|
*
|
183
185
|
* @category Callbacks
|
184
186
|
*/
|
185
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").
|
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>;
|
186
188
|
/**
|
187
189
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
188
190
|
*
|
189
191
|
* @category Callbacks
|
190
192
|
*/
|
191
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").
|
193
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
|
192
194
|
/**
|
193
195
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
|
194
196
|
*
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { ColumnChartProps as ColumnChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!ColumnChart | `ColumnChart`} component.
|
5
|
+
*/
|
6
|
+
export interface ColumnChartProps extends ColumnChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component representing categorical data with vertical rectangular bars
|
4
10
|
* whose heights are proportional to the values that they represent.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { FunnelChartProps as FunnelChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!FunnelChart | `FunnelChart`} component.
|
5
|
+
*/
|
6
|
+
export interface FunnelChartProps extends FunnelChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component that wraps the FunnelChart Preact component for use in Vue applications.
|
4
10
|
* It maintains compatibility with Vue's reactivity system while preserving the functionality of the FunnelChart.
|
@@ -1,18 +1,18 @@
|
|
1
|
-
export { AreaChart } from './area-chart';
|
2
|
-
export { BarChart } from './bar-chart';
|
3
|
-
export { ColumnChart } from './column-chart';
|
4
|
-
export { FunnelChart } from './funnel-chart';
|
5
|
-
export { LineChart } from './line-chart';
|
6
|
-
export { PieChart } from './pie-chart';
|
7
|
-
export { ScatterChart } from './scatter-chart';
|
8
|
-
export { Table } from './table';
|
9
|
-
export { PivotTable } from './pivot-table';
|
10
|
-
export { TreemapChart } from './treemap-chart';
|
11
|
-
export { SunburstChart } from './sunburst-chart';
|
12
|
-
export { PolarChart } from './polar-chart';
|
13
|
-
export { IndicatorChart } from './indicator-chart';
|
14
|
-
export { Chart } from './chart';
|
15
|
-
export { BoxplotChart } from './boxplot-chart';
|
16
|
-
export { AreamapChart } from './areamap-chart';
|
17
|
-
export { ScattermapChart } from './scattermap-chart';
|
18
|
-
export { AreaRangeChart } from './area-range-chart';
|
1
|
+
export { AreaChart, type AreaChartProps } from './area-chart';
|
2
|
+
export { BarChart, type BarChartProps } from './bar-chart';
|
3
|
+
export { ColumnChart, type ColumnChartProps } from './column-chart';
|
4
|
+
export { FunnelChart, type FunnelChartProps } from './funnel-chart';
|
5
|
+
export { LineChart, type LineChartProps } from './line-chart';
|
6
|
+
export { PieChart, type PieChartProps } from './pie-chart';
|
7
|
+
export { ScatterChart, type ScatterChartProps } from './scatter-chart';
|
8
|
+
export { Table, type TableProps } from './table';
|
9
|
+
export { PivotTable, type PivotTableProps } from './pivot-table';
|
10
|
+
export { TreemapChart, type TreemapChartProps } from './treemap-chart';
|
11
|
+
export { SunburstChart, type SunburstChartProps } from './sunburst-chart';
|
12
|
+
export { PolarChart, type PolarChartProps } from './polar-chart';
|
13
|
+
export { IndicatorChart, type IndicatorChartProps } from './indicator-chart';
|
14
|
+
export { Chart, type ChartProps } from './chart';
|
15
|
+
export { BoxplotChart, type BoxplotChartProps } from './boxplot-chart';
|
16
|
+
export { AreamapChart, type AreamapChartProps } from './areamap-chart';
|
17
|
+
export { ScattermapChart, type ScattermapChartProps } from './scattermap-chart';
|
18
|
+
export { AreaRangeChart, type AreaRangeChartProps } from './area-range-chart';
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { IndicatorChartProps as IndicatorChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!IndicatorChart | `IndicatorChart`} component.
|
5
|
+
*/
|
6
|
+
export interface IndicatorChartProps extends IndicatorChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component that provides various options for displaying one or two numeric values as a number, gauge or ticker.
|
4
10
|
*
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { LineChartProps as LineChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!LineChart | `LineChart`} component.
|
5
|
+
*/
|
6
|
+
export interface LineChartProps extends LineChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component that wraps the LineChart Preact component for use in Vue applications.
|
4
10
|
* It maintains compatibility with Vue's reactivity system while preserving the functionality of the LineChart.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { PieChartProps as PieChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!PieChart | `PieChart`} component.
|
5
|
+
*/
|
6
|
+
export interface PieChartProps extends PieChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component representing data in a circular graph with the data shown as slices of a whole,
|
4
10
|
* with each slice representing a proportion of the total.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import { type PropType } from 'vue';
|
2
|
+
import { type PolarChartProps as PolarChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!PolarChart | `PolarChart`} component.
|
5
|
+
*/
|
6
|
+
export interface PolarChartProps extends PolarChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component comparing multiple categories/variables with a spacial perspective in a radial chart.
|
4
10
|
*
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { ScatterChartProps as ScatterChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!ScatterChart | `ScatterChart`} component.
|
5
|
+
*/
|
6
|
+
export interface ScatterChartProps extends ScatterChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component displaying the distribution of two variables on an X-Axis, Y-Axis,
|
4
10
|
* and two additional fields of data that are shown as colored circles scattered across the chart.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { ScattermapChartProps as ScattermapChartPropsPreqct } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!ScattermapChart | `ScattermapChart`} component.
|
5
|
+
*/
|
6
|
+
export interface ScattermapChartProps extends ScattermapChartPropsPreqct {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component that wraps the ScattermapChart Preact component for use in Vue applications.
|
4
10
|
* It maintains compatibility with Vue's reactivity system while preserving the functionality of the ScattermapChart.
|
@@ -1,4 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
+
import type { SunburstChartProps as SunburstChartPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!SunburstChart | `SunburstChart`} component.
|
5
|
+
*/
|
6
|
+
export interface SunburstChartProps extends SunburstChartPropsPreact {
|
7
|
+
}
|
2
8
|
/**
|
3
9
|
* A Vue component that wraps the SunburstChart Preact component for use in Vue applications.
|
4
10
|
* It maintains compatibility with Vue's reactivity system while preserving the functionality of the SunburstChart.
|