docs: update event

VisActor · Feb 5, 2025 · f218088 · f218088
1 parent 62ef685
commit f218088
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 20 deletions.
diff --git a/docs/assets/api/en/event/event.md b/docs/assets/api/en/event/event.md
@@ -128,19 +128,19 @@ keystroke event
 
 Mouse over a cell event
 
-Refer to the parameter types introduced in the CLICK_CELL event for the parameter types of the event callback function.
+Refer to the parameter types introduced in the CLICK_CELL event for the parameter types of the event callback function (some parameters may be omitted and can be obtained through the corresponding interfaces).
 
 ## MOUSEENTER_CELL
 
 Mouse into cell event
 
-Refer to the parameter types introduced in the CLICK_CELL event for the parameter types of the event callback function.
+Refer to the parameter types introduced in the CLICK_CELL event for the parameter types of the event callback function. (some parameters may be omitted and can be obtained through the corresponding interfaces).
 
 ## MOUSELEAVE_CELL
 
 Mouse-out-of-cell event
 
-Refer to the parameter types introduced in the CLICK_CELL event for the parameter types of the event callback function.
+Refer to the parameter types introduced in the CLICK_CELL event for the parameter types of the event callback function. (some parameters may be omitted and can be obtained through the corresponding interfaces).
 
 ## CONTEXTMENU_CELL
 

diff --git a/docs/assets/api/zh/event/event.md b/docs/assets/api/zh/event/event.md
@@ -131,19 +131,19 @@ TABLE_EVENT_TYPE = {
 
 鼠标在某个单元格上移动事件
 
-事件回调函数的参数类型请参考 CLICK_CELL 事件中介绍的参数类型。
+事件回调函数的参数类型请参考 CLICK_CELL 事件中介绍的参数类型（会有个别参数缺省，可以通过相应的接口自行获取）。
 
 ## MOUSEENTER_CELL
 
 鼠标进入单元格事件
 
-事件回调函数的参数类型请参考 CLICK_CELL 事件中介绍的参数类型。
+事件回调函数的参数类型请参考 CLICK_CELL 事件中介绍的参数类型（会有个别参数缺省，可以通过相应的接口自行获取）。
 
 ## MOUSELEAVE_CELL
 
 鼠标离开单元格事件
 
-事件回调函数的参数类型请参考 CLICK_CELL 事件中介绍的参数类型。
+事件回调函数的参数类型请参考 CLICK_CELL 事件中介绍的参数类型（会有个别参数缺省，可以通过相应的接口自行获取）。
 
 ## CONTEXTMENU_CELL
 

diff --git a/docs/assets/demo/en/gantt/gantt-dependency-link-create.md b/docs/assets/demo/en/gantt/gantt-dependency-link-create.md
@@ -189,9 +189,9 @@ const option = {
   records,
   taskListTable: {
     columns: columns,
-    tableWidth: 400,
+    tableWidth: 'auto',
     minTableWidth: 100,
-    maxTableWidth: 600
+    maxTableWidth: 500
   },
   dependency: {
     links: [

diff --git a/docs/assets/demo/zh/gantt/gantt-dependency-link-create.md b/docs/assets/demo/zh/gantt/gantt-dependency-link-create.md
@@ -189,9 +189,9 @@ const option = {
   records,
   taskListTable: {
     columns: columns,
-    tableWidth: 400,
+    tableWidth: 'auto',
     minTableWidth: 100,
-    maxTableWidth: 600
+    maxTableWidth: 500
   },
   dependency: {
     links: [

diff --git a/packages/vtable/src/ts-types/list-table/define/basic-define.ts b/packages/vtable/src/ts-types/list-table/define/basic-define.ts
@@ -68,7 +68,9 @@ export interface IBasicColumnBodyDefine {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo & { table: BaseTableAPI }) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((
+        args: CellInfo & { table: BaseTableAPI }
+      ) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
 
   // cellType?: ColumnTypeOption | BaseColumn<T, any> | null;
 

diff --git a/packages/vtable/src/ts-types/list-table/layout-map/api.ts b/packages/vtable/src/ts-types/list-table/layout-map/api.ts
@@ -55,7 +55,7 @@ export interface HeaderData extends WidthData {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
   icons?: (string | ColumnIconOption)[] | ((args: CellInfo) => (string | ColumnIconOption)[]);
 
   field: FieldDef;
@@ -117,7 +117,7 @@ export interface ColumnData extends WidthData {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
 
   cellType: 'text' | 'link' | 'image' | 'video' | 'sparkline' | 'progressbar' | 'chart' | 'checkbox' | 'radio';
   /** 如果是绘制图表库组件的图表类型 需要将注入的组件名称 写到chartType */
@@ -165,7 +165,7 @@ export interface IndicatorData extends WidthData {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
   sparklineSpec?: SparklineSpec | ((arg0: CustomRenderFunctionArg) => SparklineSpec);
   /**
    * 是否禁用调整列宽,如果是转置表格或者是透视表的指标是行方向指定 那该配置不生效
@@ -187,7 +187,7 @@ export interface SeriesNumberColumnData extends WidthData {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
   headerIcon?: string | ColumnIconOption | (string | ColumnIconOption)[];
   cellType: 'text' | 'link' | 'image' | 'video' | 'checkbox';
   headerType: 'text' | 'link' | 'image' | 'video' | 'checkbox';

diff --git a/packages/vtable/src/ts-types/pivot-table/dimension/basic-dimension.ts b/packages/vtable/src/ts-types/pivot-table/dimension/basic-dimension.ts
@@ -19,7 +19,7 @@ export interface IBasicDimension {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
   /** 维度作为行表头时起作用，表示该维度单元格的宽度 */
   width?: number | string;
   /** 维度作为行表头时起作用，表示该维度单元格的最小宽度 */
@@ -70,5 +70,5 @@ export interface IBasicDimension {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
 }
diff --git a/packages/vtable/src/ts-types/pivot-table/indicator/basic-indicator.ts b/packages/vtable/src/ts-types/pivot-table/indicator/basic-indicator.ts
@@ -57,7 +57,7 @@ export interface IBasicColumnIndicator {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
 
   /** 指标值body单元格自定义渲染内容定义 */
   customRender?: ICustomRender; // body单元格的自定义内容

diff --git a/packages/vtable/src/ts-types/table-engine.ts b/packages/vtable/src/ts-types/table-engine.ts
@@ -129,7 +129,7 @@ export interface IRowSeriesNumber {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
   // /** 选中整行或者全选时 是否包括序号部分 */
   // selectRangeInclude?: boolean;
   /** 是否可拖拽顺序 */
@@ -155,7 +155,7 @@ export interface ColumnSeriesNumber {
     | string
     | ColumnIconOption
     | (string | ColumnIconOption)[]
-    | ((args: CellInfo) => string | ColumnIconOption | (string | ColumnIconOption)[]);
+    | ((args: CellInfo) => undefined | string | ColumnIconOption | (string | ColumnIconOption)[]);
   /** 选中整行或者全选时 是否包括序号部分 */
   selectRangeInclude?: boolean;
   /** 是否可拖拽顺序 */