Charts - Publish SeriesPoint & SeriesLabel types (#25701)

Co-authored-by: ilyakhd <[email protected]>
DevExpress · Oct 20, 2023 · e95f103 · e95f103
1 parent 665fcae
commit e95f103
Show file tree

Hide file tree

Showing 16 changed files with 846 additions and 798 deletions.
diff --git a/js/common/charts.d.ts b/js/common/charts.d.ts
diff --git a/js/viz/bar_gauge.d.ts b/js/viz/bar_gauge.d.ts
@@ -26,7 +26,6 @@ import BaseWidget, {
     BaseWidgetLoadingIndicator,
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
     FileSavingEventInfo,
     ExportInfo,
     IncidentInfo,
@@ -37,6 +36,7 @@ import {
     Palette,
     PaletteExtensionMode,
     ShiftLabelOverlap,
+    Font,
 } from '../common/charts';
 
 export {

diff --git a/js/viz/chart.d.ts b/js/viz/chart.d.ts
diff --git a/js/viz/chart_components/base_chart.d.ts b/js/viz/chart_components/base_chart.d.ts
@@ -23,8 +23,6 @@ import {
     baseSeriesObject,
     chartSeriesObject,
     dxChartAnnotationConfig,
-    dxChartSeriesTypesCommonSeriesLabel,
-    dxChartSeriesTypesCommonSeriesPoint,
 } from '../chart';
 
 import {
@@ -40,6 +38,8 @@ import BaseWidget, {
 
 import {
     AnimationEaseMode,
+    SeriesLabel,
+    SeriesPoint,
     Palette,
     PaletteExtensionMode,
 } from '../../common/charts';
@@ -110,14 +110,14 @@ export interface BaseChartOptions<TComponent> extends BaseWidgetOptions<TCompone
      * @type_function_return dxChartSeriesTypes.CommonSeries.label
      * @public
      */
-    customizeLabel?: ((pointInfo: any) => dxChartSeriesTypesCommonSeriesLabel);
+    customizeLabel?: ((pointInfo: any) => SeriesLabel);
     /**
      * @docid
      * @type_function_param1 pointInfo:object
      * @type_function_return dxChartSeriesTypes.CommonSeries.point
      * @public
      */
-    customizePoint?: ((pointInfo: any) => dxChartSeriesTypesCommonSeriesPoint);
+    customizePoint?: ((pointInfo: any) => SeriesPoint);
     /**
      * @docid BaseChartOptions.dataSource
      * @notUsedInTheme

diff --git a/js/viz/common.d.ts b/js/viz/common.d.ts
@@ -2,10 +2,6 @@ import {
     dxChartSeriesTypesCommonSeries,
 } from './chart';
 
-import {
-    Font,
-} from './core/base_widget';
-
 import {
     HorizontalAlignment,
     Orientation,
@@ -17,6 +13,7 @@ import {
     DashStyle,
     LegendMarkerState,
     SeriesType as CommonSeriesType,
+    Font,
 } from '../common/charts';
 
 import type * as Common from '../common/charts';

diff --git a/js/viz/core/base_widget.d.ts b/js/viz/core/base_widget.d.ts
@@ -32,6 +32,7 @@ import {
     TextOverflow,
     Theme,
     WordWrap,
+    Font as CommonFont,
 } from '../../common/charts';
 
 /**
@@ -277,9 +278,10 @@ export interface BaseWidgetLoadingIndicator {
     /**
      * @docid BaseWidgetOptions.loadingIndicator.font
      * @default '#767676' &prop(color)
+     * @type Font
      * @public
      */
-    font?: Font;
+    font?: CommonFont;
     /**
      * @docid BaseWidgetOptions.loadingIndicator.show
      * @default false
@@ -356,9 +358,10 @@ export interface BaseWidgetTitle {
      * @default 28 &prop(size)
      * @default 200 &prop(weight)
      * @default "'Segoe UI Light', 'Helvetica Neue Light', 'Segoe UI', 'Helvetica Neue', 'Trebuchet MS', Verdana, sans-serif" &prop(family)
+     * @type Font
      * @public
      */
-    font?: Font;
+    font?: CommonFont;
     /**
      * @docid BaseWidgetOptions.title.horizontalAlignment
      * @default 'center'
@@ -409,8 +412,9 @@ export interface BaseWidgetTitle {
        * @default 16 &prop(size)
        * @default 200 &prop(weight)
        * @default "'Segoe UI Light', 'Helvetica Neue Light', 'Segoe UI', 'Helvetica Neue', 'Trebuchet MS', Verdana, sans-serif" &prop(family)
+       * @type Font
        */
-      font?: Font;
+      font?: CommonFont;
       /**
        * @docid BaseWidgetOptions.title.subtitle.offset
        * @default 0
@@ -528,9 +532,10 @@ export interface BaseWidgetTooltip {
     /**
      * @docid BaseWidgetOptions.tooltip.font
      * @default '#232323' &prop(color)
+     * @type Font
      * @public
      */
-    font?: Font;
+    font?: CommonFont;
     /**
      * @docid BaseWidgetOptions.tooltip.format
      * @default undefined
@@ -656,44 +661,6 @@ export default class BaseWidget<TProperties> extends DOMComponent<TProperties> {
     svg(): string;
 }
 
-/**
- * @docid
- * @type object
- * @namespace DevExpress.viz
- * @hidden
- */
-export interface Font {
-    /**
-     * @docid
-     * @public
-     */
-    color?: string;
-    /**
-     * @docid
-     * @default "'Segoe UI', 'Helvetica Neue', 'Trebuchet MS', Verdana, sans-serif"
-     * @public
-     */
-    family?: string;
-    /**
-     * @docid
-     * @default 1
-     * @public
-     */
-    opacity?: number;
-    /**
-     * @docid
-     * @default 12
-     * @public
-     */
-    size?: string | number;
-    /**
-     * @docid
-     * @default 400
-     * @public
-     */
-    weight?: number;
-}
-
 /**
  * @docid
  * @type object
@@ -775,9 +742,10 @@ export interface BaseWidgetAnnotationConfig {
     /**
      * @docid
      * @default '#333333' &prop(color)
+     * @type Font
      * @public
      */
-    font?: Font;
+    font?: CommonFont;
     /**
      * @docid
      * @default undefined
@@ -915,3 +883,13 @@ export interface BaseWidgetAnnotationConfig {
      */
     y?: number;
 }
+
+// #region deprecated in 23.1
+
+/**
+ * @namespace DevExpress.viz
+ * @deprecated Use Font from common/charts instead
+ */
+export type Font = CommonFont;
+
+// #endregion
diff --git a/js/viz/funnel.d.ts b/js/viz/funnel.d.ts
@@ -28,7 +28,6 @@ import {
 import BaseWidget, {
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
     FileSavingEventInfo,
     ExportInfo,
     IncidentInfo,
@@ -48,6 +47,7 @@ import {
     ShiftLabelOverlap,
     TextOverflow,
     WordWrap,
+    Font,
 } from '../common/charts';
 
 export {

diff --git a/js/viz/gauges/base_gauge.d.ts b/js/viz/gauges/base_gauge.d.ts
@@ -19,7 +19,6 @@ import BaseWidget, {
     BaseWidgetLoadingIndicator,
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
 } from '../core/base_widget';
 
 import {
@@ -33,6 +32,7 @@ import {
     PaletteExtensionMode,
     LabelOverlap,
     ChartsColor,
+    Font,
 } from '../../common/charts';
 
 /**

diff --git a/js/viz/pie_chart.d.ts b/js/viz/pie_chart.d.ts
@@ -37,7 +37,6 @@ import {
 } from './common';
 
 import {
-    Font,
     BaseWidgetAnnotationConfig,
     FileSavingEventInfo,
     ExportInfo,
@@ -54,6 +53,7 @@ import {
     TextOverflow,
     WordWrap,
     ChartsColor,
+    Font,
 } from '../common/charts';
 
 export {

diff --git a/js/viz/polar_chart.d.ts b/js/viz/polar_chart.d.ts
@@ -38,7 +38,6 @@ import {
 } from '../core/templates/template';
 
 import {
-    Font,
     FileSavingEventInfo,
     ExportInfo,
     IncidentInfo,
@@ -68,6 +67,7 @@ import {
     VisualRange,
     ZoomPanAction,
     ChartsColor,
+    Font,
 } from '../common/charts';
 
 /**

diff --git a/js/viz/range_selector.d.ts b/js/viz/range_selector.d.ts
@@ -22,7 +22,6 @@ import {
 import BaseWidget, {
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
     FileSavingEventInfo,
     ExportInfo,
     IncidentInfo,
@@ -39,6 +38,7 @@ import {
     TimeIntervalConfig,
     VisualRange,
     VisualRangeUpdateMode,
+    Font,
 } from '../common/charts';
 
 import { SliderValueChangeMode } from '../common';

diff --git a/js/viz/sankey.d.ts b/js/viz/sankey.d.ts
@@ -19,7 +19,6 @@ import {
 import BaseWidget, {
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
     FileSavingEventInfo,
     ExportInfo,
     IncidentInfo,
@@ -34,6 +33,7 @@ import {
     Palette,
     PaletteExtensionMode,
     TextOverflow,
+    Font,
 } from '../common/charts';
 
 export {

diff --git a/js/viz/tree_map.d.ts b/js/viz/tree_map.d.ts
@@ -20,7 +20,6 @@ import BaseWidget, {
     BaseWidgetMargin,
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
     FileSavingEventInfo,
     ExportInfo,
     IncidentInfo,
@@ -34,6 +33,7 @@ import {
     Palette,
     PaletteExtensionMode,
     TextOverflow,
+    Font,
     WordWrap,
 } from '../common/charts';
 

diff --git a/js/viz/vector_map.d.ts b/js/viz/vector_map.d.ts
@@ -29,7 +29,6 @@ import BaseWidget, {
     BaseWidgetMargin,
     BaseWidgetOptions,
     BaseWidgetTooltip,
-    Font,
     BaseWidgetAnnotationConfig,
     FileSavingEventInfo,
     ExportInfo,
@@ -43,6 +42,7 @@ import {
 
 import {
     Palette,
+    Font,
 } from '../common/charts';
 
 import {

diff --git a/ts/aliases.d.ts b/ts/aliases.d.ts
@@ -445,14 +445,18 @@ declare module DevExpress.ui {
 }
 
 declare module DevExpress.viz {
-    /** @deprecated Use DevExpress.common.ScaleBreak instead */
+    /** @deprecated Use DevExpress.common.charts.ScaleBreak instead */
     export type ScaleBreak = DevExpress.common.charts.ScaleBreak
-    /** @deprecated Use DevExpress.common.SeriesType instead */
+    /** @deprecated Use DevExpress.common.charts.SeriesType instead */
     export type SeriesType = DevExpress.common.charts.SeriesType
-    /** @deprecated Use DevExpress.common.VisualRange instead */
+    /** @deprecated Use DevExpress.common.charts.VisualRange instead */
     export type VisualRange = DevExpress.common.charts.VisualRange
-    /** @deprecated Use DevExpress.common.TimeIntervalConfig instead */
+    /** @deprecated Use DevExpress.common.charts.TimeIntervalConfig instead */
     export type VizTimeInterval = DevExpress.common.charts.TimeIntervalConfig
+    /** @deprecated Use DevExpress.common.charts.SeriesPoint instead */
+    export type dxChartSeriesTypesCommonSeriesPoint = DevExpress.common.charts.SeriesPoint;
+    /** @deprecated Use DevExpress.common.charts.SeriesLabel instead */
+    export type dxChartSeriesTypesCommonSeriesLabel = DevExpress.common.charts.SeriesLabel;
 }
 
 // v23.1