@antv/s2-vue 1.2.0-alpha.1 → 1.3.0-alpha.1

package/esm/index.d.ts

@@ -143,7 +143,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
     protected abstract getTextPosition(): Point;
     getStyle<K extends keyof S2Theme = keyof CellThemes>(name?: K): DefaultCellTheme | S2Theme[K];
     protected getResizeAreaStyle(): ResizeArea;
-    protected shouldDrawResizeAreaByType(type: keyof ResizeActiveOptions): boolean | ResizeType;
+    protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType): boolean | ((cell: S2CellType<ViewMeta_2>) => boolean) | ResizeType | ((resizeInfo: ResizeInfo_2) => boolean);
     protected getCellArea(): {
         x: number;
         y: number;
@@ -310,6 +310,8 @@ declare abstract class BaseFacet {
     get scrollBarSize(): number;
     protected preCellIndexes: PanelIndexes;
     constructor(cfg: SpreadSheetFacetCfg);
+    protected getCellCustomWidth(node: Node_2_2, width: CellCustomWidth): number;
+    protected getCellDraggedWidth(node: Node_2_2): number;
     hideScrollBar: () => void;
     delayHideScrollBar: DebouncedFunc<() => void>;
     delayHideScrollbarOnMobile: () => void;
@@ -375,24 +377,16 @@ declare abstract class BaseFacet {
     private getScrollbarPosition;
     renderVScrollBar: (height: number, realHeight: number, scrollY: number) => void;
     getScrollBarOffset: (offset: number, scrollbar: ScrollBar) => number;
-    isScrollOverThePanelArea: ({ layerX, layerY }: Partial<S2WheelEvent>) => boolean;
-    isScrollOverTheCornerArea: ({ layerX, layerY }: Partial<S2WheelEvent>) => boolean;
-    updateHorizontalRowScrollOffset: ({ offset, layerX, layerY }: {
-        offset: any;
-        layerX: any;
-        layerY: any;
-    }) => void;
-    updateHorizontalScrollOffset: ({ offset, layerX, layerY }: {
-        offset: any;
-        layerX: any;
-        layerY: any;
-    }) => void;
-    isScrollToLeft: (deltaX: number) => boolean;
-    isScrollToRight: (deltaX: number) => boolean;
+    isScrollOverThePanelArea: ({ offsetX, offsetY }: CellScrollOffset) => boolean;
+    isScrollOverTheCornerArea: ({ offsetX, offsetY }: CellScrollOffset) => boolean;
+    updateHorizontalRowScrollOffset: ({ offset, offsetX, offsetY, }: CellScrollOffset) => void;
+    updateHorizontalScrollOffset: ({ offset, offsetX, offsetY, }: CellScrollOffset) => void;
+    isScrollToLeft: ({ deltaX, offsetX, offsetY }: CellScrollOffset) => boolean;
+    isScrollToRight: ({ deltaX, offsetX, offsetY }: CellScrollOffset) => boolean;
     isScrollToTop: (deltaY: number) => boolean;
     isScrollToBottom: (deltaY: number) => boolean;
     isVerticalScrollOverTheViewport: (deltaY: number) => boolean;
-    isHorizontalScrollOverTheViewport: (deltaX: number) => boolean;
+    isHorizontalScrollOverTheViewport: (scrollOffset: CellScrollOffset) => boolean;
     /**
      在当前表格滚动分两种情况:
      1. 当前表格无滚动条: 无需阻止外部容器滚动
@@ -400,7 +394,7 @@ declare abstract class BaseFacet {
      - 未滚动到顶部或底部: 当前表格滚动, 阻止外部容器滚动
      - 滚动到顶部或底部: 恢复外部容器滚动
      */
-    isScrollOverTheViewport: (deltaX: number, deltaY: number, layerY: number) => boolean;
+    isScrollOverTheViewport: (scrollOffset: CellScrollOffset) => boolean;
     cancelScrollFrame: () => boolean;
     clearScrollFrameIdOnMobile: () => void;
     /**
@@ -413,7 +407,7 @@ declare abstract class BaseFacet {
      */
     private stopScrollChainingIfNeeded;
     private stopScrollChaining;
-    onWheel: (event: S2WheelEvent) => void;
+    onWheel: (event: WheelEvent) => void;
     protected clip(scrollX: number, scrollY: number): void;
     /**
      * Translate panelGroup, rowHeader, cornerHeader, columnHeader ect
@@ -454,14 +448,13 @@ declare abstract class BaseFacet {
         cols: number[];
         rows: any[];
     };
-    drawGrid(): void;
+    updatePanelScrollGroup(): void;
     /**
      * When scroll behavior happened, only render one time in a period,
      * but render immediately in initiate
      * @protected
      */
     protected dynamicRenderCell(): void;
-    private putMergedCellsGroupToFront;
     private emitScrollEvent;
     protected onAfterScroll: DebouncedFunc<() => void>;
     protected saveInitColumnLeafNodes(columnNodes?: Node_2_2[]): void;
@@ -1070,6 +1063,8 @@ declare interface CellCfg {
     };
 }
 
+declare type CellCustomWidth = number | ((node: Node_2_2) => number);
+
 declare interface CellDataParams {
     query: DataType_2;
     isTotals?: boolean;
@@ -1085,6 +1080,14 @@ declare interface CellMeta_2 {
     [key: string]: unknown;
 }
 
+declare interface CellScrollOffset {
+    deltaX?: number;
+    deltaY?: number;
+    offset?: number;
+    offsetX: number;
+    offsetY: number;
+}
+
 declare interface CellScrollPosition_2 {
     scrollX: number;
     scrollY: number;
@@ -1161,6 +1164,7 @@ declare class ColCell extends HeaderCell {
 }
 
 declare interface ColCfg {
+    width?: CellCustomWidth;
     height?: number;
     widthByFieldValue?: Record<string, number>;
     heightByField?: Record<string, number>;
@@ -1593,7 +1597,7 @@ declare interface FormatResult {
     value: DataItem;
 }
 
-declare type Formatter = (v: unknown, data?: Data_2 | Data_2[]) => string;
+declare type Formatter = (v: unknown, data?: Data_2 | Data_2[], meta?: Node_2_2 | ViewMeta_2) => string;
 
 declare class Frame extends Group {
     cfg: FrameConfig;
@@ -1655,10 +1659,10 @@ declare interface GridAnalysisCellTheme {
 }
 
 declare class GridGroup extends Group {
-    private s2;
+    protected s2: SpreadSheet_2;
     constructor(cfg: any);
-    private gridGroup;
-    private gridInfo;
+    protected gridGroup: IGroup;
+    protected gridInfo: GridInfo;
     updateGrid: (gridInfo: GridInfo, id?: string) => void;
 }
 
@@ -1822,10 +1826,11 @@ declare interface InteractionOptions {
     hoverFocus?: boolean | HoverFocusOptions;
     enableCopy?: boolean;
     copyWithFormat?: boolean;
+    copyWithHeader?: boolean;
     autoResetSheetStyle?: boolean;
     hiddenColumnFields?: string[];
     scrollSpeedRatio?: ScrollSpeedRatio;
-    resize?: boolean | ResizeActiveOptions;
+    resize?: boolean | ResizeInteractionOptions;
     brushSelection?: boolean;
     multiSelection?: boolean;
     rangeSelection?: boolean;
@@ -2183,6 +2188,12 @@ declare type PanelIndexes = {
 };
 
 declare class PanelScrollGroup extends GridGroup {
+    protected mergedCellsGroup: IGroup;
+    constructor(cfg: any);
+    protected initMergedCellsGroup(): void;
+    updateMergedCells(): void;
+    addMergeCell(mergeCell: MergedCell): void;
+    update(gridInfo: GridInfo): void;
 }
 
 declare interface PartDrillDown {
@@ -2515,18 +2526,11 @@ declare interface RequiredPropOption<T = any> {
     required: true;
 }
 
-declare interface ResizeActiveOptions {
-    rowCellVertical?: boolean;
-    cornerCellHorizontal?: boolean;
-    colCellHorizontal?: boolean;
-    colCellVertical?: boolean;
-    rowResizeType?: ResizeType;
-}
-
 declare interface ResizeArea {
     size?: number;
     background?: string;
     guideLineColor?: string;
+    guideLineDisableColor?: string;
     guideLineDash?: number[];
     backgroundOpacity?: number;
     interactionState?: InteractionState;
@@ -2563,11 +2567,27 @@ declare interface ResizeInfo_2 {
     isResizeArea?: boolean;
     /** 字段id */
     id?: string;
+    /** 当前拖拽热区对应的节点信息 */
+    meta: Node_2_2 | ViewMeta_2;
+    /** 拖拽后的宽度 */
+    resizedWidth?: number;
+    /** 拖拽后的高度 */
+    resizedHeight?: number;
+}
+
+declare interface ResizeInteractionOptions {
+    rowCellVertical?: boolean;
+    cornerCellHorizontal?: boolean;
+    colCellHorizontal?: boolean;
+    colCellVertical?: boolean;
+    rowResizeType?: ResizeType;
+    disable?: (resizeInfo: ResizeInfo_2) => boolean;
+    visible?: (cell: S2CellType) => boolean;
 }
 
 declare interface ResizeParams_2 {
-    resizeInfo?: ResizeInfo_2;
-    style?: Style;
+    info: ResizeInfo_2;
+    style: Style;
 }
 
 declare enum ResizeType {
@@ -2676,9 +2696,12 @@ declare type RowCellCollapseTreeRowsType = {
 };
 
 declare interface RowCfg {
-    width?: number;
+    width?: CellCustomWidth;
     widthByField?: Record<string, number>;
     heightByField?: Record<string, number>;
+    /**
+     * @deprecated (已废弃, 请使用 style.treeRowsWidth 代替) tree row width(拖拽产生的，无需主动设置)
+     */
     treeRowsWidth?: number;
 }
 
@@ -2881,11 +2904,6 @@ declare interface S2Theme extends CellThemes {
     background?: Background;
 }
 
-declare interface S2WheelEvent extends WheelEvent {
-    layerX: number;
-    layerY: number;
-}
-
 declare class ScrollBar extends Group {
     isHorizontal: boolean;
     trackLen: number;
@@ -2904,19 +2922,16 @@ declare class ScrollBar extends Group {
     private eventHandlers;
     private scrollFrameId;
     constructor(scrollBarCfg: ScrollBarCfg);
-    getCoordinates: () => {
-        from: string;
-        to: string;
-    };
+    private getCoordinatesName;
     /**
-     * 当前滑块滑动的位置 0 ~ 1
+     * Antv/g 4.x 版本计算 bbox 有bug, 实际渲染的宽度会比给定的宽度大, 需要对其做修正
+     * 详情: https://github.com/antvis/S2/pull/1566/files#diff-3f08348041906ddf1e4f094bfe2ac32b35ff668918d3fbb952e9227ae462cc08R52
      */
-    current: () => number;
+    private getCoordinatesWithBBoxExtraPadding;
     /**
-     * 更新滑道长度
-     * @param newTrackLen 新的滑块长度
+     * 当前滑块滑动的位置 0 ~ 1
      */
-    updateTrackLen: (newTrackLen: number) => void;
+    current: () => number;
     /**
      * 更新滑块长度
      * @param newThumbLen 新的滑道长度
@@ -3821,7 +3836,6 @@ declare abstract class SpreadSheet_2 extends EE {
     backgroundGroup: IGroup;
     panelGroup: IGroup;
     panelScrollGroup: PanelScrollGroup;
-    mergedCellsGroup: IGroup;
     frozenRowGroup: FrozenGroup_2;
     frozenColGroup: FrozenGroup_2;
     frozenTrailingRowGroup: FrozenGroup_2;
@@ -3963,6 +3977,20 @@ declare abstract class SpreadSheet_2 extends EE {
     clearColumnLeafNodes(): void;
     private initHiddenColumnsDetail;
     private clearCanvasEvent;
+    /**
+     * 计算文本在画布中的宽度
+     * @param text 待计算的文本
+     * @param font 文本 css 样式
+     * @returns 文本宽度
+     */
+    measureTextWidth: ((text: number | string, font: unknown) => number) & MemoizedFunction;
+    /**
+     * 粗略计算文本在画布中的宽度
+     * @param text 待计算的文本
+     * @param font 文本 css 样式
+     * @returns 文本宽度
+     */
+    measureTextWidthRoughly: (text: any, font?: any) => number;
 }
 
 /**

package/esm/index.js

@@ -1619,17 +1619,20 @@ function size(collection) {
   }
   return baseKeys(collection).length;
 }
-const analyzeAdaptive = (paramsContainer, adaptive) => {
+const analyzeAdaptive = (defaultContainer, adaptive) => {
   var _a, _b, _c;
-  let container = paramsContainer;
-  let adaptiveWidth = true;
-  let adaptiveHeight = false;
-  if (typeof adaptive !== "boolean") {
-    container = ((_a = adaptive == null ? void 0 : adaptive.getContainer) == null ? void 0 : _a.call(adaptive)) || paramsContainer;
-    adaptiveWidth = (_b = adaptive == null ? void 0 : adaptive.width) != null ? _b : true;
-    adaptiveHeight = (_c = adaptive == null ? void 0 : adaptive.height) != null ? _c : true;
-  }
-  return { container, adaptiveWidth, adaptiveHeight };
+  if (isBoolean(adaptive)) {
+    return {
+      container: defaultContainer,
+      adaptiveWidth: true,
+      adaptiveHeight: false
+    };
+  }
+  return {
+    container: ((_a = adaptive == null ? void 0 : adaptive.getContainer) == null ? void 0 : _a.call(adaptive)) || defaultContainer,
+    adaptiveWidth: (_b = adaptive == null ? void 0 : adaptive.width) != null ? _b : true,
+    adaptiveHeight: (_c = adaptive == null ? void 0 : adaptive.height) != null ? _c : true
+  };
 };
 const createResizeObserver = (params) => {
   let isFirstRender = true;
@@ -2703,6 +2706,8 @@ const initBaseSheetEmits = () => {
     "selected",
     "reset",
     "linkFieldJump",
+    "click",
+    "doubleClick",
     "scroll"
   ];
   return keys2;
@@ -2975,7 +2980,7 @@ var DrillDown = /* @__PURE__ */ _export_sfc(_sfc_main$3, [["render", _sfc_render
 const _sfc_main$2 = defineComponent({
   name: "PivotSheet",
   props: initBaseSheetProps(),
-  emits: initBaseSheetEmits(),
+  emits: [],
   setup(props, ctx) {
     const s2Ref = useExpose(ctx.expose);
     const { options: pivotOptions } = toRefs(props);