@sisense/sdk-ui-vue 1.12.0 → 1.14.0

package/dist/src/components/charts/area-range-chart.d.ts

@@ -0,0 +1,73 @@
+import type { PropType } from 'vue';
+/**
+ * A Vue component that displays a range of data over a given time period
+ * or across multiple categories. It is particularly useful for visualizing
+ * the minimum and maximum values in a dataset, along with the area between these values.
+ *
+ * @example
+ * Here's how you can use the AreaRangeChart component in a Vue application:
+ * ```vue
+ * <template>
+ * <AreaRangeChart
+      :dataOptions="areaRangeChartProps.dataOptions"
+      :dataSet="areaRangeChartProps.dataSet"
+      :filters="areaRangeChartProps.filters"
+    />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import { measureFactory } from '@sisense/sdk-data';
+ * import * as DM from '../assets/sample-retail-model';
+ * import {AreaRangeChart, type AreaRangeChartProps} from '@sisense/sdk-ui-vue';
+ *
+ * const dimProductName = DM.DimProducts.ProductName;
+ * const areaRangeChartProps = ref<AreaRangeChartProps>({
+ *   dataSet: DM.DataSource,
+ *   dataOptions: {
+ *     category: [dimProductName],
+ *     value: [{
+ *       title: 'Order Revenue',
+ *       upperBound: measureFactory.multiply(
+ *         measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Lower Revenue'),
+ *         0.6,
+ *       ),
+ *       lowerBound: measureFactory.multiply(
+ *         measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Upper Revenue'),
+ *         1.4,
+ *       ),
+ *     }],
+ *     breakBy: [],
+ *   },
+ *   filters: [],
+ * });
+ * ```
+ * <img src="media://vue-area-range-chart-example.png" width="800"/>
+ * @param {AreaRangeChartProps} - Area chart properties
+ * @returns Area Range Chart component
+ * @group Charts
+ * @beta
+ */
+export declare const AreaRangeChart: import("vue").DefineComponent<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").RangeChartDataOptions>;
+    dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").AreaRangeStyleOptions | 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<{
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").RangeChartDataOptions>;
+    dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
+    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").AreaRangeStyleOptions | undefined>;
+}>>, {}, {}>;

package/dist/src/components/charts/index.d.ts

@@ -15,3 +15,4 @@ export { Chart } from './chart';
 export { BoxplotChart } from './boxplot-chart';
 export { AreamapChart } from './areamap-chart';
 export { ScattermapChart } from './scattermap-chart';
+export { AreaRangeChart } from './area-range-chart';

package/dist/src/components/dashboard/dashboard-by-id.d.ts

