@visactor/vchart-types 1.7.0-alpha.1 → 1.7.0

package/types/chart/util.d.ts

@@ -1,3 +1,4 @@
+import type { IChartSpec } from '../typings';
 import type { ICartesianChartSpec } from './cartesian/interface';
 import type { IChartOption } from './interface/common';
 import type { IUpdateSpecResult } from '../model/interface';
@@ -10,3 +11,10 @@ export declare function calculateChartSize(spec: {
     height: number;
 };
 export declare function mergeUpdateResult(resultA: IUpdateSpecResult, resultB: IUpdateSpecResult): IUpdateSpecResult;
+export declare function getTrimPaddingConfig(chartType: string, spec: IChartSpec): {
+    paddingInner: number;
+    paddingOuter: number;
+} | {
+    paddingOuter: number;
+    paddingInner?: undefined;
+};

package/types/compile/mark/compilable-mark.d.ts

@@ -10,6 +10,7 @@ import { MarkData } from './mark-data';
 import { GrammarType } from '../interface/compilable-item';
 import type { IEvent } from '../../event/interface';
 import type { TransformedLabelSpec } from '../../component/label';
+import type { ICustomPath2D } from '@visactor/vrender-core';
 export declare abstract class CompilableMark extends GrammarItem implements ICompilableMark {
     readonly grammarType = GrammarType.mark;
     readonly type: MarkType;
@@ -75,6 +76,10 @@ export declare abstract class CompilableMark extends GrammarItem implements ICom
     protected _progressiveConfig: IMarkProgressiveConfig;
     getProgressiveConfig(): IMarkProgressiveConfig;
     setProgressiveConfig(config: IMarkProgressiveConfig): void;
+    protected _setCustomizedShape?: (datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D;
+    setCustomizedShapeCallback(callback: (datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D): void;
+    protected _enableSegments: boolean;
+    setEnableSegments(enable: boolean): void;
     protected _option: ICompilableMarkOption;
     constructor(option: ICompilableMarkOption, name: string, model: IModel);
     protected _product: Maybe<IMark>;

package/types/compile/mark/interface.d.ts

@@ -9,6 +9,7 @@ import type { Maybe, Datum, StringOrNumber } from '../../typings';
 import type { MarkData } from './mark-data';
 import type { TransformedLabelSpec } from '../../component/label';
 import type { IRegion } from '../../region/interface';
+import type { ICustomPath2D } from '@visactor/vrender-core';
 export interface ICompilableMarkOption extends GrammarItemInitOption {
     key?: string | ((datum: Datum) => string);
     groupKey?: string;
@@ -69,6 +70,7 @@ export interface ICompilableMark extends IGrammarItem {
     getMarks: () => ICompilableMark[];
     setSkipBeforeLayouted: (skip: boolean) => void;
     getSkipBeforeLayouted: () => boolean;
+    setCustomizedShapeCallback: (callback: (datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D) => void;
     runAnimationByState: (animationState?: string) => IAnimateArranger;
     stopAnimationByState: (animationState?: string) => IAnimate;
     pauseAnimationByState: (animationState: string) => IAnimate;

package/types/component/axis/base-axis.d.ts

@@ -99,31 +99,7 @@ export declare abstract class AxisComponent<T extends ICommonAxisSpec & Record<s
             style: any;
             state: {};
         };
-        title: {
-            visible: any;
-            position: any;
-            space: any;
-            autoRotate: boolean;
-            angle: number;
-            textStyle: any;
-            padding: any;
-            shape: {
-                visible: any;
-                space: any;
-                style: any;
-            };
-            background: {
-                visible: any;
-                style: any;
-            };
-            state: {
-                text: {};
-                shape: {};
-                background: {};
-            };
-            pickable: boolean;
-            childrenPickable: boolean;
-        };
+        title: any;
         panel: {
             visible: any;
             style: any;

package/types/component/axis/interface/spec.d.ts

@@ -3,6 +3,7 @@ import type { IAnimationSpec } from '../../../animation/spec';
 import type { Datum, IPadding, IRectMarkSpec, IRuleMarkSpec, ISymbolMarkSpec, ITextMarkSpec, StringOrNumber } from '../../../typings';
 import type { IComponentSpec } from '../../base/interface';
 import type { AxisType, IAxisItem, ITickCallbackOption, StyleCallback } from './common';
+import type { IRichTextCharacter } from '@visactor/vrender-core';
 export interface ICommonAxisSpec extends Omit<IComponentSpec, 'orient' | 'center'>, IAnimationSpec<string, string> {
     type?: AxisType;
     visible?: boolean;
@@ -31,6 +32,7 @@ export interface ILinearAxisSpec {
     tooltipFilterRange?: number | [number, number];
 }
 export interface IBandAxisSpec {
+    trimPadding?: boolean;
     bandPadding?: number | number[];
     paddingInner?: number | number[];
     paddingOuter?: number | number[];
@@ -63,7 +65,8 @@ export interface ISubTick extends IAxisItem<IRuleMarkSpec> {
     state?: AxisItemStateStyle<IRuleMarkSpec>;
 }
 export interface ILabel extends IAxisItem<ITextMarkSpec> {
-    formatMethod?: (text: string | string[], datum?: Datum) => string | string[];
+    type?: 'text' | 'rich' | 'html';
+    formatMethod?: (text: string | string[], datum?: Datum) => string | string[] | IRichTextCharacter[];
     space?: number;
     inside?: boolean;
     minGap?: number;
@@ -85,7 +88,8 @@ export interface ITitle extends IAxisItem<ITextMarkSpec> {
         space?: number;
         state?: AxisItemStateStyle<Partial<ISymbolMarkSpec>>;
     };
-    text?: string | string[];
+    type?: 'text' | 'rich' | 'html';
+    text?: string | string[] | IRichTextCharacter[];
     angle?: number;
     state?: AxisItemStateStyle<Partial<ITextMarkSpec>>;
 }

package/types/component/data-zoom/data-filter-base-component.d.ts

@@ -1,7 +1,7 @@
 import { BaseComponent } from '../base/base-component';
 import type { IEffect, IModelInitOption } from '../../model/interface';
 import type { IComponent, IComponentOption } from '../interface';
-import type { AdaptiveSpec, ILayoutRect, ILayoutType, IOrientType, StringOrNumber } from '../../typings';
+import type { AdaptiveSpec, ILayoutRect, ILayoutType, IOrientType, IRect, StringOrNumber } from '../../typings';
 import type { IBaseScale } from '@visactor/vscale';
 import type { ICartesianBandAxisSpec } from '../axis/cartesian';
 import type { IBoundsLike } from '@visactor/vutils';
@@ -61,6 +61,8 @@ export declare abstract class DataFilterBaseComponent<T extends IDataFilterCompo
     protected abstract _computeHeight(): number;
     protected abstract _handleDataCollectionChange(): void;
     protected _handleChange(start: number, end: number, updateComponent?: boolean): void;
+    protected _isReverse(): boolean;
+    protected _updateRangeFactor(tag?: string, label?: string): void;
     effect: IEffect;
     protected _visible: boolean;
     get visible(): boolean;
@@ -109,6 +111,7 @@ export declare abstract class DataFilterBaseComponent<T extends IDataFilterCompo
     protected _handleChartMove: (value: number, rate: number) => void;
     protected _initCommonEvent(): void;
     updateLayoutAttribute(): void;
+    onLayoutStart(layoutRect: IRect, viewRect: ILayoutRect, ctx: any): void;
     getBoundsInRect(rect: ILayoutRect): IBoundsLike;
     hide(): void;
     show(): void;

package/types/component/data-zoom/data-zoom/data-zoom.d.ts

@@ -27,7 +27,7 @@ export declare class DataZoom<T extends IDataZoomSpec = IDataZoomSpec> extends D
     onLayoutEnd(ctx: any): void;
     protected _initValueScale(): void;
     protected _updateScaleRange(): void;
-    protected _computeDomainOfValueScale(): number[];
+    protected _computeDomainOfValueScale(): unknown[];
     protected _computeMiddleHandlerSize(): number;
     protected _computeWidth(): number;
     protected _computeHeight(): number;

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

@@ -2,6 +2,7 @@ import type { IPercent } from '../../typings/layout';
 import type { ConvertToMarkStyleSpec, ITextMarkSpec } from '../../typings/visual';
 import type { IComponentSpec } from '../base/interface';
 import type { IComponent } from '../interface';
+import type { IRichTextCharacter } from '@visactor/vrender-core';
 export interface IIndicatorItemSpec {
     visible?: boolean;
     field?: string;
@@ -9,7 +10,10 @@ export interface IIndicatorItemSpec {
     autoLimit?: boolean;
     autoFit?: boolean;
     fitPercent?: number;
-    style?: Omit<ConvertToMarkStyleSpec<ITextMarkSpec>, 'visible'>;
+    style?: Omit<ConvertToMarkStyleSpec<ITextMarkSpec>, 'visible' | 'text'> & {
+        type?: 'text' | 'rich' | 'html';
+        text?: string | string[] | number | number[] | IRichTextCharacter[];
+    };
 }
 export type IIndicator = IComponent;
 export interface IIndicatorSpec extends IComponentSpec {

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

@@ -2,6 +2,7 @@ import type { BaseLabelAttrs } from '@visactor/vrender-components';
 import type { ConvertToMarkStyleSpec, Datum, ITextMarkSpec } from '../../typings';
 import type { IComponentSpec } from '../base/interface';
 import type { ISeries } from '../..';
+import type { IRichTextCharacter } from '@visactor/vrender-core';
 import type { ILabelMark } from '../../mark/label';
 export interface ILabelFormatMethodContext {
     series?: ISeries;
@@ -9,7 +10,9 @@ export interface ILabelFormatMethodContext {
 export interface ILabelSpec extends IComponentSpec {
     visible?: boolean;
     interactive?: boolean;
-    formatMethod?: (text: string | string[], datum?: Datum, ctx?: ILabelFormatMethodContext) => string | string[];
+    textType?: string;
+    formatMethod?: (text: string | string[], datum?: Datum, ctx?: ILabelFormatMethodContext) => string | string[] | IRichTextCharacter[];
+    formatter?: string;
     offset?: number;
     position?: string;
     style?: ConvertToMarkStyleSpec<ITextMarkSpec>;

package/types/component/label/util.d.ts

@@ -20,7 +20,7 @@ export declare enum LabelRule {
     stackLabel = "stackLabel",
     line = "line"
 }
-export declare function textAttribute(labelInfo: ILabelInfo, datum: Datum, formatMethod?: ILabelSpec['formatMethod']): any;
+export declare function textAttribute(labelInfo: ILabelInfo, datum: Datum, formatMethod?: ILabelSpec['formatMethod'], formatter?: ILabelSpec['formatter']): any;
 export declare function symbolLabel(labelInfo: ILabelInfo): {
     position: string | ((datum: Datum) => any);
     overlap: boolean | {

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

@@ -1,5 +1,5 @@
 import type { IPadding } from '@visactor/vutils';
-import type { SymbolType } from '@visactor/vrender-core';
+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';
@@ -33,8 +33,9 @@ export type IMarkerLabelWithoutRefSpec = {
         padding?: IPadding | number[] | number;
         style?: Omit<IRectMarkSpec, 'visible'>;
     };
-    text?: string | string[] | number | number[];
-    formatMethod?: (markData: Datum[], seriesData: Datum[]) => string | string[] | number | number[];
+    type?: 'text' | 'rich' | 'html';
+    text?: string | string[] | number | number[] | IRichTextCharacter[];
+    formatMethod?: (markData: Datum[], seriesData: Datum[]) => string | string[] | number | number[] | IRichTextCharacter[];
     style?: Omit<ITextMarkSpec, 'visible'>;
     shape?: {
         visible?: boolean;

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

@@ -5,8 +5,10 @@ import type { IComponentSpec } from '../../base/interface';
 export interface ITitleSpec extends Omit<IComponentSpec, 'orient'> {
     visible?: boolean;
     orient?: IOrientType;
-    text: Text | Text[];
-    subtext?: Text | Text[];
+    text?: string | number | string[] | number[] | IRichTextCharacter[];
+    textType?: string;
+    subtext?: string | number | string[] | number[] | IRichTextCharacter[];
+    subtextType?: string;
     x?: number;
     y?: number;
     width?: number;

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

@@ -1,10 +1,10 @@
+import type { IRegion } from '../../region/interface';
+import type { IPoint, IOrientType, ILayoutType, ILayoutRect } from '../../typings';
 import { BaseComponent } from '../base/base-component';
-import { ComponentTypeEnum } from '../interface/type';
 import type { IComponentOption } from '../interface';
+import { ComponentTypeEnum } from '../interface/type';
 import type { ITitle, ITitleSpec, ITitleTheme } from './interface';
-import type { IRegion } from '../../region/interface';
 import type { IGraphic } from '@visactor/vrender-core';
-import type { IPoint, IOrientType, ILayoutType, ILayoutRect } from '../../typings';
 export declare class Title extends BaseComponent<ITitleSpec> implements ITitle {
     static type: ComponentTypeEnum;
     type: ComponentTypeEnum;

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

@@ -43,7 +43,7 @@ export declare abstract class BaseTooltipHandler implements ITooltipHandler {
     protected _getActualTooltipPosition: (actualTooltip: IToolTipActual, params: TooltipHandlerParams, tooltipBoxSize: IContainerSize | undefined) => ITooltipPositionActual;
     protected _getTooltipBoxSize(actualTooltip: IToolTipActual, changePositionOnly: boolean): IContainerSize | undefined;
     protected _getParentElement(spec: ITooltipSpec): HTMLElement;
-    getTooltipContainer(): HTMLElement | IGroup;
+    getTooltipContainer(): IGroup | HTMLElement;
     protected _initFromSpec(): void;
     reInit(): void;
 }

package/types/component/tooltip/handler/utils/common.d.ts

@@ -2,6 +2,7 @@ import type { Datum } from '@visactor/vgrammar-core';
 import type { MaybeArray, TooltipContentProperty, TooltipData, TooltipPatternProperty } from '../../../../typings';
 import type { TooltipHandlerParams } from '../../interface';
 import type { ITooltipTextStyle } from '../interface/style';
+import type { TooltipRichTextAttrs } from '@visactor/vrender-components';
 export declare function escapeHTML(value: any): string;
 export declare const getTooltipContentValue: <T>(field?: TooltipContentProperty<T>, datum?: any, params?: TooltipHandlerParams) => T;
 export declare const getTooltipPatternValue: <T>(field?: MaybeArray<TooltipPatternProperty<T>>, data?: TooltipData, params?: TooltipHandlerParams) => MaybeArray<TooltipPatternProperty<T>> extends TooltipPatternProperty<T>[] ? MaybeArray<T> : T;
@@ -12,7 +13,7 @@ export declare const getScale: (element: HTMLElement, boundingClientRect?: DOMRe
 interface ITooltipTextInfo {
     width: number;
     height: number;
-    text: MaybeArray<number> | MaybeArray<string>;
+    text: MaybeArray<number> | MaybeArray<string> | TooltipRichTextAttrs;
 }
-export declare const measureTooltipText: (text: string, style: ITooltipTextStyle) => ITooltipTextInfo;
+export declare const measureTooltipText: (text: string | TooltipRichTextAttrs, style: ITooltipTextStyle) => ITooltipTextInfo;
 export {};

package/types/mark/text.d.ts

@@ -1,10 +1,12 @@
 import type { ITextMarkSpec } from '../typings/visual';
 import { BaseMark } from './base/base-mark';
 import type { IMarkRaw, IMarkStyle } from './interface';
-import { MarkTypeEnum } from './interface/type';
+import { MarkTypeEnum } from './interface';
+import type { IGroupMark } from '@visactor/vgrammar-core';
 export type ITextMark = IMarkRaw<ITextMarkSpec>;
 export declare class TextMark extends BaseMark<ITextMarkSpec> implements ITextMark {
     static readonly type = MarkTypeEnum.text;
     readonly type = MarkTypeEnum.text;
     protected _getDefaultStyle(): IMarkStyle<ITextMarkSpec>;
+    protected _initProduct(group?: string | IGroupMark): void;
 }

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

@@ -9,6 +9,7 @@ import type { IMarkProgressiveConfig } from '../../mark/interface';
 import type { StringOrNumber } from '../../typings';
 import type { TransformedLabelSpec } from '../../component/label';
 import type { SeriesMarkNameEnum } from './type';
+import type { ICustomPath2D } from '@visactor/vrender-core';
 export interface ISeriesSeriesInfo {
     key: string;
     index?: number;
@@ -66,6 +67,7 @@ export interface ISeriesMarkInitOption {
     progressive?: IMarkProgressiveConfig;
     label?: TransformedLabelSpec;
     support3d?: boolean;
+    customShape?: (datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D;
 }
 export interface ISeriesMarkInfo extends IModelMarkInfo {
     name: SeriesMarkNameEnum | string;

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

@@ -23,6 +23,7 @@ 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';
 export type IChartPadding = ILayoutOrientPadding | number;
 export interface IInitOption extends Omit<IRenderOption, 'pluginList'> {
     dom?: string | HTMLElement;
@@ -169,6 +170,7 @@ export type IMarkSpec<T extends ICommonSpec = ICommonSpec> = {
     style?: ConvertToMarkStyleSpec<T>;
     state?: Record<StateValue, IMarkStateSpec<T> | IMarkStateStyleSpec<T>>;
     support3d?: boolean;
+    customShape?: (datum: any[], attrs: any, path: ICustomPath2D) => ICustomPath2D;
 } & IMarkProgressiveConfig;
 export type IMarkStateFilter = {
     fields: {

package/types/typings/tooltip/line.d.ts

@@ -1,16 +1,17 @@
 import type { TooltipContentProperty } from './common';
 import type { ITooltipLabelActual, ITooltipLabelPattern } from './label';
 import type { ITooltipShapeActual, ITooltipShapePattern } from './shape';
+import type { TooltipRichTextAttrs } from '@visactor/vrender-components';
 export interface IToolTipLinePattern extends ITooltipShapePattern, ITooltipLabelPattern {
     key?: TooltipContentProperty<string>;
-    value?: TooltipContentProperty<string>;
+    value?: TooltipContentProperty<string | TooltipRichTextAttrs>;
     visible?: TooltipContentProperty<boolean>;
     isKeyAdaptive?: TooltipContentProperty<boolean>;
     spaceRow?: TooltipContentProperty<number>;
 }
 export interface IToolTipLineActual extends ITooltipShapeActual, ITooltipLabelActual {
     key?: string;
-    value?: string;
+    value?: string | TooltipRichTextAttrs;
     visible?: boolean;
     isKeyAdaptive?: boolean;
     spaceRow?: number;

package/types/typings/visual.d.ts

@@ -10,6 +10,7 @@ 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';
 export interface IVisualSpecBase<D, T> {
     type: ScaleType;
     domain: D[];
@@ -98,7 +99,6 @@ export interface ISymbolMarkSpec extends IFillMarkSpec {
 export interface ILineLikeMarkSpec extends IFillMarkSpec {
     curveType?: InterpolateType;
     defined?: boolean;
-    enableSegments?: boolean;
 }
 export interface IAreaMarkSpec extends ILineLikeMarkSpec {
     x1?: number;
@@ -116,7 +116,8 @@ export interface IRuleMarkSpec extends ILineMarkSpec {
     y1?: number;
 }
 export interface ITextMarkSpec extends IFillMarkSpec {
-    text?: StringOrNumber | string[];
+    type?: 'html' | 'rich' | 'text';
+    text?: StringOrNumber | string[] | IRichTextCharacter[] | Function;
     dx?: number;
     dy?: number;
     fontSize?: number;