@sisense/sdk-ui 1.17.1 → 1.18.0

package/dist/chart-options-processor/translations/design-options.d.ts

@@ -22,7 +22,13 @@ export type BaseDesignOptionsType = {
     yAxis: Axis;
     x2Axis?: Axis;
     y2Axis?: Axis;
-    autoZoom: boolean;
+    autoZoom: {
+        enabled: boolean;
+        scrollerLocation?: {
+            min: number;
+            max: number;
+        };
+    };
     dataLimits: DataLimits;
 };
 export type CartesianChartDesignOptions = BaseDesignOptionsType & DesignPerSeries;

package/dist/chart-options-processor/translations/navigator.d.ts

@@ -26,7 +26,8 @@ type Navigator = {
         right: string;
     };
 };
-export declare const getNavigator: (type: HighchartsType, enabled: boolean, xAxisCount: number) => Navigator | {
+export declare const getNavigator: (type: HighchartsType, enabled: boolean, xAxisCount: number, dimension: number, isVertical?: boolean) => Navigator | {
     enabled: boolean;
 };
+export declare function setInitialScrollerPosition(chart: Highcharts.Chart, scrollerStart: number, scrollerEnd: number): void;
 export {};

package/dist/chart-options-processor/translations/sunburst/sunburst-series.d.ts

@@ -37,4 +37,10 @@ export declare function prepareSunburstDataItems(chartData: CategoricalChartData
     parent?: string | undefined;
     low?: number | null | undefined;
     high?: number | null | undefined;
+    trend?: {
+        min: number;
+        max: number;
+        median: number;
+        average: number;
+    } | undefined;
 })[];

package/dist/chart-options-processor/translations/tooltip-utils.d.ts

@@ -46,6 +46,12 @@ export type InternalSeries = {
         };
         upperPointName?: string;
         lowerPointName?: string;
+        trend?: {
+            min: number;
+            max: number;
+            median: number;
+            average: number;
+        };
     };
     percentage?: number;
 };

package/dist/chart-options-processor/translations/translations-to-highcharts.d.ts

@@ -41,6 +41,12 @@ export type SeriesPointStructure = {
     parent?: string;
     low?: number | null;
     high?: number | null;
+    trend?: {
+        min: number;
+        max: number;
+        median: number;
+        average: number;
+    };
 };
 export type AxisClipped = {
     minClipped: boolean;

package/dist/common/components/loading-indicator.d.ts

@@ -56,6 +56,12 @@ export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
             dividerLineWidth: number;
             dividerLineColor: string;
         };
