@sisense/sdk-ui 1.2.0 → 1.4.0

package/dist/sisense-chart/sisense-chart.d.ts

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

package/dist/sisense-chart/types.d.ts

@@ -0,0 +1,5 @@
+import { DataPointsEventHandler, ScatterDataPointsEventHandler } from '../props.js';
+import { BoxplotDataPoint, DataPoint, ScatterDataPoint } from '../types.js';
+export type SisenseChartDataPointsEventHandler = DataPointsEventHandler | ScatterDataPointsEventHandler;
+export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
+export type SisenseChartDataPointEventHandler = (point: SisenseChartDataPoint, nativeEvent: PointerEvent) => void;

package/dist/table/hooks/use-table-data.d.ts

@@ -1,10 +1,10 @@
-import { Attribute, Data, DataSource, Filter, FilterRelation, Measure } from '@sisense/sdk-data';
+import { Attribute, Data, DataSource, Filter, FilterRelationsJaql, Measure } from '@sisense/sdk-data';
 import { TableDataOptionsInternal } from '../../chart-data-options/types';
 type UseDataProps = {
     dataSet: Data | DataSource | undefined;
     dataOptions: TableDataOptionsInternal | null;
     filters: Filter[] | undefined;
-    filterRelations: FilterRelation | undefined;
+    filterRelations: FilterRelationsJaql | undefined;
     count: number;
     offset: number;
 };

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,13 @@ 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';
+import { Coordinates } from './charts/map-charts/scattermap/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
@@ -311,6 +313,49 @@ export interface TableStyleOptions {
      */
     height?: number;
 }
+/** Configuration options that define functional style of the various elements of {@link PivotTable} */
+export interface PivotTableStyleOptions {
+    /**
+     * Boolean flag whether to fill header cells with background color
+     */
+    headersColor?: boolean;
+    /**
+     * Boolean flag whether to apply background color to alternate rows.
+     */
+    alternatingRowsColor?: boolean;
+    /**
+     * Boolean flag whether to apply background color to alternate columns
+     */
+    alternatingColumnsColor?: boolean;
+    /**
+     * Number of rows per page
+     *
+     * Default value is 25
+     *
+     */
+    rowsPerPage?: number;
+    /**
+     * Total width of the component, which is considered in the following order of priority:
+     *
+     * 1. Value passed to this property (in pixels)
+     * 2. Width of the container wrapping this component
+     * 3. Default value of 400px
+     *
+     */
+    width?: number;
+    /**
+     * Total height of the component, which is considered in the following order of priority:
+     *
+     * 1. Value passed to this property (in pixels).
+     * 2. Height of the container wrapping this component
+     * 3. Default value of 500px (for component without header) or 525px (for component with header).
+     */
+    height?: number;
+    /**
+     * Boolean flag whether the height of the component should be automatically adjusted to fit the content
+     */
+    isAutoHeight?: boolean;
+}
 /**
  * Common part of IndicatorStyleOptions for all types of indicator
  *
@@ -318,6 +363,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 +381,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 {
@@ -442,37 +491,37 @@ export type NumberFormatConfig = {
     /**
      * Supported formats
      */
-    name: 'Numbers' | 'Currency' | 'Percent';
+    name?: 'Numbers' | 'Currency' | 'Percent';
     /**
      * The number of decimal places
      */
-    decimalScale: DecimalScale;
+    decimalScale?: DecimalScale;
     /**
      * Boolean flag whether to show an abbreviation
      * for a number greater than or equal one trillion - e.g. 1T
      */
-    trillion: boolean;
+    trillion?: boolean;
     /**
      * Boolean flag whether to show an abbreviation
      * for a number greater than or equal one billion - e.g. 1B
      */
-    billion: boolean;
+    billion?: boolean;
     /**
      * Boolean flag whether to show an abbreviation
      * for a number greater than or equal one million - e.g. 1M
      */
-    million: boolean;
+    million?: boolean;
     /**
      * Boolean flag whether to show an abbreviation
      * for a number greater than or equal one thousand - e.g. 1K
      */
-    kilo: boolean;
+    kilo?: boolean;
     /**
      * Boolean flag whether the thousand separator is shown
      *
      * If true, show the thousand separator, e.g. `1,000`. Otherwise, show `1000`
      */
-    thousandSeparator: boolean;
+    thousandSeparator?: boolean;
     /**
      * Boolean flag whether `symbol` is shown in front of or after the number
      *
@@ -480,12 +529,18 @@ export type NumberFormatConfig = {
      *
      * If false, append `symbol` after the number, e.g. show `1000¥` when `symbol` is `¥`.
      */
-    prefix: boolean;
+    prefix?: boolean;
     /**
      * Symbol to show in front of or after the number depending on the value of `prefix`.
      */
-    symbol: string;
+    symbol?: string;
 };
+/**
+ * {@link NumberFormatConfig} with all props required
+ *
+ * @internal
+ */
+export type CompleteNumberFormatConfig = Required<NumberFormatConfig>;
 /** Identifier of a theme as defined in the Sisense instance. */
 export type ThemeOid = string;
 /** Theme settings defining the look and feel of components. */
@@ -623,12 +678,31 @@ 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 +713,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 +721,40 @@ 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;
+/**
+ * Data point in an Scattermap chart.
+ */
+export type ScattermapDataPoint = {
+    /** Location name displayed on marker */
+    displayName: string;
+    /** Array with categories strings used for location definition */
+    categories: string[];
+    /** Numeric measure value */
+    value: number;
+    /** Location coordinates */
+    coordinates: Coordinates;
+};
 /**
  * This is the minimum definition of Highcharts
  * events, Series, and Point that we require. As
@@ -799,3 +898,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/utils/utility-types.d.ts

@@ -40,4 +40,16 @@ type PickTypeOf<T, K extends string | number | symbol> = K extends AllKeys<T> ?
  * Abstract object with any unknown values
  */
 export type AnyObject = Record<string, any>;
+/**
+ * Allows you to make a property of an object required.
+ * @example
+ * type T = {
+ *   a: string;
+ *   b?: number;
+ *   c?: boolean;
+ * };
+ *
+ * type TRequiredB = WithRequiredProp<T, 'b'>; // { a: string; b: number; c?: boolean; }
+ */
+export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 export {};

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-breadcrumbs/styled-buttons.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="react" />
 export declare const StyledPrevButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
-}, "style" | "children" | "size" | "color" | "disabled" | "className" | "tabIndex" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "sx" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
+}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "sx" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;
 export declare const StyledNextButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
-}, "style" | "children" | "size" | "color" | "disabled" | "className" | "tabIndex" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "sx" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
+}, "style" | "children" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "sx" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;

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[];
@@ -30,7 +30,7 @@ export declare const useDrilldown: (dataOptions: ChartDataOptions, drilldownOpti
         outliersEnabled?: boolean | undefined;
     } | {
         category: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn | undefined)[];
-        value: (import("@sisense/sdk-data").Column | import("../../types").StyledColumn | import("@sisense/sdk-data").MeasureColumn | import("@sisense/sdk-data").CalculatedMeasureColumn | import("../../types").StyledMeasureColumn)[];
+        value: (import("@sisense/sdk-data").Column | import("@sisense/sdk-data").MeasureColumn | import("@sisense/sdk-data").CalculatedMeasureColumn | import("../../types").StyledMeasureColumn | import("../../types").StyledColumn)[];
         outliers?: [import("@sisense/sdk-data").Column | import("../../types").StyledColumn] | undefined;
         valueTitle: string;
     };
@@ -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;