@univerjs-pro/engine-chart 0.24.0 → 0.25.0-insiders.20260608-e4336f7

package/lib/types/types.d.ts

@@ -1,11 +1,13 @@
-import type { CellValue, IDisposable, LocaleService, Nullable } from '@univerjs/core';
+import type { CellValue, IDisposable, Nullable } from '@univerjs/core';
 import type { Observable } from 'rxjs';
 import type { AreaLineStyle, AxisAlignEnum, AxisValueType, CategoryType, ChartBorderDashType, ChartSourceDataTypeEnum, ChartTrendlineType, ChartTypeBits, DataOrientation, InvalidValueType, IRuntimeAxisPosition, IRuntimeAxisPriority, LabelAlignEnum, LegendPositionEnum, LinePointShape, PieLabelPosition, RadarShape, RelationChartLayoutEnum, SelectModeEnum, SeriesLabelPosition, TitlePositionEnum, WaterfallSeriesTypeEnum, WaterfallStackTypeEnum, WordCloudShapeEnum } from './enum';
-import type { IEchartTheme } from './model/constants/build-in-theme';
+import type { IEchartTheme } from './models/constants/build-in-theme';
+import type { IChartLocaleTexts } from './models/chart-locale-texts';
 import type { BarSeriesOption } from './utils/echarts';
 export type DeepPartial<T> = T extends Record<string, any> ? T extends any[] ? T : {
     [key in keyof T]+?: DeepPartial<T[key]>;
 } : T;
+export type ChartDirection = 'ltr' | 'rtl';
 export interface IChartDataSource {
     data$: Observable<IUniverDataSet>;
     canSwitchOrient$: Observable<boolean>;
@@ -173,7 +175,7 @@ export interface IChartRuntimeContext {
      */
     isDarkMode: boolean;
     hasSecondaryAxis: boolean;
-    localeService: LocaleService;
+    localeTexts: IChartLocaleTexts;
     wordCloudImageMaskMap: Map<string, HTMLImageElement>;
 }
 export interface ILabelStyle {
@@ -237,6 +239,7 @@ export interface IDataPointStyle extends IPointStyle {
 }
 export interface ISeriesStyle {
     chartType?: ChartTypeBits.Line | ChartTypeBits.Column | ChartTypeBits.Area;
+    /** Compatibility switch for placing this series on the secondary vertical axis. It does not change the yAxis/rightYAxis option bucket semantics. */
     rightYAxis?: boolean;
     color: Nullable<string>;
     fillOpacity: number;
@@ -283,6 +286,8 @@ export interface ITrendLine {
 }
 export interface IChartStyle {
     runtime: IChartRuntimeContext;
+    /** Runtime-only locale direction. It must not be persisted in chart snapshots. */
+    direction: ChartDirection;
     width: number;
     height: number;
     theme: string;
@@ -297,13 +302,17 @@ export interface IChartStyle {
         title: Omit<ILabelStyle, 'visible'>;
         subtitle: Omit<ILabelStyle, 'visible'>;
         xAxisTitle: Omit<ILabelStyle, 'visible'>;
+        /** Primary vertical axis title. RTL may render it on the physical right, but it is still persisted here. */
         yAxisTitle: Omit<ILabelStyle, 'visible'>;
+        /** Secondary vertical axis title. */
         rightYAxisTitle: Omit<ILabelStyle, 'visible'>;
         titlePosition: TitlePositionEnum;
     };
     legend: ILegendStyle;
     xAxis: IAxisOptions;
+    /** Primary vertical axis options. This is a semantic bucket, not the physical left-axis bucket. */
     yAxis: IAxisOptions;
+    /** Secondary vertical axis options. Do not store RTL primary vertical axis edits here. */
     rightYAxis: RightYAxisOptions;
     allSeriesStyle: IAllSeriesStyle;
     seriesStyleMap: {

package/lib/types/util.d.ts

@@ -6,6 +6,7 @@ export declare const chartBitsUtils: {
     chartBitToString(bit: ChartTypeBits): "" | "line" | "bar" | "scatter" | "pie" | "radar" | "graph" | "funnel" | "sankey" | "boxplot" | "heatmap" | "combination" | "wordCloud";
 };
 export declare const setProperty: (data: Record<string, any>, propertyPath: string, value: any) => void;
+export declare const getProperty: <T = any>(data: Record<string, any> | undefined, propertyPath: string) => T | undefined;
 /**
  * Set graphic element to data.
  * because we use graphic element to draw watermark title, so we need to set it to data.