@antv/s2-vue 2.0.0-next.7 → 2.0.0-next.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/index.d.ts CHANGED
@@ -1,11 +1,16 @@
1
1
  import { AllowedComponentProps } from 'vue';
2
2
  import { BaseTooltip } from '@antv/s2';
3
+ import { BaseTooltipOperatorMenuOptions } from '@antv/s2';
3
4
  import { Canvas } from '@antv/g';
5
+ import type { CanvasConfig } from '@antv/g';
4
6
  import type { CellScrollPosition } from '@antv/s2';
7
+ import { ColCell } from '@antv/s2';
5
8
  import { ComponentCustomProps } from 'vue';
6
9
  import { ComponentOptionsMixin } from 'vue';
7
10
  import { ComputedRef } from 'vue';
11
+ import { CornerCell } from '@antv/s2';
8
12
  import type * as CSS_2 from 'csstype';
13
+ import { CSSGlobalKeywords } from '@antv/g-lite/dist/css';
9
14
  import { DataCell } from '@antv/s2';
10
15
  import { DebouncedFunc } from 'lodash';
11
16
  import { DefineComponent } from 'vue';
@@ -16,6 +21,8 @@ import { ExtractPropTypes } from 'vue';
16
21
  import { FederatedPointerEvent } from '@antv/g';
17
22
  import { GEvent } from '@antv/s2';
18
23
  import { Group } from '@antv/g';
24
+ import { Group as Group_2 } from '@antv/g-lite';
25
+ import type { HeaderActionIcon } from '@antv/s2';
19
26
  import { HiddenColumnsInfo } from '@antv/s2';
20
27
  import { ICanvas } from '@antv/g';
21
28
  import type { IEventTarget } from '@antv/g';
@@ -25,6 +32,7 @@ import { LayoutResult } from '@antv/s2';
25
32
  import { Line } from '@antv/g';
26
33
  import { LineStyleProps } from '@antv/g';
27
34
  import { MemoizedFunction } from 'lodash';
35
+ import { MergedCell } from '@antv/s2';
28
36
  import { Node as Node_2 } from '@antv/s2';
29
37
  import { Pagination } from '@antv/s2';
30
38
  import type { PaginationProps } from 'ant-design-vue';
@@ -33,6 +41,7 @@ import { Polygon } from '@antv/g';
33
41
  import { PropType } from 'vue';
34
42
  import { RawData } from '@antv/s2';
35
43
  import { Rect } from '@antv/g';
44
+ import { Rectangle } from '@antv/g';
36
45
  import { Ref } from 'vue';
37
46
  import { ResizeInfo } from '@antv/s2';
38
47
  import { ResizeParams } from '@antv/s2';
@@ -43,6 +52,7 @@ import { S2MountContainer } from '@antv/s2';
43
52
  import { S2Options } from '@antv/s2';
44
53
  import { S2RenderOptions } from '@antv/s2';
45
54
  import { ScrollOffset } from '@antv/s2';
55
+ import { SeriesNumberCell } from '@antv/s2';
46
56
  import { ShallowRef } from 'vue';
47
57
  import { SortParams } from '@antv/s2';
48
58
  import { SpreadSheet } from '@antv/s2';
@@ -52,12 +62,9 @@ import { TextStyleProps } from '@antv/g';
52
62
  import { ThemeCfg } from '@antv/s2';
53
63
  import { Timer } from 'd3-timer';
54
64
  import { TooltipContentType } from '@antv/s2';
55
- import { ViewMeta } from '@antv/s2';
56
65
  import { ViewMetaData } from '@antv/s2';
57
66
  import { VNodeProps } from 'vue';
58
67
 
59
- declare type ActionIconName = string | FullyIconName;
60
-
61
68
  declare type Adaptive = boolean | {
62
69
  width?: boolean;
63
70
  height?: boolean;
@@ -122,24 +129,13 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
122
129
  protected textShapes: CustomText[];
123
130
  protected linkFieldShape: Line;
124
131
  protected actualText: string;
125
- protected actualTextWidth: number;
132
+ protected originalText: string;
126
133
  protected conditions: Conditions;
127
134
  protected conditionIntervalShape: Rect | undefined;
128
135
  protected conditionIconShape: GuiIcon;
129
136
  protected conditionIconShapes: GuiIcon[];
130
137
  protected groupedIcons: GroupedIcons;
131
138
  protected stateShapes: Map<StateShapeLayer, DisplayObject<any, any>>;
132
- constructor(meta: T, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]);
133
- getMeta(): T;
134
- setMeta(viewMeta: T): void;
135
- getIconStyle(): DeepRequired<IconTheme>;
136
- getActualText(): string;
137
- getFieldValue(): string;
138
- /**
139
- * in case there are more params to be handled
140
- * @param options any type's rest params
141
- */
142
- protected handleRestOptions(...options: unknown[]): void;
143
139
  /**
144
140
  * Return the type of the cell
145
141
  */
@@ -160,11 +156,64 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
160
156
  protected abstract getIconPosition(): PointLike;
161
157
  protected abstract findFieldCondition(conditions: Condition[] | undefined): Condition | undefined;
162
158
  protected abstract mappingValue(condition: Condition): ConditionMappingResult | undefined | null;
159
+ constructor(meta: T, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]);
160
+ /**
161
+ * in case there are more params to be handled
162
+ * @param options any type's rest params
163
+ */
164
+ protected handleRestOptions(...options: unknown[]): void;
165
+ getMeta(): T;
166
+ setMeta(viewMeta: T): void;
167
+ getIconStyle(): DeepRequired<IconTheme>;
168
+ /**
169
+ * 获取实际渲染的文本 (含省略号)
170
+ */
171
+ getActualText(): string;
172
+ /**
173
+ * 实际渲染的文本宽度, 如果是多行文本, 取最大的一行宽度
174
+ */
175
+ getActualTextWidth(): number;
176
+ /**
177
+ * 实际渲染的文本宽度, 如果是多行文本, 取每一行文本高度的总和)
178
+ * @alias getMultiLineActualTextHeight
179
+ */
180
+ getActualTextHeight(): number;
181
+ /**
182
+ * 获取实际渲染的多行文本 (含省略号)
183
+ */
184
+ getMultiLineActualTexts(): string[];
185
+ /**
186
+ * 实际渲染的多行文本宽度 (每一行文本宽度的总和)
187
+ */
188
+ getMultiLineActualTextWidth(): number;
189
+ /**
190
+ * 实际渲染的多行文本高度 (每一行文本高度的总和)
191
+ * @alias getActualTextHeight
192
+ */
193
+ getMultiLineActualTextHeight(): number;
194
+ /**
195
+ * 获取原始的文本 (不含省略号)
196
+ */
197
+ getOriginalText(): string;
198
+ /**
199
+ * 文本是否溢出 (有省略号)
200
+ */
201
+ isTextOverflowing(): boolean;
202
+ /**
203
+ * 是否是多行文本
204
+ */
205
+ isMultiLineText(): boolean;
206
+ getEmptyPlaceholder(): string | undefined;
207
+ /**
208
+ * 获取文本包围盒
209
+ */
210
+ getTextLineBoundingRects(): Rectangle[];
211
+ getFieldValue(): string;
163
212
  protected shouldInit(): boolean;
164
213
  getStyle<K extends keyof InternalFullyTheme = CellType>(name?: K): InternalFullyTheme[K] | InternalFullyCellTheme;
165
214
  getLinkFieldShape(): Line;
166
215
  protected getResizeAreaStyle(): ResizeArea;
167
- protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): boolean | ResizeType | ((resizeInfo: ResizeInfo_2) => boolean) | ((cell: S2CellType_2<ViewMeta_2>) => boolean) | undefined;
216
+ protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): boolean | ResizeType | ((resizeInfo: ResizeInfo_2) => boolean) | ((cell: S2CellType_2) => boolean) | undefined;
168
217
  getBBoxByType(type?: CellClipBox): SimpleBBox;
169
218
  drawBorders(): void;
170
219
  /**
@@ -181,10 +230,12 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
181
230
  * 交互使用的背景色
182
231
  */
183
232
  protected drawInteractiveBgShape(): void;
184
- protected drawTextShape(): void;
233
+ renderTextShape(style: TextStyleProps, options?: RenderTextShapeOptions): CustomText;
234
+ updateTextPosition(position?: PointLike): void;
235
+ drawTextShape(options?: RenderTextShapeOptions): void;
185
236
  protected drawLinkFieldShape(showLinkFieldShape: boolean, linkFillColor: string): void;
186
237
  protected getLinkFieldStyle(): string;
187
- protected drawLinkField(meta: Node_2_2 | ViewMeta_2): void;
238
+ protected drawLinkField(meta: Node_2_2 | ViewMeta): void;
188
239
  updateByState(stateName: InteractionStateName, cell: S2CellType_2): void;