@@ -0,0 +1,30 @@
+import type { PropType } from 'vue';
+/**
+ * A DashboardById component used for easily rendering a dashboard by its ID in a Sisense Fusion instance.
+ *
+ * @example
+ * Here's how you can use the DashboardById component in a Vue application:
+ * ```vue
+ * <template>
+ *    <DashboardById
+ *      :dashboardOid="dashboardOid"
+ *    />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { DashboardById } from '@sisense/sdk-ui-vue';
+ *
+ * const dashboardOid = '6441e728dac1920034bce737';
+ * </script>
+ * ```
+ * @group Fusion Embed
+ * @fusionEmbed
+ * @internal
+ */
+export declare const DashboardById: import("vue").DefineComponent<{
+    dashboardOid: PropType<string>;
+}, (() => 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<{
+    dashboardOid: PropType<string>;
+}>>, {}, {}>;

package/dist/src/components/dashboard/dashboard.d.ts

@@ -0,0 +1,50 @@
+import type { PropType } from 'vue';
+/**
+ * A Dashboard 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="dashboard"
+ *    :title="dashboard.title"
+ *    :layout="dashboard.layout"
+ *    :widgets="dashboard.widgets"
+ *    :filters="dashboard.filters"
+ *    :defaultDataSource="dashboard.dataSource"
+ *    :widgetFilterOptions="dashboard.widgetFilterOptions"
+ *  />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { DashboardById, useGetDashboardModel } from '@sisense/sdk-ui-vue';
+ *
+ * const { dashboard } = useGetDashboardModel({
+ *  dashboardOid: '6441e728dac1920034bce737',
+ *  includeWidgets: true,
+ *  includeFilters: true,
+ * });
+ * </script>
+ * ```
+ * @group Fusion Embed
+ * @fusionEmbed
+ * @internal
+ */
+export declare const Dashboard: import("vue").DefineComponent<{
+    title: PropType<string>;
+    layout: PropType<import("@sisense/sdk-ui-preact").Layout>;
+    widgets: PropType<import("@sisense/sdk-ui-preact").WidgetModel[]>;
+    filters: PropType<import("@sisense/sdk-data").Filter[]>;
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    widgetFilterOptions: PropType<import("@sisense/sdk-ui-preact").WidgetFilterOptions | 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<{
+    title: PropType<string>;
+    layout: PropType<import("@sisense/sdk-ui-preact").Layout>;
+    widgets: PropType<import("@sisense/sdk-ui-preact").WidgetModel[]>;
+    filters: PropType<import("@sisense/sdk-data").Filter[]>;
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    widgetFilterOptions: PropType<import("@sisense/sdk-ui-preact").WidgetFilterOptions | undefined>;
+}>>, {}, {}>;

package/dist/src/components/dashboard/index.d.ts

@@ -0,0 +1,2 @@
+export { DashboardById } from './dashboard-by-id';
+export { Dashboard } from './dashboard';

package/dist/src/components/filters/date-range-filter-tile.d.ts

@@ -34,8 +34,8 @@ import type { PropType } from 'vue';
  * </script>
  * ```
  * <img src="media://vue-date-range-filter-tile-example.png" width="800px" />
- * @param props - MemberFilterTile props
- * @returns MemberFilterTile component
+ * @param props - DateRangeFilterTile props
+ * @returns DateRangeFilterTile component
  * @group Filter Tiles
  */
 export declare const DateRangeFilterTile: import("vue").DefineComponent<{
@@ -47,6 +47,8 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
     onChange: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
     parentFilters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
     title: PropType<string>;
+    /** @internal */
+    tiled: PropType<boolean | 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<{
@@ -58,4 +60,6 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
     onChange: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
     parentFilters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
     title: PropType<string>;
+    /** @internal */
+    tiled: PropType<boolean | undefined>;
 }>>, {}, {}>;

package/dist/src/composables/use-custom-drilldown.d.ts

@@ -56,6 +56,37 @@ export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimensio
     drilldownDimension: Ref<Attribute | undefined>;
     drilldownFilters: Ref<{
         readonly members: any[];
+        _deactivatedMembers: any[];
+        backgroundFilter?: {
+            readonly guid: string;
+            readonly attribute: {
+                readonly expression: string;
+                getSort: () => import("@sisense/sdk-data").Sort;
+                sort: (sort: import("@sisense/sdk-data").Sort) => Attribute;
+                name: string;
+                readonly type: string;
+                readonly description: string;
+                readonly id: string;
+                serializable: () => any;
+                toJSON: () => any;
+                jaql: (nested?: boolean | undefined) => any;
+                skipValidation?: boolean | undefined;
+                composeCode?: string | undefined;
+            };
+            isScope: boolean;
+            disabled: boolean;
+            locked: boolean;
+            filterJaql: () => any;
+            name: string;
+            readonly type: string;
+            readonly description: string;
+            readonly id: string;
+            serializable: () => any;
+            toJSON: () => any;
+            jaql: (nested?: boolean | undefined) => any;
+            skipValidation?: boolean | undefined;
+            composeCode?: string | undefined;
+        } | undefined;
         readonly id: string;
         serializable: () => any;
         filterJaql: () => any;
@@ -76,6 +107,7 @@ export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimensio
         readonly filterType: string;
         readonly guid: string;
         disabled: boolean;
+        locked: boolean;
         readonly name: string;
         isScope: boolean;
         jaql: (nested?: boolean | undefined) => any;

package/dist/src/lib.d.ts

@@ -8,3 +8,4 @@ export * from './types';
 export { default as DrilldownWidget } from './components/drilldown-widget.vue';
 export * from './sdk-ui-core-exports';
 export * from './components/widgets';
+export * from './components/dashboard';

package/dist/src/providers/theme-provider.d.ts

@@ -369,6 +369,8 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
 /**
  * Theme provider, which allows you to adjust the look and feel of child components.
  *
+ * Components not wrapped in a theme provider use the current theme from the connected Fusion instance by default.
+ *
  * @example
  * Example of a theme provider, which changes the colors and font of the nested indicator chart:
  * ```vue

package/dist/src/sdk-ui-core-exports.d.ts

@@ -1,5 +1,5 @@
 export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
-export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, MemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, AreaRangeChartProps, MemberFilterTileProps, BasicMemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, DashboardByIdProps, DashboardProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, Layout, WidgetFilterOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
 import type { ContextMenuProps as ContextMenuPropsPreact, ThemeProviderProps as ThemeProviderPropsPreact } from '@sisense/sdk-ui-preact';
 export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
 export type ThemeProviderProps = Omit<ThemeProviderPropsPreact, 'children'>;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.12.0",
+  "version": "1.14.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -42,7 +42,7 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
-    "@sisense/sdk-ui-preact": "^1.12.0",
+    "@sisense/sdk-ui-preact": "^1.14.0",
     "deepmerge": "^4.3.1",
     "lodash": "^4.17.21",
     "vue": "^3.3.2"