@sisense/sdk-ui 2.3.1 → 2.4.1

package/dist/packages/sdk-ui/src/types.d.ts

@@ -10,7 +10,7 @@ import { LegendPosition } from './chart-options-processor/translations/legend-se
 import { Coordinates } from './charts/map-charts/scattermap/types';
 import { StyledColumn, StyledMeasureColumn, Hierarchy, HierarchyId } from '.';
 import { HighchartsOptionsInternal } from './chart-options-processor/chart-options-service';
-import { CSSProperties } from 'react';
+import { CSSProperties, ReactNode } from 'react';
 import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
 import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
 import { SoftUnion } from './utils/utility-types';
@@ -965,6 +965,17 @@ export type DashboardThemeSettings = {
     dividerLineColor?: string;
     borderWidth?: number;
     borderColor?: string;
+    /**
+     * Toolbar style settings for dashboard
+     */
+    toolbar?: {
+        /** Primary text color for the dashboard toolbar */
+        primaryTextColor?: string;
+        /** Secondary text color for the dashboard toolbar */
+        secondaryTextColor?: string;
+        /** Background color for the dashboard toolbar */
+        backgroundColor?: string;
+    };
 };
 /**
  * Filter theme settings
@@ -1164,7 +1175,7 @@ export type CompleteThemeSettings = DeepRequired<Omit<ThemeSettings, 'typography
     };
 };
 /** Complete set of configuration options that define functional style of the various elements of the charts as well as the look and feel of widget itself and widget header. */
-export type WidgetStyleOptions = (ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions | PluginWidgetStyleOptions) & WidgetContainerStyleOptions;
+export type WidgetStyleOptions = (ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions | CustomWidgetStyleOptions) & WidgetContainerStyleOptions;
 /** Style settings defining the look and feel of widget itself and widget header */
 export interface WidgetContainerStyleOptions {
     /** Space between widget container edge and the chart */
@@ -1207,6 +1218,12 @@ export interface WidgetContainerStyleOptions {
          * @internal
          */
         renderToolbar?: RenderToolbarHandler;
+        /**
+         * Custom title to render in widget header
+         *
+         * @internal
+         */
+        renderTitle?: RenderTitleHandler;
     };
 }
 /**
@@ -1221,6 +1238,8 @@ export type NlqChartWidgetStyleOptions = {
 };
 /** @internal */
 export type RenderToolbarHandler = (onRefresh: () => void, defaultToolbar: JSX.Element) => JSX.Element | null;
+/** @internal */
+export type RenderTitleHandler = (defaultHeaderTitle: ReactNode) => ReactNode;
 /** Style settings defining the look and feel of the widget created in Fusion */
 export interface WidgetByIdStyleOptions extends WidgetContainerStyleOptions {
     /**
@@ -1263,9 +1282,9 @@ export type TextWidgetStyleOptions = {
     bgColor: string;
 };
 /**
- * Style settings defining the look and feel of PluginWidget
+ * Style settings defining the look and feel of CustomWidget
  */
-export type PluginWidgetStyleOptions = Record<string, unknown> & WidgetContainerStyleOptions;
+export type CustomWidgetStyleOptions = Record<string, unknown> & WidgetContainerStyleOptions;
 /**
  * Runs type guard check for ThemeOid.
  *
@@ -1407,6 +1426,29 @@ export type BoxplotDataPoint = {
         outliers: DataPointEntry[];
     };
 };
+/** Data point that represents the entire Indicator chart data. */
+export type IndicatorDataPoint = {
+    /**
+     * A collection of data point entries that represents values for all related `dataOptions`.
+     *
+     * @internal
+     */
+    entries?: {
+        value?: DataPointEntry;
+        secondary?: DataPointEntry;
+        min?: DataPointEntry;
+        max?: DataPointEntry;
+    };
+};
+/**
+ * Data point that represents the entire Text widget data.
+ *
+ * @internal
+ */
+export type TextWidgetDataPoint = {
+    /** HTML content of the text widget */
+    html?: string;
+};
 /**
  * Data point in an Areamap chart.
  */
@@ -1562,6 +1604,18 @@ export type MenuPosition = {
     /** Vertical position */
     top: number;
 };
+/**
+ * Menu alignment configuration for positioning
+ * Used in {@link @sisense/sdk-ui!ContextMenuProps | `ContextMenuProps`}
+ *
+ * @internal
+ */
+export type MenuAlignment = {
+    /** Vertical alignment of the menu relative to its anchor point */
+    vertical?: 'top' | 'bottom';
+    /** Horizontal alignment of the menu relative to its anchor point */
+    horizontal?: 'left' | 'right';
+};
 /**
  * Context menu section
  * Used in {@link @sisense/sdk-ui!ContextMenuProps | `ContextMenuProps`}
@@ -1629,7 +1683,7 @@ export type LoadingIndicatorConfig = {
     enabled?: boolean;
 };
 /**
- * Data options with arbitrary keys. This is typically used in the context of a plugin widget.
+ * Data options with arbitrary keys. This is typically used in the context of a custom widget.
  */
 export type GenericDataOptions = Record<string, Array<StyledColumn | StyledMeasureColumn>>;
 /**

package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts

@@ -22,7 +22,7 @@ export type TextWidgetType = 'richtexteditor';
 /**
  * The type of a widget on a dashboard.
  */
-export type FusionWidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'plugin';
+export type FusionWidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'custom';
 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",
@@ -376,7 +376,7 @@ export type FunnelWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions &
         decimals: boolean;
     };
 };