189
240
  protected getInteractiveBorderShapeStyle<T>(borderSize: T & number): {
190
241
  x: number;
@@ -203,7 +254,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
203
254
  resetTextAndConditionIconShapes(): void;
204
255
  get cellConditions(): Conditions;
205
256
  drawConditionIconShapes(): void;
206
- getTextConditionMappingResult(): ConditionMappingResult<unknown> | null | undefined;
257
+ getTextConditionMappingResult(): ConditionMappingResult | null | undefined;
207
258
  getContainConditionMappingResultTextStyle(style: TextTheme | undefined): {
208
259
  fill: string;
209
260
  minValue?: number | undefined;
@@ -212,13 +263,19 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
212
263
  isCompare?: boolean | undefined;
213
264
  intelligentReverseTextColor?: boolean | undefined;
214
265
  fieldValue?: number | undefined;
215
- fontFamily?: string | undefined;
216
266
  fontSize?: number | undefined;
217
- fontWeight?: number | "bold" | "normal" | "bolder" | "lighter" | undefined;
218
267
  linkTextFill?: string | undefined;
219
- opacity?: number | undefined;
220
268
  textAlign?: TextAlign | undefined;
221
269
  textBaseline?: TextBaseline | undefined;
270
+ opacity?: string | number | undefined;
271
+ fontFamily?: string | undefined;
272
+ fontWeight?: number | "bold" | CSSGlobalKeywords | "normal" | "bolder" | "lighter" | undefined;
273
+ wordWrap?: boolean | undefined;
274
+ maxLines?: number | undefined;
275
+ lineHeight?: string | number | undefined;
276
+ textOverflow?: string | undefined;
277
+ fontStyle?: CSSGlobalKeywords | "normal" | "italic" | "oblique" | undefined;
278
+ fontVariant?: string | undefined;
222
279
  };
223
280
  /**
224
281
  * 获取默认字体颜色:根据字段标记背景颜色,设置字体颜色
@@ -233,7 +290,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
233
290
  intelligentReverseTextColor: boolean;
234
291
  backgroundColor?: undefined;
235
292
  };
236
- getIconConditionResult(): FullyIconName | undefined;
293
+ getIconConditionResult(): HeaderActionNameOptions | undefined;
237
294
  protected getActionAndConditionIconWidth(position?: IconPosition): number;
238
295
  }
239
296
 
@@ -280,6 +337,7 @@ declare interface BaseChartData {
280
337
  x: keyof RawData_2;
281
338
  y: keyof RawData_2;
282
339
  };
340
+ [key: string]: unknown;
283
341
  }
284
342
 
285
343
  declare interface BaseCornerOptions {
@@ -296,15 +354,36 @@ declare interface BaseDataSet {
296
354
  }
297
355
 
298
356
  declare abstract class BaseDataSet_2 {
357
+ /**
358
+ * 字段信息
359
+ */
299
360
  fields: Fields;
361
+ /**
362
+ * 字段元信息,包含有字段名、格式化、描述等
363
+ */
300
364
  meta: Meta[];
365
+ /**
366
+ * 原始数据
367
+ */
301
368
  originData: RawData_2[];
369
+ /**
370
+ * 二维索引数据
371
+ */
302
372
  indexesData: RawData_2[][] | RawData_2[];
373
+ /**
374
+ * 高级排序, 组内排序
375
+ */
303
376
  sortParams: SortParams_2 | undefined;
377
+ /**
378
+ * 筛选配置
379
+ */
304
380
  filterParams: FilterParam[] | undefined;
381
+ /**
382
+ * 表格实例
383
+ */
305
384
  protected spreadsheet: SpreadSheet_2;
306
- constructor(spreadsheet: SpreadSheet_2);
307
385
  protected displayData: RawData_2[];
386
+ constructor(spreadsheet: SpreadSheet_2);
308
387
  private getField;
309
388
  /**
310
389
  * 获取字段信息
@@ -319,12 +398,12 @@ declare abstract class BaseDataSet_2 {
319
398
  * 获取自定义单元格字段名称
320
399
  * @param cell
321
400
  */
322
- getCustomRowFieldName(cell: S2CellType_2<ViewMeta_2 | Node_2_2>): string | undefined;
401
+ getCustomRowFieldName(cell: S2CellType_2<ViewMeta | Node_2_2>): string | undefined;
323
402
  /**
324
403
  * 获取自定义单元格字段描述
325
404
  * @param cell
326
405
  */
327
- getCustomFieldDescription: (cell: S2CellType_2<ViewMeta_2 | Node_2_2>) => string | undefined;
406
+ getCustomFieldDescription: (cell: S2CellType_2<ViewMeta | Node_2_2>) => string | undefined;
328
407
  /**
329
408
  * 获得字段格式方法
330
409
  * @param field
@@ -335,8 +414,15 @@ declare abstract class BaseDataSet_2 {
335
414
  * @param field
336
415
  */
337
416
  getFieldDescription(field: CustomHeaderField): string | undefined;
417
+ /**
418
+ * 设置数据配置
419
+ * @param dataCfg
420
+ */
338
421
  setDataCfg(dataCfg: S2DataConfig_2): void;
339
- processMeta(meta: Meta[] | undefined, defaultExtraFieldText: string): Meta[];
422
+ /**
423
+ * 添加 (角头/数值虚拟字段) 格式化信息
424
+ */
425
+ getFieldMetaWithExtraField(meta: Meta[] | undefined, defaultExtraFieldText: string): Meta[];
340
426
  getDisplayDataSet(): RawData_2[];
341
427
  getValueRangeByField(field: string): ValueRange;
342
428
  /** ******************NEED IMPLEMENT BY USER CASE************************ */
@@ -346,6 +432,7 @@ declare abstract class BaseDataSet_2 {
346
432
  */
347
433
  abstract processDataCfg(dataCfg: S2DataConfig_2): S2DataConfig_2;
348
434
  /**
435
+ * 获取指定字段下的维值
349
436
  * 1、query !== null
350
437
  * province city => field
351
438
  * 辽宁省
@@ -359,30 +446,28 @@ declare abstract class BaseDataSet_2 {
359
446
  * query param is not necessary, when just
360
447
  * get some field's all dimension values
361
448
  *
362
- * @param field current dimensions
363
- * @param query dimension value query
449
+ * @param field
450
+ * @param query
364
451
  */
365
452
  abstract getDimensionValues(field: string, query?: Query): string[];
366
453
  /**
367
- * In most cases, this function to get the specific
368
- * cross data cell data
369
- * @param params
454
+ * 获取单个的单元格数据
370
455
  */
371
- abstract getCellData(params: CellDataParams): ViewMetaData_2 | undefined;
456
+ abstract getCellData(params: GetCellDataParams): ViewMetaData_2 | undefined;
372
457
  /**
373
- * To get a row or column cells data;
374
- * if query is empty, return all data
375
- * @param query
376
- * @param totals @TotalSelectionsOfMultiData
377
- * @param drillDownFields
458
+ * 获取批量的单元格数据
459
+ * 如果 query 为空, 则返回全量数据
460
+ */
461
+ abstract getCellMultiData(params: GetCellMultiDataParams): ViewMetaData_2[];
462
+ /**
463
+ * 是否超过 1 个数值
378
464
  */
379
- abstract getMultiData(query: Query, totals?: TotalSelectionsOfMultiData, drillDownFields?: string[]): Data[] | CellData[];
380
465
  moreThanOneValue(): boolean;
381
466
  /**
382
467
  * get a row cells data including cell
383
- * @param cells
468
+ * @param cellMeta
384
469
  */
385
- abstract getRowData(cells: CellMeta): RowData;
470
+ abstract getRowData(cellMeta: CellMeta): RowData;
386
471
  }
387
472
 
388
473
  declare interface BaseDrillDownComponentProps<DataSet = BaseDataSet> {
@@ -441,7 +526,8 @@ declare abstract class BaseFacet {
441
526
  gridInfo: GridInfo;
442
527
  protected abstract doLayout(): LayoutResult_2;
443
528
  abstract getViewCellHeights(): ViewCellHeights;
444
- abstract getCellMeta(rowIndex: number, colIndex: number): ViewMeta_2 | null;
529
+ abstract getCellMeta(rowIndex: number, colIndex: number): ViewMeta | null;
530
+ protected abstract getColNodeHeight(colNode: Node_2_2, colsHierarchy: Hierarchy): number;
445
531
  protected scrollFrameId: ReturnType<typeof requestAnimationFrame> | null;
446
532
  get scrollBarTheme(): DeepRequired<ScrollBarTheme>;
447
533
  get scrollBarSize(): number;
@@ -456,7 +542,12 @@ declare abstract class BaseFacet {
456
542
  protected getRowCellHeight(node: Node_2_2): number;
457
543
  protected getColCellDraggedWidth(node: Node_2_2): number | undefined;
458
544
  protected getColCellDraggedHeight(node: Node_2_2): number | undefined;
459
- protected getDefaultColNodeHeight(colNode: Node_2_2): number;
545
+ protected getDefaultColNodeHeight(colNode: Node_2_2, colsHierarchy: Hierarchy): number;
546
+ protected getCellAdaptiveHeight(cell: HeaderCell, defaultHeight: number): number;
547
+ /**
548
+ * 将每一层级的采样节点更新为高度最大的节点 (未隐藏, 非汇总节点)
549
+ */
550
+ protected updateColsHierarchySampleMaxHeightNodes(colsHierarchy: Hierarchy): void;
460
551
  hideScrollBar: () => void;
461
552
  delayHideScrollBar: DebouncedFunc<() => void>;
462
553
  delayHideScrollbarOnMobile: () => void;
@@ -569,8 +660,8 @@ declare abstract class BaseFacet {
569
660
  * @protected
570
661
  */
571
662
  protected translateRelatedGroups(scrollX: number, scrollY: number, hRowScroll: number): void;
572
- addCell: (cell: S2CellType_2<ViewMeta_2>) => void;
573
- realCellRender: (scrollX: number, scrollY: number) => void;
663
+ addDataCell: (cell: DataCell_2) => void;
664
+ realDataCellRender: (scrollX: number, scrollY: number) => void;
574
665
  protected init(): void;
575
666
  protected renderBackground(): void;
576
667
  /**
@@ -769,45 +860,45 @@ declare abstract class BaseFacet {
769
860
  /**
770
861
  * 获取列头单元格 (不含可视区域)
771
862
  */
772
- getColCells(): ColCell[];
863
+ getColCells(): ColCell_2[];
773
864
  /**
774
865
  * 获取列头叶子节点单元格 (不含可视区域)
775
866
  */
776
- getColLeafCells(): ColCell[];
867
+ getColLeafCells(): ColCell_2[];
777
868
  /**
778
869
  * 获取合并单元格 (不含可视区域)
779
870
  */
780
- getMergedCells(): MergedCell[];
871
+ getMergedCells(): MergedCell_2[];
781
872
  /**
782
873
  * 获取角头单元格
783
874
  */
784
- getCornerCells(): CornerCell[];
875
+ getCornerCells(): CornerCell_2[];
785
876
  /**
786
877
  * 获取序号单元格
787
878
  */
788
- abstract getSeriesNumberCells(): SeriesNumberCell[] | TableSeriesNumberCell[];
879
+ abstract getSeriesNumberCells(): SeriesNumberCell_2[] | TableSeriesNumberCell[];
789
880
  /**
790
881
  * 获取表头单元格 (角头,行头,列头) (不含可视区域)
791
882
  * @example 获取全部: facet.getHeaderCells()
792
883
  * @example 获取一组 facet.getHeaderCells(['root[&]浙江省[&]宁波市', 'root[&]浙江省[&]杭州市'])
793
884
  */
794
- getHeaderCells(cellIds?: string[]): S2CellType_2<ViewMeta_2>[];
885
+ getHeaderCells(cellIds?: string[]): S2CellType_2<ViewMeta>[];
795
886
  /**
796
887
  * 根据单元格 id 获取指定单元格 (不含可视区域)
797
888
  * @example facet.getCellById('root[&]浙江省[&]宁波市')
798
889
  */
799
- getCellById(cellId: string): S2CellType_2<ViewMeta_2> | undefined;
890
+ getCellById(cellId: string): S2CellType_2<ViewMeta> | undefined;
800
891
  /**
801
892
  * 根据单元格 field 获取指定单元格 (不含可视区域)
802
893
  * @example facet.getCellByField('city')
803
894
  */
804
- getCellsByField(cellField: string): S2CellType_2<ViewMeta_2>[];
895
+ getCellsByField(cellField: string): S2CellType_2<ViewMeta>[];
805
896
  /**
806
897
  * 获取所有单元格 (角头,行头,列头,数值) (不含可视区域)
807
898
  * @example 获取全部: facet.getCells()
808
899
  * @example 获取一组 facet.getCells(['root[&]浙江省[&]宁波市', 'root[&]浙江省[&]杭州市'])
809
900
  */
810
- getCells(cellIds?: string[]): S2CellType_2<ViewMeta_2>[];
901
+ getCells(cellIds?: string[]): S2CellType_2<ViewMeta>[];
811
902
  getInitColLeafNodes(): Node_2_2[];
812
903
  clearInitColLeafNodes(): void;
813
904
  }
@@ -829,8 +920,12 @@ declare interface BaseFields {
829
920
  * use {@see headerConfig} instead
830
921
  */
831
922
  declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
923
+ protected abstract layout(): void;
924
+ protected abstract offset(): void;
925
+ protected abstract clip(): void;
926
+ protected abstract getCellInstance(node: Node_2_2): S2CellType_2;
832
927
  protected headerConfig: T;
833
- protected constructor(cfg: T);
928
+ protected constructor(config: T);
834
929
  getHeaderConfig(): T;
835
930
  /**
836
931
  * 清空热区,为重绘做准备,防止热区重复渲染
@@ -851,9 +946,6 @@ declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
851
946
  * @param type
852
947
  */
853
948
  onRowScrollX(rowHeaderScrollX: number, type: string): void;
854
- protected abstract layout(): void;
855
- protected abstract offset(): void;
856
- protected abstract clip(): void;
857
949
  clear(): void;
858
950
  /**
859
951
  * Check whether header cell in viewPort
@@ -939,14 +1031,14 @@ loading: BooleanConstructor;
939
1031
  partDrillDown: ObjectConstructor;
940
1032
  header: ObjectConstructor;
941
1033
  options: {
942
- type: PropType<S2Options<TooltipContentType, Pagination, string | Element, string>>;
943
- default: S2Options<TooltipContentType, Pagination, string | Element, string>;
1034
+ type: PropType<SheetComponentOptions>;
1035
+ default: SheetComponentOptions;
944
1036
  };
945
1037
  adaptive: {
946
1038
  type: PropType<Adaptive>;
947
1039
  default: Adaptive;
948
1040
  };
949
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
1041
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
950
1042
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
951
1043
  }, {
952
1044
  S2_PREFIX_CLS: string;
@@ -965,7 +1057,7 @@ showSizeChange: (nextPageSize: number) => void;
965
1057
  handlePageChange: (nextCurrent: number) => void;
966
1058
  handlePageSizeChange: (nextSize: number) => void;
967
1059
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
968
- spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet;
1060
+ spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => SpreadSheet;
969
1061
  sheetUpdate: SheetUpdateCallback;
970
1062
  rowCellHover: (data: TargetCellInfo) => void;
971
1063
  rowCellClick: (data: TargetCellInfo) => void;
@@ -977,6 +1069,7 @@ rowCellMouseMove: (data: TargetCellInfo) => void;
977
1069
  rowCellCollapsed: (params: RowCellCollapsedParams) => void;
978
1070
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
979
1071
  rowCellScroll: (position: Required<ScrollOffset>) => void;
1072
+ rowCellRender: (cell: ColCell) => void;
980
1073
  colCellHover: (data: TargetCellInfo) => void;
981
1074
  colCellClick: (data: TargetCellInfo) => void;
982
1075
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -989,6 +1082,7 @@ colCellHidden: (data: {
989
1082
  currentHiddenColumnsInfo: HiddenColumnsInfo;
990
1083
  hiddenColumnsDetail: HiddenColumnsInfo[];
991
1084
  }) => void;
1085
+ colCellRender: (cell: ColCell) => void;
992
1086
  dataCellHover: (data: TargetCellInfo) => void;
993
1087
  dataCellClick: (data: TargetCellInfo) => void;
994
1088
  dataCellDoubleClick: (data: TargetCellInfo) => void;
@@ -997,7 +1091,8 @@ dataCellMouseDown: (data: TargetCellInfo) => void;
997
1091
  dataCellMouseUp: (data: TargetCellInfo) => void;
998
1092
  dataCellMouseMove: (data: TargetCellInfo) => void;
999
1093
  dataCellBrushSelection: (brushRangeDataCells: DataCell[]) => void;
1000
- dataCellSelectMove: (metas: ViewMetaData[]) => void;
1094
+ dataCellSelectMove: (metaList: ViewMetaData[]) => void;
1095
+ dataCellRender: (cell: DataCell) => void;
1001
1096
  cornerCellHover: (data: TargetCellInfo) => void;
1002
1097
  cornerCellClick: (data: TargetCellInfo) => void;
1003
1098
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -1005,6 +1100,7 @@ cornerCellContextMenu: (data: TargetCellInfo) => void;
1005
1100
  cornerCellMouseDown: (data: TargetCellInfo) => void;
1006
1101
  cornerCellMouseUp: (data: TargetCellInfo) => void;
1007
1102
  cornerCellMouseMove: (data: TargetCellInfo) => void;
1103
+ cornerCellRender: (cell: CornerCell) => void;
1008
1104
  mergedCellsHover: (data: TargetCellInfo) => void;
1009
1105
  mergedCellsClick: (data: TargetCellInfo) => void;
1010
1106
  mergedCellsDoubleClick: (data: TargetCellInfo) => void;
@@ -1012,6 +1108,8 @@ mergedCellsContextMenu: (data: TargetCellInfo) => void;
1012
1108
  mergedCellsMouseDown: (data: TargetCellInfo) => void;
1013
1109
  mergedCellsMouseUp: (data: TargetCellInfo) => void;
1014
1110
  mergedCellsMouseMove: (data: TargetCellInfo) => void;
1111
+ mergedCellsRender: (cell: MergedCell) => void;
1112
+ seriesNumberCellRender: (cell: SeriesNumberCell) => void;
1015
1113
  rangeSort: (params: SortParams) => void;
1016
1114
  rangeSorted: (event: GEvent) => void;
1017
1115
  rangeFilter: (data: {
@@ -1021,7 +1119,7 @@ filteredValues: string[];
1021
1119
  rangeFiltered: (data: ViewMetaData[]) => void;
1022
1120
  layoutAfterHeaderLayout: (layoutResult: LayoutResult) => void;
1023
1121
  layoutPagination: (data: LayoutPaginationParams) => void;
1024
- layoutCellMounted: (cell: S2CellType<ViewMeta>) => void;
1122
+ layoutCellRender: <T extends S2CellType = S2CellType>(cell: T) => void;
1025
1123
  beforeRender: () => void;
1026
1124
  afterRender: () => void;
1027
1125
  mounted: (spreadsheet: SpreadSheet) => void;
@@ -1059,7 +1157,7 @@ mouseHover: (event: GEvent) => void;
1059
1157
  mouseUp: (event: MouseEvent) => void;
1060
1158
  mouseDown: (event: MouseEvent) => void;
1061
1159
  mouseMove: (event: MouseEvent) => void;
1062
- selected: (cells: S2CellType<ViewMeta>[]) => void;
1160
+ selected: (cells: S2CellType[]) => void;
1063
1161
  reset: (event: KeyboardEvent) => void;
1064
1162
  linkFieldJump: (data: {
1065
1163
  field: string;
@@ -1091,14 +1189,14 @@ loading: BooleanConstructor;
1091
1189
  partDrillDown: ObjectConstructor;
1092
1190
  header: ObjectConstructor;
1093
1191
  options: {
1094
- type: PropType<S2Options<TooltipContentType, Pagination, string | Element, string>>;
1095
- default: S2Options<TooltipContentType, Pagination, string | Element, string>;
1192
+ type: PropType<SheetComponentOptions>;
1193
+ default: SheetComponentOptions;
1096
1194
  };
1097
1195
  adaptive: {
1098
1196
  type: PropType<Adaptive>;
1099
1197
  default: Adaptive;
1100
1198
  };
1101
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
1199
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
1102
1200
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
1103
1201
  }>> & {
1104
1202
  onSheetUpdate?: (params: S2RenderOptions) => any;
@@ -1112,6 +1210,7 @@ onRowCellMouseMove?: (data: TargetCellInfo) => any;
1112
1210
  onRowCellCollapsed?: (params: RowCellCollapsedParams) => any;
1113
1211
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
1114
1212
  onRowCellScroll?: (position: Required<ScrollOffset>) => any;
1213
+ onRowCellRender?: (cell: ColCell) => any;
1115
1214
  onColCellHover?: (data: TargetCellInfo) => any;
1116
1215
  onColCellClick?: (data: TargetCellInfo) => any;
1117
1216
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1124,6 +1223,7 @@ onColCellHidden?: (data: {
1124
1223
  currentHiddenColumnsInfo: HiddenColumnsInfo;
1125
1224
  hiddenColumnsDetail: HiddenColumnsInfo[];
1126
1225
  }) => any;
1226
+ onColCellRender?: (cell: ColCell) => any;
1127
1227
  onDataCellHover?: (data: TargetCellInfo) => any;
1128
1228
  onDataCellClick?: (data: TargetCellInfo) => any;
1129
1229
  onDataCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1132,7 +1232,8 @@ onDataCellMouseDown?: (data: TargetCellInfo) => any;
1132
1232
  onDataCellMouseUp?: (data: TargetCellInfo) => any;
1133
1233
  onDataCellMouseMove?: (data: TargetCellInfo) => any;
1134
1234
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => any;
1135
- onDataCellSelectMove?: (metas: ViewMetaData[]) => any;
1235
+ onDataCellSelectMove?: (metaList: ViewMetaData[]) => any;
1236
+ onDataCellRender?: (cell: DataCell) => any;
1136
1237
  onCornerCellHover?: (data: TargetCellInfo) => any;
1137
1238
  onCornerCellClick?: (data: TargetCellInfo) => any;
1138
1239
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1140,6 +1241,7 @@ onCornerCellContextMenu?: (data: TargetCellInfo) => any;
1140
1241
  onCornerCellMouseDown?: (data: TargetCellInfo) => any;
1141
1242
  onCornerCellMouseUp?: (data: TargetCellInfo) => any;
1142
1243
  onCornerCellMouseMove?: (data: TargetCellInfo) => any;
1244
+ onCornerCellRender?: (cell: CornerCell) => any;
1143
1245
  onMergedCellsHover?: (data: TargetCellInfo) => any;
1144
1246
  onMergedCellsClick?: (data: TargetCellInfo) => any;
1145
1247
  onMergedCellsDoubleClick?: (data: TargetCellInfo) => any;
@@ -1147,6 +1249,8 @@ onMergedCellsContextMenu?: (data: TargetCellInfo) => any;
1147
1249
  onMergedCellsMouseDown?: (data: TargetCellInfo) => any;
1148
1250
  onMergedCellsMouseUp?: (data: TargetCellInfo) => any;
1149
1251
  onMergedCellsMouseMove?: (data: TargetCellInfo) => any;
1252
+ onMergedCellsRender?: (cell: MergedCell) => any;
1253
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell) => any;
1150
1254
  onRangeSort?: (params: SortParams) => any;
1151
1255
  onRangeSorted?: (event: GEvent) => any;
1152
1256
  onRangeFilter?: (data: {
@@ -1156,7 +1260,7 @@ filteredValues: string[];
1156
1260
  onRangeFiltered?: (data: ViewMetaData[]) => any;
1157
1261
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult) => any;
1158
1262
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
1159
- onLayoutCellMounted?: (cell: S2CellType<ViewMeta>) => any;
1263
+ onLayoutCellRender?: (cell: S2CellType) => any;
1160
1264
  onBeforeRender?: () => any;
1161
1265
  onAfterRender?: () => any;
1162
1266
  onMounted?: (spreadsheet: SpreadSheet) => any;
@@ -1194,7 +1298,7 @@ onMouseHover?: (event: GEvent) => any;
1194
1298
  onMouseUp?: (event: MouseEvent) => any;
1195
1299
  onMouseDown?: (event: MouseEvent) => any;
1196
1300
  onMouseMove?: (event: MouseEvent) => any;
1197
- onSelected?: (cells: S2CellType<ViewMeta>[]) => any;
1301
+ onSelected?: (cells: S2CellType[]) => any;
1198
1302
  onReset?: (event: KeyboardEvent) => any;
1199
1303
  onLinkFieldJump?: (data: {
1200
1304
  field: string;
@@ -1208,9 +1312,9 @@ spreadsheet: SpreadSheet;
1208
1312
  }) => any;
1209
1313
  onRowCellBrushSelection?: (event: GEvent) => any;
1210
1314
  onColCellBrushSelection?: (event: GEvent) => any;
1211
- onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => any;
1315
+ onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => any;
1212
1316
  }, {
1213
- options: S2Options<TooltipContentType, Pagination, string | Element, string>;
1317
+ options: SheetComponentOptions;
1214
1318
  loading: boolean;
1215
1319
  adaptive: boolean | {
1216
1320
  width?: boolean;
@@ -1221,16 +1325,15 @@ showPagination: boolean | {
1221
1325
  onShowSizeChange?: (pageSize: number) => void;
1222
1326
  onChange?: (current: number) => void;
1223
1327
  };
1224
- }>;
1328
+ }, {}>;
1225
1329
 
1226
- declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillDown = PartDrillDown, Header = unknown, Options = S2Options<TooltipContentType, Pagination>> {
1330
+ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Header = unknown, Options = S2Options<TooltipContentType, Pagination>> {
1227
1331
  sheetType?: SheetType;
1228
1332
  spreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: Options) => SpreadSheet;
1229
1333
  dataCfg: S2DataConfig;
1230
1334
  options?: Options;
1231
1335
  loading?: boolean;
1232
1336
  partDrillDown?: PartialDrillDown;
1233
- renderConfig?: RenderHandler;
1234
1337
  adaptive?: Adaptive;
1235
1338
  showPagination?: boolean | {
1236
1339
  onShowSizeChange?: (pageSize: number) => void;
@@ -1250,6 +1353,7 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1250
1353
  onRowCellCollapsed?: (params: RowCellCollapsedParams) => void;
1251
1354
  onRowCellAllCollapsed?: (isCollapsed: boolean) => void;
1252
1355
  onRowCellScroll?: (position: CellScrollPosition) => void;
1356
+ onRowCellRender?: (cell: ColCell) => void;
1253
1357
  onColCellHover?: (data: TargetCellInfo) => void;
1254
1358
  onColCellClick?: (data: TargetCellInfo) => void;
1255
1359
  onColCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1262,6 +1366,7 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1262
1366
  currentHiddenColumnsInfo: HiddenColumnsInfo;
1263
1367
  hiddenColumnsDetail: HiddenColumnsInfo[];
1264
1368
  }) => void;
1369
+ onColCellRender?: (cell: ColCell) => void;
1265
1370
  onDataCellHover?: (data: TargetCellInfo) => void;
1266
1371
  onDataCellClick?: (data: TargetCellInfo) => void;
1267
1372
  onDataCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1270,7 +1375,8 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1270
1375
  onDataCellMouseUp?: (data: TargetCellInfo) => void;
1271
1376
  onDataCellMouseMove?: (data: TargetCellInfo) => void;
1272
1377
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => void;
1273
- onDataCellSelectMove?: (metas: ViewMetaData[]) => void;
1378
+ onDataCellSelectMove?: (metaList: ViewMetaData[]) => void;
1379
+ onDataCellRender?: (cell: DataCell) => void;
1274
1380
  onCornerCellHover?: (data: TargetCellInfo) => void;
1275
1381
  onCornerCellClick?: (data: TargetCellInfo) => void;
1276
1382
  onCornerCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1278,6 +1384,7 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1278
1384
  onCornerCellMouseDown?: (data: TargetCellInfo) => void;
1279
1385
  onCornerCellMouseUp?: (data: TargetCellInfo) => void;
1280
1386
  onCornerCellMouseMove?: (data: TargetCellInfo) => void;
1387
+ onCornerCellRender?: (cell: CornerCell) => void;
1281
1388
  onMergedCellsHover?: (data: TargetCellInfo) => void;
1282
1389
  onMergedCellsClick?: (data: TargetCellInfo) => void;
1283
1390
  onMergedCellsDoubleClick?: (data: TargetCellInfo) => void;
@@ -1285,6 +1392,9 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1285
1392
  onMergedCellsMouseDown?: (data: TargetCellInfo) => void;
1286
1393
  onMergedCellsMouseUp?: (data: TargetCellInfo) => void;
1287
1394
  onMergedCellsMouseMove?: (data: TargetCellInfo) => void;
1395
+ onMergedCellsRender?: (cell: MergedCell) => void;
1396
+ /** ================ SeriesNumber Cell ================ */
1397
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell) => void;
1288
1398
  onRangeSort?: (params: SortParams) => void;
1289
1399
  onRangeSorted?: (event: GEvent) => void;
1290
1400
  onRangeFilter?: (data: {
@@ -1294,7 +1404,7 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1294
1404
  onRangeFiltered?: (data: ViewMetaData[]) => void;
1295
1405
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult) => void;
1296
1406
  onLayoutPagination?: (data: LayoutPaginationParams) => void;
1297
- onLayoutCellMounted?: (cell: S2CellType) => void;
1407
+ onLayoutCellRender?: <T extends S2CellType = S2CellType>(cell: T) => void;
1298
1408
  onBeforeRender?: () => void;
1299
1409
  onAfterRender?: () => void;
1300
1410
  onMounted?: (spreadsheet: SpreadSheet) => void;
@@ -1349,16 +1459,24 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1349
1459
  }
1350
1460
 
1351
1461
  /**
1352
- * Base tooltips component
1462
+ * Tooltip 基类
1463
+ * @see https://s2.antv.antgroup.com/manual/basic/tooltip#%E8%87%AA%E5%AE%9A%E4%B9%89
1464
+ * @example
1465
+ * import CustomTooltip extends BaseTooltip {
1466
+ renderContent() {}
1467
+ show() {}
1468
+ hide() {}
1469
+ destroy() {}
1470
+ }
1353
1471
  */
1354
- declare class BaseTooltip_2 {
1472
+ declare class BaseTooltip_2<Content = TooltipContentType_2, Menu = BaseTooltipOperatorMenuOptions_2> {
1355
1473
  visible: boolean;
1356
1474
  spreadsheet: SpreadSheet_2;
1357
1475
  container: HTMLElement | null;
1358
- options: TooltipShowOptions;
1476
+ options: TooltipShowOptions<Content, Menu>;
1359
1477
  position: TooltipPosition;
1360
1478
  constructor(spreadsheet: SpreadSheet_2);
1361
- show<T = Element | string>(options: TooltipShowOptions<T>): void;
1479
+ show<T = Content, M = Menu>(options: TooltipShowOptions<T, M>): void;
1362
1480
  hide(): void;
1363
1481
  destroy(): void;
1364
1482
  renderContent<T = TooltipContentType_2>(content: T): void;
@@ -1368,7 +1486,7 @@ declare class BaseTooltip_2 {
1368
1486
  private getContainer;
1369
1487
  }
1370
1488
 
1371
- declare interface BaseTooltipConfig<T = TooltipContentType_2, Icon = Element | string, Text = string> {
1489
+ declare interface BaseTooltipConfig<T = TooltipContentType_2, Menu = BaseTooltipOperatorMenuOptions_2> {
1372
1490
  /**
1373
1491
  * 是否开启 tooltip, 在点击/悬停/停留/刷选/多选等场景会显示
1374
1492
  * @description @antv/s2 中只保留了 tooltip 的核心显隐逻辑,提供相应数据,不渲染内容
@@ -1385,7 +1503,7 @@ declare interface BaseTooltipConfig<T = TooltipContentType_2, Icon = Element | s
1385
1503
  * 自定义操作项
1386
1504
  * @see https://s2.antv.antgroup.com/manual/basic/tooltip#%E8%87%AA%E5%AE%9A%E4%B9%89
1387
1505
  */
1388
- operation?: TooltipOperation<Icon, Text>;
1506
+ operation?: TooltipOperation<Menu>;
1389
1507
  /**
1390
1508
  * 显示边界, 当 tooltip 超过边界时自动调整显示位置,container: 图表区域,body: 整个浏览器窗口,设置为 `null` 可关闭此功能
1391
1509
  */
@@ -1394,7 +1512,7 @@ declare interface BaseTooltipConfig<T = TooltipContentType_2, Icon = Element | s
1394
1512
  * 自定义 Tooltip 类
1395
1513
  * @see https://s2.antv.antgroup.com/zh/examples/react-component/tooltip/#custom-tooltip
1396
1514
  */
1397
- render?: (spreadsheet: SpreadSheet_2) => BaseTooltip_2;
1515
+ render?: (spreadsheet: SpreadSheet_2) => BaseTooltip_2<T, Menu>;
1398
1516
  /**
1399
1517
  * 自定义坐标
1400
1518
  */
@@ -1402,7 +1520,7 @@ declare interface BaseTooltipConfig<T = TooltipContentType_2, Icon = Element | s
1402
1520
  /**
1403
1521
  * 自定义挂载容器, 默认 body
1404
1522
  */
1405
- getContainer?: () => HTMLElement;
1523
+ getContainer?: () => HTMLElement | null;
1406
1524
  /**
1407
1525
  * 容器类名
1408
1526
  */
@@ -1413,6 +1531,8 @@ declare interface BaseTooltipConfig<T = TooltipContentType_2, Icon = Element | s
1413
1531
  style?: CSS_2.Properties;
1414
1532
  }
1415
1533
 
1534
+ declare type BaseTooltipOperatorMenuOptions_2 = TooltipOperatorMenuOptions<Element | string, string>;
1535
+
1416
1536
  declare interface BBox {
1417
1537
  x: number;
1418
1538
  y: number;
@@ -1472,8 +1592,11 @@ declare interface BulletValue {
1472
1592
  declare interface CalcTotals {
1473
1593
  /** 聚合方式 */
1474
1594
  aggregation?: Aggregation;
1475
- /** 自定义计算 */
1476
- calcFunc?: (query: Query, arr: CellData[]) => number;
1595
+ /**
1596
+ * 自定义计算汇总
1597
+ * @see https://s2.antv.antgroup.com/examples/analysis/totals/#custom
1598
+ */
1599
+ calcFunc?: (query: Query, data: CellData[]) => number;
1477
1600
  }
1478
1601
 
1479
1602
  declare type CanvasEventHandler = (event: FederatedPointerEvent) => void;
@@ -1490,7 +1613,7 @@ declare enum CellBorderPosition {
1490
1613
  RIGHT = "RIGHT"
1491
1614
  }
1492
1615
 
1493
- declare type CellCallback<T extends BaseHeaderConfig> = (node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: T) => S2CellType_2;
1616
+ declare type CellCallback<T extends BaseHeaderConfig, K extends S2CellType_2> = (node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: T) => K;
1494
1617
 
1495
1618
  /**
1496
1619
  * 类似 background-clip 属性: https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip
@@ -1528,13 +1651,6 @@ declare class CellData {
1528
1651
  get [VALUE_FIELD](): DataItem;
1529
1652
  }
1530
1653
 
1531
- declare interface CellDataParams {
1532
- query: Query;
1533
- isTotals?: boolean;
1534
- rowNode?: Node_2_2;
1535
- isRow?: boolean;
1536
- }
1537
-
1538
1654
  declare type CellEventTarget = FederatedPointerEvent['target'] | null | undefined | EventTarget | IEventTarget;
1539
1655
 
1540
1656
  declare interface CellMeta {
@@ -1594,8 +1710,7 @@ declare enum CellType {
1594
1710
  MERGED_CELL = "mergedCell"
1595
1711
  }
1596
1712
 
1597
- declare class ColCell extends HeaderCell {
1598
- protected headerConfig: ColHeaderConfig;
1713
+ declare class ColCell_2 extends HeaderCell<ColHeaderConfig> {
1599
1714
  get cellType(): CellType;
1600
1715
  protected getBorderPositions(): CellBorderPosition[];
1601
1716
  protected initCell(): void;
@@ -1656,7 +1771,8 @@ declare interface ColCellStyle extends BaseCellStyle {
1656
1771
  declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1657
1772
  protected scrollGroup: Group;
1658
1773
  protected background: DisplayObject;
1659
- constructor(cfg: ColHeaderConfig);
1774
+ constructor(config: ColHeaderConfig);
1775
+ protected getCellInstance(node: Node_2_2): S2CellType_2;
1660
1776
  private initScrollGroup;
1661
1777
  /**
1662
1778
  * Make colHeader scroll with hScrollBar
@@ -1667,7 +1783,6 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1667
1783
  onColScroll(scrollX: number, type: string): void;
1668
1784
  protected clip(): void;
1669
1785
  clear(): void;
1670
- protected getCellInstance(node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: ColHeaderConfig): S2CellType_2;
1671
1786
  protected getCellGroup(node: Node_2_2): Group;
1672
1787
  protected isColCellInRect(node: Node_2_2): boolean;
1673
1788
  protected layout(): void;
@@ -1736,15 +1851,13 @@ declare class CornerBBox extends BaseBBox {
1736
1851
  private adjustCornerBBoxWidth;
1737
1852
  }
1738
1853
 
1739
- declare class CornerCell extends HeaderCell {
1740
- cornerType: CornerNodeType;
1741
- protected headerConfig: CornerHeaderConfig;
1742
- protected isBolderText(): boolean;
1854
+ declare class CornerCell_2 extends HeaderCell<CornerHeaderConfig> {
1743
1855
  get cellType(): CellType;
1856
+ protected isBolderText(): boolean;
1744
1857
  protected getBorderPositions(): CellBorderPosition[];
1745
1858
  update(): void;
1746
1859
  protected initCell(): void;
1747
- protected drawTextShape(): void;
1860
+ drawTextShape(options?: RenderTextShapeOptions): void;
1748
1861
  /**
1749
1862
  * 绘制折叠展开的icon
1750
1863
  */
@@ -1758,13 +1871,14 @@ declare class CornerCell extends HeaderCell {
1758
1871
  protected getMaxTextWidth(): number;
1759
1872
  protected getTextPosition(): PointLike;
1760
1873
  protected getFormattedFieldValue(): FormatResult;
1761
- protected getCornerText(): string;
1762
1874
  }
1763
1875
 
1764
1876
  /**
1765
1877
  * Corner Header for SpreadSheet
1766
1878
  */
1767
1879
  declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1880
+ constructor(config: CornerHeaderConfig);
1881
+ protected getCellInstance(node: Node_2_2): CornerCell_2;
1768
1882
  /**
1769
1883
  * Get corner Header by config
1770
1884
  */
@@ -1778,7 +1892,6 @@ declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1778
1892
  width: number;
1779
1893
  height: number;
1780
1894
  }): Node_2_2[];
1781
- constructor(cfg: CornerHeaderConfig);
1782
1895
  /**
1783
1896
  * Make cornerHeader scroll with hScrollBar
1784
1897
  * @param scrollX
@@ -1823,12 +1936,22 @@ declare interface CustomInteraction {
1823
1936
  }
1824
1937
 
1825
1938
  declare interface CustomSVGIcon {
1826
- /** icon 名称 */
1939
+ /**
1940
+ * icon 名称
1941
+ */
1827
1942
  name: string;
1828
1943
  /**
1829
- * 1、base 64
1830
- * 2svg本地文件(兼容老方式,可以改颜色)
1831
- * 3、线上支持的图片地址
1944
+ * @example 1、base64
1945
+ * @example 2. svg本地文件 (兼容老方式, 可以改颜色)
1946
+
1947
+ import Icon from 'path/to/xxx.svg'
1948
+
1949
+ => { name: 'iconA', svg: Icon }
1950
+ => { name: 'iconB', svg: '<svg>...</svg>' }
1951
+
1952
+ * @example 3. 线上支持的图片地址
1953
+ 带后缀: https://gw.alipayobjects.com/zos/antfincdn/gu1Fsz3fw0/filter%26sort_filter.svg
1954
+ 无后缀: https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*5nsESLuvc_EAAAAAAAAAAAAADmJ7AQ/original
1832
1955
  */
1833
1956
  svg: string;
1834
1957
  }
@@ -1885,9 +2008,28 @@ declare type Data = (RawData_2 & ExtraData) | undefined | null;
1885
2008
  * 2、icon align in right with size {@link ICON_SIZE}
1886
2009
  * 3、left rect area is interval(in left) and text(in right)
1887
2010
  */
1888
- declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2011
+ declare class DataCell_2 extends BaseCell<ViewMeta> {
1889
2012
  iconPosition: PointLike;
1890
2013
  get cellType(): CellType;
2014
+ isMultiData(): boolean;
2015
+ isChartData(): boolean;
2016
+ getRenderChartData(): BaseChartData;
2017
+ getRenderChartOptions(): {
2018
+ type: MiniChartTypes;
2019
+ data: RawData_2[];
2020
+ encode?: {
2021
+ x: string;
2022
+ y: string;
2023
+ } | undefined;
2024
+ x: number;
2025
+ y: number;
2026
+ width: number;
2027
+ height: number;
2028
+ autoFit: boolean;
2029
+ theme: {
2030
+ type: string;
2031
+ };
2032
+ };
1891
2033
  protected getBorderPositions(): CellBorderPosition[];
1892
2034
  get valueRangeByField(): ValueRange;
1893
2035
  protected handleByStateName(cells: CellMeta[], stateName: InteractionStateName): void;
@@ -1895,8 +2037,8 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
1895
2037
  protected handleSelect(cells: CellMeta[]): void;
1896
2038
  protected handleHover(cells: CellMeta[]): void;
1897
2039
  update(): void;
1898
- setMeta(viewMeta: ViewMeta_2): void;
1899
- protected drawTextShape(): void;
2040
+ setMeta(viewMeta: ViewMeta): void;
2041
+ drawTextShape(options?: RenderTextShapeOptions): void;
1900
2042
  protected initCell(): void;
1901
2043
  protected generateIconConfig(): void;
1902
2044
  protected getTextStyle(): TextTheme;
@@ -1931,7 +2073,7 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
1931
2073
  private toggleConditionIntervalShapeOpacity;
1932
2074
  }
1933
2075
 
1934
- declare type DataCellCallback = (viewMeta: ViewMeta_2) => S2CellType_2;
2076
+ declare type DataCellCallback = (viewMeta: ViewMeta) => DataCell_2;
1935
2077
 
1936
2078
  declare interface DataCellStyle {
1937
2079
  /**
@@ -2036,6 +2178,7 @@ declare interface EmitterType {
2036
2178
  [S2Event.DATA_CELL_CONTEXT_MENU]: CanvasEventHandler;
2037
2179
  [S2Event.DATA_CELL_BRUSH_SELECTION]: (cells: (DataCell_2 | CellMeta)[]) => void;
2038
2180
  [S2Event.DATA_CELL_SELECT_MOVE]: (metas: CellMeta[]) => void;
2181
+ [S2Event.DATA_CELL_RENDER]: (cell: DataCell_2) => void;
2039
2182
  /** ================ Row Cell ================ */
2040
2183
  [S2Event.ROW_CELL_MOUSE_DOWN]: CanvasEventHandler;
2041
2184
  [S2Event.ROW_CELL_MOUSE_MOVE]: CanvasEventHandler;
@@ -2050,6 +2193,7 @@ declare interface EmitterType {
2050
2193
  [S2Event.ROW_CELL_COLLAPSED__PRIVATE]: (data: RowCellCollapsedParams_2) => void;
2051
2194
  [S2Event.ROW_CELL_ALL_COLLAPSED]: (isCollapsed: boolean) => void;
2052
2195
  [S2Event.ROW_CELL_ALL_COLLAPSED__PRIVATE]: (isCollapsed: boolean) => void;
2196
+ [S2Event.ROW_CELL_RENDER]: (cell: RowCell) => void;
2053
2197
  /** ================ Col Cell ================ */
2054
2198
  [S2Event.COL_CELL_MOUSE_DOWN]: CanvasEventHandler;
2055
2199
  [S2Event.COL_CELL_MOUSE_MOVE]: CanvasEventHandler;
@@ -2058,9 +2202,10 @@ declare interface EmitterType {
2058
2202
  [S2Event.COL_CELL_DOUBLE_CLICK]: CanvasEventHandler;
2059
2203
  [S2Event.COL_CELL_CONTEXT_MENU]: CanvasEventHandler;
2060
2204
  [S2Event.COL_CELL_MOUSE_UP]: CanvasEventHandler;
2061
- [S2Event.COL_CELL_BRUSH_SELECTION]: (cells: ColCell[]) => void;
2205
+ [S2Event.COL_CELL_BRUSH_SELECTION]: (cells: ColCell_2[]) => void;
2062
2206
  [S2Event.COL_CELL_EXPANDED]: (expandedNode: Node_2_2) => void;
2063
2207
  [S2Event.COL_CELL_HIDDEN]: (currentHiddenColumnsInfo: HiddenColumnsInfo_2, hiddenColumnsDetail: HiddenColumnsInfo_2[]) => void;
2208
+ [S2Event.COL_CELL_RENDER]: (cell: ColCell_2) => void;
2064
2209
  /** ================ Corner Cell ================ */
2065
2210
  [S2Event.CORNER_CELL_MOUSE_MOVE]: CanvasEventHandler;
2066
2211
  [S2Event.CORNER_CELL_MOUSE_DOWN]: CanvasEventHandler;
@@ -2069,6 +2214,7 @@ declare interface EmitterType {
2069
2214
  [S2Event.CORNER_CELL_DOUBLE_CLICK]: CanvasEventHandler;
2070
2215
  [S2Event.CORNER_CELL_CONTEXT_MENU]: CanvasEventHandler;
2071
2216
  [S2Event.CORNER_CELL_MOUSE_UP]: CanvasEventHandler;
2217
+ [S2Event.CORNER_CELL_RENDER]: (cell: CornerCell_2) => void;
2072
2218
  /** ================ Merged Cells ================ */
2073
2219
  [S2Event.MERGED_CELLS_MOUSE_DOWN]: CanvasEventHandler;
2074
2220
  [S2Event.MERGED_CELLS_MOUSE_MOVE]: CanvasEventHandler;
@@ -2077,6 +2223,9 @@ declare interface EmitterType {
2077
2223
  [S2Event.MERGED_CELLS_CLICK]: CanvasEventHandler;
2078
2224
  [S2Event.MERGED_CELLS_CONTEXT_MENU]: CanvasEventHandler;
2079
2225
  [S2Event.MERGED_CELLS_DOUBLE_CLICK]: CanvasEventHandler;
2226
+ [S2Event.MERGED_CELLS_RENDER]: (cell: MergedCell_2) => void;
2227
+ /** ================ SeriesNumber Cell ================ */
2228
+ [S2Event.SERIES_NUMBER_CELL_RENDER]: (cell: SeriesNumberCell_2) => void;
2080
2229
  /** ================ Layout ================ */
2081
2230
  [S2Event.LAYOUT_PAGINATION]: (data: {
2082
2231
  pageSize: number;
@@ -2090,7 +2239,7 @@ declare interface EmitterType {
2090
2239
  remove: [number, number][];
2091
2240
  spreadsheet: SpreadSheet_2;
2092
2241
  }) => void;
2093
- [S2Event.LAYOUT_CELL_MOUNTED]: (cell: S2CellType_2) => void;
2242
+ [S2Event.LAYOUT_CELL_RENDER]: <T extends S2CellType_2>(cell: T) => void;
2094
2243
  [S2Event.LAYOUT_BEFORE_RENDER]: () => void;
2095
2244
  [S2Event.LAYOUT_AFTER_RENDER]: () => void;
2096
2245
  [S2Event.LAYOUT_DESTROY]: () => void;
@@ -2191,7 +2340,13 @@ declare interface FormatResult {
2191
2340
  value: DataItem;
2192
2341
  }
2193
2342
 
2194
- declare type Formatter = (v: unknown, data?: ViewMetaData_2 | ViewMetaData_2[], meta?: Node_2_2 | ViewMeta_2) => string;
2343
+ /**
2344
+ * 第二个参数在以下情况会传入:
2345
+ * 1. data cell 格式化
2346
+ * 2. copy/export
2347
+ * 3. tooltip, 且仅在选择多个单元格时,data 类型为数组
2348
+ */
2349
+ declare type Formatter = (v: unknown, data?: ViewMetaData_2 | ViewMetaData_2[], meta?: Node_2_2 | ViewMeta) => string;
2195
2350
 
2196
2351
  declare class Frame extends Group {
2197
2352
  cfg: FrameConfig;
@@ -2232,12 +2387,39 @@ declare interface FrameConfig {
2232
2387
  declare class FrozenGroup extends GridGroup {
2233
2388
  }
2234
2389
 
2235
- declare type FullyIconName = {
2236
- name: string;
2237
- position: IconPosition;
2238
- fill?: string;
2239
- isConditionIcon?: boolean;
2240
- };
2390
+ declare interface GetCellDataParams {
2391
+ /**
2392
+ * 查询条件
2393
+ */
2394
+ query: Query;
2395
+ /**
2396
+ * 是否是汇总节点
2397
+ */
2398
+ isTotals?: boolean;
2399
+ /**
2400
+ * 行头节点, 用于下钻场景
2401
+ */
2402
+ rowNode?: Node_2_2;
2403
+ /**
2404
+ * 是否是行头
2405
+ */
2406
+ isRow?: boolean;
2407
+ }
2408
+
2409
+ declare interface GetCellMultiDataParams {
2410
+ /**
2411
+ * 查询条件
2412
+ */
2413
+ query: Query;
2414
+ /**
2415
+ * 汇总
2416
+ */
2417
+ totals?: TotalSelectionsOfMultiData;
2418
+ /**
2419
+ * 下钻
2420
+ */
2421
+ drillDownFields?: string[];
2422
+ }
2241
2423
 
2242
2424
  declare type GetInitProps<T, OptionalKeys = GetOptionalKeys<T>> = {
2243
2425
  [K in keyof T as IsEmitKey<T[K]> extends true ? never : K]-?: K extends OptionalKeys ? PropOption<NonNullable<T[K]>> : RequiredPropOption<NonNullable<T[K]>>;
@@ -2279,7 +2461,7 @@ declare interface GridInfo {
2279
2461
  }
2280
2462
 
2281
2463
  declare type GroupedIcons = {
2282
- [key in IconPosition]: FullyIconName[];
2464
+ [key in IconPosition]: HeaderActionNameOptions[];
2283
2465
  };
2284
2466
 
2285
2467
  /**
@@ -2290,6 +2472,7 @@ declare class GuiIcon extends Group {
2290
2472
  iconImageShape: CustomImage;
2291
2473
  private cfg;
2292
2474
  constructor(cfg: GuiIconCfg);
2475
+ getCfg(): GuiIconCfg;
2293
2476
  getImage(name: string, cacheKey: string, fill?: string): Promise<HTMLImageElement>;
2294
2477
  /**
2295
2478
  * 1. https://xxx.svg
@@ -2331,57 +2514,95 @@ declare class HdAdapter {
2331
2514
  private renderByZoomScale;
2332
2515
  }
2333
2516
 
2334
- declare interface HeaderActionIcon {
2517
+ declare interface HeaderActionIcon_2 extends HeaderActionIconBaseOptions {
2335
2518
  /**
2336
- * 已注册的 icon 类型或自定义的 icon 类型名
2519
+ * 内置 icon 或通过 @customSVGIcons 自定义的 icon 名称
2337
2520
  * 如果是 string[], 则默认 icon 位置为右侧
2521
+ * @see https://s2.antv.antgroup.com/manual/advanced/custom/custom-icon
2522
+ * @example icons: ['iconNameA', 'iconNameB']
2523
+ * @example icons: [{ name: 'iconNameA', position: "left", fill: "red" }]
2524
+ */
2525
+ icons: HeaderActionName[];
2526
+ /**
2527
+ * 所属的 cell 类型, 即当前 icon 展示在哪种类型单元格中
2528
+ * @example belongsCell: 'rowCell'
2529
+ */
2530
+ belongsCell: Omit<CellType, 'dataCell' | 'mergedCell' | 'seriesNumberCell'>;
2531
+ }
2532
+
2533
+ declare interface HeaderActionIconBaseOptions {
2534
+ /**
2535
+ * 是否默认隐藏, 开启后 hover 后才显示, 关闭后则始终显示, 可根据当前单元格信息动态判断
2536
+ * @example defaultHide: (meta, iconName) => meta.id === 'xxx'
2537
+ * @default false
2338
2538
  */
2339
- icons: ActionIconName[];
2340
- belongsCell: Omit<CellType, 'dataCell'>;
2341
- /** 是否默认隐藏, true 为 hover后显示, false 为一直显示 */
2342
2539
  defaultHide?: boolean | ((meta: Node_2_2, iconName: string) => boolean);
2343
- /** 是否展示当前 iconNames 配置的 icon */
2540
+ /**
2541
+ * 是否展示, 可根据当前单元格信息动态判断
2542
+ * @example displayCondition: (meta, iconName) => !meta.isTotals
2543
+ */
2344
2544
  displayCondition?: (mete: Node_2_2, iconName: string) => boolean;
2345
- /** 点击回调函数 */
2545
+ /**
2546
+ * 点击回调函数
2547
+ */
2346
2548
  onClick?: (headerIconClickParams: HeaderIconClickParams) => void;
2347
- /** 悬停回调函数 */
2549
+ /**
2550
+ * 悬停回调函数
2551
+ */
2348
2552
  onHover?: (headerIconHoverParams: HeaderIconHoverParams) => void;
2349
2553
  }
2350
2554
 
2351
- declare interface HeaderActionIconOptions {
2352
- iconName: string;
2555
+ declare interface HeaderActionIconOptions extends HeaderActionIconBaseOptions {
2556
+ fill?: string;
2557
+ name: string;
2353
2558
  x: number;
2354
2559
  y: number;
2355
- onClick?: (headerIconClickParams: HeaderIconClickParams) => void;
2356
- onHover?: (headerIconHoverParams: HeaderIconHoverParams) => void;
2357
2560
  isSortIcon?: boolean;
2358
- defaultHide?: boolean;
2359
2561
  }
2360
2562
 
2361
- declare abstract class HeaderCell extends BaseCell<Node_2_2> {
2362
- protected headerConfig: BaseHeaderConfig;
2563
+ declare type HeaderActionName = string | Omit<HeaderActionNameOptions, 'isConditionIcon'>;
2564
+
2565
+ declare type HeaderActionNameOptions = HeaderActionIconBaseOptions & {
2566
+ /**
2567
+ * icon 颜色配置
2568
+ * @description 优先级: 单个 icon > 主题 icon 配置 > 文本颜色
2569
+ */
2570
+ fill?: string;
2571
+ /**
2572
+ * icon 名称
2573
+ */
2574
+ name: string;
2575
+ /**
2576
+ * icon 相对文本的位置
2577
+ * 可选: 'left' | 'right'
2578
+ */
2579
+ position?: IconPosition;
2580
+ /**
2581
+ * 是否是条件格式的 icon
2582
+ */
2583
+ isConditionIcon?: boolean;
2584
+ };
2585
+
2586
+ declare abstract class HeaderCell<T extends BaseHeaderConfig = BaseHeaderConfig> extends BaseCell<Node_2_2> {
2587
+ protected headerConfig: T;
2363
2588
  protected actionIconConfig: InternalFullyHeaderActionIcon | undefined;
2364
2589
  protected treeIcon: GuiIcon | undefined;
2365
2590
  protected treeLeafNodeAlignDot: DisplayObject | undefined;
2366
2591
  protected actionIcons: GuiIcon[];
2367
2592
  protected hasDefaultHiddenIcon: boolean;
2368
- protected conditionIconMappingResult: FullyIconName | undefined;
2593
+ protected conditionIconMappingResult: HeaderActionNameOptions | undefined;
2369
2594
  /** left icon 绘制起始坐标 */
2370
2595
  protected leftIconPosition: PointLike;
2371
- /** left icon 绘制起始坐标 */
2596
+ /** right icon 绘制起始坐标 */
2372
2597
  protected rightIconPosition: PointLike;
2373
2598
  protected abstract isBolderText(): boolean;
2374
- protected handleRestOptions(...[headerConfig]: [BaseHeaderConfig]): void;
2599
+ getHeaderConfig(): T;
2600
+ protected handleRestOptions(...[headerConfig]: [T]): void;
2375
2601
  protected initCell(): void;
2376
2602
  protected generateIconConfig(): void;
2377
2603
  protected getFormattedFieldValue(): FormatResult;
2378
2604
  protected showSortIcon(): boolean | "" | undefined;
2379
- protected getActionIconsCount(): number;
2380
- protected getActionIconStyle(): {
2381
- width: number;
2382
- height: number;
2383
- fill: string;
2384
- };
2605
+ protected getActionIconStyle(options: Partial<HeaderActionIconOptions>): Partial<GuiIconCfg>;
2385
2606
  protected hasDefaultHideActionIcon(): boolean;
2386
2607
  protected addActionIcon(options: HeaderActionIconOptions): void;
2387
2608
  protected drawActionAndConditionIcons(): void;
@@ -2407,10 +2628,11 @@ declare abstract class HeaderCell extends BaseCell<Node_2_2> {
2407
2628
  mappingValue(condition: Condition): ConditionMappingResult;
2408
2629
  findFieldCondition(conditions: Condition[]): Condition | undefined;
2409
2630
  getTreeIcon(): GuiIcon | undefined;
2631
+ getActionIcons(): GuiIcon[];
2410
2632
  }
2411
2633
 
2412
2634
  declare interface HeaderIconClickParams {
2413
- iconName: string;
2635
+ name: string;
2414
2636
  meta: Node_2_2;
2415
2637
  event?: FederatedPointerEvent;
2416
2638
  }
@@ -2505,7 +2727,7 @@ declare interface InteractionOptions {
2505
2727
  * 链接跳转
2506
2728
  * @see https://s2.antv.antgroup.com/manual/advanced/interaction/link-jump
2507
2729
  */
2508
- linkFields?: string[] | ((meta: Node_2_2 | ViewMeta_2) => boolean);
2730
+ linkFields?: string[] | ((meta: Node_2_2 | ViewMeta) => boolean);
2509
2731
  /**
2510
2732
  * 选中单元格高亮聚焦
2511
2733
  */
@@ -2668,8 +2890,8 @@ declare enum InterceptType {
2668
2890
 
2669
2891
  declare type InternalFullyCellTheme = DeepRequired<DefaultCellTheme>;
2670
2892
 
2671
- declare interface InternalFullyHeaderActionIcon extends HeaderActionIcon {
2672
- icons: FullyIconName[];
2893
+ declare interface InternalFullyHeaderActionIcon extends HeaderActionIcon_2 {
2894
+ icons: HeaderActionNameOptions[];
2673
2895
  isSortIcon?: boolean;
2674
2896
  }
2675
2897
 
@@ -2693,7 +2915,7 @@ declare type LayoutArrange = (spreadsheet: SpreadSheet_2, parent: Node_2_2, fiel
2693
2915
  /**
2694
2916
  * determine the data of cells in Cartesian coordinates
2695
2917
  */
2696
- declare type LayoutCellMeta = (viewMeta: ViewMeta_2) => ViewMeta_2 | null;
2918
+ declare type LayoutCellMeta = (viewMeta: ViewMeta) => ViewMeta | null;
2697
2919
 
2698
2920
  /**
2699
2921
  * determine the location(x,y,width,height eg..) of every node
@@ -2792,24 +3014,21 @@ declare type MatrixPlainTransformer = (data: DataItem[][], separator?: string) =
2792
3014
  /**
2793
3015
  * Cell for panelGroup area
2794
3016
  */
2795
- declare class MergedCell extends DataCell_2 {
3017
+ declare class MergedCell_2 extends DataCell_2 {
2796
3018
  cells: S2CellType_2[];
2797
- constructor(spreadsheet: SpreadSheet_2, cells: S2CellType_2[], meta?: ViewMeta_2);
2798
- handleRestOptions(...[cells]: [S2CellType_2[]]): void;
2799
3019
  get cellType(): CellType;
3020
+ constructor(spreadsheet: SpreadSheet_2, cells: S2CellType_2[], meta?: ViewMeta);
3021
+ handleRestOptions(...[cells]: [S2CellType_2[]]): void;
2800
3022
  update(): void;
2801
3023
  protected initCell(): void;
2802
3024
  /**
2803
3025
  * Draw merged cells background
2804
3026
  */
2805
3027
  protected drawBackgroundShape(): void;
2806
- /**
2807
- * Render data text
2808
- */
2809
- drawTextShape(): void;
3028
+ drawTextShape(options?: RenderTextShapeOptions): void;
2810
3029
  }
2811
3030
 
2812
- declare type MergedCellCallback = (spreadsheet: SpreadSheet_2, cells: S2CellType_2[], meta?: ViewMeta_2) => MergedCell;
3031
+ declare type MergedCellCallback = (spreadsheet: SpreadSheet_2, cells: S2CellType_2[], meta?: ViewMeta) => MergedCell_2;
2813
3032
 
2814
3033
  declare interface MergedCellInfo {
2815
3034
  colIndex?: number;
@@ -2906,7 +3125,7 @@ declare class Node_2_2 {
2906
3125
  isPivotMode: boolean;
2907
3126
  seriesNumberWidth: number;
2908
3127
  spreadsheet: SpreadSheet_2;
2909
- query?: Record<string, any>;
3128
+ query?: Query;
2910
3129
  belongsCell?: S2CellType_2 | null | undefined;
2911
3130
  inCollapseNode?: boolean;
2912
3131
  cornerType?: CornerNodeType;
@@ -3011,6 +3230,25 @@ declare interface Pagination_2 {
3011
3230
  }
3012
3231
 
3013
3232
  declare interface Palette extends PaletteMeta {
3233
+ /**
3234
+ * 基础色值(共15个)
3235
+ *
3236
+ * 1. 角头字体、列头字体
3237
+ * 2. 行头背景、数据格背景(斑马纹)
3238
+ * 3. 行头&数据格交互(hover、选中、十字)
3239
+ * 4. 角头背景、列头背景
3240
+ * 5. 列头交互(hover、选中)
3241
+ * 6. 刷选遮罩
3242
+ * 7. 行头 link
3243
+ * 8. mini bar、resize 交互(参考线等)
3244
+ * 9. 数据格背景(非斑马纹)、整体表底色(建议白色)
3245
+ * 10. 行头边框、数据格边框
3246
+ * 11. 角头边框、列头边框
3247
+ * 12. 竖向大分割线
3248
+ * 13. 横向大分割线
3249
+ * 14. 数据格字体
3250
+ * 15. 行头字体、数据格交互色(hover)
3251
+ */
3014
3252
  basicColors: string[];
3015
3253
  }
3016
3254
 
@@ -3065,18 +3303,17 @@ declare class PanelScrollGroup extends GridGroup {
3065
3303
  getMergedCellsGroup(): Group;
3066
3304
  protected initMergedCellsGroup(): void;
3067
3305
  updateMergedCells(): void;
3068
- addMergeCell(mergeCell: MergedCell): void;
3306
+ addMergeCell(mergedCell: MergedCell_2): void;
3069
3307
  update(gridInfo: GridInfo): void;
3070
3308
  }
3071
3309
 
3072
- declare interface PartDrillDown<T = BaseDrillDownComponentProps> {
3310
+ declare interface PartDrillDown<T = BaseDrillDownComponentProps> extends Pick<HeaderActionIcon, 'displayCondition'> {
3073
3311
  drillConfig: T;
3074
3312
  drillItemsNum?: number;
3075
3313
  fetchData: (meta: Node_2, drillFields: string[]) => Promise<PartDrillDownInfo>;
3076
3314
  clearDrillDown?: {
3077
3315
  rowId: string;
3078
3316
  };
3079
- displayCondition?: (meta: Node_2) => boolean;
3080
3317
  }
3081
3318
 
3082
3319
  declare interface PartDrillDownFieldInLevel {
@@ -3107,20 +3344,20 @@ loading: BooleanConstructor;
3107
3344
  partDrillDown: ObjectConstructor;
3108
3345
  header: ObjectConstructor;
3109
3346
  options: {
3110
- type: PropType<S2Options<TooltipContentType, Pagination, string | Element, string>>;
3111
- default: S2Options<TooltipContentType, Pagination, string | Element, string>;
3347
+ type: PropType<SheetComponentOptions>;
3348
+ default: SheetComponentOptions;
3112
3349
  };
3113
3350
  adaptive: {
3114
3351
  type: PropType<Adaptive>;
3115
3352
  default: Adaptive;
3116
3353
  };
3117
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
3354
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
3118
3355
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
3119
3356
  }, {
3120
3357
  s2Ref: ShallowRef<SheetExpose>;
3121
- options: S2Options<TooltipContentType, Pagination, string | Element, string>;
3358
+ options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>;
3122
3359
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3123
- spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet;
3360
+ spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => SpreadSheet;
3124
3361
  sheetUpdate: SheetUpdateCallback;
3125
3362
  rowCellHover: (data: TargetCellInfo) => void;
3126
3363
  rowCellClick: (data: TargetCellInfo) => void;
@@ -3132,6 +3369,7 @@ rowCellMouseMove: (data: TargetCellInfo) => void;
3132
3369
  rowCellCollapsed: (params: RowCellCollapsedParams) => void;
3133
3370
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
3134
3371
  rowCellScroll: (position: Required<ScrollOffset>) => void;
3372
+ rowCellRender: (cell: ColCell) => void;
3135
3373
  colCellHover: (data: TargetCellInfo) => void;
3136
3374
  colCellClick: (data: TargetCellInfo) => void;
3137
3375
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3144,6 +3382,7 @@ colCellHidden: (data: {
3144
3382
  currentHiddenColumnsInfo: HiddenColumnsInfo;
3145
3383
  hiddenColumnsDetail: HiddenColumnsInfo[];
3146
3384
  }) => void;
3385
+ colCellRender: (cell: ColCell) => void;
3147
3386
  dataCellHover: (data: TargetCellInfo) => void;
3148
3387
  dataCellClick: (data: TargetCellInfo) => void;
3149
3388
  dataCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3152,7 +3391,8 @@ dataCellMouseDown: (data: TargetCellInfo) => void;
3152
3391
  dataCellMouseUp: (data: TargetCellInfo) => void;
3153
3392
  dataCellMouseMove: (data: TargetCellInfo) => void;
3154
3393
  dataCellBrushSelection: (brushRangeDataCells: DataCell[]) => void;
3155
- dataCellSelectMove: (metas: ViewMetaData[]) => void;
3394
+ dataCellSelectMove: (metaList: ViewMetaData[]) => void;
3395
+ dataCellRender: (cell: DataCell) => void;
3156
3396
  cornerCellHover: (data: TargetCellInfo) => void;
3157
3397
  cornerCellClick: (data: TargetCellInfo) => void;
3158
3398
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3160,6 +3400,7 @@ cornerCellContextMenu: (data: TargetCellInfo) => void;
3160
3400
  cornerCellMouseDown: (data: TargetCellInfo) => void;
3161
3401
  cornerCellMouseUp: (data: TargetCellInfo) => void;
3162
3402
  cornerCellMouseMove: (data: TargetCellInfo) => void;
3403
+ cornerCellRender: (cell: CornerCell) => void;
3163
3404
  mergedCellsHover: (data: TargetCellInfo) => void;
3164
3405
  mergedCellsClick: (data: TargetCellInfo) => void;
3165
3406
  mergedCellsDoubleClick: (data: TargetCellInfo) => void;
@@ -3167,6 +3408,8 @@ mergedCellsContextMenu: (data: TargetCellInfo) => void;
3167
3408
  mergedCellsMouseDown: (data: TargetCellInfo) => void;
3168
3409
  mergedCellsMouseUp: (data: TargetCellInfo) => void;
3169
3410
  mergedCellsMouseMove: (data: TargetCellInfo) => void;
3411
+ mergedCellsRender: (cell: MergedCell) => void;
3412
+ seriesNumberCellRender: (cell: SeriesNumberCell) => void;
3170
3413
  rangeSort: (params: SortParams) => void;
3171
3414
  rangeSorted: (event: GEvent) => void;
3172
3415
  rangeFilter: (data: {
@@ -3176,7 +3419,7 @@ filteredValues: string[];
3176
3419
  rangeFiltered: (data: ViewMetaData[]) => void;
3177
3420
  layoutAfterHeaderLayout: (layoutResult: LayoutResult) => void;
3178
3421
  layoutPagination: (data: LayoutPaginationParams) => void;
3179
- layoutCellMounted: (cell: S2CellType<ViewMeta>) => void;
3422
+ layoutCellRender: <T extends S2CellType = S2CellType>(cell: T) => void;
3180
3423
  beforeRender: () => void;
3181
3424
  afterRender: () => void;
3182
3425
  mounted: (spreadsheet: SpreadSheet) => void;
@@ -3214,7 +3457,7 @@ mouseHover: (event: GEvent) => void;
3214
3457
  mouseUp: (event: MouseEvent) => void;
3215
3458
  mouseDown: (event: MouseEvent) => void;
3216
3459
  mouseMove: (event: MouseEvent) => void;
3217
- selected: (cells: S2CellType<ViewMeta>[]) => void;
3460
+ selected: (cells: S2CellType[]) => void;
3218
3461
  reset: (event: KeyboardEvent) => void;
3219
3462
  linkFieldJump: (data: {
3220
3463
  field: string;
@@ -3246,14 +3489,14 @@ loading: BooleanConstructor;
3246
3489
  partDrillDown: ObjectConstructor;
3247
3490
  header: ObjectConstructor;
3248
3491
  options: {
3249
- type: PropType<S2Options<TooltipContentType, Pagination, string | Element, string>>;
3250
- default: S2Options<TooltipContentType, Pagination, string | Element, string>;
3492
+ type: PropType<SheetComponentOptions>;
3493
+ default: SheetComponentOptions;
3251
3494
  };
3252
3495
  adaptive: {
3253
3496
  type: PropType<Adaptive>;
3254
3497
  default: Adaptive;
3255
3498
  };
3256
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
3499
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
3257
3500
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
3258
3501
  }>> & {
3259
3502
  onSheetUpdate?: (params: S2RenderOptions) => any;
@@ -3267,6 +3510,7 @@ onRowCellMouseMove?: (data: TargetCellInfo) => any;
3267
3510
  onRowCellCollapsed?: (params: RowCellCollapsedParams) => any;
3268
3511
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
3269
3512
  onRowCellScroll?: (position: Required<ScrollOffset>) => any;
3513
+ onRowCellRender?: (cell: ColCell) => any;
3270
3514
  onColCellHover?: (data: TargetCellInfo) => any;
3271
3515
  onColCellClick?: (data: TargetCellInfo) => any;
3272
3516
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3279,6 +3523,7 @@ onColCellHidden?: (data: {
3279
3523
  currentHiddenColumnsInfo: HiddenColumnsInfo;
3280
3524
  hiddenColumnsDetail: HiddenColumnsInfo[];
3281
3525
  }) => any;
3526
+ onColCellRender?: (cell: ColCell) => any;
3282
3527
  onDataCellHover?: (data: TargetCellInfo) => any;
3283
3528
  onDataCellClick?: (data: TargetCellInfo) => any;
3284
3529
  onDataCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3287,7 +3532,8 @@ onDataCellMouseDown?: (data: TargetCellInfo) => any;
3287
3532
  onDataCellMouseUp?: (data: TargetCellInfo) => any;
3288
3533
  onDataCellMouseMove?: (data: TargetCellInfo) => any;
3289
3534
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => any;
3290
- onDataCellSelectMove?: (metas: ViewMetaData[]) => any;
3535
+ onDataCellSelectMove?: (metaList: ViewMetaData[]) => any;
3536
+ onDataCellRender?: (cell: DataCell) => any;
3291
3537
  onCornerCellHover?: (data: TargetCellInfo) => any;
3292
3538
  onCornerCellClick?: (data: TargetCellInfo) => any;
3293
3539
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3295,6 +3541,7 @@ onCornerCellContextMenu?: (data: TargetCellInfo) => any;
3295
3541
  onCornerCellMouseDown?: (data: TargetCellInfo) => any;
3296
3542
  onCornerCellMouseUp?: (data: TargetCellInfo) => any;
3297
3543
  onCornerCellMouseMove?: (data: TargetCellInfo) => any;
3544
+ onCornerCellRender?: (cell: CornerCell) => any;
3298
3545
  onMergedCellsHover?: (data: TargetCellInfo) => any;
3299
3546
  onMergedCellsClick?: (data: TargetCellInfo) => any;
3300
3547
  onMergedCellsDoubleClick?: (data: TargetCellInfo) => any;
@@ -3302,6 +3549,8 @@ onMergedCellsContextMenu?: (data: TargetCellInfo) => any;
3302
3549
  onMergedCellsMouseDown?: (data: TargetCellInfo) => any;
3303
3550
  onMergedCellsMouseUp?: (data: TargetCellInfo) => any;
3304
3551
  onMergedCellsMouseMove?: (data: TargetCellInfo) => any;
3552
+ onMergedCellsRender?: (cell: MergedCell) => any;
3553
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell) => any;
3305
3554
  onRangeSort?: (params: SortParams) => any;
3306
3555
  onRangeSorted?: (event: GEvent) => any;
3307
3556
  onRangeFilter?: (data: {
@@ -3311,7 +3560,7 @@ filteredValues: string[];
3311
3560
  onRangeFiltered?: (data: ViewMetaData[]) => any;
3312
3561
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult) => any;
3313
3562
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
3314
- onLayoutCellMounted?: (cell: S2CellType<ViewMeta>) => any;
3563
+ onLayoutCellRender?: (cell: S2CellType) => any;
3315
3564
  onBeforeRender?: () => any;
3316
3565
  onAfterRender?: () => any;
3317
3566
  onMounted?: (spreadsheet: SpreadSheet) => any;
@@ -3349,7 +3598,7 @@ onMouseHover?: (event: GEvent) => any;
3349
3598
  onMouseUp?: (event: MouseEvent) => any;
3350
3599
  onMouseDown?: (event: MouseEvent) => any;
3351
3600
  onMouseMove?: (event: MouseEvent) => any;
3352
- onSelected?: (cells: S2CellType<ViewMeta>[]) => any;
3601
+ onSelected?: (cells: S2CellType[]) => any;
3353
3602
  onReset?: (event: KeyboardEvent) => any;
3354
3603
  onLinkFieldJump?: (data: {
3355
3604
  field: string;
@@ -3363,9 +3612,9 @@ spreadsheet: SpreadSheet;
3363
3612
  }) => any;
3364
3613
  onRowCellBrushSelection?: (event: GEvent) => any;
3365
3614
  onColCellBrushSelection?: (event: GEvent) => any;
3366
- onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => any;
3615
+ onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => any;
3367
3616
  }, {
3368
- options: S2Options<TooltipContentType, Pagination, string | Element, string>;
3617
+ options: SheetComponentOptions;
3369
3618
  loading: boolean;
3370
3619
  adaptive: boolean | {
3371
3620
  width?: boolean;
@@ -3376,7 +3625,7 @@ showPagination: boolean | {
3376
3625
  onShowSizeChange?: (pageSize: number) => void;
3377
3626
  onChange?: (current: number) => void;
3378
3627
  };
3379
- }>;
3628
+ }, {}>;
3380
3629
 
3381
3630
  declare interface Point {
3382
3631
  x: number;
@@ -3409,6 +3658,13 @@ declare interface RangeColors {
3409
3658
 
3410
3659
  declare type RawData_2 = Record<string, DataItem>;
3411
3660
 
3661
+ declare interface RenderTextShapeOptions {
3662
+ /**
3663
+ * 只渲染文本, 不记录 textShape 信息
3664
+ */
3665
+ shallowRender: boolean;
3666
+ }
3667
+
3412
3668
  declare interface RequiredPropOption<T = any> {
3413
3669
  type?: PropType<T>;
3414
3670
  required: true;
@@ -3429,6 +3685,10 @@ declare interface ResizeArea {
3429
3685
  backgroundOpacity?: number;
3430
3686
  /** 交互态 */
3431
3687
  interactionState?: InteractionState;
3688
+ /** 单元格可拖拽最小宽度 */
3689
+ minCellWidth?: number;
3690
+ /** 单元格可拖拽最小高度 */
3691
+ minCellHeight?: number;
3432
3692
  }
3433
3693
 
3434
3694
  declare enum ResizeAreaEffect {
@@ -3464,7 +3724,7 @@ declare interface ResizeInfo_2 {
3464
3724
  isResizeArea?: boolean;
3465
3725
  isResizeMask?: boolean;
3466
3726
  /** 当前拖拽热区对应的节点信息 */
3467
- meta: Node_2_2 | ViewMeta_2;
3727
+ meta: Node_2_2 | ViewMeta;
3468
3728
  /** 拖拽后的宽度 */
3469
3729
  resizedWidth?: number;
3470
3730
  /** 拖拽后的高度 */
@@ -3514,7 +3774,7 @@ declare class RootInteraction {
3514
3774
  setState(interactionStateInfo: InteractionStateInfo): void;
3515
3775
  getState(): InteractionStateInfo;
3516
3776
  setInteractedCells(cell: S2CellType_2): void;
3517
- getInteractedCells(): S2CellType_2<ViewMeta_2>[];
3777
+ getInteractedCells(): S2CellType_2<ViewMeta>[];
3518
3778
  resetState(): void;
3519
3779
  getCurrentStateName(): InteractionStateName | undefined;
3520
3780
  isEqualStateName(stateName: InteractionStateName): boolean;
@@ -3533,8 +3793,8 @@ declare class RootInteraction {
3533
3793
  selectHeaderCell: (selectHeaderCellInfo?: SelectHeaderCellInfo) => true | undefined;
3534
3794
  highlightNodes: (nodes?: Node_2_2[]) => void;
3535
3795
  mergeCells: (cellsInfo?: MergedCellInfo[], hideData?: boolean) => void;
3536
- unmergeCell: (removedCells: MergedCell) => void;
3537
- hideColumns(hiddenColumnFields?: string[], forceRender?: boolean): void;
3796
+ unmergeCell: (removedCells: MergedCell_2) => void;
3797
+ hideColumns(hiddenColumnFields?: string[], forceRender?: boolean): Promise<void>;
3538
3798
  private getBrushSelectionInfo;
3539
3799
  private getDefaultInteractions;
3540
3800
  private registerInteractions;
@@ -3553,8 +3813,7 @@ declare class RootInteraction {
3553
3813
  getSelectedCellHighlight(): InteractionCellSelectedHighlightOptions;
3554
3814
  }
3555
3815
 
3556
- declare class RowCell extends HeaderCell {
3557
- protected headerConfig: RowHeaderConfig;
3816
+ declare class RowCell extends HeaderCell<RowHeaderConfig> {
3558
3817
  get cellType(): CellType;
3559
3818
  protected getBorderPositions(): CellBorderPosition[];
3560
3819
  protected initCell(): void;
@@ -3566,7 +3825,7 @@ declare class RowCell extends HeaderCell {
3566
3825
  protected drawTreeIcon(): void;
3567
3826
  protected drawTreeLeafNodeAlignDot(): void;
3568
3827
  protected isBolderText(): boolean;
3569
- protected drawTextShape(): void;
3828
+ drawTextShape(options?: RenderTextShapeOptions): void;
3570
3829
  protected drawResizeAreaInLeaf(): void;
3571
3830
  protected getContentIndent(): number;
3572
3831
  protected getTextIndent(): number;
@@ -3615,7 +3874,8 @@ declare type RowData = Data | CellData[];
3615
3874
  * Row Header for SpreadSheet
3616
3875
  */
3617
3876
  declare class RowHeader extends BaseHeader<RowHeaderConfig> {
3618
- constructor(cfg: RowHeaderConfig);
3877
+ constructor(config: RowHeaderConfig);
3878
+ protected getCellInstance(node: Node_2_2): RowCell;
3619
3879
  protected layout(): void;
3620
3880
  protected offset(): void;
3621
3881
  protected clip(): void;
@@ -3623,7 +3883,7 @@ declare class RowHeader extends BaseHeader<RowHeaderConfig> {
3623
3883
 
3624
3884
  declare type RowHeaderConfig = BaseHeaderConfig;
3625
3885
 
3626
- declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Icon = Element | string, Text = string> {
3886
+ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> {
3627
3887
  /**
3628
3888
  * 表格宽度
3629
3889
  */
@@ -3645,7 +3905,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
3645
3905
  * 提示信息
3646
3906
  * @see https://s2.antv.antgroup.com/manual/basic/tooltip
3647
3907
  */
3648
- tooltip?: Tooltip<T, Icon, Text> | null;
3908
+ tooltip?: Tooltip<T, Menu> | null;
3649
3909
  /**
3650
3910
  * 交互配置
3651
3911
  * @see https://s2.antv.antgroup.com/manual/advanced/interaction/basic
@@ -3671,7 +3931,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
3671
3931
  * 自定义表头图标配置
3672
3932
  * @see https://s2.antv.antgroup.com/manual/advanced/custom/custom-icon
3673
3933
  */
3674
- headerActionIcons?: HeaderActionIcon[];
3934
+ headerActionIcons?: HeaderActionIcon_2[];
3675
3935
  /**
3676
3936
  * 自定义 SVG 图标
3677
3937
  * @see https://s2.antv.antgroup.com/manual/advanced/custom/custom-icon
@@ -3691,18 +3951,27 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
3691
3951
  * 空值单元格占位符
3692
3952
  */
3693
3953
  placeholder?: ((meta: Record<string, any>) => string) | string;
3694
- /**
3695
- * 是否支持 CSS 的 transform 属性
3696
- */
3697
- supportCSSTransform?: boolean;
3698
- /**
3699
- * 自定义 DPR, 默认 "window.devicePixelRatio"
3700
- */
3701
- devicePixelRatio?: number;
3702
3954
  /**
3703
3955
  * 设备类型: pc / mobile
3704
3956
  */
3705
3957
  device?: DeviceType;
3958
+ /**
3959
+ * 自定义 AntV/G 渲染引擎配置参数 & 插件注册
3960
+ * @see https://g.antv.antgroup.com/plugins/intro
3961
+ * @see https://g.antv.antgroup.com/api/canvas/options
3962
+ * @example
3963
+ import { Plugin as PluginA11y } from '@antv/g-plugin-a11y';
3964
+
3965
+ transformCanvasConfig(renderer) {
3966
+ console.log('当前已注册插件:', renderer.getPlugins(), renderer.getConfig());
3967
+ renderer.registerPlugin(new PluginA11y({ enableExtractingText: true }));
3968
+
3969
+ return {
3970
+ supportsCSSTransform: true,
3971
+ };
3972
+ },
3973
+ */
3974
+ transformCanvasConfig?: (renderer: CanvasConfig['renderer'], spreadsheet: SpreadSheet_2) => (Partial<CanvasConfig> | null | undefined) | void;
3706
3975
  /** *********** 自定义单元格 hooks **************** */
3707
3976
  /**
3708
3977
  * 自定义数值单元格
@@ -3713,22 +3982,22 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
3713
3982
  * 自定义角头单元格
3714
3983
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#corner-cell
3715
3984
  */
3716
- cornerCell?: CellCallback<CornerHeaderConfig>;
3985
+ cornerCell?: CellCallback<CornerHeaderConfig, CornerCell_2>;
3717
3986
  /**
3718
3987
  * 自定义序号单元格
3719
3988
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#series-number-cell
3720
3989
  */
3721
- seriesNumberCell?: CellCallback<BaseHeaderConfig>;
3990
+ seriesNumberCell?: CellCallback<BaseHeaderConfig, SeriesNumberCell_2>;
3722
3991
  /**
3723
3992
  * 自定义行头单元格
3724
3993
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#row-cell
3725
3994
  */
3726
- rowCell?: CellCallback<RowHeaderConfig>;
3995
+ rowCell?: CellCallback<RowHeaderConfig, RowCell>;
3727
3996
  /**
3728
3997
  * 自定义列头单元格
3729
3998
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#col-cell
3730
3999
  */
3731
- colCell?: CellCallback<ColHeaderConfig>;
4000
+ colCell?: CellCallback<ColHeaderConfig, S2CellType_2>;
3732
4001
  /**
3733
4002
  * 自定义合并单元格
3734
4003
  */
@@ -3779,7 +4048,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
3779
4048
  facet?: (spreadsheet: SpreadSheet_2) => BaseFacet;
3780
4049
  }
3781
4050
 
3782
- declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell | CornerCell | RowCell | SeriesNumberCell | MergedCell | TableCornerCell | TableSeriesNumberCell | BaseCell<T>;
4051
+ declare type S2CellType_2<T extends SimpleBBox = ViewMeta> = DataCell_2 | HeaderCell | ColCell_2 | CornerCell_2 | RowCell | SeriesNumberCell_2 | MergedCell_2 | TableCornerCell | TableSeriesNumberCell | BaseCell<T>;
3783
4052
 
3784
4053
  declare interface S2DataConfig_2 {
3785
4054
  /**
@@ -3818,6 +4087,7 @@ declare enum S2Event {
3818
4087
  ROW_CELL_BRUSH_SELECTION = "row-cell:brush-selection",
3819
4088
  ROW_CELL_COLLAPSED = "row-cell:collapsed",
3820
4089
  ROW_CELL_ALL_COLLAPSED = "row-cell:all-collapsed",
4090
+ ROW_CELL_RENDER = "row-cell:render",
3821
4091
  ROW_CELL_COLLAPSED__PRIVATE = "row-cell:collapsed__private",
3822
4092
  ROW_CELL_ALL_COLLAPSED__PRIVATE = "row-cell:all-collapsed__private",
3823
4093
  /** ================ Col Cell ================ */
@@ -3831,6 +4101,7 @@ declare enum S2Event {
3831
4101
  COL_CELL_BRUSH_SELECTION = "col-cell:brush-selection",
3832
4102
  COL_CELL_EXPANDED = "col-cell:expanded",
3833
4103
  COL_CELL_HIDDEN = "col-cell:hidden",
4104
+ COL_CELL_RENDER = "col-cell:render",
3834
4105
  /** ================ Data Cell ================ */
3835
4106
  DATA_CELL_HOVER = "data-cell:hover",
3836
4107
  DATA_CELL_CLICK = "data-cell:click",
@@ -3841,6 +4112,7 @@ declare enum S2Event {
3841
4112
  DATA_CELL_MOUSE_MOVE = "data-cell:mouse-move",
3842
4113
  DATA_CELL_BRUSH_SELECTION = "data-cell:brush-selection",
3843
4114
  DATA_CELL_SELECT_MOVE = "data-cell:select-move",
4115
+ DATA_CELL_RENDER = "data-cell:render",
3844
4116
  /** ================ Corner Cell ================ */
3845
4117
  CORNER_CELL_HOVER = "corner-cell:hover",
3846
4118
  CORNER_CELL_CLICK = "corner-cell:click",
@@ -3849,6 +4121,7 @@ declare enum S2Event {
3849
4121
  CORNER_CELL_MOUSE_DOWN = "corner-cell:mouse-down",
3850
4122
  CORNER_CELL_MOUSE_UP = "corner-cell:mouse-up",
3851
4123
  CORNER_CELL_MOUSE_MOVE = "corner-cell:mouse-move",
4124
+ CORNER_CELL_RENDER = "corner-cell:render",
3852
4125
  /** ================ Merged Cells ================ */
3853
4126
  MERGED_CELLS_HOVER = "merged-cells:hover",
3854
4127
  MERGED_CELLS_CLICK = "merged-cells:click",
@@ -3857,6 +4130,9 @@ declare enum S2Event {
3857
4130
  MERGED_CELLS_MOUSE_DOWN = "merged-cells:mouse-down",
3858
4131
  MERGED_CELLS_MOUSE_UP = "merged-cells:mouse-up",
3859
4132
  MERGED_CELLS_MOUSE_MOVE = "merged-cells:mouse-move",
4133
+ MERGED_CELLS_RENDER = "merged-cells:render",
4134
+ /** ================ SeriesNumber Cell ================ */
4135
+ SERIES_NUMBER_CELL_RENDER = "series-number-cell:render",
3860
4136
  /** ================ Sort ================ */
3861
4137
  RANGE_SORT = "sort:range-sort",
3862
4138
  RANGE_SORTED = "sort:range-sorted",
@@ -3865,7 +4141,7 @@ declare enum S2Event {
3865
4141
  RANGE_FILTERED = "filter:range-filtered",
3866
4142
  /** ================ Table Layout ================ */
3867
4143
  LAYOUT_AFTER_HEADER_LAYOUT = "layout:after-header-layout",
3868
- LAYOUT_CELL_MOUNTED = "layout:cell-mounted",
4144
+ LAYOUT_CELL_RENDER = "layout:cell-render",
3869
4145
  LAYOUT_PAGINATION = "layout:pagination",
3870
4146
  LAYOUT_AFTER_REAL_DATA_CELL_RENDER = "layout:after-real-data-cell-render",
3871
4147
  LAYOUT_AFTER_RENDER = "layout:after-render",
@@ -3908,7 +4184,7 @@ declare interface S2EventHandler {
3908
4184
 
3909
4185
  declare type S2MountContainer_2 = string | Element;
3910
4186
 
3911
- declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Icon = Element | string, Text = string> extends S2BasicOptions<T, P, Icon, Text>, S2PivotSheetOptions {
4187
+ declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> extends S2BasicOptions<T, P, Menu>, S2PivotSheetOptions {
3912
4188
  /**
3913
4189
  * 行列冻结
3914
4190
  */
@@ -4124,13 +4400,14 @@ declare interface ScrollSpeedRatio {
4124
4400
  declare type SelectedHandler = (cells: S2CellType_2[]) => void;
4125
4401
 
4126
4402
  declare interface SelectHeaderCellInfo {
4127
- cell: S2CellType_2<ViewMeta_2>;
4403
+ cell: S2CellType_2<ViewMeta>;
4128
4404
  isMultiSelection?: boolean;
4129
4405
  }
4130
4406
 
4131
- declare class SeriesNumberCell extends BaseCell<Node_2_2> {
4407
+ declare class SeriesNumberCell_2 extends BaseCell<Node_2_2> {
4132
4408
  protected headerConfig: BaseHeaderConfig;
4133
4409
  protected handleRestOptions(...[headerConfig]: [BaseHeaderConfig]): void;
4410
+ getHeaderConfig(): BaseHeaderConfig;
4134
4411
  get cellType(): CellType;
4135
4412
  protected getBorderPositions(): CellBorderPosition[];
4136
4413
  protected initCell(): void;
@@ -4150,6 +4427,8 @@ declare class SeriesNumberCell extends BaseCell<Node_2_2> {
4150
4427
  }
4151
4428
 
4152
4429
  declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
4430
+ constructor(config: BaseHeaderConfig);
4431
+ protected getCellInstance(node: Node_2_2): SeriesNumberCell_2;
4153
4432
  /**
4154
4433
  * Get seriesNumber header by config
4155
4434
  */
@@ -4160,14 +4439,13 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
4160
4439
  spreadsheet: SpreadSheet_2;
4161
4440
  cornerWidth: number;
4162
4441
  }): SeriesNumberHeader;
4163
- constructor(cfg: BaseHeaderConfig);
4164
4442
  clip(): void;
4165
4443
  layout(): void;
4166
4444
  protected offset(): void;
4167
4445
  getNodes(): Node_2_2[];
4168
4446
  }
4169
4447
 
4170
- export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4448
+ export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4171
4449
  s2Ref: ShallowRef<SheetExpose>;
4172
4450
  sheetType: ComputedRef<DefineComponent< {
4173
4451
  sheetType: PropType<SheetType>;
@@ -4187,20 +4465,20 @@ loading: BooleanConstructor;
4187
4465
  partDrillDown: ObjectConstructor;
4188
4466
  header: ObjectConstructor;
4189
4467
  options: {
4190
- type: PropType<S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>>;
4191
- default: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>;
4468
+ type: PropType<SheetComponentOptions>;
4469
+ default: SheetComponentOptions;
4192
4470
  };
4193
4471
  adaptive: {
4194
4472
  type: PropType<Adaptive>;
4195
4473
  default: Adaptive;
4196
4474
  };
4197
- onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2>;
4475
+ onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: SheetComponentOptions) => SpreadSheet_2>;
4198
4476
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
4199
4477
  }, {
4200
4478
  s2Ref: ShallowRef<SheetExpose>;
4201
- options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>;
4479
+ options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>;
4202
4480
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4203
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
4481
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
4204
4482
  sheetUpdate: SheetUpdateCallback;
4205
4483
  rowCellHover: (data: TargetCellInfo_2) => void;
4206
4484
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -4212,6 +4490,7 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
4212
4490
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
4213
4491
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
4214
4492
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
4493
+ rowCellRender: (cell: ColCell_2) => void;
4215
4494
  colCellHover: (data: TargetCellInfo_2) => void;
4216
4495
  colCellClick: (data: TargetCellInfo_2) => void;
4217
4496
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4224,6 +4503,7 @@ colCellHidden: (data: {
4224
4503
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4225
4504
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4226
4505
  }) => void;
4506
+ colCellRender: (cell: ColCell_2) => void;
4227
4507
  dataCellHover: (data: TargetCellInfo_2) => void;
4228
4508
  dataCellClick: (data: TargetCellInfo_2) => void;
4229
4509
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4232,7 +4512,8 @@ dataCellMouseDown: (data: TargetCellInfo_2) => void;
4232
4512
  dataCellMouseUp: (data: TargetCellInfo_2) => void;
4233
4513
  dataCellMouseMove: (data: TargetCellInfo_2) => void;
4234
4514
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
4235
- dataCellSelectMove: (metas: ViewMetaData_2[]) => void;
4515
+ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
4516
+ dataCellRender: (cell: DataCell_2) => void;
4236
4517
  cornerCellHover: (data: TargetCellInfo_2) => void;
4237
4518
  cornerCellClick: (data: TargetCellInfo_2) => void;
4238
4519
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4240,6 +4521,7 @@ cornerCellContextMenu: (data: TargetCellInfo_2) => void;
4240
4521
  cornerCellMouseDown: (data: TargetCellInfo_2) => void;
4241
4522
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
4242
4523
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
4524
+ cornerCellRender: (cell: CornerCell_2) => void;
4243
4525
  mergedCellsHover: (data: TargetCellInfo_2) => void;
4244
4526
  mergedCellsClick: (data: TargetCellInfo_2) => void;
4245
4527
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4247,6 +4529,8 @@ mergedCellsContextMenu: (data: TargetCellInfo_2) => void;
4247
4529
  mergedCellsMouseDown: (data: TargetCellInfo_2) => void;
4248
4530
  mergedCellsMouseUp: (data: TargetCellInfo_2) => void;
4249
4531
  mergedCellsMouseMove: (data: TargetCellInfo_2) => void;
4532
+ mergedCellsRender: (cell: MergedCell_2) => void;
4533
+ seriesNumberCellRender: (cell: SeriesNumberCell_2) => void;
4250
4534
  rangeSort: (params: SortParams_2) => void;
4251
4535
  rangeSorted: (event: FederatedPointerEvent) => void;
4252
4536
  rangeFilter: (data: {
@@ -4256,7 +4540,7 @@ filteredValues: string[];
4256
4540
  rangeFiltered: (data: ViewMetaData_2[]) => void;
4257
4541
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
4258
4542
  layoutPagination: (data: LayoutPaginationParams) => void;
4259
- layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
4543
+ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
4260
4544
  beforeRender: () => void;
4261
4545
  afterRender: () => void;
4262
4546
  mounted: (spreadsheet: SpreadSheet_2) => void;
@@ -4294,7 +4578,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
4294
4578
  mouseUp: (event: MouseEvent) => void;
4295
4579
  mouseDown: (event: MouseEvent) => void;
4296
4580
  mouseMove: (event: MouseEvent) => void;
4297
- selected: (cells: S2CellType_2<ViewMeta_2>[]) => void;
4581
+ selected: (cells: S2CellType_2[]) => void;
4298
4582
  reset: (event: KeyboardEvent) => void;
4299
4583
  linkFieldJump: (data: {
4300
4584
  field: string;
@@ -4326,14 +4610,14 @@ loading: BooleanConstructor;
4326
4610
  partDrillDown: ObjectConstructor;
4327
4611
  header: ObjectConstructor;
4328
4612
  options: {
4329
- type: PropType<S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>>;
4330
- default: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>;
4613
+ type: PropType<SheetComponentOptions>;
4614
+ default: SheetComponentOptions;
4331
4615
  };
4332
4616
  adaptive: {
4333
4617
  type: PropType<Adaptive>;
4334
4618
  default: Adaptive;
4335
4619
  };
4336
- onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2>;
4620
+ onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: SheetComponentOptions) => SpreadSheet_2>;
4337
4621
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
4338
4622
  }>> & {
4339
4623
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
@@ -4347,6 +4631,7 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
4347
4631
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
4348
4632
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
4349
4633
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
4634
+ onRowCellRender?: (cell: ColCell_2) => any;
4350
4635
  onColCellHover?: (data: TargetCellInfo_2) => any;
4351
4636
  onColCellClick?: (data: TargetCellInfo_2) => any;
4352
4637
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4359,6 +4644,7 @@ onColCellHidden?: (data: {
4359
4644
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4360
4645
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4361
4646
  }) => any;
4647
+ onColCellRender?: (cell: ColCell_2) => any;
4362
4648
  onDataCellHover?: (data: TargetCellInfo_2) => any;
4363
4649
  onDataCellClick?: (data: TargetCellInfo_2) => any;
4364
4650
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4367,7 +4653,8 @@ onDataCellMouseDown?: (data: TargetCellInfo_2) => any;
4367
4653
  onDataCellMouseUp?: (data: TargetCellInfo_2) => any;
4368
4654
  onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
4369
4655
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
4370
- onDataCellSelectMove?: (metas: ViewMetaData_2[]) => any;
4656
+ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
4657
+ onDataCellRender?: (cell: DataCell_2) => any;
4371
4658
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
4372
4659
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
4373
4660
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4375,6 +4662,7 @@ onCornerCellContextMenu?: (data: TargetCellInfo_2) => any;
4375
4662
  onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
4376
4663
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
4377
4664
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
4665
+ onCornerCellRender?: (cell: CornerCell_2) => any;
4378
4666
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
4379
4667
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
4380
4668
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4382,6 +4670,8 @@ onMergedCellsContextMenu?: (data: TargetCellInfo_2) => any;
4382
4670
  onMergedCellsMouseDown?: (data: TargetCellInfo_2) => any;
4383
4671
  onMergedCellsMouseUp?: (data: TargetCellInfo_2) => any;
4384
4672
  onMergedCellsMouseMove?: (data: TargetCellInfo_2) => any;
4673
+ onMergedCellsRender?: (cell: MergedCell_2) => any;
4674
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell_2) => any;
4385
4675
  onRangeSort?: (params: SortParams_2) => any;
4386
4676
  onRangeSorted?: (event: FederatedPointerEvent) => any;
4387
4677
  onRangeFilter?: (data: {
@@ -4391,7 +4681,7 @@ filteredValues: string[];
4391
4681
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
4392
4682
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
4393
4683
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
4394
- onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
4684
+ onLayoutCellRender?: (cell: S2CellType_2) => any;
4395
4685
  onBeforeRender?: () => any;
4396
4686
  onAfterRender?: () => any;
4397
4687
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
@@ -4429,7 +4719,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
4429
4719
  onMouseUp?: (event: MouseEvent) => any;
4430
4720
  onMouseDown?: (event: MouseEvent) => any;
4431
4721
  onMouseMove?: (event: MouseEvent) => any;
4432
- onSelected?: (cells: S2CellType_2<ViewMeta_2>[]) => any;
4722
+ onSelected?: (cells: S2CellType_2[]) => any;
4433
4723
  onReset?: (event: KeyboardEvent) => any;
4434
4724
  onLinkFieldJump?: (data: {
4435
4725
  field: string;
@@ -4443,9 +4733,9 @@ spreadsheet: SpreadSheet_2;
4443
4733
  }) => any;
4444
4734
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
4445
4735
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
4446
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4736
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => any;
4447
4737
  }, {
4448
- options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>;
4738
+ options: SheetComponentOptions;
4449
4739
  loading: boolean;
4450
4740
  adaptive: boolean | {
4451
4741
  width?: boolean;
@@ -4456,10 +4746,10 @@ showPagination: boolean | {
4456
4746
  onShowSizeChange?: (pageSize: number) => void;
4457
4747
  onChange?: (current: number) => void;
4458
4748
  };
4459
- }> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4749
+ }, {}> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4460
4750
  s2Ref: ShallowRef<SheetExpose>;
4461
4751
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4462
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
4752
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
4463
4753
  sheetUpdate: SheetUpdateCallback;
4464
4754
  rowCellHover: (data: TargetCellInfo_2) => void;
4465
4755
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -4471,6 +4761,7 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
4471
4761
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
4472
4762
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
4473
4763
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
4764
+ rowCellRender: (cell: ColCell_2) => void;
4474
4765
  colCellHover: (data: TargetCellInfo_2) => void;
4475
4766
  colCellClick: (data: TargetCellInfo_2) => void;
4476
4767
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4483,6 +4774,7 @@ colCellHidden: (data: {
4483
4774
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4484
4775
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4485
4776
  }) => void;
4777
+ colCellRender: (cell: ColCell_2) => void;
4486
4778
  dataCellHover: (data: TargetCellInfo_2) => void;
4487
4779
  dataCellClick: (data: TargetCellInfo_2) => void;
4488
4780
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4491,7 +4783,8 @@ dataCellMouseDown: (data: TargetCellInfo_2) => void;
4491
4783
  dataCellMouseUp: (data: TargetCellInfo_2) => void;
4492
4784
  dataCellMouseMove: (data: TargetCellInfo_2) => void;
4493
4785
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
4494
- dataCellSelectMove: (metas: ViewMetaData_2[]) => void;
4786
+ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
4787
+ dataCellRender: (cell: DataCell_2) => void;
4495
4788
  cornerCellHover: (data: TargetCellInfo_2) => void;
4496
4789
  cornerCellClick: (data: TargetCellInfo_2) => void;
4497
4790
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4499,6 +4792,7 @@ cornerCellContextMenu: (data: TargetCellInfo_2) => void;
4499
4792
  cornerCellMouseDown: (data: TargetCellInfo_2) => void;
4500
4793
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
4501
4794
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
4795
+ cornerCellRender: (cell: CornerCell_2) => void;
4502
4796
  mergedCellsHover: (data: TargetCellInfo_2) => void;
4503
4797
  mergedCellsClick: (data: TargetCellInfo_2) => void;
4504
4798
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4506,6 +4800,8 @@ mergedCellsContextMenu: (data: TargetCellInfo_2) => void;
4506
4800
  mergedCellsMouseDown: (data: TargetCellInfo_2) => void;
4507
4801
  mergedCellsMouseUp: (data: TargetCellInfo_2) => void;
4508
4802
  mergedCellsMouseMove: (data: TargetCellInfo_2) => void;
4803
+ mergedCellsRender: (cell: MergedCell_2) => void;
4804
+ seriesNumberCellRender: (cell: SeriesNumberCell_2) => void;
4509
4805
  rangeSort: (params: SortParams_2) => void;
4510
4806
  rangeSorted: (event: FederatedPointerEvent) => void;
4511
4807
  rangeFilter: (data: {
@@ -4515,7 +4811,7 @@ filteredValues: string[];
4515
4811
  rangeFiltered: (data: ViewMetaData_2[]) => void;
4516
4812
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
4517
4813
  layoutPagination: (data: LayoutPaginationParams) => void;
4518
- layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
4814
+ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
4519
4815
  beforeRender: () => void;
4520
4816
  afterRender: () => void;
4521
4817
  mounted: (spreadsheet: SpreadSheet_2) => void;
@@ -4553,7 +4849,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
4553
4849
  mouseUp: (event: MouseEvent) => void;
4554
4850
  mouseDown: (event: MouseEvent) => void;
4555
4851
  mouseMove: (event: MouseEvent) => void;
4556
- selected: (cells: S2CellType_2<ViewMeta_2>[]) => void;
4852
+ selected: (cells: S2CellType_2[]) => void;
4557
4853
  reset: (event: KeyboardEvent) => void;
4558
4854
  linkFieldJump: (data: {
4559
4855
  field: string;
@@ -4567,7 +4863,7 @@ spreadsheet: SpreadSheet_2;
4567
4863
  }) => void;
4568
4864
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
4569
4865
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
4570
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4866
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4571
4867
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4572
4868
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4573
4869
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -4579,6 +4875,7 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
4579
4875
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
4580
4876
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
4581
4877
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
4878
+ onRowCellRender?: (cell: ColCell_2) => any;
4582
4879
  onColCellHover?: (data: TargetCellInfo_2) => any;
4583
4880
  onColCellClick?: (data: TargetCellInfo_2) => any;
4584
4881
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4591,6 +4888,7 @@ onColCellHidden?: (data: {
4591
4888
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4592
4889
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4593
4890
  }) => any;
4891
+ onColCellRender?: (cell: ColCell_2) => any;
4594
4892
  onDataCellHover?: (data: TargetCellInfo_2) => any;
4595
4893
  onDataCellClick?: (data: TargetCellInfo_2) => any;
4596
4894
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4599,7 +4897,8 @@ onDataCellMouseDown?: (data: TargetCellInfo_2) => any;
4599
4897
  onDataCellMouseUp?: (data: TargetCellInfo_2) => any;
4600
4898
  onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
4601
4899
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
4602
- onDataCellSelectMove?: (metas: ViewMetaData_2[]) => any;
4900
+ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
4901
+ onDataCellRender?: (cell: DataCell_2) => any;
4603
4902
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
4604
4903
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
4605
4904
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4607,6 +4906,7 @@ onCornerCellContextMenu?: (data: TargetCellInfo_2) => any;
4607
4906
  onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
4608
4907
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
4609
4908
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
4909
+ onCornerCellRender?: (cell: CornerCell_2) => any;
4610
4910
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
4611
4911
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
4612
4912
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4614,6 +4914,8 @@ onMergedCellsContextMenu?: (data: TargetCellInfo_2) => any;
4614
4914
  onMergedCellsMouseDown?: (data: TargetCellInfo_2) => any;
4615
4915
  onMergedCellsMouseUp?: (data: TargetCellInfo_2) => any;
4616
4916
  onMergedCellsMouseMove?: (data: TargetCellInfo_2) => any;
4917
+ onMergedCellsRender?: (cell: MergedCell_2) => any;
4918
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell_2) => any;
4617
4919
  onRangeSort?: (params: SortParams_2) => any;
4618
4920
  onRangeSorted?: (event: FederatedPointerEvent) => any;
4619
4921
  onRangeFilter?: (data: {
@@ -4623,7 +4925,7 @@ filteredValues: string[];
4623
4925
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
4624
4926
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
4625
4927
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
4626
- onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
4928
+ onLayoutCellRender?: (cell: S2CellType_2) => any;
4627
4929
  onBeforeRender?: () => any;
4628
4930
  onAfterRender?: () => any;
4629
4931
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
@@ -4661,7 +4963,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
4661
4963
  onMouseUp?: (event: MouseEvent) => any;
4662
4964
  onMouseDown?: (event: MouseEvent) => any;
4663
4965
  onMouseMove?: (event: MouseEvent) => any;
4664
- onSelected?: (cells: S2CellType_2<ViewMeta_2>[]) => any;
4966
+ onSelected?: (cells: S2CellType_2[]) => any;
4665
4967
  onReset?: (event: KeyboardEvent) => any;
4666
4968
  onLinkFieldJump?: (data: {
4667
4969
  field: string;
@@ -4675,10 +4977,10 @@ spreadsheet: SpreadSheet_2;
4675
4977
  }) => any;
4676
4978
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
4677
4979
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
4678
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4679
- }, {}>>;
4980
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => any;
4981
+ }, {}, {}>>;
4680
4982
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4681
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
4983
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
4682
4984
  sheetUpdate: SheetUpdateCallback;
4683
4985
  rowCellHover: (data: TargetCellInfo_2) => void;
4684
4986
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -4690,6 +4992,7 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
4690
4992
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
4691
4993
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
4692
4994
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
4995
+ rowCellRender: (cell: ColCell_2) => void;
4693
4996
  colCellHover: (data: TargetCellInfo_2) => void;
4694
4997
  colCellClick: (data: TargetCellInfo_2) => void;
4695
4998
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4702,6 +5005,7 @@ colCellHidden: (data: {
4702
5005
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4703
5006
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4704
5007
  }) => void;
5008
+ colCellRender: (cell: ColCell_2) => void;
4705
5009
  dataCellHover: (data: TargetCellInfo_2) => void;
4706
5010
  dataCellClick: (data: TargetCellInfo_2) => void;
4707
5011
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4710,7 +5014,8 @@ dataCellMouseDown: (data: TargetCellInfo_2) => void;
4710
5014
  dataCellMouseUp: (data: TargetCellInfo_2) => void;
4711
5015
  dataCellMouseMove: (data: TargetCellInfo_2) => void;
4712
5016
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
4713
- dataCellSelectMove: (metas: ViewMetaData_2[]) => void;
5017
+ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
5018
+ dataCellRender: (cell: DataCell_2) => void;
4714
5019
  cornerCellHover: (data: TargetCellInfo_2) => void;
4715
5020
  cornerCellClick: (data: TargetCellInfo_2) => void;
4716
5021
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4718,6 +5023,7 @@ cornerCellContextMenu: (data: TargetCellInfo_2) => void;
4718
5023
  cornerCellMouseDown: (data: TargetCellInfo_2) => void;
4719
5024
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
4720
5025
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
5026
+ cornerCellRender: (cell: CornerCell_2) => void;
4721
5027
  mergedCellsHover: (data: TargetCellInfo_2) => void;
4722
5028
  mergedCellsClick: (data: TargetCellInfo_2) => void;
4723
5029
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4725,6 +5031,8 @@ mergedCellsContextMenu: (data: TargetCellInfo_2) => void;
4725
5031
  mergedCellsMouseDown: (data: TargetCellInfo_2) => void;
4726
5032
  mergedCellsMouseUp: (data: TargetCellInfo_2) => void;
4727
5033
  mergedCellsMouseMove: (data: TargetCellInfo_2) => void;
5034
+ mergedCellsRender: (cell: MergedCell_2) => void;
5035
+ seriesNumberCellRender: (cell: SeriesNumberCell_2) => void;
4728
5036
  rangeSort: (params: SortParams_2) => void;
4729
5037
  rangeSorted: (event: FederatedPointerEvent) => void;
4730
5038
  rangeFilter: (data: {
@@ -4734,7 +5042,7 @@ filteredValues: string[];
4734
5042
  rangeFiltered: (data: ViewMetaData_2[]) => void;
4735
5043
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
4736
5044
  layoutPagination: (data: LayoutPaginationParams) => void;
4737
- layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
5045
+ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
4738
5046
  beforeRender: () => void;
4739
5047
  afterRender: () => void;
4740
5048
  mounted: (spreadsheet: SpreadSheet_2) => void;
@@ -4772,7 +5080,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
4772
5080
  mouseUp: (event: MouseEvent) => void;
4773
5081
  mouseDown: (event: MouseEvent) => void;
4774
5082
  mouseMove: (event: MouseEvent) => void;
4775
- selected: (cells: S2CellType_2<ViewMeta_2>[]) => void;
5083
+ selected: (cells: S2CellType_2[]) => void;
4776
5084
  reset: (event: KeyboardEvent) => void;
4777
5085
  linkFieldJump: (data: {
4778
5086
  field: string;
@@ -4786,7 +5094,7 @@ spreadsheet: SpreadSheet_2;
4786
5094
  }) => void;
4787
5095
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
4788
5096
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
4789
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5097
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4790
5098
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4791
5099
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4792
5100
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -4798,6 +5106,7 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
4798
5106
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
4799
5107
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
4800
5108
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
5109
+ onRowCellRender?: (cell: ColCell_2) => any;
4801
5110
  onColCellHover?: (data: TargetCellInfo_2) => any;
4802
5111
  onColCellClick?: (data: TargetCellInfo_2) => any;
4803
5112
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4810,6 +5119,7 @@ onColCellHidden?: (data: {
4810
5119
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4811
5120
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4812
5121
  }) => any;
5122
+ onColCellRender?: (cell: ColCell_2) => any;
4813
5123
  onDataCellHover?: (data: TargetCellInfo_2) => any;
4814
5124
  onDataCellClick?: (data: TargetCellInfo_2) => any;
4815
5125
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4818,7 +5128,8 @@ onDataCellMouseDown?: (data: TargetCellInfo_2) => any;
4818
5128
  onDataCellMouseUp?: (data: TargetCellInfo_2) => any;
4819
5129
  onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
4820
5130
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
4821
- onDataCellSelectMove?: (metas: ViewMetaData_2[]) => any;
5131
+ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
5132
+ onDataCellRender?: (cell: DataCell_2) => any;
4822
5133
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
4823
5134
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
4824
5135
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4826,6 +5137,7 @@ onCornerCellContextMenu?: (data: TargetCellInfo_2) => any;
4826
5137
  onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
4827
5138
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
4828
5139
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
5140
+ onCornerCellRender?: (cell: CornerCell_2) => any;
4829
5141
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
4830
5142
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
4831
5143
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4833,6 +5145,8 @@ onMergedCellsContextMenu?: (data: TargetCellInfo_2) => any;
4833
5145
  onMergedCellsMouseDown?: (data: TargetCellInfo_2) => any;
4834
5146
  onMergedCellsMouseUp?: (data: TargetCellInfo_2) => any;
4835
5147
  onMergedCellsMouseMove?: (data: TargetCellInfo_2) => any;
5148
+ onMergedCellsRender?: (cell: MergedCell_2) => any;
5149
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell_2) => any;
4836
5150
  onRangeSort?: (params: SortParams_2) => any;
4837
5151
  onRangeSorted?: (event: FederatedPointerEvent) => any;
4838
5152
  onRangeFilter?: (data: {
@@ -4842,7 +5156,7 @@ filteredValues: string[];
4842
5156
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
4843
5157
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
4844
5158
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
4845
- onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
5159
+ onLayoutCellRender?: (cell: S2CellType_2) => any;
4846
5160
  onBeforeRender?: () => any;
4847
5161
  onAfterRender?: () => any;
4848
5162
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
@@ -4880,7 +5194,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
4880
5194
  onMouseUp?: (event: MouseEvent) => any;
4881
5195
  onMouseDown?: (event: MouseEvent) => any;
4882
5196
  onMouseMove?: (event: MouseEvent) => any;
4883
- onSelected?: (cells: S2CellType_2<ViewMeta_2>[]) => any;
5197
+ onSelected?: (cells: S2CellType_2[]) => any;
4884
5198
  onReset?: (event: KeyboardEvent) => any;
4885
5199
  onLinkFieldJump?: (data: {
4886
5200
  field: string;
@@ -4894,8 +5208,8 @@ spreadsheet: SpreadSheet_2;
4894
5208
  }) => any;
4895
5209
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
4896
5210
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
4897
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4898
- }, {}>;
5211
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => any;
5212
+ }, {}, {}>;
4899
5213
 
4900
5214
  declare type SheetComponentOptions = S2Options<TooltipContentType, Pagination & PaginationProps>;
4901
5215
 
@@ -4920,8 +5234,9 @@ declare interface SimpleBBox {
4920
5234
  declare type SimpleData = string | number | null;
4921
5235
 
4922
5236
  declare interface Sort {
4923
- /** 字段id,业务中一般是displayId */
5237
+ /** 字段id */
4924
5238
  sortFieldId: string;
5239
+ /** 排序方式 */
4925
5240
  sortMethod?: SortMethod;
4926
5241
  /** 自定义排序 */
4927
5242
  sortBy?: string[];
@@ -4975,27 +5290,37 @@ declare interface SplitLine {
4975
5290
  }
4976
5291
 
4977
5292
  declare abstract class SpreadSheet_2 extends EE {
5293
+ themeName: ThemeName;
4978
5294
  theme: InternalFullyTheme;
4979
5295
  store: Store;
4980
5296
  dataCfg: S2DataConfig_2;
4981
5297
  options: S2Options_2;
4982
5298
  dataSet: BaseDataSet_2;
4983
- /**
4984
- * Facet: determine how to render headers/cell
4985
- */
4986
5299
  facet: BaseFacet;
4987
5300
  tooltip: BaseTooltip_2;
4988
5301
  container: Canvas;
4989
5302
  interaction: RootInteraction;
4990
5303
  hdAdapter: HdAdapter;
4991
- private untypedOn;
4992
- private untypedEmit;
4993
5304
  /**
4994
5305
  * 表格是否已销毁
4995
5306
  */
4996
5307
  private destroyed;
5308
+ private untypedOn;
5309
+ private untypedEmit;
4997
5310
  on: <K extends keyof EmitterType>(event: K, listener: EmitterType[K]) => this;
4998
5311
  emit: <K extends keyof EmitterType>(event: K, ...args: Parameters<EmitterType[K]>) => boolean;
5312
+ protected abstract bindEvents(): void;
5313
+ abstract getDataSet(): BaseDataSet_2;
5314
+ abstract enableFrozenHeaders(): boolean;
5315
+ abstract isPivotMode(): boolean;
5316
+ abstract isCustomRowFields(): boolean;
5317
+ abstract isHierarchyTreeType(): boolean;
5318
+ abstract isFrozenRowHeader(): boolean;
5319
+ abstract isTableMode(): boolean;
5320
+ abstract isValueInCols(): boolean;
5321
+ protected abstract buildFacet(): void;
5322
+ abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): void;
5323
+ abstract groupSortByMethod(sortMethod: SortMethod, meta: Node_2_2): void;
4999
5324
  constructor(dom: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2 | null);
5000
5325
  isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
5001
5326
  isCustomColumnFields(): boolean;
@@ -5008,38 +5333,8 @@ declare abstract class SpreadSheet_2 extends EE {
5008
5333
  private initInteraction;
5009
5334
  private initTooltip;
5010
5335
  private renderTooltip;
5011
- protected abstract bindEvents(): void;
5012
- abstract getDataSet(): BaseDataSet_2;
5013
- /**
5014
- * 是否开启冻结行列头效果
5015
- */
5016
- abstract enableFrozenHeaders(): boolean;
5017
- /**
5018
- * Check if is pivot mode
5019
- */
5020
- abstract isPivotMode(): boolean;
5021
- abstract isCustomRowFields(): boolean;
5022
- /**
5023
- * tree type must be in strategy mode
5024
- */
5025
- abstract isHierarchyTreeType(): boolean;
5026
- /**
5027
- * Scroll Freeze Row Header
5028
- */
5029
- abstract isFrozenRowHeader(): boolean;
5030
- /**
5031
- * Check if is pivot mode
5032
- */
5033
- abstract isTableMode(): boolean;
5034
- /**
5035
- * Check if the value is in the columns
5036
- */
5037
- abstract isValueInCols(): boolean;
5038
- protected abstract buildFacet(): void;
5039
- abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): void;
5040
- abstract handleGroupSort(event: FederatedPointerEvent, meta: Node_2_2): void;
5041
- showTooltip<T = TooltipContentType_2>(showOptions: TooltipShowOptions<T>): void;
5042
- showTooltipWithInfo(event: FederatedPointerEvent | MouseEvent, cellInfos: TooltipData[], options?: TooltipOptions): void;
5336
+ showTooltip<T = TooltipContentType_2, Menu = BaseTooltipOperatorMenuOptions_2>(showOptions: TooltipShowOptions<T, Menu>): Promise<void>;
5337
+ showTooltipWithInfo(event: FederatedPointerEvent | MouseEvent, cellInfos: TooltipData[], options?: TooltipOptions): Promise<void> | void;
5043
5338
  hideTooltip(): void;
5044
5339
  destroyTooltip(): void;
5045
5340
  registerIcons(): void;
@@ -5060,8 +5355,11 @@ declare abstract class SpreadSheet_2 extends EE {
5060
5355
  UNSAFE_render(reloadData?: boolean, options?: S2RenderOptions_2): void;
5061
5356
  render(reloadData?: boolean, options?: S2RenderOptions_2): Promise<void>;
5062
5357
  destroy(): void;
5358
+ private setThemeName;
5063
5359
  setThemeCfg(themeCfg?: ThemeCfg_2): void;
5064
5360
  setTheme(theme: S2Theme): void;
5361
+ getTheme(): InternalFullyTheme;
5362
+ getThemeName(): "default" | "colorful" | "gray" | "dark";
5065
5363
  /**
5066
5364
  * Update pagination config which store in {@see options}
5067
5365
  * @param pagination
@@ -5093,10 +5391,9 @@ declare abstract class SpreadSheet_2 extends EE {
5093
5391
  getCell<T extends S2CellType_2 = S2CellType_2>(target: CellEventTarget): T | null;
5094
5392
  getCellType(target: CellEventTarget): CellType | undefined;
5095
5393
  /**
5096
- * get total's config by dimension id
5097
- * @param dimension unique dimension id
5394
+ * 获取当前维度对应的汇总配置
5098
5395
  */
5099
- getTotalsConfig(dimension: string): Partial<Totals['row']>;
5396
+ getTotalsConfig(dimension: string): Total;
5100
5397
  /**
5101
5398
  * Create all related groups, contains:
5102
5399
  * 1. container -- base canvas group
@@ -5140,6 +5437,7 @@ declare abstract class SpreadSheet_2 extends EE {
5140
5437
  measureTextWidthRoughly: (text: any, font?: any) => number;
5141
5438
  updateSortMethodMap(nodeId: string, sortMethod: SortMethod, replace?: boolean): void;
5142
5439
  getMenuDefaultSelectedKeys(nodeId: string): string[];
5440
+ handleGroupSort(event: FederatedPointerEvent, meta: Node_2_2): void;
5143
5441
  }
5144
5442
 
5145
5443
  declare type StateShapeLayer = 'interactiveBgShape' | 'interactiveBorderShape';
@@ -5233,7 +5531,7 @@ declare interface StoreKey {
5233
5531
  /**
5234
5532
  * 上一次点击的单元格
5235
5533
  */
5236
- lastClickedCell: S2CellType_2<ViewMeta_2> | null;
5534
+ lastClickedCell: S2CellType_2<ViewMeta> | null;
5237
5535
  /**
5238
5536
  * 初始化时的边界滚动配置
5239
5537
  */
@@ -5245,7 +5543,7 @@ declare interface StoreKey {
5245
5543
  [key: string]: unknown;
5246
5544
  }
5247
5545
 
5248
- declare class TableColCell extends ColCell {
5546
+ declare class TableColCell extends ColCell_2 {
5249
5547
  protected handleRestOptions(...[headerConfig]: [BaseHeaderConfig]): void;
5250
5548
  protected isFrozenCell(): boolean;
5251
5549
  protected getFormattedFieldValue(): FormatResult;
@@ -5254,7 +5552,7 @@ declare class TableColCell extends ColCell {
5254
5552
  x: number;
5255
5553
  y: number;
5256
5554
  };
5257
- protected getColResizeArea(): Group | undefined;
5555
+ protected getColResizeArea(): Group_2 | undefined;
5258
5556
  protected isSortCell(): boolean;
5259
5557
  protected showSortIcon(): boolean | undefined;
5260
5558
  protected getTextStyle(): DeepRequired<TextTheme>;
@@ -5280,10 +5578,10 @@ declare class TableSeriesNumberCell extends TableDataCell {
5280
5578
  protected getTextStyle(): TextTheme;
5281
5579
  }
5282
5580
 
5283
- export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
5581
+ export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
5284
5582
  s2Ref: ShallowRef<SheetExpose>;
5285
5583
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5286
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
5584
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
5287
5585
  sheetUpdate: SheetUpdateCallback;
5288
5586
  rowCellHover: (data: TargetCellInfo_2) => void;
5289
5587
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -5295,6 +5593,7 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
5295
5593
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
5296
5594
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
5297
5595
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
5596
+ rowCellRender: (cell: ColCell_2) => void;
5298
5597
  colCellHover: (data: TargetCellInfo_2) => void;
5299
5598
  colCellClick: (data: TargetCellInfo_2) => void;
5300
5599
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5307,6 +5606,7 @@ colCellHidden: (data: {
5307
5606
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
5308
5607
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
5309
5608
  }) => void;
5609
+ colCellRender: (cell: ColCell_2) => void;
5310
5610
  dataCellHover: (data: TargetCellInfo_2) => void;
5311
5611
  dataCellClick: (data: TargetCellInfo_2) => void;
5312
5612
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5315,7 +5615,8 @@ dataCellMouseDown: (data: TargetCellInfo_2) => void;
5315
5615
  dataCellMouseUp: (data: TargetCellInfo_2) => void;
5316
5616
  dataCellMouseMove: (data: TargetCellInfo_2) => void;
5317
5617
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
5318
- dataCellSelectMove: (metas: ViewMetaData_2[]) => void;
5618
+ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
5619
+ dataCellRender: (cell: DataCell_2) => void;
5319
5620
  cornerCellHover: (data: TargetCellInfo_2) => void;
5320
5621
  cornerCellClick: (data: TargetCellInfo_2) => void;
5321
5622
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5323,6 +5624,7 @@ cornerCellContextMenu: (data: TargetCellInfo_2) => void;
5323
5624
  cornerCellMouseDown: (data: TargetCellInfo_2) => void;
5324
5625
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
5325
5626
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
5627
+ cornerCellRender: (cell: CornerCell_2) => void;
5326
5628
  mergedCellsHover: (data: TargetCellInfo_2) => void;
5327
5629
  mergedCellsClick: (data: TargetCellInfo_2) => void;
5328
5630
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5330,6 +5632,8 @@ mergedCellsContextMenu: (data: TargetCellInfo_2) => void;
5330
5632
  mergedCellsMouseDown: (data: TargetCellInfo_2) => void;
5331
5633
  mergedCellsMouseUp: (data: TargetCellInfo_2) => void;
5332
5634
  mergedCellsMouseMove: (data: TargetCellInfo_2) => void;
5635
+ mergedCellsRender: (cell: MergedCell_2) => void;
5636
+ seriesNumberCellRender: (cell: SeriesNumberCell_2) => void;
5333
5637
  rangeSort: (params: SortParams_2) => void;
5334
5638
  rangeSorted: (event: FederatedPointerEvent) => void;
5335
5639
  rangeFilter: (data: {
@@ -5339,7 +5643,7 @@ filteredValues: string[];
5339
5643
  rangeFiltered: (data: ViewMetaData_2[]) => void;
5340
5644
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
5341
5645
  layoutPagination: (data: LayoutPaginationParams) => void;
5342
- layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
5646
+ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
5343
5647
  beforeRender: () => void;
5344
5648
  afterRender: () => void;
5345
5649
  mounted: (spreadsheet: SpreadSheet_2) => void;
@@ -5377,7 +5681,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
5377
5681
  mouseUp: (event: MouseEvent) => void;
5378
5682
  mouseDown: (event: MouseEvent) => void;
5379
5683
  mouseMove: (event: MouseEvent) => void;
5380
- selected: (cells: S2CellType_2<ViewMeta_2>[]) => void;
5684
+ selected: (cells: S2CellType_2[]) => void;
5381
5685
  reset: (event: KeyboardEvent) => void;
5382
5686
  linkFieldJump: (data: {
5383
5687
  field: string;
@@ -5391,7 +5695,7 @@ spreadsheet: SpreadSheet_2;
5391
5695
  }) => void;
5392
5696
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5393
5697
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5394
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5698
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5395
5699
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
5396
5700
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5397
5701
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -5403,6 +5707,7 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
5403
5707
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
5404
5708
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
5405
5709
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
5710
+ onRowCellRender?: (cell: ColCell_2) => any;
5406
5711
  onColCellHover?: (data: TargetCellInfo_2) => any;
5407
5712
  onColCellClick?: (data: TargetCellInfo_2) => any;
5408
5713
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5415,6 +5720,7 @@ onColCellHidden?: (data: {
5415
5720
  currentHiddenColumnsInfo: HiddenColumnsInfo_2;
5416
5721
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
5417
5722
  }) => any;
5723
+ onColCellRender?: (cell: ColCell_2) => any;
5418
5724
  onDataCellHover?: (data: TargetCellInfo_2) => any;
5419
5725
  onDataCellClick?: (data: TargetCellInfo_2) => any;
5420
5726
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5423,7 +5729,8 @@ onDataCellMouseDown?: (data: TargetCellInfo_2) => any;
5423
5729
  onDataCellMouseUp?: (data: TargetCellInfo_2) => any;
5424
5730
  onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
5425
5731
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
5426
- onDataCellSelectMove?: (metas: ViewMetaData_2[]) => any;
5732
+ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
5733
+ onDataCellRender?: (cell: DataCell_2) => any;
5427
5734
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
5428
5735
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
5429
5736
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5431,6 +5738,7 @@ onCornerCellContextMenu?: (data: TargetCellInfo_2) => any;
5431
5738
  onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
5432
5739
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
5433
5740
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
5741
+ onCornerCellRender?: (cell: CornerCell_2) => any;
5434
5742
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
5435
5743
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
5436
5744
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5438,6 +5746,8 @@ onMergedCellsContextMenu?: (data: TargetCellInfo_2) => any;
5438
5746
  onMergedCellsMouseDown?: (data: TargetCellInfo_2) => any;
5439
5747
  onMergedCellsMouseUp?: (data: TargetCellInfo_2) => any;
5440
5748
  onMergedCellsMouseMove?: (data: TargetCellInfo_2) => any;
5749
+ onMergedCellsRender?: (cell: MergedCell_2) => any;
5750
+ onSeriesNumberCellRender?: (cell: SeriesNumberCell_2) => any;
5441
5751
  onRangeSort?: (params: SortParams_2) => any;
5442
5752
  onRangeSorted?: (event: FederatedPointerEvent) => any;
5443
5753
  onRangeFilter?: (data: {
@@ -5447,7 +5757,7 @@ filteredValues: string[];
5447
5757
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
5448
5758
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
5449
5759
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
5450
- onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
5760
+ onLayoutCellRender?: (cell: S2CellType_2) => any;
5451
5761
  onBeforeRender?: () => any;
5452
5762
  onAfterRender?: () => any;
5453
5763
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
@@ -5485,7 +5795,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
5485
5795
  onMouseUp?: (event: MouseEvent) => any;
5486
5796
  onMouseDown?: (event: MouseEvent) => any;
5487
5797
  onMouseMove?: (event: MouseEvent) => any;
5488
- onSelected?: (cells: S2CellType_2<ViewMeta_2>[]) => any;
5798
+ onSelected?: (cells: S2CellType_2[]) => any;
5489
5799
  onReset?: (event: KeyboardEvent) => any;
5490
5800
  onLinkFieldJump?: (data: {
5491
5801
  field: string;
@@ -5499,8 +5809,8 @@ spreadsheet: SpreadSheet_2;
5499
5809
  }) => any;
5500
5810
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
5501
5811
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
5502
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
5503
- }, {}>;
5812
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => any;
5813
+ }, {}, {}>;
5504
5814
 
5505
5815
  declare interface TargetCellInfo_2 {
5506
5816
  target: S2CellType_2;
@@ -5521,19 +5831,13 @@ declare interface TextCondition extends Condition<TextTheme> {
5521
5831
  position?: IconPosition;
5522
5832
  }
5523
5833
 
5524
- declare interface TextTheme extends TextAlignStyle {
5525
- /** 字体 */
5526
- fontFamily?: string;
5834
+ declare interface TextTheme extends TextAlignStyle, Pick<TextStyleProps, 'fontFamily' | 'fontSize' | 'fontWeight' | 'fill' | 'opacity' | 'wordWrap' | 'maxLines' | 'lineHeight' | 'textOverflow' | 'fontStyle' | 'fontVariant'> {
5527
5835
  /** 字体大小 */
5528
5836
  fontSize?: number;
5529
- /** 字体粗细 */
5530
- fontWeight?: number | 'normal' | 'bold' | 'bolder' | 'lighter';
5531
5837
  /** 字体颜色 */
5532
5838
  fill?: string;
5533
5839
  /** 链接文本颜色 */
5534
5840
  linkTextFill?: string;
5535
- /** 字体透明度 */
5536
- opacity?: number;
5537
5841
  }
5538
5842
 
5539
5843
  declare interface ThemeCfg_2 {
@@ -5547,23 +5851,23 @@ declare interface ThemeCfg_2 {
5547
5851
 
5548
5852
  declare type ThemeName = keyof typeof PALETTE_MAP;
5549
5853
 
5550
- declare interface Tooltip<T = TooltipContentType_2, Icon = Element | string, Text = string> extends BaseTooltipConfig<T, Icon, Text> {
5854
+ declare interface Tooltip<T = TooltipContentType_2, Menu = BaseTooltipOperatorMenuOptions_2> extends BaseTooltipConfig<T, Menu> {
5551
5855
  /**
5552
5856
  * Tooltip 行头单元格配置
5553
5857
  */
5554
- rowCell?: BaseTooltipConfig<T, Icon, Text>;
5858
+ rowCell?: BaseTooltipConfig<T, Menu>;
5555
5859
  /**
5556
5860
  * Tooltip 列头单元格配置
5557
5861
  */
5558
- colCell?: BaseTooltipConfig<T, Icon, Text>;
5862
+ colCell?: BaseTooltipConfig<T, Menu>;
5559
5863
  /**
5560
5864
  * Tooltip 角头单元格配置
5561
5865
  */
5562
- cornerCell?: BaseTooltipConfig<T, Icon, Text>;
5866
+ cornerCell?: BaseTooltipConfig<T, Menu>;
5563
5867
  /**
5564
5868
  * Tooltip 数值单元格配置
5565
5869
  */
5566
- dataCell?: BaseTooltipConfig<T, Icon, Text>;
5870
+ dataCell?: BaseTooltipConfig<T, Menu>;
5567
5871
  }
5568
5872
 
5569
5873
  declare type TooltipAutoAdjustBoundary = 'body' | 'container' | null | undefined;
@@ -5596,14 +5900,14 @@ declare type TooltipHeadInfo = {
5596
5900
  cols: TooltipDetailListItem[];
5597
5901
  };
5598
5902
 
5599
- declare type TooltipInterpretationOptions = {
5903
+ declare type TooltipInterpretationOptions<T = TooltipContentType_2, Icon = Element | string, Text = string> = {
5600
5904
  name: string;
5601
- icon?: Element | string;
5602
- text?: string;
5603
- render?: Element | string;
5905
+ icon?: Icon;
5906
+ text?: Text;
5907
+ content?: T;
5604
5908
  };
5605
5909
 
5606
- declare interface TooltipOperation<Icon = Element | string, Text = string> extends TooltipOperatorOptions<Icon, Text> {
5910
+ declare interface TooltipOperation<Menu = BaseTooltipOperatorMenuOptions_2> extends TooltipOperatorOptions<Menu> {
5607
5911
  /**
5608
5912
  * 隐藏列 (叶子节点有效)
5609
5913
  */
@@ -5618,33 +5922,51 @@ declare interface TooltipOperation<Icon = Element | string, Text = string> exten
5618
5922
  tableSort?: boolean;
5619
5923
  }
5620
5924
 
5621
- declare type TooltipOperatorClickHandler = (params: {
5622
- key: SortMethod;
5925
+ declare type TooltipOperatorClickHandler = (info: TooltipOperatorMenuInfo, cell: S2CellType_2 | undefined | null) => void;
5926
+
5927
+ declare interface TooltipOperatorMenuInfo {
5928
+ key: string;
5623
5929
  [key: string]: unknown;
5624
- }) => void;
5930
+ }
5625
5931
 
5626
- declare interface TooltipOperatorMenu<Icon = Element | string, Text = string> {
5932
+ declare interface TooltipOperatorMenuItem<Icon, Text> {
5627
5933
  /** 唯一标识 */
5628
5934
  key: string;
5629
5935
  /** 自定义 icon */
5630
5936
  icon?: Icon;
5631
5937
  /** 名称 */
5632
- text?: Text;
5938
+ label?: Text;
5633
5939
  /** 点击回调 */
5634
- onClick?: (cell: S2CellType_2) => void;
5940
+ onClick?: TooltipOperatorClickHandler;
5635
5941
  /** 是否显示 */
5636
5942
  visible?: boolean | ((cell: S2CellType_2) => boolean);
5637
5943
  /** 子菜单 */
5638
- children?: TooltipOperatorMenu<Icon, Text>[];
5944
+ children?: TooltipOperatorMenuItem<Icon, Text>[];
5639
5945
  }
5640
5946
 
5641
- declare interface TooltipOperatorOptions<Icon = Element | string, Text = string> {
5947
+ declare interface TooltipOperatorMenuOptions<Icon, Text> {
5948
+ /**
5949
+ * 菜单内容
5950
+ */
5951
+ items?: TooltipOperatorMenuItem<Icon, Text>[];
5952
+ /**
5953
+ * 菜单项点击
5954
+ */
5642
5955
  onClick?: TooltipOperatorClickHandler;
5643
- menus?: TooltipOperatorMenu<Icon, Text>[];
5956
+ /**
5957
+ * 默认选中的菜单项 key
5958
+ */
5644
5959
  defaultSelectedKeys?: string[];
5645
5960
  }
5646
5961
 
5647
- declare interface TooltipOptions<Icon = Element | string, Text = string> {
5962
+ declare interface TooltipOperatorOptions<Menu = BaseTooltipOperatorMenuOptions_2> {
5963
+ /**
5964
+ * 菜单项配置
5965
+ */
5966
+ menu?: Menu;
5967
+ }
5968
+
5969
+ declare interface TooltipOptions<Menu = BaseTooltipOperatorMenuOptions_2> {
5648
5970
  /**
5649
5971
  * 是否隐藏汇总项
5650
5972
  * @example "数量(总和) 999"
@@ -5653,7 +5975,7 @@ declare interface TooltipOptions<Icon = Element | string, Text = string> {
5653
5975
  /**
5654
5976
  * 顶部操作项
5655
5977
  */
5656
- operator?: TooltipOperatorOptions<Icon, Text>;
5978
+ operator?: TooltipOperatorOptions<Menu>;
5657
5979
  /**
5658
5980
  * 是否是小计/总计
5659
5981
  */
@@ -5702,13 +6024,14 @@ declare interface TooltipPositionInfo {
5702
6024
  event: FederatedPointerEvent | MouseEvent;
5703
6025
  }
5704
6026
 
5705
- declare type TooltipShowOptions<T = TooltipContentType_2, Icon = Element | string, Text = string> = {
6027
+ declare type TooltipShowOptions<T = TooltipContentType_2, Menu = BaseTooltipOperatorMenuOptions_2> = {
5706
6028
  position: TooltipPosition;
5707
6029
  data?: TooltipData;
5708
6030
  cellInfos?: TooltipDataItem[];
5709
- options?: TooltipOptions<Icon, Text>;
5710
- content?: ((cell: S2CellType_2, defaultTooltipShowOptions: TooltipShowOptions<T, Icon, Text>) => T) | T;
6031
+ options?: TooltipOptions<Menu>;
6032
+ content?: ((cell: S2CellType_2, defaultTooltipShowOptions: TooltipShowOptions<T, Menu>) => T) | T;
5711
6033
  event?: FederatedPointerEvent | MouseEvent;
6034
+ onMounted?: () => void;
5712
6035
  };
5713
6036
 
5714
6037
  declare interface TooltipSummaryOptions {
@@ -5721,33 +6044,53 @@ declare interface TooltipSummaryOptions {
5721
6044
  declare type TooltipSummaryOptionsValue = number | string | undefined | null;
5722
6045
 
5723
6046
  declare interface Total {
5724
- /** 是否显示总计 */
5725
- showGrandTotals: boolean;
5726
- /** 是否显示小计 */
5727
- showSubTotals: boolean | {
6047
+ /**
6048
+ * 是否显示总计
6049
+ */
6050
+ showGrandTotals?: boolean;
6051
+ /**
6052
+ *是否显示小计
6053
+ */
6054
+ showSubTotals?: boolean | {
5728
6055
  /** 当子维度个数 <=1 时,仍然展示小计:默认 true */
5729
6056
  always: boolean;
5730
6057
  };
5731
- calcTotals?: CalcTotals;
6058
+ /**
6059
+ * 自定义计算总计
6060
+ */
6061
+ calcGrandTotals?: CalcTotals;
6062
+ /**
6063
+ * 自定义计算小计
6064
+ */
5732
6065
  calcSubTotals?: CalcTotals;
5733
- /** 小计的汇总维度 */
5734
- subTotalsDimensions: string[];
5735
- /** 总计布局位置,默认是下或右 */
5736
- reverseLayout: boolean;
5737
- /** 小计布局位置,默认下或者右 */
5738
- reverseSubLayout: boolean;
5739
- label?: string;
5740
- subLabel?: string;
6066
+ /**
6067
+ * 小计的汇总维度
6068
+ * @example subTotalsDimensions: ['province']
6069
+ */
6070
+ subTotalsDimensions?: string[];
6071
+ /**
6072
+ * 总计布局位置,默认是下或右
6073
+ */
6074
+ reverseGrandTotalsLayout?: boolean;
6075
+ /**
6076
+ * 小计布局位置,默认是下或右
6077
+ */
6078
+ reverseSubTotalsLayout?: boolean;
6079
+ /**
6080
+ * 总计展示名
6081
+ * @default "总计"
6082
+ */
6083
+ grandTotalsLabel?: string;
6084
+ /**
6085
+ * 小计展示名
6086
+ * @default "小计"
6087
+ */
6088
+ subTotalsLabel?: string;
5741
6089
  }
5742
6090
 
5743
- /**
5744
- * tableau的英文是这个,这里有个绕的概念
5745
- * 如,某行维度需要展示小计,实际上是将对应的一列数据进行聚合,所以文案上显示的应该是“展示列小计”
5746
- * 但是内部配置我倾向于仍然按照字段所属维度区,即配置的row,代表的是行维度而不是行小计
5747
- */
5748
6091
  declare interface Totals {
5749
- row?: Partial<Total>;
5750
- col?: Partial<Total>;
6092
+ row?: Total;
6093
+ col?: Total;
5751
6094
  }
5752
6095
 
5753
6096
  declare type TotalSelection = {
@@ -5787,7 +6130,7 @@ declare interface ViewCellHeights {
5787
6130
  };
5788
6131
  }
5789
6132
 
5790
- declare interface ViewMeta_2 {
6133
+ declare interface ViewMeta {
5791
6134
  spreadsheet: SpreadSheet_2;
5792
6135
  id: string;
5793
6136
  x: number;
@@ -5815,7 +6158,7 @@ declare interface ViewMeta_2 {
5815
6158
 
5816
6159
  declare type ViewMetaData_2 = Data | CellData;
5817
6160
 
5818
- declare type ViewMetaIndexType = keyof Pick<ViewMeta_2, 'colIndex' | 'rowIndex'>;
6161
+ declare type ViewMetaIndexType = keyof Pick<ViewMeta, 'colIndex' | 'rowIndex'>;
5819
6162
 
5820
6163
  /**
5821
6164
  * 移动端滚动事件