@sisense/sdk-ui-vue 1.12.0 → 1.13.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/index.cjs +367 -321
- package/dist/index.js +43896 -40151
- package/dist/src/components/charts/area-range-chart.d.ts +73 -0
- package/dist/src/components/charts/index.d.ts +1 -0
- package/dist/src/components/filters/date-range-filter-tile.d.ts +6 -2
- package/dist/src/composables/use-custom-drilldown.d.ts +1 -0
- package/dist/src/sdk-ui-core-exports.d.ts +1 -1
- package/package.json +2 -2
@@ -0,0 +1,73 @@
|
|
1
|
+
import type { PropType } from 'vue';
|
2
|
+
/**
|
3
|
+
* A Vue component that displays a range of data over a given time period
|
4
|
+
* or across multiple categories. It is particularly useful for visualizing
|
5
|
+
* the minimum and maximum values in a dataset, along with the area between these values.
|
6
|
+
*
|
7
|
+
* @example
|
8
|
+
* Here's how you can use the AreaRangeChart component in a Vue application:
|
9
|
+
* ```vue
|
10
|
+
* <template>
|
11
|
+
* <AreaRangeChart
|
12
|
+
:dataOptions="areaRangeChartProps.dataOptions"
|
13
|
+
:dataSet="areaRangeChartProps.dataSet"
|
14
|
+
:filters="areaRangeChartProps.filters"
|
15
|
+
/>
|
16
|
+
* </template>
|
17
|
+
*
|
18
|
+
* <script setup lang="ts">
|
19
|
+
* import { ref } from 'vue';
|
20
|
+
* import { measureFactory } from '@sisense/sdk-data';
|
21
|
+
* import * as DM from '../assets/sample-retail-model';
|
22
|
+
* import {AreaRangeChart, type AreaRangeChartProps} from '@sisense/sdk-ui-vue';
|
23
|
+
*
|
24
|
+
* const dimProductName = DM.DimProducts.ProductName;
|
25
|
+
* const areaRangeChartProps = ref<AreaRangeChartProps>({
|
26
|
+
* dataSet: DM.DataSource,
|
27
|
+
* dataOptions: {
|
28
|
+
* category: [dimProductName],
|
29
|
+
* value: [{
|
30
|
+
* title: 'Order Revenue',
|
31
|
+
* upperBound: measureFactory.multiply(
|
32
|
+
* measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Lower Revenue'),
|
33
|
+
* 0.6,
|
34
|
+
* ),
|
35
|
+
* lowerBound: measureFactory.multiply(
|
36
|
+
* measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Upper Revenue'),
|
37
|
+
* 1.4,
|
38
|
+
* ),
|
39
|
+
* }],
|
40
|
+
* breakBy: [],
|
41
|
+
* },
|
42
|
+
* filters: [],
|
43
|
+
* });
|
44
|
+
* ```
|
45
|
+
* <img src="media://vue-area-range-chart-example.png" width="800"/>
|
46
|
+
* @param {AreaRangeChartProps} - Area chart properties
|
47
|
+
* @returns Area Range Chart component
|
48
|
+
* @group Charts
|
49
|
+
* @beta
|
50
|
+
*/
|
51
|
+
export declare const AreaRangeChart: import("vue").DefineComponent<{
|
52
|
+
dataOptions: PropType<import("@sisense/sdk-ui-preact").RangeChartDataOptions>;
|
53
|
+
dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
|
54
|
+
filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
|
55
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
56
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
|
57
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
58
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
59
|
+
onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
|
60
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").AreaRangeStyleOptions | undefined>;
|
61
|
+
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
62
|
+
[key: string]: any;
|
63
|
+
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
64
|
+
dataOptions: PropType<import("@sisense/sdk-ui-preact").RangeChartDataOptions>;
|
65
|
+
dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
|
66
|
+
filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
|
67
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
68
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
|
69
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
70
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
71
|
+
onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
|
72
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").AreaRangeStyleOptions | undefined>;
|
73
|
+
}>>, {}, {}>;
|
@@ -34,8 +34,8 @@ import type { PropType } from 'vue';
|
|
34
34
|
* </script>
|
35
35
|
* ```
|
36
36
|
* <img src="media://vue-date-range-filter-tile-example.png" width="800px" />
|
37
|
-
* @param props -
|
38
|
-
* @returns
|
37
|
+
* @param props - DateRangeFilterTile props
|
38
|
+
* @returns DateRangeFilterTile component
|
39
39
|
* @group Filter Tiles
|
40
40
|
*/
|
41
41
|
export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
@@ -47,6 +47,8 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
47
47
|
onChange: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
48
48
|
parentFilters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
49
49
|
title: PropType<string>;
|
50
|
+
/** @internal */
|
51
|
+
tiled: PropType<boolean | undefined>;
|
50
52
|
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
51
53
|
[key: string]: any;
|
52
54
|
}>) | 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<{
|
|
58
60
|
onChange: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
59
61
|
parentFilters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
60
62
|
title: PropType<string>;
|
63
|
+
/** @internal */
|
64
|
+
tiled: PropType<boolean | undefined>;
|
61
65
|
}>>, {}, {}>;
|
@@ -56,6 +56,7 @@ export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimensio
|
|
56
56
|
drilldownDimension: Ref<Attribute | undefined>;
|
57
57
|
drilldownFilters: Ref<{
|
58
58
|
readonly members: any[];
|
59
|
+
_deactivatedMembers: any[];
|
59
60
|
readonly id: string;
|
60
61
|
serializable: () => any;
|
61
62
|
filterJaql: () => any;
|
@@ -1,5 +1,5 @@
|
|
1
1
|
export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
|
2
|
-
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';
|
2
|
+
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, 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, 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';
|
3
3
|
import type { ContextMenuProps as ContextMenuPropsPreact, ThemeProviderProps as ThemeProviderPropsPreact } from '@sisense/sdk-ui-preact';
|
4
4
|
export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
|
5
5
|
export type ThemeProviderProps = Omit<ThemeProviderPropsPreact, 'children'>;
|
package/package.json
CHANGED
@@ -11,7 +11,7 @@
|
|
11
11
|
"Sisense",
|
12
12
|
"Compose SDK"
|
13
13
|
],
|
14
|
-
"version": "1.
|
14
|
+
"version": "1.13.0",
|
15
15
|
"type": "module",
|
16
16
|
"main": "./dist/index.cjs",
|
17
17
|
"module": "./dist/index.js",
|
@@ -42,7 +42,7 @@
|
|
42
42
|
"format:check": "prettier --check ."
|
43
43
|
},
|
44
44
|
"dependencies": {
|
45
|
-
"@sisense/sdk-ui-preact": "^1.
|
45
|
+
"@sisense/sdk-ui-preact": "^1.13.0",
|
46
46
|
"deepmerge": "^4.3.1",
|
47
47
|
"lodash": "^4.17.21",
|
48
48
|
"vue": "^3.3.2"
|