+        filter: {
+            panel: {
+                titleColor: string;
+                backgroundColor: string;
+            };
+        };
         aiChat: {
             backgroundColor: string;
             primaryTextColor: string;

package/dist/dashboard/dashboard-by-id.d.ts

@@ -5,6 +5,24 @@ import { DashboardByIdProps } from './types';
  *
  * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
  *
+ * @example
+ *
+ * ```ts
+ * import { DashboardById } from '@sisense/sdk-ui';
+
+  const CodeExample = () => {
+    return (
+      <>
+        <DashboardById
+          dashboardOid="65a82171719e7f004018691c"
+        />
+      </>
+    );
+  };
+
+  export default CodeExample;
+ * ```
+ *
  * @group Fusion Embed
  * @fusionEmbed
  * @alpha

package/dist/dashboard/dashboard.d.ts

@@ -5,6 +5,40 @@ import { DashboardProps } from '../dashboard/types';
  *
  * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
  *
+ * @example
+ *
+ * ```ts
+ * import { Dashboard, useGetDashboardModel } from '@sisense/sdk-ui';
+
+const CodeExample = () => {
+  const { dashboard } = useGetDashboardModel({
+    dashboardOid: '65a82171719e7f004018691c',
+    includeFilters: true,
+    includeWidgets: true,
+  });
+
+  return (
+    <>
+      {dashboard && (
+        <Dashboard
+        defaultDataSource={dashboard.dataSource}
+        title={dashboard.title}
+        layout={dashboard.layout}
+        styleOptions={dashboard.styleOptions}
+        widgets={dashboard.widgets}
+        filters={dashboard.filters}
+        widgetFilterOptions={
+          dashboard.widgetFilterOptions
+        }
+        />
+      )}
+    </>
+  );
+};
+
+export default CodeExample;
+ * ```
+ *
  * @group Fusion Embed
  * @fusionEmbed
  * @alpha

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

@@ -1,6 +1,19 @@
 import { DashboardDto, FilterDto, CascadingFilterDto } from '../api/types/dashboard-dto';
 import { FiltersIgnoringRules, WidgetDto } from './types';
 import { IncludeAllFilter } from '@sisense/sdk-data';
+/**
+ * Extracts and merges dashboard and widget filters. This consolidates all
+ * filters applicable for a widget.
+ *
+ * @param dashboard - The dashboard containing the filters.
+ * @param widget - The widget containing the filters.
+ * @returns An object containing an array of filters and an array of highlights.
+ * @internal
+ */
+export declare function extractCombinedFilters(dashboard: DashboardDto, widget: WidgetDto): {
+    filters: import("@sisense/sdk-data").Filter[];
+    highlights: import("@sisense/sdk-data").Filter[];
+};
 /**
  * Extracts dashboard filters applicable to a widget.
  *
@@ -520,7 +533,12 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
                 level?: "string" | undefined;
             }) | undefined;
             exclude: {
-                members: string[];
+                members: string[]; /**
+                 * Retrieves a list of attributes allowed for widget highlight filters.
+                 *
+                 * @param {WidgetDto} widget - The widget to retrieve highlight attributes from.
+                 * @returns {string[]} An array of allowed attributes for highlight filters.
+                 */
             };
         } | {
             filter?: import("@sisense/sdk-data").TurnOffMembersFilter | ({

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

@@ -3,6 +3,20 @@ import { StyledMeasureColumn, StyledColumn, Color } from '../types';
 import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types';
 import { WidgetDataOptions } from '../models';
 export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalAttribute | DimensionalCalculatedMeasure | DimensionalBaseMeasure;
+/** @internal */
+export declare function applyStatisticalModels(dataOption: StyledMeasureColumn, statisticalModels?: {
+    forecast?: {
+        isEnabled: boolean;
+        isViewerDisabled: boolean;
+        confidence: number;
+        forecastPeriod: number;
+    };
+    trend?: {
+        isEnabled: boolean;
+        isViewerDisabled: boolean;
+        trendType: string;
+    };
+}): StyledMeasureColumn;
 export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledMeasureColumn | StyledColumn;
 /** @internal */
 export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {

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

@@ -864,4 +864,4 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
  * @param panels - The array of panels.
  * @returns The extracted filters.
  */
-export declare function extractFilters(panels: Panel[]): import("@sisense/sdk-data").Filter[];
+export declare function extractWidgetFilters(panels: Panel[]): import("@sisense/sdk-data").Filter[];

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

@@ -1,9 +1,13 @@
-import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, WidgetStyleOptions } from '../types';
-import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign } from './types';
+import { ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, WidgetStyleOptions } from '../types';
+import { WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
+/**
+ * @internal
+ */
+export type CartesianChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions;
 export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
 export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
 export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
-export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widgetSubtype: WidgetSubtype, style: WidgetStyle, panels: Panel[]): ChartStyleOptions | TableStyleOptions;
+export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions;
 /**
  * Merges the widget style with the widget design
  *

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

@@ -35,6 +35,8 @@ export type Datasource = {
  *
  * This is the (not-comprehensive) structure of the response from the
  * `/api/v1/dashboards/${dashboardOid}/widgets/${widgetOid}` endpoint.
+ *
+ * @internal
  */
 export interface WidgetDto {
     oid: string;
@@ -53,8 +55,16 @@ export interface WidgetDto {
         dashboardFiltersMode: `${WidgetDashboardFilterMode}`;
         selector: boolean;
         drillToAnywhere?: boolean;
+        previousScrollerLocation?: AutoZoomNavigatorScrollerLocation;
     };
 }
+/**
+ * @description the scroll location of the navigator scroller / auto zoom feature
+ */
+export type AutoZoomNavigatorScrollerLocation = {
+    min: number;
+    max: number;
+};
 export type WidgetDesign = {
     widgetBackgroundColor: string;
     widgetSpacing: keyof typeof LEGACY_DESIGN_TYPES;
@@ -114,6 +124,46 @@ export type DatetimeMask = {
     type: string;
     dateAndTime?: string;
 };
+export type StatisticalModels = {
+    forecast?: {
+        isEnabled: boolean;
+        isViewerDisabled: boolean;
+        explainVariable: null;
+        evaluation: {
+            type: string;
+            numLastPointsForEvaluation: number;
+            ignoreLast: number;
+        };
+        forecastPeriod: number;
+        confidence: number;
+        modelType: string;
+        boundaries: {
+            upper: {
+                isEnabled: boolean;
+                value: null;
+            };
+            lower: {
+                isEnabled: boolean;
+                value: null;
+            };
+            isInt: {
+                isEnabled: boolean;
+            };
+        };
+    };
+    trend?: {
+        isEnabled: boolean;
+        isViewerDisabled: boolean;
+        trendType: string;
+        ignoreAnomalies: boolean;
+        trendOnForecast: boolean;
+        compare: {
+            isEnabled: boolean;
+            period: string;
+        };
+        isAccessible: boolean;
+    };
+};
 export type PanelItem = {
     instanceid?: string;
     format?: {
@@ -134,6 +184,7 @@ export type PanelItem = {
     categoriesSorting?: JaqlSortDirection;
     isColored?: boolean;
     geoLevel?: 'country' | 'state' | 'city';
+    statisticalModels?: StatisticalModels;
     field?: {
         id: string;
         index: number;

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

@@ -51,10 +51,11 @@ export declare function mergeFiltersByStrategy(widgetFilters?: Filter[], codeFil
  * Replaces nodes of filter reations tree with fetched filters by instance id.
  *
  * @param filters - The filters from the dashboard.
+ * @param highlights - The highlights from the dashboard
  * @param filterRelations - Fetched filter relations.
  * @returns {FilterRelations} Filter relations with filters in nodes.
  */
-export declare function getFilterRelationsFromJaql(filters: Filter[], filterRelations: FilterRelationsJaql | undefined): FilterRelations | Filter[];
+export declare function getFilterRelationsFromJaql(filters: Filter[], highlights: Filter[], filterRelations: FilterRelationsJaql | undefined): FilterRelations | Filter[];
 /**
  * Converts filter relations model to filter relations jaql.
  *