-export type PluginStyle = any;
+export type CustomWidgetStyle = any;
 export type TableWidgetStyle = {
     'colors/columns': boolean;
     'colors/headers': boolean;

package/dist/packages/sdk-ui/src/widget-by-id/utils.d.ts

@@ -1,7 +1,7 @@
 import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options.js';
 import { ChartType, RenderToolbarHandler } from '../types.js';
 import { Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, FusionWidgetType } from './types.js';
-import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, TextWidgetProps, CommonWidgetProps, WithCommonWidgetProps, WidgetProps, WidgetType } from '../props';
+import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, CustomWidgetProps, TextWidgetProps, CommonWidgetProps, WithCommonWidgetProps, WidgetProps, WidgetType } from '../props';
 import { WidgetTypeInternal } from '../models/widget/types';
 import { WidgetModel } from '../models';
 export { mergeFilters, getFilterRelationsFromJaql, convertFilterRelationsModelToJaql, getFilterCompareId, } from '@sisense/sdk-data';
@@ -23,8 +23,8 @@ export declare function isPivotWidget(widgetType: WidgetType): boolean;
 export declare function isTextFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
 export declare function isTextWidget(widgetType: WidgetType): boolean;
 export declare function isTextWidgetDtoStyle(widgetStyle: WidgetStyle): widgetStyle is TextWidgetDtoStyle;
-export declare function isPluginFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
-export declare function isPluginWidget(widgetType: WidgetType): boolean;
+export declare function isCustomWidgetFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isCustomWidget(widgetType: WidgetType): boolean;
 export declare function isChartFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
 export declare function isChartWidget(widgetType: WidgetType): boolean;
 /**
@@ -44,13 +44,13 @@ export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widge
  */
 export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'>;
 /**
- * Type guard for checking if the widget props is for a plugin widget
+ * Type guard for checking if the widget props is for a custom widget
  *
  * @param widgetProps - The widget props to check.
- * @returns whether the widget props is for a plugin widget
+ * @returns whether the widget props is for a custom widget
  * @internal
  */
-export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PluginWidgetProps, 'plugin'>;
+export declare function isCustomWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<CustomWidgetProps, 'custom'>;
 /**
  * Type guard for checking if the widget props is for a chart widget
  *

package/dist/packages/sdk-ui/src/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;
-}, "loading" | "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
+}, "loading" | "children" | "disabled" | "size" | "className" | "style" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
     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;
-}, "loading" | "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
+}, "loading" | "children" | "disabled" | "size" | "className" | "style" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge" | "loadingIndicator"> & {
     theme?: import("@emotion/react").Theme | undefined;
 }, {}, {}>;

package/dist/packages/sdk-ui/src/widgets/custom-widget.d.ts

@@ -0,0 +1,8 @@
+import { FunctionComponent } from 'react';
+import { CustomWidgetProps } from '../props';
+/**
+ * Component that renders a custom widget.
+ *
+ * @internal
+ */
+export declare const CustomWidget: FunctionComponent<CustomWidgetProps>;