@sisense/sdk-ui-vue 2.15.0 → 2.16.0

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

@@ -16,4 +16,5 @@ export { Chart, type ChartProps } from './chart';
 export { BoxplotChart, type BoxplotChartProps } from './boxplot-chart';
 export { AreamapChart, type AreamapChartProps } from './areamap-chart';
 export { ScattermapChart, type ScattermapChartProps } from './scattermap-chart';
+export { StreamgraphChart, type StreamgraphChartProps } from './streamgraph-chart';
 export { AreaRangeChart, type AreaRangeChartProps } from './area-range-chart';

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

@@ -0,0 +1,182 @@
+import type { StreamgraphChartProps as StreamgraphChartPropsPreact } from '@sisense/sdk-ui-preact';
+import type { PropType } from 'vue';
+/**
+ * Props of the {@link @sisense/sdk-ui-vue!StreamgraphChart | `StreamgraphChart`} component.
+ */
+export interface StreamgraphChartProps extends StreamgraphChartPropsPreact {
+}
+/**
+ * A Vue component that displays a streamgraph chart.
+ *
+ * A streamgraph is a type of stacked area chart where areas are displaced around
+ * a central axis. It is particularly effective for displaying volume across
+ * different categories or over time with a relative scale that emphasizes
+ * overall patterns and trends.
+ *
+ * @example
+ * Here's how you can use the StreamgraphChart component in a Vue application:
+ * ```vue
+ * <template>
+ * <StreamgraphChart
+ *      :dataOptions="streamgraphChartProps.dataOptions"
+ *      :dataSet="streamgraphChartProps.dataSet"
+ *      :filters="streamgraphChartProps.filters"
+ *      :styleOptions="streamgraphChartProps.styleOptions"
+ *    />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue';
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
+ * import * as DM from '../assets/sample-ecommerce';
+ * import { StreamgraphChart, type StreamgraphChartProps } from '@sisense/sdk-ui-vue';
+ *
+ * const streamgraphChartProps = ref<StreamgraphChartProps>({
+ *   dataSet: DM.DataSource,
+ *   dataOptions: {
+ *     category: [DM.Commerce.Date.Quarters],
+ *     value: [measureFactory.sum(DM.Commerce.Revenue, 'Revenue')],
+ *     breakBy: [DM.Category.Category],
+ *   },
+ *   filters: [filterFactory.members(DM.Category.Category, ['Electronics', 'Clothing'])],
+ *   styleOptions: {
+ *     width: 1200,
+ *     height: 500,
+ *   },
+ * });
+ * ```
+ * @param {StreamgraphChartProps} - Streamgraph chart properties
+ * @returns Streamgraph Chart component
+ * @group Charts
+ */
+export declare const StreamgraphChart: import("vue").DefineComponent<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.dataOptions}
+     *
+     * @category Chart
+     */
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.dataSet}
+     *
+     * @category Data
+     */
+    dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.filters}
+     *
+     * @category Data
+     */
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.styleOptions}
+     *
+     * @category Chart
+     */
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").StreamgraphStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | 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!StreamgraphChartProps.dataOptions}
+     *
+     * @category Chart
+     */
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.dataSet}
+     *
+     * @category Data
+     */
+    dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.filters}
+     *
+     * @category Data
+     */
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.styleOptions}
+     *
+     * @category Chart
+     */
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").StreamgraphStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!StreamgraphChartProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
+}>>, {}, {}>;

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, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, 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';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, 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, StreamgraphStyleOptions, 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';