@sisense/sdk-ui-vue 2.10.0 → 2.11.0

package/dist/packages/sdk-ui-vue/src/components/charts/calendar-heatmap-chart.d.ts

@@ -0,0 +1,178 @@
+import type { PropType } from 'vue';
+import type { CalendarHeatmapChartProps as CalendarHeatmapChartPropsPreact } from '@sisense/sdk-ui-preact';
+/**
+ * Props of the {@link @sisense/sdk-ui-vue!CalendarHeatmapChart | `CalendarHeatmapChart`} component.
+ */
+export interface CalendarHeatmapChartProps extends CalendarHeatmapChartPropsPreact {
+}
+/**
+ * A Vue component that visualizes values over days in a calendar-like view,
+ * making it easy to identify daily patterns or anomalies
+ *
+ * @example
+ * Here's how you can use the CalendarHeatmapChart component in a Vue application:
+ * ```vue
+ * <template>
+ * <CalendarHeatmapChart
+      :dataOptions="calendarChartProps.dataOptions"
+      :dataSet="calendarChartProps.dataSet"
+      :filters="calendarChartProps.filters"
+      :styleOptions="calendarChartProps.styleOptions"
+    />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
+ * import * as DM from '../assets/sample-retail-model';
+ * import { CalendarHeatmapChart, type CalendarHeatmapChartProps } from '@sisense/sdk-ui-vue';
+ *
+ * const calendarChartProps = ref<CalendarHeatmapChartProps>({
+ *   dataSet: DM.DataSource,
+ *   dataOptions: {
+ *     date: DM.DimDate.Date.Days,
+ *     value: measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue'),
+ *   },
+ *   styleOptions: {
+ *     viewType: 'quarter',
+ *   },
+ *   filters: [],
+ * });
+ * </script>
+ * ```
+ * <img src="media://vue-calendar-heatmap-chart-example.png" width="800"/>
+ * @param {CalendarHeatmapChartProps} - Calendar heatmap chart properties
+ * @returns Calendar Heatmap Chart component
+ * @group Charts
+ */
+export declare const CalendarHeatmapChart: import("vue").DefineComponent<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.dataOptions}
+     *
+     * @category Chart
+     */
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapChartDataOptions>;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.dataSet}
+     *
+     * @category Data
+     */
+    dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.filters}
+     *
+     * @category Data
+     */
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.styleOptions}
+     *
+     * @category Chart
+     */
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointsEventHandler | 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!CalendarHeatmapChartProps.dataOptions}
+     *
+     * @category Chart
+     */
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapChartDataOptions>;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.dataSet}
+     *
+     * @category Data
+     */
+    dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.filters}
+     *
+     * @category Data
+     */
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.styleOptions}
+     *
+     * @category Chart
+     */
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointsEventHandler | undefined>;
+}>>, {}, {}>;

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

@@ -1,5 +1,6 @@
 export { AreaChart, type AreaChartProps } from './area-chart';
 export { BarChart, type BarChartProps } from './bar-chart';
+export { CalendarHeatmapChart, type CalendarHeatmapChartProps } from './calendar-heatmap-chart';
 export { ColumnChart, type ColumnChartProps } from './column-chart';
 export { FunnelChart, type FunnelChartProps } from './funnel-chart';
 export { LineChart, type LineChartProps } from './line-chart';

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

@@ -1,2 +1,2 @@
 export { boxWhiskerProcessResult, extractDimensionsAndMeasures } 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, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, 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, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, TranslationConfig, } from '@sisense/sdk-ui-preact';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, 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, CalendarHeatmapStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, 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, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, TranslationConfig, } from '@sisense/sdk-ui-preact';