@sisense/sdk-ui 1.2.0 → 1.3.0

package/dist/translation/resources/en.d.ts

@@ -30,6 +30,7 @@ export declare const translation: {
             tabularWidgetNotSupported: string;
             onlyTabularWidgetsSupported: string;
         };
+        unknownFilterInFilterRelations: string;
     };
     errorBoxText: string;
     chartNoData: string;

package/dist/translation/resources/index.d.ts

@@ -34,6 +34,7 @@ export declare const resources: {
                 tabularWidgetNotSupported: string;
                 onlyTabularWidgetsSupported: string;
             };
+            unknownFilterInFilterRelations: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -117,6 +118,7 @@ export declare const resources: {
                 tabularWidgetNotSupported: string;
                 onlyTabularWidgetsSupported: string;
             };
+            unknownFilterInFilterRelations: string;
         };
         errorBoxText: string;
         chartNoData: string;

package/dist/types.d.ts

@@ -8,11 +8,12 @@ import { ScatterMarkerSize } from './chart-options-processor/translations/scatte
 import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType } from './chart-options-processor/translations/types';
 import { DataPointsEventHandler } from './props';
 import { LegendPosition } from './chart-options-processor/translations/legend-section';
+import { GeoDataElement, RawGeoDataElement } from './chart-data/types';
 export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
-export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, };
+export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, };
 export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
 /**
  * @internal
@@ -318,6 +319,8 @@ export interface TableStyleOptions {
  */
 export interface BaseIndicatorStyleOptions {
     indicatorComponents?: IndicatorComponents;
+    /** Boolean flag to force render indicator in ticker mode regardless of display size */
+    forceTickerView?: boolean;
 }
 /** Configuration options that define functional style of the various elements of Numeric Simple {@link IndicatorChart} */
 export interface NumericSimpleIndicatorStyleOptions extends BaseIndicatorStyleOptions {
@@ -334,6 +337,8 @@ export interface NumericBarIndicatorStyleOptions extends BaseIndicatorStyleOptio
 export interface GaugeIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/gauge';
     skin: 1 | 2;
+    /** Bar height for gauge indicator in ticker mode */
+    tickerBarHeight?: number;
 }
 /** Configuration options that define functional style of the various elements of {@link ScatterChart} */
 export interface ScatterStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
