@sisense/sdk-ui-vue 1.18.1 → 1.20.0

package/dist/{src → packages/sdk-ui-vue/src}/components/dashboard/dashboard-by-id.d.ts

@@ -21,7 +21,7 @@ import type { PropType } from 'vue';
  * ```
  * @group Fusion Embed
  * @fusionEmbed
- * @alpha
+ * @beta
  */
 export declare const DashboardById: import("vue").DefineComponent<{
     /**

package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard.d.ts

@@ -0,0 +1,110 @@
+import type { PropType } from 'vue';
+/**
+ * A component used for easily rendering a dashboard.
+ *
+ * @example
+ * Here's how you can use the Dashboard component in a Vue application:
+ * ```vue
+ * <template>
+ *  <Dashboard
+ *    v-if="dashboardProps"
+ *    :title="dashboardProps.title"
+ *    :layoutOptions="dashboardProps.layoutOptions"
+ *    :widgets="dashboardProps.widgets"
+ *    :filters="dashboardProps.filters"
+ *    :defaultDataSource="dashboardProps.dataSource"
+ *    :widgetsOptions="dashboardProps.widgetsOptions"
+ *    :styleOptions="dashboardProps.styleOptions"
+ *  />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { dashboardModelTranslator, useGetDashboardModel } from '@sisense/sdk-ui-vue';
+ *
+ * const { dashboard } = useGetDashboardModel({
+ *  dashboardOid: '6441e728dac1920034bce737',
+ *  includeWidgets: true,
+ *  includeFilters: true,
+ * });
+ *
+ * const dashboardProps = computed(() =>
+ *   dashboard.value ? dashboardModelTranslator.toDashboardProps(dashboard.value) : null,
+ * );
+ * </script>
+ * ```
+ * @group Dashboarding
+ * @beta
+ */
+export declare const Dashboard: import("vue").DefineComponent<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.title}
+     */
+    title: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.layoutOptions}
+     */
+    layoutOptions: PropType<import("@sisense/sdk-ui-preact").DashboardLayoutOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
+     *
+     * @internal
+     */
+    config: PropType<import("@sisense/sdk-ui-preact").DashboardConfig | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
+     */
+    widgets: PropType<import("@sisense/sdk-ui-preact").WidgetProps[]>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
+     */
+    filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
+     */
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetsOptions}
+     */
+    widgetsOptions: PropType<import("@sisense/sdk-ui-preact").WidgetsOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.styleOptions}
+     */
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardStyleOptions | undefined>;
+}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.title}
+     */
+    title: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.layoutOptions}
+     */
+    layoutOptions: PropType<import("@sisense/sdk-ui-preact").DashboardLayoutOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
+     *
+     * @internal
+     */
+    config: PropType<import("@sisense/sdk-ui-preact").DashboardConfig | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
+     */
+    widgets: PropType<import("@sisense/sdk-ui-preact").WidgetProps[]>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
+     */
+    filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
+     */
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetsOptions}
+     */
+    widgetsOptions: PropType<import("@sisense/sdk-ui-preact").WidgetsOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.styleOptions}
+     */
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardStyleOptions | undefined>;
+}>>, {}, {}>;

package/dist/{src → packages/sdk-ui-vue/src}/components/filters/basic-member-filter-tile.d.ts

@@ -23,7 +23,7 @@ import type { PropType } from 'vue';
  */
 export declare const BasicMemberFilterTile: import("vue").DefineComponent<{
     allMembers: PropType<import("@sisense/sdk-ui-preact").Member[]>;
-    initialSelectedMembers: PropType<import("@sisense/sdk-ui/dist/filters/components/member-filter-tile/members-reducer").SelectedMember[] | undefined>;
+    initialSelectedMembers: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/member-filter-tile/members-reducer").SelectedMember[] | undefined>;
     isDependent: PropType<boolean | undefined>;
     maxAllowedMembers: PropType<number | undefined>;
     onUpdateSelectedMembers: PropType<((members: string[], disabled?: boolean | undefined) => void) | undefined>;
@@ -33,7 +33,7 @@ export declare const BasicMemberFilterTile: import("vue").DefineComponent<{
     [key: string]: any;
 }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     allMembers: PropType<import("@sisense/sdk-ui-preact").Member[]>;
-    initialSelectedMembers: PropType<import("@sisense/sdk-ui/dist/filters/components/member-filter-tile/members-reducer").SelectedMember[] | undefined>;
+    initialSelectedMembers: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/member-filter-tile/members-reducer").SelectedMember[] | undefined>;
     isDependent: PropType<boolean | undefined>;
     maxAllowedMembers: PropType<number | undefined>;
     onUpdateSelectedMembers: PropType<((members: string[], disabled?: boolean | undefined) => void) | undefined>;

package/dist/{src → packages/sdk-ui-vue/src}/components/widgets/chart-widget.d.ts

@@ -54,7 +54,7 @@ import type { PropType } from 'vue';
  * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
  * @param props - ChartWidget properties
  * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType | chartType}
- * @group Chart Utilities
+ * @group Dashboarding
  */
 export declare const ChartWidget: import("vue").DefineComponent<{
     /**

package/dist/{src → packages/sdk-ui-vue/src}/composables/index.d.ts

@@ -5,4 +5,5 @@ export { useGetDashboardModels } from './use-get-dashboard-models.js';
 export { useGetSharedFormula } from './use-get-shared-formula.js';
 export { useGetWidgetModel } from './use-get-widget-model.js';
 export { useFetch } from './use-fetch.js';
+export { usePlugins } from './use-plugins.js';
 export type { UseFetchOptions } from './use-fetch.js';