@sisense/sdk-ui 1.18.1 → 1.19.0

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

@@ -13,11 +13,15 @@ export type CategoricalWidgetType = 'chart/pie' | 'chart/funnel' | 'treemap' | '
  * The type of a widget on a dashboard that is a variant of tabular widget.
  */
 export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg' | 'pivot' | 'pivot2';
+/**
+ * The type of a widget on a dashboard that is a variant of text widget.
+ */
+export type TextWidgetType = 'richtexteditor';
 /**
  * The type of a widget on a dashboard.
  */
-export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | 'plugin';
-export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst' | 'boxplot/full' | 'boxplot/hollow' | 'map/scatter' | 'areamap/world' | 'areamap/usa';
+export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'plugin';
+export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst' | 'boxplot/full' | 'boxplot/hollow' | 'map/scatter' | 'areamap/world' | 'areamap/usa' | 'richtexteditor';
 export declare enum WidgetDashboardFilterMode {
     FILTER = "filter",
     SELECT = "select"
@@ -47,6 +51,7 @@ export interface WidgetDto {
         ignore?: FiltersIgnoringRules;
         panels: Panel[];
         drillHistory?: PanelItem[];
+        usedFormulasMapping?: any;
     };
     style: WidgetStyle;
     title: string;
@@ -55,8 +60,32 @@ export interface WidgetDto {
         dashboardFiltersMode: `${WidgetDashboardFilterMode}`;
         selector: boolean;
         drillToAnywhere?: boolean;
-        previousScrollerLocation?: AutoZoomNavigatorScrollerLocation;
+        previousScrollerLocation?: AutoZoomNavigatorScrollerLocation | EmptyAutoZoomNavigatorScrollerLocation;
+        triggersDomready?: boolean;
+        autoUpdateOnEveryChange?: boolean;
+        hideFromWidgetList?: boolean;
+        disableExportToCSV?: boolean;
+        disableExportToImage?: boolean;
+        toolbarButton?: any;
+        disallowSelector?: boolean;
+        disallowWidgetTitle?: boolean;
+        supportsHierarchies?: boolean;
     };
+    source?: any;
+    owner?: string;
+    userId?: string;
+    created?: string;
+    lastUpdated?: string;
+    instanceType?: string;
+    selection?: any;
+    tags?: any;
+    instanceid?: string;
+    realTimeRefreshing?: boolean;
+    dashboardid?: string;
+    _dataSourcePermission?: string;
+    userAuth?: any;
+    _toDisableOptionsList?: any;
+    _id?: string;
 }
 /**
  * @description the scroll location of the navigator scroller / auto zoom feature
@@ -65,6 +94,12 @@ export type AutoZoomNavigatorScrollerLocation = {
     min: number;
     max: number;
 };
+/** @internal sometimes Fusion widgets contain dumb scroller location with both locations empty */
+type EmptyAutoZoomNavigatorScrollerLocation = {
+    min: null;
+    max: null;
+};
+export declare function isValidScrollerLocation(scrollerLocation?: AutoZoomNavigatorScrollerLocation | EmptyAutoZoomNavigatorScrollerLocation): scrollerLocation is AutoZoomNavigatorScrollerLocation;
 export type WidgetDesign = {
     widgetBackgroundColor: string;
     widgetSpacing: keyof typeof LEGACY_DESIGN_TYPES;
@@ -112,6 +147,7 @@ export type NumericMask = {
     };
     separated?: boolean;
     type?: string;
+    abbreviateAll?: boolean;
 };
 export type DatetimeMask = {
     isdefault?: boolean;
@@ -120,6 +156,7 @@ export type DatetimeMask = {
     months: string;
     weeks: string;
     minutes: string;
+    seconds: string;
     days: string;
     type: string;
     dateAndTime?: string;
@@ -189,6 +226,8 @@ export type PanelItem = {
         id: string;
         index: number;
     };
+    panel?: string;
+    hierarchies?: any;
 };
 export type PanelColorFormat = PanelColorFormatSingle | PanelColorFormatRange | PanelColorFormatConditional;
 export type PanelMembersFormat = Record<string, {
@@ -236,6 +275,7 @@ type AxisTitleStyle = {
     text?: string;
 };
 export type AxisStyle = {
+    inactive?: boolean;
     enabled: boolean;
     ticks: boolean;
     labels: LabelsStyle;
@@ -267,9 +307,10 @@ export type CartesianWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions
     };
     markers?: {
         enabled: boolean;
-        size: number;
+        size: number | string;
         fill: string;
     };
+    dataLimits?: any;
 };
 export type PolarWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions & {
     categories?: AxisStyle;
@@ -405,7 +446,8 @@ export type ScattermapWidgetStyle = WidgetContainerStyleOptions & {
 export type AreamapWidgetStyle = {};
 export type WidgetStyle = {
     widgetDesign?: WidgetDesign;
-} & (CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle);
+    narration?: any;
+} & (CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle | TextWidgetDtoStyle);
 export declare enum FiltersMergeStrategyEnum {
     WIDGET_FIRST = "widgetFirst",
     CODE_FIRST = "codeFirst",
@@ -426,4 +468,12 @@ export type PivotWidgetStyle = {
     rowHeight?: number;
     automaticHeight?: boolean;
 };
+export type TextWidgetDtoStyle = {
+    content: {
+        html: string;
+        vAlign: `valign-${'middle' | 'top' | 'bottom'}`;
+        bgColor: string;
+        textAlign: 'center';
+    };
+};
 export {};

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

@@ -1,13 +1,15 @@
 import { type Filter, JaqlSortDirection, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
 import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options';
 import { ChartType, type SortDirection } from '../types';
-import { FiltersMergeStrategy, Panel, PanelItem, WidgetSubtype, WidgetType } from './types';
+import { FiltersMergeStrategy, Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types';
 export declare function getChartType(widgetType: WidgetType): ChartType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
 type WidgetTypeOrString = string | WidgetType;
 export declare function isSupportedWidgetType(widgetType: WidgetTypeOrString): widgetType is WidgetType;
 export declare function isTableWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function isPivotWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isTextWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isTextWidgetDtoStyle(widgetStyle: WidgetStyle): widgetStyle is TextWidgetDtoStyle;
 export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function getEnabledPanelItems(panels: Panel[], panelName: string): PanelItem[];
 export declare function getRootPanelItem(item: PanelItem): PanelItem;