@visactor/vchart-types 1.7.1 → 1.7.3

package/types/component/marker/interface.d.ts

@@ -3,11 +3,18 @@ import type { SymbolType, IRichTextCharacter } from '@visactor/vrender-core';
 import type { IRectMarkSpec, ISymbolMarkSpec, ITextMarkSpec, StringOrNumber } from '../../typings';
 import type { IComponentSpec } from '../base/interface';
 import type { Datum } from '@visactor/vrender-components';
+import type { ICartesianSeries } from '../../series/interface';
+import type { IOptionAggrField, IOptionSeries } from '../../data/transforms/aggregation';
+export type OffsetPoint = {
+    x?: number | string;
+    y?: number | string;
+};
 export type IAggrType = 'sum' | 'average' | 'min' | 'max' | 'variance' | 'standardDeviation' | 'median';
 export type IDataPos = StringOrNumber | IAggrType;
-export type IDataPosCallback = (relativeSeriesData: any, startRelativeSeriesData: any, endRelativeSeriesData: any) => IDataPos;
+export type IDataPosCallback = (relativeSeriesData: Datum[], startRelativeSeriesData: Datum[], endRelativeSeriesData: Datum[], relativeSeries: ICartesianSeries, startRelativeSeries: ICartesianSeries, endRelativeSeries: ICartesianSeries) => StringOrNumber;
+export type IDataPointCallback = (relativeSeriesData: Datum[], relativeSeries: ICartesianSeries) => StringOrNumber;
 export type IDataPointSpec = {
-    [key: string]: IDataPos;
+    [key: string]: IDataPos | IDataPointCallback;
     refRelativeSeriesIndex?: number;
     refRelativeSeriesId?: StringOrNumber;
     xFieldIndex?: number;
@@ -15,12 +22,17 @@ export type IDataPointSpec = {
     yFieldIndex?: number;
     yFieldDim?: string;
 };
-type Point = {
-    x: number;
-    y: number;
+export type MarkerPositionPoint = {
+    x: StringOrNumber;
+    y: StringOrNumber;
 };
+export type ICoordinateOption = {
+    x?: IOptionAggrField | (IDataPointCallback | StringOrNumber)[];
+    y?: IOptionAggrField | (IDataPointCallback | StringOrNumber)[];
+    getRefRelativeSeries?: () => ICartesianSeries;
+} & IOptionSeries;
 export type IMarkerPositionsSpec = {
-    positions: Point[];
+    positions: MarkerPositionPoint[];
     regionRelative?: boolean;
 };
 export type IMarkerLabelWithoutRefSpec = {
@@ -52,12 +64,11 @@ export interface IMarkerRef {
     refY?: number;
     refAngle?: number;
 }
-export interface IMarkerAxisSpec {
+export interface IMarkerCrossSeriesSpec {
     startRelativeSeriesIndex?: number;
     endRelativeSeriesIndex?: number;
     startRelativeSeriesId?: string;
     endRelativeSeriesId?: string;
-    relativeRelativeSeriesIndex?: number;
 }
 export interface IMarkerSpec extends IComponentSpec {
     relativeSeriesIndex?: number;
@@ -74,4 +85,3 @@ export interface IMarkerSymbol extends IMarkerRef {
     size?: number;
     style?: Omit<ISymbolMarkSpec, 'visible'>;
 }
-export {};

package/types/component/marker/mark-area/interface/spec.d.ts

@@ -1,26 +1,24 @@
 import type { IComponent } from '../../../interface';
-import type { IMarkerPositionsSpec, IDataPointSpec, IDataPos, IMarkerSpec, IMarkerAxisSpec, IDataPosCallback } from '../../interface';
+import type { IMarkerPositionsSpec, IDataPointSpec, IDataPos, IMarkerSpec, IDataPosCallback, IMarkerCrossSeriesSpec, OffsetPoint } from '../../interface';
 import type { IMarkAreaTheme } from './theme';
 export type IMarkArea = IComponent;
 export type IRegressType = 'regression';
-export type IMarkAreaSpec = IMarkerSpec & (IMarkAreaXSpec | IMarkAreaYSpec | (IMarkAreaXSpec & IMarkAreaYSpec) | IMarkAreaCoordinateSpec | IMarkAreaPositionsSpec) & IMarkAreaTheme;
-export interface IMarkAreaXSpec extends IMarkerAxisSpec {
+export type IMarkAreaSpec = IMarkerSpec & (IMarkAreaXSpec | IMarkAreaYSpec | IMarkAreaXYSpec | IMarkAreaCoordinateSpec | IMarkerPositionsSpec) & IMarkAreaTheme;
+export interface IMarkAreaXSpec extends IMarkerCrossSeriesSpec {
     x: IDataPos | IDataPosCallback;
     x1: IDataPos | IDataPosCallback;
 }
-export interface IMarkAreaYSpec extends IMarkerAxisSpec {
+export interface IMarkAreaYSpec extends IMarkerCrossSeriesSpec {
     y: IDataPos | IDataPosCallback;
     y1: IDataPos | IDataPosCallback;
 }
-export interface IMarkAreaAngleSpec extends IMarkerAxisSpec {
-    startAngle: IDataPos | IDataPosCallback;
-    endAngle: IDataPos | IDataPosCallback;
-}
-export interface IMarkAreaRadiusSpec extends IMarkerAxisSpec {
-    startRadius: IDataPos | IDataPosCallback;
-    endRadius: IDataPos | IDataPosCallback;
+export interface IMarkAreaXYSpec extends IMarkerCrossSeriesSpec {
+    x: IDataPos | IDataPosCallback;
+    x1: IDataPos | IDataPosCallback;
+    y: IDataPos | IDataPosCallback;
+    y1: IDataPos | IDataPosCallback;
 }
 export type IMarkAreaCoordinateSpec = {
     coordinates: IDataPointSpec[];
+    coordinatesOffset?: OffsetPoint[];
 };
-export type IMarkAreaPositionsSpec = IMarkerPositionsSpec;

package/types/component/marker/mark-area/mark-area.d.ts

@@ -3,7 +3,8 @@ import type { IComponentOption } from '../../interface';
 import { ComponentTypeEnum } from '../../interface/type';
 import { MarkArea as MarkAreaComponent } from '@visactor/vrender-components';
 import { BaseMarker } from '../base-marker';
-export declare class MarkArea extends BaseMarker<IMarkAreaSpec & IMarkAreaTheme> implements IMarkArea {
+import type { IGroup } from '@visactor/vrender-core';
+export declare class MarkArea extends BaseMarker<IMarkAreaSpec> implements IMarkArea {
     static type: ComponentTypeEnum;
     type: ComponentTypeEnum;
     name: string;
@@ -11,7 +12,7 @@ export declare class MarkArea extends BaseMarker<IMarkAreaSpec & IMarkAreaTheme>
     protected _theme: IMarkAreaTheme;
     protected _markerComponent: MarkAreaComponent;
     static createComponent(spec: any, options: IComponentOption): MarkArea | MarkArea[];
-    protected _createMarkerComponent(): void;
+    protected _createMarkerComponent(): IGroup;
     protected _markerLayout(): void;
     protected _initDataView(): void;
 }

package/types/component/marker/mark-line/interface/spec.d.ts

@@ -1,24 +1,35 @@
 import type { IComponent } from '../../../interface';
-import type { IAggrType, IMarkerPositionsSpec, IDataPointSpec, IMarkerSpec, IMarkerAxisSpec, IDataPos, IDataPosCallback, IMarkerLabelSpec } from '../../interface';
+import type { IAggrType, IMarkerPositionsSpec, IDataPointSpec, IMarkerSpec, IDataPos, IDataPosCallback, IMarkerLabelSpec, IMarkerCrossSeriesSpec, OffsetPoint } from '../../interface';
 import type { IRegressType } from '../../mark-area/interface';
 import type { IMarkLineTheme } from './theme';
 import type { ILineMarkSpec, IPoint } from '../../../../typings';
 export type IMarkLine = IComponent;
-export type IMarkLineSpec = (IMarkerSpec & (IMarkLineXSpec | IMarkLineYSpec | IMarkLineCoordinateSpec | IMarkLinePositionsSpec) & IMarkLineTheme) | IStepMarkLineSpec;
-export interface IMarkLineXSpec extends IMarkerAxisSpec {
+export type IMarkLineSpec = (IMarkerSpec & (IMarkLineXSpec | IMarkLineYSpec | IMarkLineXYSpec | IMarkLineXYY1Spec | IMarkLineYXX1Spec | IMarkLineCoordinateSpec | IMarkerPositionsSpec) & IMarkLineTheme) | IStepMarkLineSpec;
+export interface IMarkLineXSpec extends IMarkerCrossSeriesSpec {
     x: IDataPos | IDataPosCallback;
 }
-export interface IMarkLineYSpec extends IMarkerAxisSpec {
+export interface IMarkLineXYY1Spec extends IMarkerCrossSeriesSpec {
+    x: IDataPos | IDataPosCallback;
     y: IDataPos | IDataPosCallback;
+    y1: IDataPos | IDataPosCallback;
 }
-export interface IMarkLineAngleSpec extends IMarkerAxisSpec {
-    angle: IDataPos | IDataPosCallback;
+export interface IMarkLineYSpec extends IMarkerCrossSeriesSpec {
+    y: IDataPos | IDataPosCallback;
 }
-export interface IMarkLineRadiusSpec extends IMarkerAxisSpec {
-    radius: IDataPos | IDataPosCallback;
+export interface IMarkLineYXX1Spec extends IMarkerCrossSeriesSpec {
+    y: IDataPos | IDataPosCallback;
+    x: IDataPos | IDataPosCallback;
+    x1: IDataPos | IDataPosCallback;
+}
+export interface IMarkLineXYSpec extends IMarkerCrossSeriesSpec {
+    x: IDataPos | IDataPosCallback;
+    y: IDataPos | IDataPosCallback;
+    x1: IDataPos | IDataPosCallback;
+    y1: IDataPos | IDataPosCallback;
 }
 export type IMarkLineCoordinateSpec = {
     coordinates: IDataPointSpec[];
+    coordinatesOffset?: OffsetPoint[];
     process?: {
         x: IAggrType;
     } | {
@@ -27,7 +38,6 @@ export type IMarkLineCoordinateSpec = {
         xy: IRegressType;
     };
 };
-export type IMarkLinePositionsSpec = IMarkerPositionsSpec;
 export type IStepMarkLineSpec = IMarkerSpec & {
     type: 'type-step';
     connectDirection: 'top' | 'bottom' | 'left' | 'right';
@@ -49,4 +59,5 @@ export type IStepMarkLineSpec = IMarkerSpec & {
     };
 } | {
     positions: [IPoint, IPoint];
+    regionRelative?: boolean;
 });

package/types/component/marker/mark-line/mark-line.d.ts

@@ -3,15 +3,17 @@ import type { IComponentOption } from '../../interface';
 import { ComponentTypeEnum } from '../../interface/type';
 import { MarkLine as MarkLineComponent } from '@visactor/vrender-components';
 import { BaseMarker } from '../base-marker';
-export declare class MarkLine extends BaseMarker<IMarkLineSpec & IMarkLineTheme> implements IMarkLine {
+import type { IGroup } from '@visactor/vrender-core';
+export declare class MarkLine extends BaseMarker<IMarkLineSpec> implements IMarkLine {
     static type: ComponentTypeEnum;
     type: ComponentTypeEnum;
     name: string;
     layoutZIndex: number;
     protected _theme: IMarkLineTheme;
     protected _markerComponent: MarkLineComponent;
+    private _isXYLayout;
     static createComponent(spec: any, options: IComponentOption): MarkLine | MarkLine[];
-    protected _createMarkerComponent(): void;
+    protected _createMarkerComponent(): IGroup;
     protected _markerLayout(): void;
     protected _initDataView(): void;
 }

package/types/component/marker/mark-point/interface/spec.d.ts

@@ -1,15 +1,17 @@
-import type { IPoint } from '../../../../typings';
 import type { IComponent } from '../../../interface';
-import type { IDataPointSpec, IMarkerSpec, IMarkerSymbol } from '../../interface';
+import type { IDataPointSpec, IDataPos, IDataPosCallback, IMarkerSpec, IMarkerSymbol, MarkerPositionPoint, OffsetPoint } from '../../interface';
 import type { IMarkPointTheme } from './theme';
 export type IMarkPoint = IComponent;
-export type IMarkPointSpec = IMarkerSpec & (IMarkPointCoordinateSpec | IMarkPointPositionsSpec) & IMarkPointTheme<IMarkerSymbol>;
+export type IMarkPointSpec = IMarkerSpec & (IMarkPointXYSpec | IMarkPointCoordinateSpec | IMarkPointPositionsSpec) & IMarkPointTheme<IMarkerSymbol>;
+export type IMarkPointXYSpec = {
+    y: IDataPos | IDataPosCallback;
+    x: IDataPos | IDataPosCallback;
+};
 export type IMarkPointCoordinateSpec = {
     coordinates: IDataPointSpec;
-    relativeRelativeSeriesIndex?: number;
-    relativeRelativeSeriesId?: string;
+    coordinatesOffset?: OffsetPoint;
 };
 export type IMarkPointPositionsSpec = {
-    position: IPoint;
+    position: MarkerPositionPoint;
     regionRelative?: boolean;
 };

package/types/component/marker/mark-point/mark-point.d.ts

@@ -3,7 +3,8 @@ import type { IComponentOption } from '../../interface';
 import { ComponentTypeEnum } from '../../interface/type';
 import { MarkPoint as MarkPointComponent } from '@visactor/vrender-components';
 import { BaseMarker } from '../base-marker';
-export declare class MarkPoint extends BaseMarker<IMarkPointSpec & IMarkPointTheme> implements IMarkPoint {
+import type { IGroup } from '@visactor/vrender-core';
+export declare class MarkPoint extends BaseMarker<IMarkPointSpec> implements IMarkPoint {
     static type: ComponentTypeEnum;
     type: ComponentTypeEnum;
     name: string;
@@ -11,7 +12,7 @@ export declare class MarkPoint extends BaseMarker<IMarkPointSpec & IMarkPointThe
     protected _theme: IMarkPointTheme;
     protected _markerComponent: MarkPointComponent;
     static createComponent(spec: any, options: IComponentOption): MarkPoint | MarkPoint[];
-    protected _createMarkerComponent(): void;
+    protected _createMarkerComponent(): IGroup;
     protected _markerLayout(): void;
     protected _initDataView(): void;
 }

package/types/component/marker/utils.d.ts

@@ -1,5 +1,16 @@
-import type { ICartesianSeries } from '../../series/interface';
+import type { ICartesianSeries, ISeries } from '../../series/interface';
 import type { DataView } from '@visactor/vdataset';
 import type { IPoint } from '../../typings';
+import type { IDataPos, MarkerPositionPoint } from './interface';
+import type { IRegion } from '../../region/interface';
+import type { OffsetPoint } from './interface';
+export declare function isAggrSpec(spec: IDataPos): boolean;
 export declare function xyLayout(data: DataView, startRelativeSeries: ICartesianSeries, endRelativeSeries: ICartesianSeries, relativeSeries: ICartesianSeries, autoRange: boolean): IPoint[][];
-export declare function coordinateLayout(data: DataView, relativeSeries: ICartesianSeries, autoRange: boolean): IPoint[];
+export declare function coordinateLayout(data: DataView, relativeSeries: ICartesianSeries, autoRange: boolean, coordinatesOffset: OffsetPoint[] | OffsetPoint): IPoint[];
+export declare function positionLayout(positions: MarkerPositionPoint[], series: ISeries, regionRelative: boolean): IPoint[];
+export declare function computeClipRange(regions: IRegion[]): {
+    minX: number;
+    maxX: number;
+    minY: number;
+    maxY: number;
+};

package/types/component/player/player.d.ts

@@ -38,7 +38,7 @@ export declare class Player extends BaseComponent<IPlayer> implements IComponent
     };
     changeRegions(regions: IRegion[]): void;
     onRender(ctx: IModelRenderOption): void;
-    getVRenderComponents(): IGraphic[];
+    protected _getNeedClearVRenderComponents(): IGraphic[];
     private _getPlayerAttrs;
     private _createOrUpdatePlayerComponent;
     private _computeLayoutRect;

package/types/component/title/title.d.ts

@@ -40,7 +40,7 @@ export declare class Title extends BaseComponent<ITitleSpec> implements ITitle {
     private _getTitleLayoutRect;
     private _getTitleAttrs;
     private _createOrUpdateTitleComponent;
-    getVRenderComponents(): IGraphic[];
+    protected _getNeedClearVRenderComponents(): IGraphic[];
     clear(): void;
 }
 export declare const registerTitle: () => void;

package/types/component/tooltip/tooltip.d.ts

@@ -32,7 +32,7 @@ export declare class Tooltip extends BaseComponent<any> implements ITooltip {
     protected _isTooltipShown: boolean;
     isTooltipShown(): boolean;
     changeRegions(regions: IRegion[]): void;
-    getVRenderComponents(): IGraphic[];
+    protected _getNeedClearVRenderComponents(): IGraphic[];
     protected _registerEvent(): void;
     protected _releaseEvent(): void;
     onLayout(ctx: IModelLayoutOption): void;

package/types/data/transforms/aggregation.d.ts

@@ -15,7 +15,7 @@ export type IOptionSeries = {
     getStartRelativeSeries: () => ICartesianSeries;
     getEndRelativeSeries: () => ICartesianSeries;
 };
-export type IOptionCallback = (relativeSeriesData: any, startRelativeSeriesData: any, endRelativeSeriesData: any) => IOptionPos;
+export type IOptionCallback = (relativeSeriesData: any, startRelativeSeriesData: any, endRelativeSeriesData: any, relativeSeries: ICartesianSeries, startRelative: ICartesianSeries, endRelative: ICartesianSeries) => IOptionPos;
 export type IOptionAggr = {
     x?: IOptionPos | IOptionCallback;
     y?: IOptionPos | IOptionCallback;
@@ -29,6 +29,6 @@ export declare function markerVariance(_data: Array<DataView>, opt: IOption): nu
 export declare function markerStandardDeviation(_data: Array<DataView>, opt: IOption): number;
 export declare function markerMedian(_data: Array<DataView>, opt: IOption): number;
 export declare function markerAggregation(_data: Array<DataView>, options: IOptionAggr[]): {
-    x: StringOrNumber[] | StringOrNumber | null;
-    y: StringOrNumber[] | StringOrNumber | null;
+    x: StringOrNumber[] | StringOrNumber | IOptionCallback | null;
+    y: StringOrNumber[] | StringOrNumber | IOptionCallback | null;
 }[];

package/types/model/base-model.d.ts

@@ -71,7 +71,7 @@ export declare abstract class BaseModel<T extends IModelSpec> extends Compilable
     protected _getDefaultSpecFromChart(chartSpec: any): Partial<T>;
     protected _shouldMergeThemeToSpec(): boolean;
     protected _prepareSpecBeforeMergingTheme(obj?: any): any;
-    setCurrentTheme(noRender?: boolean): Promise<void>;
+    setCurrentTheme(): void;
     updateLayoutAttribute(): void;
     setAttrFromSpec(): void;
     protected _convertMarkStyle<T extends ICommonSpec = ICommonSpec>(style: Partial<IMarkStyle<T> | ConvertToMarkStyleSpec<T>>): Partial<IMarkStyle<T> | ConvertToMarkStyleSpec<T>>;

package/types/model/interface.d.ts

@@ -74,7 +74,7 @@ export interface IModel extends ICompilable {
     getSpecIndex: () => number;
     onLayoutStart: (layoutRect: IRect, viewRect: ILayoutRect, ctx: IModelLayoutOption) => void;
     onLayoutEnd: (ctx: IModelLayoutOption) => void;
-    setCurrentTheme: (noRender?: boolean) => void;
+    setCurrentTheme: () => void;
     getColorScheme: () => IThemeColorScheme | undefined;
     setMarkStyle: <T extends ICommonSpec>(mark?: IMarkRaw<T>, style?: Partial<IMarkStyle<T> | ConvertToMarkStyleSpec<T>>, state?: StateValueType, level?: number) => void;
     initMarkStyleWithSpec: (mark?: IMark, spec?: any, key?: string) => void;
@@ -89,6 +89,7 @@ export interface ILayoutModel extends IModel {
     afterSetLayoutStartPoint: (pos: ILayoutPoint) => void;
 }
 export interface IModelOption extends ICompilableInitOption {
+    type: string;
     eventDispatcher: IEventDispatcher;
     dataSet: DataSet;
     map: Map<StringOrNumber, IModel | IMark>;

package/types/series/gauge/gauge-pointer.d.ts

@@ -2,7 +2,7 @@ import type { IMark } from '../../mark/interface';
 import { MarkTypeEnum } from '../../mark/interface/type';
 import type { SeriesMarkMap } from '../interface';
 import { SeriesTypeEnum } from '../interface/type';
-import type { IGaugePointerSeriesSpec, IGaugePointerSeriesTheme } from './interface';
+import type { IGaugePointerSeriesSpec, IGaugePointerSeriesTheme, PinMarkSpec, PointerMarkSpec } from './interface';
 import type { Datum, Maybe } from '../../typings';
 import { ProgressLikeSeries } from '../polar/progress-like';
 export declare class GaugePointerSeries<T extends IGaugePointerSeriesSpec = IGaugePointerSeriesSpec> extends ProgressLikeSeries<T> {
@@ -21,6 +21,7 @@ export declare class GaugePointerSeries<T extends IGaugePointerSeriesSpec = IGau
     initGroups(): void;
     private initPointerMarkStyle;
     protected initTooltip(): void;
+    protected _getPointerAnchor(datum: Datum, markSpec: PinMarkSpec | PointerMarkSpec): import("../../typings").IPoint;
     protected _getPointerWidth(): number;
     protected _getPointerHeight(datum: Datum): number;
     protected _getPointerAngle(datum: Datum): number;

package/types/series/gauge/interface.d.ts

@@ -21,10 +21,12 @@ export type PointerMarkSpec = {
     innerPadding?: number;
     outerPadding?: number;
     center?: [number, number];
+    isOnCenter?: boolean;
 };
 export type PinMarkSpec = {
     width?: number;
     height?: number;
+    isOnCenter?: boolean;
 };
 export interface IGaugePointerSeriesTheme extends IProgressLikeSeriesTheme {
     [SeriesMarkNameEnum.pin]?: Partial<IMarkTheme<IPathMarkSpec> & PinMarkSpec>;

package/types/series/util/utils.d.ts

@@ -1,5 +1,10 @@
 import type { IAxisHelper as CartesianHelper } from '../../component/axis/cartesian/interface/common';
 import type { Datum } from '../../typings';
 import type { IPolarAxisHelper } from '../../component/axis';
+import type { ICartesianSeries } from '..';
 export declare function isPolarAxisSeries(type: string): boolean;
 export declare function sortDataInAxisHelper(axisHelper: CartesianHelper | IPolarAxisHelper, field: string, dataList: Datum[]): void;
+export declare function getGroupAnimationParams(series: ICartesianSeries): {
+    dataIndex: (datum: any) => any;
+    dataCount: () => any;
+};

package/types/typings/visual.d.ts

@@ -9,8 +9,7 @@ import type { IAttributeOpt, IModelMarkAttributeContext } from '../compile/mark'
 import type { Datum, StringOrNumber } from './common';
 import type { IPadding } from '@visactor/vutils';
 import type { IColorKey } from '../theme/color-scheme/interface';
-import type { IRepeatType, TextAlignType, TextBaselineType } from '@visactor/vrender-core';
-import type { IRichTextCharacter } from '@visactor/vrender-core';
+import type { IRepeatType, TextAlignType, TextBaselineType, IRichTextCharacter } from '@visactor/vrender-core';
 export interface IVisualSpecBase<D, T> {
     type: ScaleType;
     domain: D[];
@@ -74,6 +73,7 @@ export interface ICommonSpec {
     anchor3d?: [number, number];
     pickMode?: 'accurate' | 'imprecise' | 'custom';
     boundsMode?: 'accurate' | 'imprecise';
+    pickStrokeBuffer?: number;
     texture?: TextureType | string;
     textureColor?: string;
     textureSize?: number;
@@ -128,6 +128,7 @@ export interface ITextMarkSpec extends IFillMarkSpec {
     fontStyle?: FontStyle;
     maxLineWidth?: number;
     ellipsis?: string;
+    suffixPosition?: 'start' | 'end' | 'middle';
     lineBreak?: string;
     underline?: boolean;
     lineThrough?: boolean;