@antv/s2-vue 2.0.0-next.5 → 2.0.0-next.6

package/esm/index.d.ts

@@ -60,6 +60,11 @@ declare type Adaptive = boolean | {
     getContainer?: () => HTMLElement;
 };
 
+declare interface AdjustLeafNodesParams {
+    leafNodes: Node_2_2[];
+    hierarchy: Hierarchy;
+}
+
 declare enum Aggregation {
     SUM = "SUM",
     MIN = "MIN",
@@ -69,7 +74,7 @@ declare enum Aggregation {
 
 declare interface AreaRange {
     start: number;
-    width: number;
+    size: number;
 }
 
 declare interface Background {
@@ -122,7 +127,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
     getMeta(): T;
     setMeta(viewMeta: T): void;
     getIconStyle(): IconTheme | undefined;
-    getTextAndIconPosition(iconCount?: number): {
+    getTextIconPosition(iconCount?: number): {
         text: {
             x: number;
             y: number;
@@ -233,8 +238,17 @@ declare interface BaseCellStyle {
 }
 
 declare interface BaseChartData {
+    /**
+     * 类型
+     */
     type: MiniChartTypes;
+    /**
+     * 数据
+     */
     data: RawData_2[];
+    /**
+     * 坐标轴数据
+     */
     encode?: {
         x: keyof RawData_2;
         y: keyof RawData_2;
@@ -573,6 +587,27 @@ declare abstract class BaseFacet {
     protected saveInitColumnLeafNodes(columnNodes?: Node_2_2[]): void;
     getHiddenColumnsInfo(columnNode: Node_2_2): HiddenColumnsInfo_2 | undefined;
     getCornerNodes(): Node_2_2[];
+    /**
+     * @description 自定义行头时, 叶子节点层级不定, 需要自动对齐其宽度, 填充空白
+     * -------------------------------------------------
+     * |  自定义节点 a-1  |  自定义节点 a-1-1              |
+     * |-------------   |-------------     |------------|
+     * |  自定义节点 b-1  |  自定义节点 b-1-1 |  指标 1    |
+     * -------------------------------------------------
+     */
+    adjustRowLeafNodesWidth(params: AdjustLeafNodesParams): void;
+    /**
+     * @description 自定义列头时, 叶子节点层级不定, 需要自动对齐其高度, 填充空白
+     * ------------------------------------------------------------------------
+     * |                       自定义节点 a-1                                   |
+     * |----------------------------------------------------------------------|
+     * |                 自定义节点 a-1-1               |                       |
+     * |-------------|-------------|------------------|   自定义节点 a-1-2      |
+     * |   指标 1    |  自定义节点 a-1-1-1    | 指标 2  |                        |
+     * ----------------------------------------------------------------------
+     */
+    adjustColLeafNodesHeight(params: AdjustLeafNodesParams): void;
+    adjustLeafNodesSize(type: 'width' | 'height'): ({ leafNodes, hierarchy }: AdjustLeafNodesParams) => void;
 }
 
 declare interface BaseFields {
@@ -638,11 +673,9 @@ declare interface BaseHeaderConfig {
     viewportWidth: number;
     viewportHeight: number;
     position: PointLike;
-    data: Node_2_2[];
+    nodes: Node_2_2[];
     spreadsheet: SpreadSheet_2;
     sortParam?: SortParam;
-    linkFields: string[] | ((meta: Node_2_2 | ViewMeta_2) => boolean);
-    hierarchyType: S2Options_2['hierarchyType'];
 }
 
 declare interface BaseNodeConfig {
@@ -1175,8 +1208,17 @@ declare interface BulletTheme {
 }
 
 declare interface BulletValue {
+    /**
+     * 类型
+     */
     type: MiniChartTypes.Bullet;
+    /**
+     * 当前值
+     */
     measure: number | string;
+    /**
+     * 目标值
+     */
     target: number | string;
     [key: string]: unknown;
 }
@@ -1298,15 +1340,16 @@ declare enum CellTypes {
 
 declare class ColCell extends HeaderCell {
     protected headerConfig: ColHeaderConfig;
-    /** 文字绘制起始坐标 */
-    protected textPosition: PointLike;
+    /** icon 绘制起始坐标 */
+    protected iconPosition: PointLike;
     get cellType(): CellTypes;
     protected getBorderPositions(): CellBorderPosition[];
     protected initCell(): void;
+    protected getFormattedFieldValue(): FormatResult;
     protected getMaxTextWidth(): number;
-    protected getIconPosition(): PointLike;
     protected isBolderText(): boolean;
     protected getTextPosition(): PointLike;
+    protected getIconPosition(): PointLike;
     protected getActionIconsWidth(): number;
     protected getColResizeArea(): Group | undefined;
     protected getHorizontalResizeAreaName(): string;
@@ -1362,6 +1405,7 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
     protected scrollGroup: Group;
     protected background: DisplayObject;
     constructor(cfg: ColHeaderConfig);
+    private initScrollGroup;
     /**
      * Make colHeader scroll with hScrollBar
      * @param scrollX horizontal offset
@@ -1371,9 +1415,9 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
     onColScroll(scrollX: number, type: string): void;
     protected clip(): void;
     clear(): void;
-    protected getCellInstance(item: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: ColHeaderConfig): S2CellType_2;
+    protected getCellInstance(node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: ColHeaderConfig): S2CellType_2;
     protected getCellGroup(node: Node_2_2): Group;
-    protected isColCellInRect(item: Node_2_2): boolean;
+    protected isColCellInRect(node: Node_2_2): boolean;
     protected layout(): void;
     protected offset(): void;
 }
@@ -1530,11 +1574,26 @@ export declare class CustomTooltip extends BaseTooltip {
 }
 
 declare interface CustomTreeNode {
+    /**
+     * 字段唯一标识
+     */
     field: string;
+    /**
+     * 标题
+     */
     title?: string;
+    /**
+     * 是否收起（默认都展开）
+     */
     collapsed?: boolean;
+    /**
+     * 字段描述
+     */
     description?: string;
-    children?: string[] | CustomTreeNode[];
+    /**
+     * 子节点
+     */
+    children?: CustomTreeNode[];
 }
 
 declare type Data = (RawData_2 & ExtraData) | undefined | null;
@@ -2383,7 +2442,11 @@ declare class Node_2_2 {
     isGrandTotals?: boolean;
     isSubTotals?: boolean;
     hiddenChildNodeInfo?: HiddenColumnsInfo_2 | null;
-    extra?: Record<string, any>;
+    extra?: {
+        description?: string;
+        isCustomNode?: boolean;
+        [key: string]: any;
+    };
     [key: string]: any;
     constructor(cfg: BaseNodeConfig);
     /**
@@ -2440,6 +2503,7 @@ declare class Node_2_2 {
      *
      */
     getTotalHeightForTreeHierarchy(): number;
+    isSeriesNumberNode(): boolean;
 }
 
 declare interface OffsetConfig {
@@ -2996,6 +3060,8 @@ declare class RootInteraction {
 
 declare class RowCell extends HeaderCell {
     protected headerConfig: RowHeaderConfig;
+    /** icon 绘制起始坐标 */
+    protected iconPosition: PointLike;
     get cellType(): CellTypes;
     protected getBorderPositions(): CellBorderPosition[];
     protected initCell(): void;
@@ -3013,10 +3079,7 @@ declare class RowCell extends HeaderCell {
     protected getContentIndent(): number;
     protected getTextIndent(): number;
     protected isTreeLevel(): any;
-    protected getIconPosition(): {
-        x: number;
-        y: number;
-    };
+    protected getIconPosition(): PointLike;
     protected getMaxTextWidth(): number;
     protected getTextArea(): {
         x: number;
@@ -3025,7 +3088,6 @@ declare class RowCell extends HeaderCell {
         height: number;
     };
     protected getTextPosition(): PointLike;
-    protected getIconYPosition(): number;
 }
 
 declare type RowCellCollapsedParams_2 = {
@@ -3203,10 +3265,25 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
 declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell | CornerCell | RowCell | SeriesNumberCell | MergedCell | TableCornerCell | TableSeriesCell | BaseCell<T>;
 
 declare interface S2DataConfig_2 {
+    /**
+     * 原始明细数据
+     */
     data: RawData_2[];
+    /**
+     * 维度字段
+     */
     fields: Fields;
+    /**
+     * 字段元数据
+     */
     meta?: Meta[];
+    /**
+     * 排序配置
+     */
     sortParams?: SortParams_2;
+    /**
+     * 筛选配置
+     */
     filterParams?: FilterParam[];
     [key: string]: unknown;
 }
@@ -4368,6 +4445,8 @@ declare abstract class SpreadSheet_2 extends EE {
     on: <K extends keyof EmitterType>(event: K, listener: EmitterType[K]) => this;
     emit: <K extends keyof EmitterType>(event: K, ...args: Parameters<EmitterType[K]>) => boolean;
     constructor(dom: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2 | null);
+    isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
+    isCustomColumnFields(): boolean;
     private setOverscrollBehavior;
     private restoreOverscrollBehavior;
     private setDebug;
@@ -4387,9 +4466,7 @@ declare abstract class SpreadSheet_2 extends EE {
      * Check if is pivot mode
      */
     abstract isPivotMode(): boolean;
-    abstract isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
     abstract isCustomRowFields(): boolean;
-    abstract isCustomColumnFields(): boolean;
     /**
      * tree type must be in strategy mode
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@antv/s2-vue",
-  "version": "2.0.0-next.5",
+  "version": "2.0.0-next.6",
   "main": "lib/index.js",
   "unpkg": "dist/index.min.js",
   "module": "esm/index.js",