@@ -623,12 +628,29 @@ export type DrilldownOptions = {
 /** Selection for the drilldown */
 export type DrilldownSelection = {
     /** Points selected for drilldown */
-    points: DataPoint[];
+    points: ChartDataPoint[];
     /** Dimension to drilldown to */
     nextDimension: Attribute;
 };
-export type DataPoints = DataPoint[] | ScatterDataPoint[];
-/** Data point in a chart. */
+/**
+ * Data points in a chart. Array of data points of the same data point type.
+ */
+export type ChartDataPoints = DataPoint[] | ScatterDataPoint[] | BoxplotDataPoint[] | AreamapDataPoint[];
+/**
+ * Abstract data point in a chart - union of all types of data points.
+ */
+export type ChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | AreamapDataPoint;
+/**
+ * Abstract data point in a chart that based on Highcharts.
+ * @internal
+ */
+export type HighchartsBasedChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
+/**
+ * Abstract event handler for data point click event
+ * @internal
+ */
+export type ChartDataPointEventHandler = (point: ChartDataPoint, nativeEvent: PointerEvent | MouseEvent) => void;
+/** Data point in a regular chart. */
 export type DataPoint = {
     /** Value of the data point */
     value?: string | number;
@@ -639,7 +661,7 @@ export type DataPoint = {
     /** Series associated with the data point */
     seriesValue?: string | number;
 };
-/** Data point in a chart. */
+/** Data point in a Scatter chart. */
 export type ScatterDataPoint = {
     x?: string | number;
     y?: string | number;
@@ -647,15 +669,27 @@ export type ScatterDataPoint = {
     breakByPoint?: string;
     breakByColor?: string;
 };
+/** Data point in a Boxplot chart. */
 export type BoxplotDataPoint = {
+    /** Value of the box minimum */
     boxMin: number;
+    /** Value of the box median */
     boxMedian: number;
+    /** Value of the box maximum */
     boxMax: number;
+    /** Value of the box minimal whisker */
     whiskerMin: number;
+    /** Value of the box maximal whisker */
     whiskerMax: number;
+    /** Value of the category for the data point */
     categoryValue?: string | number;
+    /** Display value of category of the data point */
     categoryDisplayValue?: string;
 };
+/**
+ * Data point in an Areamap chart.
+ */
+export type AreamapDataPoint = GeoDataElement;
 /**
  * This is the minimum definition of Highcharts
  * events, Series, and Point that we require. As
@@ -799,3 +833,16 @@ export type CustomDrilldownResult = {
      */
     breadcrumbsComponent?: JSX.Element;
 };
+/**
+ * A config that defines the behavior of the loading indicator
+ */
+export type LoadingIndicatorConfig = {
+    /**
+     * Delay in milliseconds before the loading indicator is shown
+     */
+    delay?: number;
+    /**
+     * Boolean flag that defines if the loading indicator should be shown
+     */
+    enabled?: boolean;
+};

package/dist/utils/filters-comparator.d.ts

@@ -1,4 +1,4 @@
-import { Filter, FilterRelation } from '@sisense/sdk-data';
+import { Filter, FilterRelations, FilterRelationsJaql } from '@sisense/sdk-data';
 /**
  * Checks if the filters have changed by deep comparison.
  *
@@ -20,4 +20,4 @@ export declare function isFiltersChanged(prevFilters: Filter[] | undefined, newF
  * @remarks
  * The function ignores node swaps since this does not affect logical result.
  */
-export declare function isRelationsChanged(prevFilters: Filter[] | undefined, newFilters: Filter[] | undefined, prevRelations: FilterRelation | undefined, newRelations: FilterRelation | undefined): boolean;
+export declare function isRelationsChanged(prevFilters: Filter[] | undefined, newFilters: Filter[] | undefined, prevRelations: FilterRelations | FilterRelationsJaql | undefined, newRelations: FilterRelations | FilterRelationsJaql | undefined): boolean;

package/dist/widgets/common/custom-drilldown.d.ts

@@ -1,4 +1,4 @@
-import { DataPoint, StyledColumn, DrilldownSelection } from '../../types.js';
+import { StyledColumn, DrilldownSelection, DataPoint } from '../../types.js';
 import { Attribute, Column, MembersFilter } from '@sisense/sdk-data';
 export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimension, }: {
     drilldownDimensions: Attribute[];

package/dist/widgets/common/drilldown.d.ts

@@ -1,4 +1,4 @@
-import { ChartDataOptions, DataPoint, DrilldownOptions, DrilldownSelection } from '../../types';
+import { ChartDataOptions, ChartDataPoint, DataPoint, DrilldownOptions, DrilldownSelection } from '../../types';
 import { Attribute, MembersFilter } from '@sisense/sdk-data';
 export declare const useDrilldown: (dataOptions: ChartDataOptions, drilldownOptions?: DrilldownOptions) => {
     drilldownFilters: never[];
@@ -40,3 +40,5 @@ export declare const useDrilldown: (dataOptions: ChartDataOptions, drilldownOpti
     drilldownSelections: DrilldownSelection[];
     availableDrilldowns: Attribute[];
 };
+export declare function getMemberNameFromDataPoint(point: ChartDataPoint): string;
+export declare function getDisplayMemberNameFromDataPoint(point: ChartDataPoint): string;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "exports": {
     ".": {
@@ -39,12 +39,12 @@
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.11.6",
-    "@sisense/sdk-common": "^1.2.0",
-    "@sisense/sdk-data": "^1.2.0",
-    "@sisense/sdk-pivot-client": "^1.2.0",
-    "@sisense/sdk-query-client": "^1.2.0",
-    "@sisense/sdk-rest-client": "^1.2.0",
-    "@sisense/sdk-tracking": "^1.2.0",
+    "@sisense/sdk-common": "^1.3.0",
+    "@sisense/sdk-data": "^1.3.0",
+    "@sisense/sdk-pivot-client": "^1.3.0",
+    "@sisense/sdk-query-client": "^1.3.0",
+    "@sisense/sdk-rest-client": "^1.3.0",
+    "@sisense/sdk-tracking": "^1.3.0",
     "@sisense/sisense-charts": "5.1.0-alpha-04052758.0",
     "@tanstack/react-query": "4.36.1",
     "classnames": "^2.3.2",

package/dist/dashboard-widget/translate-widget.d.ts

@@ -1,12 +0,0 @@
-import { CompleteThemeSettings } from '../types';
-import { WidgetDto } from './types';
-import { ChartWidgetProps, TableWidgetProps } from '../props';
-export type TableWidgetExtractedProps = {
-    type: 'table';
-    props: TableWidgetProps;
-};
-export type ChartWidgetExtractedProps = {
-    type: 'chart';
-    props: ChartWidgetProps;
-};
-export declare function extractWidgetProps(widget: WidgetDto, themeSettings?: CompleteThemeSettings): TableWidgetExtractedProps | ChartWidgetExtractedProps;

package/dist/query-execution/utils.d.ts

@@ -1,9 +0,0 @@
-import type { ExecuteQueryParams } from './index';
-import type { WidgetDto } from '../dashboard-widget/types';
-/**
- * Extracts query parameters from a widget object.
- *
- * @param {WidgetDto} widget - The widget from which to extract query parameters.
- * @returns {ExecuteQueryParams} An object containing extracted query parameters.
- */
-export declare function extractQueryFromWidget(widget: WidgetDto): ExecuteQueryParams;

package/dist/sisense-chart.d.ts

@@ -1,23 +0,0 @@
-/// <reference types="react" />
-import { ChartDataOptionsInternal } from './chart-data-options/types';
-import { ChartData } from './chart-data/types';
-import { DataPointEventHandler, DataPointsEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler } from './chart-options-processor/apply-event-handlers';
-import { BeforeRenderHandler } from './props';
-import { ChartDesignOptions } from './chart-options-processor/translations/types';
-import { ChartType, CompleteThemeSettings } from './types';
-interface Props {
-    chartType: ChartType;
-    chartData: ChartData;
-    chartDataOptions: ChartDataOptionsInternal;
-    designOptions: ChartDesignOptions;
-    themeSettings?: CompleteThemeSettings;
-    onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler;
-    onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler;
-    onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler;
-    onBeforeRender?: BeforeRenderHandler;
-}
-/**
- * @internal
- */
-export declare const SisenseChart: ({ chartType, chartData, chartDataOptions, designOptions, themeSettings, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, }: Props) => JSX.Element | null;
-export {};