@sisense/sdk-ui 1.15.1 → 1.17.0

package/dist/types.d.ts

@@ -634,6 +634,25 @@ export interface ChartThemeSettings {
     backgroundColor?: string;
     /** Toolbar Background color, can be used as a secondary background color */
     panelBackgroundColor?: string;
+    /** Animation options */
+    animation?: {
+        /** Chart initialization animation options */
+        init?: {
+            /**
+             * Animation duration in milliseconds.
+             * If not specified, the default value, `auto`, will be used with a different default value applied per chart type.
+             */
+            duration?: number | 'auto';
+        };
+        /** Chart redraw animation options */
+        redraw?: {
+            /**
+             * Animation duration in milliseconds.
+             * If not specified, the default value, `auto`, will be used with a different default value applied per chart type.
+             */
+            duration?: number | 'auto';
+        };
+    };
 }
 /**
  * Theme settings specific to the AI Chatbot component
@@ -825,6 +844,57 @@ export interface GeneralThemeSettings {
     /** Hover color for primary buttons */
     primaryButtonHoverColor?: string;
 }
+/** Possible sizes for spacing. */
+export type SpaceSizes = 'None' | 'Large' | 'Medium' | 'Small';
+/** Possible sizes for border radius. */
+export type RadiusSizes = 'None' | 'Large' | 'Medium' | 'Small';
+/** Possible types of shadows. */
+export type ShadowsTypes = 'None' | 'Light' | 'Medium' | 'Dark';
+/** Possible types of text alignment. */
+export type AlignmentTypes = 'Left' | 'Center' | 'Right';
+/** Widget theme settings */
+export type WidgetThemeSettings = {
+    /** Space between widget container edge and the chart */
+    spaceAround?: SpaceSizes;
+    /** Corner radius of the widget container */
+    cornerRadius?: RadiusSizes;
+    /**
+     * Shadow level of the widget container
+     *
+     * Effective only when spaceAround is defined
+     */
+    shadow?: ShadowsTypes;
+    /** Widget container border toggle */
+    border?: boolean;
+    /** Widget container border color */
+    borderColor?: string;
+    /** Widget header styles */
+    header?: {
+        /** Header title text color */
+        titleTextColor?: string;
+        /** Header title alignment */
+        titleAlignment?: AlignmentTypes;
+        /** Toggle of the divider line between widget header and chart */
+        dividerLine?: boolean;
+        /** Divider line color */
+        dividerLineColor?: string;
+        /** Header background color */
+        backgroundColor?: string;
+    };
+};
+/**
+ * Dashboard theme settings
+ *
+ * @internal
+ */
+export type DashboardThemeSettings = {
+    /** Background color */
+    backgroundColor?: string;
+    /** Width of the divider line between widgets */
+    dividerLineWidth?: number;
+    /** Divider line color */
+    dividerLineColor?: string;
+};
 /** Theme settings defining the look and feel of components. */
 export interface ThemeSettings {
     /** Chart theme settings */
@@ -835,6 +905,14 @@ export interface ThemeSettings {
     typography?: TypographyThemeSettings;
     /** General theme settings */
     general?: GeneralThemeSettings;
+    /** Widget theme settings */
+    widget?: WidgetThemeSettings;
+    /**
+     * Dashboard theme settings
+     *
+     * @internal
+     */
+    dashboard?: DashboardThemeSettings;
     /**
      * Theme settings specific to the AI Chatbot component
      */
@@ -846,18 +924,20 @@ export interface ThemeSettings {
  * @internal
  */
 export type CompleteThemeSettings = DeepRequired<ThemeSettings>;
+/** 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) & WidgetContainerStyleOptions;
 /** Style settings defining the look and feel of widget itself and widget header */
-export interface WidgetStyleOptions {
+export interface WidgetContainerStyleOptions {
     /** Space between widget container edge and the chart */
-    spaceAround?: 'Large' | 'Medium' | 'Small';
+    spaceAround?: SpaceSizes;
     /** Corner radius of the widget container */
-    cornerRadius?: 'Large' | 'Medium' | 'Small';
+    cornerRadius?: RadiusSizes;
     /**
      * Shadow level of the widget container
      *
      * Effective only when spaceAround is defined
      */
-    shadow?: 'Light' | 'Medium' | 'Dark';
+    shadow?: ShadowsTypes;
     /** Widget container border toggle */
     border?: boolean;
     /** Widget container border color */
@@ -875,7 +955,7 @@ export interface WidgetStyleOptions {
         /** Header title text color */
         titleTextColor?: string;
         /** Header title alignment */
-        titleAlignment?: 'Left' | 'Center' | undefined;
+        titleAlignment?: AlignmentTypes;
         /** Toggle of the divider line between widget header and chart */
         dividerLine?: boolean;
         /** Divider line color */
@@ -893,7 +973,7 @@ export interface WidgetStyleOptions {
 /** @internal */
 export type RenderToolbarHandler = (onRefresh: () => void, defaultToolbar: JSX.Element) => JSX.Element | null;
 /** Style settings defining the look and feel of DashboardWidget */
-export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
+export interface DashboardWidgetStyleOptions extends WidgetContainerStyleOptions {
     /**
      * Total width of the component, which is considered in the following order of priority:
      *
@@ -913,19 +993,19 @@ export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
     height?: number;
 }
 /** Style settings defining the look and feel of ChartWidget */
-export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetStyleOptions;
+export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
  * Style settings defining the look and feel of TableWidget
  *
  * @internal
  */
-export type TableWidgetStyleOptions = TableStyleOptions & WidgetStyleOptions;
+export type TableWidgetStyleOptions = TableStyleOptions & WidgetContainerStyleOptions;
 /**
  * Style settings defining the look and feel of TableWidget
  *
  * @internal
  */
-export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetStyleOptions;
+export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetContainerStyleOptions;
 /**
  * Runs type guard check for ThemeOid.
  *