@sisense/sdk-ui-vue 2.33.0 → 2.34.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.
Files changed (8) hide show
  1. package/dist/index.cjs +1 -1
  2. package/dist/index.js +418 -356
  3. package/dist/src/components/charts/index.d.ts +1 -0
  4. package/dist/src/components/charts/kpi-chart.d.ts +171 -0
  5. package/dist/src/components/widgets/chart-widget.d.ts +2 -2
  6. package/dist/src/components/widgets/widget.d.ts +2 -2
  7. package/dist/src/sdk-ui-core-exports.d.ts +1 -1
  8. package/package.json +3 -3
package/dist/src/components/charts/index.d.ts CHANGED
@@ -12,6 +12,7 @@ export { TreemapChart, type TreemapChartProps } from './treemap-chart';
12
12
  export { SunburstChart, type SunburstChartProps } from './sunburst-chart';
13
13
  export { PolarChart, type PolarChartProps } from './polar-chart';
14
14
  export { IndicatorChart, type IndicatorChartProps } from './indicator-chart';
15
+ export { KpiChart, type KpiChartProps } from './kpi-chart';
15
16
  export { Chart, type ChartProps } from './chart';
16
17
  export { BoxplotChart, type BoxplotChartProps } from './boxplot-chart';
17
18
  export { AreamapChart, type AreamapChartProps } from './areamap-chart';
