@visactor/vchart-types 1.9.1 → 1.10.0-alpha.0

package/types/series/word-cloud/interface.d.ts

@@ -1,4 +1,4 @@
-import type { ITextMarkSpec, IMarkSpec, ISeriesSpec } from '../../typings';
+import type { ITextMarkSpec, IMarkSpec, ISeriesSpec, ITextFormatMethod } from '../../typings';
 import type { IAnimationSpec, IMarkAnimateSpec, IStateAnimateSpec } from '../../animation/spec';
 import type { SeriesMarkNameEnum } from '../interface/type';
 import type { WordcloudAppearPreset } from './animation';
@@ -71,7 +71,7 @@ export interface IWordCloudSeriesBaseSpec extends ISeriesSpec, IAnimationSpec<st
     wordCloudShapeConfig?: WordCloudShapeConfigType;
     [SeriesMarkNameEnum.word]?: IMarkSpec<ITextMarkSpec> & {
         padding?: number;
-        formatMethod?: (datum?: any) => string;
+        formatMethod?: ITextFormatMethod<[datum?: any]>;
     };
     [SeriesMarkNameEnum.fillingWord]?: IMarkSpec<ITextMarkSpec> & {
         padding?: number;
@@ -87,11 +87,9 @@ export interface IWordCloudSeriesSpec extends IWordCloudSeriesBaseSpec {
 export interface IWordCloudSeriesTheme {
     [SeriesMarkNameEnum.word]?: IMarkSpec<ITextMarkSpec> & {
         padding?: number;
-        formatMethod?: (datum?: any) => string;
     };
     [SeriesMarkNameEnum.fillingWord]?: IMarkSpec<ITextMarkSpec> & {
         padding?: number;
-        formatMethod?: (datum?: any) => string;
     };
 }
 export interface IWordCloud3dSeriesSpec extends IWordCloudSeriesBaseSpec {
@@ -102,10 +100,8 @@ export interface IWordCloud3dSeriesSpec extends IWordCloudSeriesBaseSpec {
 export interface IWordCloud3dSeriesTheme {
     [SeriesMarkNameEnum.word]?: IMarkSpec<ITextMarkSpec> & {
         padding?: number;
-        formatMethod?: (text: string | string[], datum?: any) => string | string[];
     };
     [SeriesMarkNameEnum.fillingWord]?: IMarkSpec<ITextMarkSpec> & {
         padding?: number;
-        formatMethod?: (text: string | string[], datum?: any) => string | string[];
     };
 }

package/types/theme/builtin/common/series/rangeColumn.d.ts

@@ -1,2 +1,2 @@
-import { type IRangeColumnSeriesTheme } from '../../../../series/range-column/interface';
+import type { IRangeColumnSeriesTheme } from '../../../../series/range-column/interface';
 export declare const rangeColumn: IRangeColumnSeriesTheme;

package/types/typings/spec/common.d.ts

@@ -14,7 +14,7 @@ import type { Datum, StringOrNumber } from '../common';
 import type { IInvalidType } from '../data';
 import type { IMorphSeriesSpec } from '../../animation/spec';
 import type { IPlayer } from '../../component/player';
-import type { IMarkProgressiveConfig, MarkTypeEnum } from '../../mark/interface';
+import { IMarkProgressiveConfig, MarkTypeEnum } from '../../mark/interface';
 import type { IDataZoomSpec, IScrollBarSpec } from '../../component/data-zoom';
 import type { ICrosshairSpec } from '../../component/crosshair/interface';
 import type { ITheme } from '../../theme';
@@ -23,9 +23,9 @@ import type { IBrushSpec } from '../../component/brush';
 import type { ITotalLabelSpec } from '../../component/label';
 import type { ILegendSpec } from '../../component/legend';
 import type { ILayoutOrientPadding, ILayoutPaddingSpec } from '../layout';
-import type { ICustomPath2D } from '@visactor/vrender-core';
+import type { ICustomPath2D, IRichTextCharacter } from '@visactor/vrender-core';
 import type { ICommonAxisSpec } from '../../component/axis';
-import type { IMediaQuerySpec } from '..';
+import type { IComposedTextMarkSpec, IMediaQuerySpec } from '..';
 export type IChartPadding = ILayoutOrientPadding | number;
 export interface IInitOption extends Omit<IRenderOption, 'pluginList'> {
     dom?: string | HTMLElement;
@@ -235,12 +235,12 @@ export interface IPerformanceHook {
     beforeVRenderDraw?: () => void;
     afterVRenderDraw?: () => void;
 }
-export type IBuildinMarkSpec = {
+export type IBuiltInMarkSpec = {
     [MarkTypeEnum.group]: IGroupMarkSpec;
     [MarkTypeEnum.symbol]: ISymbolMarkSpec;
     [MarkTypeEnum.rule]: IRuleMarkSpec;
     [MarkTypeEnum.line]: ILineMarkSpec;
-    [MarkTypeEnum.text]: ITextMarkSpec;
+    [MarkTypeEnum.text]: IComposedTextMarkSpec;
     [MarkTypeEnum.rect]: IRectMarkSpec;
     [MarkTypeEnum.rect3d]: IRect3dMarkSpec;
     [MarkTypeEnum.image]: IImageMarkSpec;
@@ -255,8 +255,8 @@ export type IBuildinMarkSpec = {
     [MarkTypeEnum.progressArc]: IProgressArcMarkSpec;
     [MarkTypeEnum.ripple]: IRippleMarkSpec;
 };
-export type EnableMarkType = keyof IBuildinMarkSpec;
-export interface ICustomMarkSpec<T extends EnableMarkType> extends IMarkSpec<IBuildinMarkSpec[T]> {
+export type EnableMarkType = keyof IBuiltInMarkSpec;
+export interface ICustomMarkSpec<T extends EnableMarkType> extends IMarkSpec<IBuiltInMarkSpec[T]> {
     type: T;
     dataIndex?: number;
     dataId?: StringOrNumber;
@@ -273,3 +273,12 @@ export interface IExtensionMarkSpec<T extends Exclude<EnableMarkType, MarkTypeEn
 export interface IExtensionGroupMarkSpec extends ICustomMarkSpec<MarkTypeEnum.group> {
     children?: ICustomMarkSpec<EnableMarkType>[];
 }
+export type ITextFormatMethod<T extends any[]> = (...args: T) => ITextMarkSpec['text'] | {
+    type: 'text';
+    text: ITextMarkSpec['text'];
+};
+export type IRichTextFormatMethod<T extends any[]> = (...args: T) => {
+    type: 'rich';
+    text: IRichTextCharacter[];
+} | IRichTextCharacter[];
+export type IFormatMethod<T extends any[]> = (...args: T) => ReturnType<ITextFormatMethod<T>> | ReturnType<IRichTextFormatMethod<T>>;

package/types/typings/visual.d.ts

@@ -6,10 +6,10 @@ import type { ScaleType } from './scale';
 import type { ShapeType } from './shape';
 import type { IPoint } from './coordinate';
 import type { IAttributeOpt, IModelMarkAttributeContext } from '../compile/mark';
-import type { Datum, StringOrNumber } from './common';
+import type { Datum } from './common';
 import type { IPadding } from '@visactor/vutils';
 import type { IColorKey } from '../theme/color-scheme/interface';
-import type { IRepeatType, TextAlignType, TextBaselineType, IRichTextCharacter } from '@visactor/vrender-core';
+import type { IRepeatType, TextAlignType, TextBaselineType, IRichTextAttribute, IGraphicStyle } from '@visactor/vrender-core';
 export interface IVisualSpecBase<D, T> {
     type: ScaleType;
     domain: D[];
@@ -80,6 +80,7 @@ export interface ICommonSpec {
     texturePadding?: number;
     outerBorder?: IBorder;
     innerBorder?: IBorder;
+    html?: IMarkHtmlSpec;
     [key: string]: any;
 }
 export interface IFillMarkSpec extends ICommonSpec {
@@ -87,6 +88,7 @@ export interface IFillMarkSpec extends ICommonSpec {
     fillOpacity?: number;
     background?: string | HTMLImageElement | HTMLCanvasElement | null;
 }
+export type IMarkHtmlSpec = Partial<IGraphicStyle['html']>;
 export interface ISymbolMarkSpec extends IFillMarkSpec {
     dx?: number;
     dy?: number;
@@ -116,8 +118,7 @@ export interface IRuleMarkSpec extends ILineMarkSpec {
     y1?: number;
 }
 export interface ITextMarkSpec extends IFillMarkSpec {
-    type?: 'html' | 'rich' | 'text';
-    text?: StringOrNumber | string[] | IRichTextCharacter[] | Function;
+    text?: string | number | string[] | number[];
     dx?: number;
     dy?: number;
     fontSize?: number;
@@ -129,13 +130,17 @@ export interface ITextMarkSpec extends IFillMarkSpec {
     maxLineWidth?: number;
     ellipsis?: string;
     suffixPosition?: 'start' | 'end' | 'middle';
-    lineBreak?: string;
     underline?: boolean;
     lineThrough?: boolean;
     lineHeight?: number | string;
     poptip?: PopTipAttributes;
     direction?: 'horizontal' | 'vertical';
 }
+export type IRichTextMarkSpec = IRichTextAttribute & IFillMarkSpec & {
+    type: 'rich';
+    text: IRichTextAttribute['textConfig'];
+};
+export type IComposedTextMarkSpec = ITextMarkSpec | IRichTextMarkSpec;
 export type IPositionedTextMarkSpec = Omit<ITextMarkSpec, 'align' | 'textAlign' | 'baseline' | 'textBaseline'>;
 export interface IRectMarkSpec extends IFillMarkSpec {
     cornerRadius?: number | number[];

package/types/util/scale.d.ts

@@ -1,5 +1,6 @@
 import type { IGlobalScale } from '../scale/interface';
-import { type IBaseScale, BandScale, LinearScale, OrdinalScale, PointScale, ThresholdScale } from '@visactor/vscale';
+import type { IBaseScale } from '@visactor/vscale';
+import { BandScale, LinearScale, OrdinalScale, PointScale, ThresholdScale } from '@visactor/vscale';
 import type { IVisual } from '../typings/visual';
 import { ColorOrdinalScale } from '../scale/color-ordinal-scale';
 declare const defaultScaleMap: {

package/types/util/space.d.ts

@@ -1,4 +1,4 @@
-import { type IBoundsLike } from '@visactor/vutils';
+import type { IBoundsLike } from '@visactor/vutils';
 import type { IPadding } from '../typings/space';
 import type { IPoint } from '../typings/coordinate';
 import type { ILayoutNumber, ILayoutRect, IPercent, IPercentOffset, ILayoutPaddingSpec, ILayoutOrientPadding } from '../typings/layout';

package/types/util/spec/common.d.ts

@@ -1,5 +1,5 @@
 import { DataView } from '@visactor/vdataset';
-import { type ITheme } from '../../theme';
+import type { ITheme } from '../../theme';
 export declare function isDataView(obj: any): obj is DataView;
 export declare function isHTMLElement(obj: any): obj is Element;
 export declare function getThemeObject(theme?: string | ITheme, transformed?: boolean): ITheme;

package/types/util/spec/merge-theme.d.ts

@@ -1,4 +1,4 @@
-import { type Maybe } from '@visactor/vutils';
+import type { Maybe } from '@visactor/vutils';
 import type { IGlobalMarkThemeByName, IGlobalMarkThemeByType, ITheme } from '../../theme';
 import type { IThemeColorScheme } from '../../theme/color-scheme/interface';
 export declare function mergeTheme(target: Maybe<ITheme>, ...sources: Maybe<ITheme>[]): Maybe<ITheme>;