@sisense/sdk-ui-vue 1.19.0 → 1.21.0

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

@@ -19,9 +19,12 @@ import type { PropType } from 'vue';
  * const dashboardOid = '6441e728dac1920034bce737';
  * </script>
  * ```
+ *
+ * To learn more about this and related dashboard components,
+ * see [Embedded Dashboards](/guides/sdk/guides/dashboards/index.html).
  * @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,114 @@
+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.defaultDataSource"
+ *    :widgetsOptions="dashboardProps.widgetsOptions"
+ *    :styleOptions="dashboardProps.styleOptions"
+ *  />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { dashboardModelTranslator, useGetDashboardModel, Dashboard } from '@sisense/sdk-ui-vue';
+ * import { computed } from 'vue';
+ *
+ * const { dashboard } = useGetDashboardModel({
+ *  dashboardOid: '6441e728dac1920034bce737',
+ *  includeWidgets: true,
+ *  includeFilters: true,
+ * });
+ *
+ * const dashboardProps = computed(() =>
+ *   dashboard.value ? dashboardModelTranslator.toDashboardProps(dashboard.value) : null,
+ * );
+ * </script>
+ * ```
+ *
+ * To learn more about this and related dashboard components,
+ * see [Embedded Dashboards](/guides/sdk/guides/dashboards/index.html).
+ * @group Dashboards
+ * @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/filters/criteria-filter-tile.d.ts

@@ -1,7 +1,7 @@
 import type { PropType } from 'vue';
 /**
  * UI component that allows the user to filter numeric or text attributes according to
- * a number of built-in operations defined in the {@link NumericFilter}, {@link TextFilter}, or {@link RankingFilter}.
+ * a number of built-in operations defined in the numeric filter, text filter, or ranking filter.
  *
  * The arrangement prop determines whether the filter is rendered vertically or horizontally, with the latter intended for toolbar use and omitting title, enable/disable, and collapse/expand functionality.
  *

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

@@ -17,7 +17,7 @@ import type { PropType } from 'vue';
  *
  * <script setup lang="ts">
  * import { ref } from 'vue';
- * import { CriteriaFilterTile, type DateRangeFilterTileProps } from '@sisense/sdk-ui-vue';
+ * import { DateRangeFilterTile, type DateRangeFilterTileProps } from '@sisense/sdk-ui-vue';
  * import { filterFactory } from '@sisense/sdk-data';
  * import * as DM from '../assets/sample-retail-model';
  *

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

@@ -2,3 +2,4 @@ export { BasicMemberFilterTile } from './basic-member-filter-tile';
 export { DateRangeFilterTile } from './date-range-filter-tile';
 export { MemberFilterTile } from './member-filter-tile';
 export { CriteriaFilterTile } from './criteria-filter-tile';
+export { RelativeDateFilterTile } from './relative-date-filter-tile';

package/dist/packages/sdk-ui-vue/src/components/filters/relative-date-filter-tile.d.ts

@@ -0,0 +1,100 @@
+import type { PropType } from 'vue';
+/**
+ * Relative Date Filter Tile component for filtering data by relative date.
+ *
+ * @example
+ * Vue example of configuring the date min max values and handling onUpdate event.
+ * ```vue
+ * <template>
+ *   <RelativeDateFilterTile
+ *     :title="relativeDateFilter.title"
+ *     :filter="relativeDateFilter.filter"
+ *     :arrangement="relativeDateFilter.arrangement"
+ *     :onUpdate="relativeDateFilter.onUpdate"
+ *   />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import { RelativeDateFilterTile, type RelativeDateFilterTileProps } from '@sisense/sdk-ui-vue';
+ * import { filterFactory } from '@sisense/sdk-data';
+ * import * as DM from '../assets/sample-retail-model';
+ *
+ * const relativeDateFilterValue = ref<Filter | null>(filterFactory.dateRelativeTo(DM.DimDate.Date.Months, 0, 18);
+ *
+ * const relativeDateFilter = ref<RelativeDateFilterTileProps>({
+ *   title: 'Relative Date Filter Tile',
+ *   filter: relativeDateFilterValue.value!,
+ *   arrangement: 'vertical',
+ *   onUpdate(filter) {
+ *     relativeDateFilterValue.value = filter;
+ *   },
+ * });
+ * </script>
+ * ```
+ * <img src="media://vue-relative-date-filter-tile-example.png" width="800px" />
+ * @param props - RelativeDateFilterTile props
+ * @returns RelativeDateFilterTile component
+ * @group Filter Tiles
+ */
+export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.title}
+     */
+    title: PropType<string>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.filter}
+     */
+    filter: PropType<import("@sisense/sdk-data").Filter>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.arrangement}
+     */
+    arrangement: PropType<import("@sisense/sdk-ui-preact").FilterVariant | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
+     */
+    onUpdate: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.limit}
+     */
+    limit: PropType<{
+        maxDate: string;
+        minDate: string;
+    } | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.tileDesignOptions}
+     * @internal
+     */
+    tileDesignOptions: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/filter-tile.js").FilterTileDesignOptions | 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!RelativeDateFilterTileProps.title}
+     */
+    title: PropType<string>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.filter}
+     */
+    filter: PropType<import("@sisense/sdk-data").Filter>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.arrangement}
+     */
+    arrangement: PropType<import("@sisense/sdk-ui-preact").FilterVariant | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
+     */
+    onUpdate: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.limit}
+     */
+    limit: PropType<{
+        maxDate: string;
+        minDate: string;
+    } | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.tileDesignOptions}
+     * @internal
+     */
+    tileDesignOptions: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/filter-tile.js").FilterTileDesignOptions | 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 Dashboards
  */
 export declare const ChartWidget: import("vue").DefineComponent<{
     /**