package/dist/src/components/charts/kpi-chart.d.ts ADDED
@@ -0,0 +1,171 @@
1
+ import type { KpiChartProps as KpiChartPropsPreact } from '@sisense/sdk-ui-preact';
2
+ import type { PropType } from 'vue';
3
+ /**
4
+ * Props of the {@link @sisense/sdk-ui-vue!KpiChart | `KpiChart`} component.
5
+ */
6
+ export interface KpiChartProps extends KpiChartPropsPreact {
7
+ }
8
+ /**
9
+ * A Vue component that displays a single headline metric as a card, optionally with a
10
+ * sparkline of its trend and a readout comparing it against a baseline.
11
+ *
12
+ * Given just a measure, the card shows that number on its own. Adding a `category` — typically
13
+ * a date dimension — gives it a sparkline and a caption for the period being shown. Adding a
14
+ * `comparison` makes it also report how the metric moved: against the previous period, against
15
+ * a second measure, or against a target.
16
+ *
17
+ * @example
18
+ * Here's how you can use the KpiChart component in a Vue application:
19
+ * ```vue
20
+ * <template>
21
+ * <KpiChart
22
+ :dataSet="kpiChartProps.dataSet"
23
+ :dataOptions="kpiChartProps.dataOptions"
24
+ :filters="kpiChartProps.filters"
25
+ :styleOptions="kpiChartProps.styleOptions"
26
+ />
27
+ * </template>
28
+ *
29
+ * <script setup lang="ts">
30
+ * import { ref } from 'vue';
31
+ * import { measureFactory } from '@sisense/sdk-data';
32
+ * import * as DM from '../assets/sample-retail-model';
33
+ * import { KpiChart, type KpiChartProps } from '@sisense/sdk-ui-vue';
34
+ *
35
+ * const kpiChartProps = ref<KpiChartProps>({
36
+ * dataSet: DM.DataSource,
37
+ * dataOptions: {
38
+ * value: measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue'),
39
+ * category: DM.DimDate.Date.Months,
40
+ * comparison: { type: 'previous-period' },
41
+ * },
42
+ * styleOptions: {
43
+ * title: { text: 'Total Revenue' },
44
+ * },
45
+ * filters: [],
46
+ * });
47
+ * </script>
48
+ * ```
49
+ * @param {KpiChartProps} - KPI chart properties
50
+ * @returns KPI Chart component
51
+ * @group Charts
52
+ */
53
+ export declare const KpiChart: import("vue").DefineComponent<{
54
+ /**
55
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataOptions}
56
+ *
57
+ * @category Chart
58
+ */
59
+ dataOptions: {
60
+ type: PropType<import("@sisense/sdk-ui-preact").KpiChartDataOptions>;
61
+ required: true;
62
+ };
63
+ /**
64
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataSet}
65
+ *
66
+ * @category Data
67
+ */
68
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
69
+ /**
70
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.filters}
71
+ *
72
+ * @category Data
73
+ */
74
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
75
+ /**
76
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.highlights}
77
+ *
78
+ * @category Data
79
+ */
80
+ highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
81
+ /**
82
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.styleOptions}
83
+ *
84
+ * @category Chart
85
+ */
86
+ styleOptions: PropType<import("@sisense/sdk-ui-preact").KpiStyleOptions | undefined>;
87
+ /**
88
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onBeforeRender}
89
+ *
90
+ * @category Callbacks
91
+ */
92
+ onBeforeRender: PropType<import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
93
+ /**
94
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataReady}
95
+ *
96
+ * @category Callbacks
97
+ */
98
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
99
+ /**
100
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointClick}
101
+ *
102
+ * @category Callbacks
103
+ */
104
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
105
+ /**
106
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointContextMenu}
107
+ *
108
+ * @category Callbacks
109
+ */
110
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
111
+ }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
112
+ [key: string]: any;
113
+ }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
114
+ /**
115
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataOptions}
116
+ *
117
+ * @category Chart
118
+ */
119
+ dataOptions: {
120
+ type: PropType<import("@sisense/sdk-ui-preact").KpiChartDataOptions>;
121
+ required: true;
122
+ };
123
+ /**
124
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataSet}
125
+ *
126
+ * @category Data
127
+ */
128
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
129
+ /**
130
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.filters}
131
+ *
132
+ * @category Data
133
+ */
134
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
135
+ /**
136
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.highlights}
137
+ *
138
+ * @category Data
139
+ */
140
+ highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
141
+ /**
142
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.styleOptions}
143
+ *
144
+ * @category Chart
145
+ */
146
+ styleOptions: PropType<import("@sisense/sdk-ui-preact").KpiStyleOptions | undefined>;
147
+ /**
148
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onBeforeRender}
149
+ *
150
+ * @category Callbacks
151
+ */
152
+ onBeforeRender: PropType<import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
153
+ /**
154
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataReady}
155
+ *
156
+ * @category Callbacks
157
+ */
158
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
159
+ /**
160
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointClick}
161
+ *
162
+ * @category Callbacks
163
+ */
164
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
165
+ /**
166
+ * {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointContextMenu}
167
+ *
168
+ * @category Callbacks
169
+ */
170
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
171
+ }>>, {}, {}>;
package/dist/src/components/widgets/chart-widget.d.ts CHANGED
@@ -156,7 +156,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
156
156
  *
157
157
  * @category Widget
158
158
  */
159
- config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
159
+ config: PropType<import("@sisense/sdk-ui-preact").ChartWidgetConfig | undefined>;
160
160
  /**
161
161
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.id}
162
162
  *
@@ -288,7 +288,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
288
288
  *
289
289
  * @category Widget
290
290
  */
291
- config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
291
+ config: PropType<import("@sisense/sdk-ui-preact").ChartWidgetConfig | undefined>;
292
292
  /**
293
293
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.id}
294
294
  *
package/dist/src/components/widgets/widget.d.ts CHANGED
@@ -113,7 +113,7 @@ export declare const Widget: import("vue").DefineComponent<{
113
113
  *
114
114
  * @category Widget
115
115
  */
116
- config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
116
+ config: PropType<import("@sisense/sdk-ui-preact").ChartWidgetConfig | import("@sisense/sdk-ui-preact").PivotTableWidgetConfig | import("@sisense/sdk-ui-preact").TextWidgetConfig | import("@sisense/sdk-ui-preact").CustomWidgetConfig | import("@sisense/sdk-ui-preact").FilterWidgetConfig | undefined>;
117
117
  /**
118
118
  * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
119
119
  *
@@ -251,7 +251,7 @@ export declare const Widget: import("vue").DefineComponent<{
251
251
  *
252
252
  * @category Widget
253
253
  */
254
- config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
254
+ config: PropType<import("@sisense/sdk-ui-preact").ChartWidgetConfig | import("@sisense/sdk-ui-preact").PivotTableWidgetConfig | import("@sisense/sdk-ui-preact").TextWidgetConfig | import("@sisense/sdk-ui-preact").CustomWidgetConfig | import("@sisense/sdk-ui-preact").FilterWidgetConfig | undefined>;
255
255
  /**
256
256
  * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
257
257
  *
package/dist/src/sdk-ui-core-exports.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export { boxWhiskerProcessResult, extractDimensionsAndMeasures, formatNumber, formatDate, getDefaultDateFormat, formatDataSet, } from '@sisense/sdk-ui-preact';
2
2
  export { WidgetHeaderMenuTargets } from '@sisense/sdk-ui-preact';
3
- export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, SankeyChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, CommonDataOptions, FormatDateOptions, FormatDataSetOptions, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, SankeyChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, DataOptionLocation, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, CalendarHeatmapStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, SankeyStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, CalendarHeatmapDataPoint, CalendarDayOfWeek, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetConfig, WidgetHeaderConfig, WidgetHeaderMenuActionItem, WidgetHeaderMenuConfig, WidgetHeaderMenuItem, WidgetHeaderMenuSubmenuItem, WidgetHeaderMenuTarget, WidgetNarrativeConfig, WidgetNarrativeDisplayLocation, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, FilterWidgetProps, FilterWidgetFilterType, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';
3
+ export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, KpiChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, SankeyChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, CommonDataOptions, FormatDateOptions, FormatDataSetOptions, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, KpiChartDataOptions, KpiComparison, KpiValueMode, ScattermapChartDataOptions, AreamapChartDataOptions, SankeyChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, DataOptionLocation, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, CalendarHeatmapStyleOptions, KpiStyleOptions, KpiValueStyleOptions, KpiTitleStyleOptions, KpiComparisonStyleOptions, KpiSparklineStyleOptions, KpiSparklineType, KpiCardStyleOptions, KpiTextSize, KpiIconCondition, KpiIcon, KpiIconName, ScattermapStyleOptions, AreamapStyleOptions, SankeyStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, CalendarHeatmapDataPoint, CalendarDayOfWeek, IndicatorBeforeRenderHandler, IndicatorRenderOptions, KpiBeforeRenderHandler, KpiRenderOptions, KpiDataPoint, KpiComparisonInfo, KpiDataPointEventHandler, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetConfig, ChartWidgetConfig, PivotTableWidgetConfig, CustomWidgetConfig, TextWidgetConfig, FilterWidgetConfig, WidgetHeaderConfig, WidgetHeaderMenuActionItem, WidgetHeaderMenuConfig, WidgetHeaderMenuItem, WidgetHeaderMenuSubmenuItem, WidgetHeaderMenuTarget, WidgetNarrativeConfig, WidgetNarrativeDisplayLocation, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, FilterWidgetProps, FilterWidgetFilterType, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "Sisense",
12
12
  "Compose SDK"
13
13
  ],
14
- "version": "2.33.0",
14
+ "version": "2.34.0",
15
15
  "type": "module",
16
16
  "main": "./dist/index.cjs",
17
17
  "module": "./dist/index.js",
@@ -72,8 +72,8 @@
72
72
  "clean": "rm -rf ./dist && rm -rf ./coverage && rm -rf tsconfig.tsbuildinfo"
73
73
  },
74
74
  "dependencies": {
75
- "@sisense/sdk-data": "2.33.0",
76
- "@sisense/sdk-ui-preact": "2.33.0",
75
+ "@sisense/sdk-data": "2.34.0",
76
+ "@sisense/sdk-ui-preact": "2.34.0",
77
77
  "lodash-es": "^4.17.21",
78
78
  "ts-deepmerge": "^8.0.0",
79
79
  "vue": "^3.3.2"