Merge pull request #2856 from VisActor/docs/supplemet-gantt-option

Docs/supplemet gantt option
2024-11-23 03:45:41 +00:00 · 2024-11-18 11:53:44 +08:00 · 2024-11-18 11:53:44 +08:00 · 7c4d9a6128
commit 7c4d9a6128
parent a40a7c0a05 530dcfc452
4 changed files with 114 additions and 101 deletions
--- a/docs/assets/changelog/en/release.md
+++ b/docs/assets/changelog/en/release.md
@ -2,28 +2,27 @@

 2024-11-15

-
 **🆕 New feature**
-
- **@visactor/vtable**: add event changing_header_position
- **@visactor/vtable**: drag order highlight line render
- **@visactor/vtable**: add change_header_position_fail event
- **@visactor/vtable**: add argument recalculateColWidths for api toggleHierarchyState [#2817](https://github.com/VisActor/VTable/issues/2817)
- **@visactor/vtable**: add InvertHighlightPlugin
- **@visactor/vtable**: add vtable-calendar
+
+- **@visactor/vtable**: add event changing_header_position
+- **@visactor/vtable-gantt**: drag order highlight line render
+- **@visactor/vtable**: add change_header_position_fail event
+- **@visactor/vtable**: add argument recalculateColWidths for api toggleHierarchyState [#2817](https://github.com/VisActor/VTable/issues/2817)
+- **@visactor/vtable**: add InvertHighlightPlugin
+- **@visactor/vtable**: add vtable-calendar

 **🐛 Bug fix**
-
- **@visactor/vtable**: pivot chart pie type selected state not work [#2178](https://github.com/VisActor/VTable/issues/2178)
- **@visactor/vtable**: rose pivotchart click legend then hover chart render error [#2209](https://github.com/VisActor/VTable/issues/2209)
- **@visactor/vtable**: when chart row is frozen render error [#2800](https://github.com/VisActor/VTable/issues/2800)
- **@visactor/vtable**: when after select range not exist [#2804](https://github.com/VisActor/VTable/issues/2804)
- **@visactor/vtable**: call renderWithRecreateCells should not effect colWidth when widthMode is adaptive [#2835](https://github.com/VisActor/VTable/issues/2835)
- **@visactor/vtable**: add CarouselAnimationPlugin
- **@visactor/vtable**: add HeaderHighlightPlugin
+
+- **@visactor/vtable**: pivot chart pie type selected state not work [#2178](https://github.com/VisActor/VTable/issues/2178)
+- **@visactor/vtable**: rose pivotchart click legend then hover chart render error [#2209](https://github.com/VisActor/VTable/issues/2209)
+- **@visactor/vtable**: when chart row is frozen render error [#2800](https://github.com/VisActor/VTable/issues/2800)
+- **@visactor/vtable**: when after select range not exist [#2804](https://github.com/VisActor/VTable/issues/2804)
+- **@visactor/vtable**: call renderWithRecreateCells should not effect colWidth when widthMode is adaptive [#2835](https://github.com/VisActor/VTable/issues/2835)
+- **@visactor/vtable**: add CarouselAnimationPlugin
+- **@visactor/vtable**: add HeaderHighlightPlugin

 **🔨 Refactor**
-
+
 - **@visactor/vtable**: when set disableSelect but api selectCell can work [#2799](https://github.com/VisActor/VTable/issues/2799)

 [more detail about v1.11.0](https://github.com/VisActor/VTable/releases/tag/v1.11.0)
@ -32,13 +31,10 @@

 2024-11-11

-
 **🐛 Bug fix**
-
- **@visactor/vtable**: pivot chart spec enable select not work [#2210](https://github.com/VisActor/VTable/issues/2210)
- **@visactor/vtable**: sortState field undefined occor error
-

+- **@visactor/vtable**: pivot chart spec enable select not work [#2210](https://github.com/VisActor/VTable/issues/2210)
+- **@visactor/vtable**: sortState field undefined occor error

 [more detail about v1.10.5](https://github.com/VisActor/VTable/releases/tag/v1.10.5)

@ -46,26 +42,23 @@

 2024-11-07

-
 **🆕 New feature**
-
- **@visactor/vtable**: gantt dependency line support tree node [#2701](https://github.com/VisActor/VTable/issues/2701)
- **@visactor/vtable**: when drag on header can select cells continuous [#2751](https://github.com/VisActor/VTable/issues/2751)
+
+- **@visactor/vtable-gantt**: gantt dependency line support tree node [#2701](https://github.com/VisActor/VTable/issues/2701)
+- **@visactor/vtable**: when drag on header can select cells continuous [#2751](https://github.com/VisActor/VTable/issues/2751)

 **🐛 Bug fix**
-
- **@visactor/vtable**: when markline date less then minDate should not show [#2689](https://github.com/VisActor/VTable/issues/2689)
- **@visactor/vtable**: pivot table header icon display incorrect [#2735](https://github.com/VisActor/VTable/issues/2735)
- **@visactor/vtable**: parse axes config error when user set axes [#2749](https://github.com/VisActor/VTable/issues/2749)
- **@visactor/vtable**: cellType set funciton occor error [#2754](https://github.com/VisActor/VTable/issues/2754)
- **@visactor/vtable**: when pivot cell type set chart not data cell render error [#2758](https://github.com/VisActor/VTable/issues/2758)
- **@visactor/vtable**: legend problems [#2764](https://github.com/VisActor/VTable/issues/2764) [#2755](https://github.com/VisActor/VTable/issues/2755)
- **@visactor/vtable**: create task shedule date error [#2771](https://github.com/VisActor/VTable/issues/2771)
- **@visactor/vtable**: fix cellLocation in pivot-table [#2694](https://github.com/VisActor/VTable/issues/2694)
- **@visactor/vtable**: fix menu scale pos problem [#2734](https://github.com/VisActor/VTable/issues/2734)
- **@visactor/vtable**: fix tree frozen row problem [#2619](https://github.com/VisActor/VTable/issues/2619)
-

+- **@visactor/vtable-gantt**: when markline date less then minDate should not show [#2689](https://github.com/VisActor/VTable/issues/2689)
+- **@visactor/vtable**: pivot table header icon display incorrect [#2735](https://github.com/VisActor/VTable/issues/2735)
+- **@visactor/vtable**: parse axes config error when user set axes [#2749](https://github.com/VisActor/VTable/issues/2749)
+- **@visactor/vtable**: cellType set funciton occor error [#2754](https://github.com/VisActor/VTable/issues/2754)
+- **@visactor/vtable**: when pivot cell type set chart not data cell render error [#2758](https://github.com/VisActor/VTable/issues/2758)
+- **@visactor/vtable**: legend problems [#2764](https://github.com/VisActor/VTable/issues/2764) [#2755](https://github.com/VisActor/VTable/issues/2755)
+- **@visactor/vtable-gantt**: create task shedule date error [#2771](https://github.com/VisActor/VTable/issues/2771)
+- **@visactor/vtable**: fix cellLocation in pivot-table [#2694](https://github.com/VisActor/VTable/issues/2694)
+- **@visactor/vtable**: fix menu scale pos problem [#2734](https://github.com/VisActor/VTable/issues/2734)
+- **@visactor/vtable**: fix tree frozen row problem [#2619](https://github.com/VisActor/VTable/issues/2619)

 [more detail about v1.10.4](https://github.com/VisActor/VTable/releases/tag/v1.10.4)

@ -73,12 +66,9 @@

 2024-11-01

-
 **🐛 Bug fix**
-
- **@visactor/vtable**: type define columnWidthConfig
-

+- **@visactor/vtable**: type define columnWidthConfig

 [more detail about v1.10.3](https://github.com/VisActor/VTable/releases/tag/v1.10.3)

@ -86,38 +76,35 @@

 2024-11-01

-
 **🆕 New feature**
-
- **@visactor/vtable**: headerSelectMode option add body setting [#2491](https://github.com/VisActor/VTable/issues/2491)
- **@visactor/vtable**: add freeze_click event [#2641](https://github.com/VisActor/VTable/issues/2641)
- **@visactor/vtable**: add columnWidthConfig to set width by dimensions [#2696](https://github.com/VisActor/VTable/issues/2696)
+
+- **@visactor/vtable**: headerSelectMode option add body setting [#2491](https://github.com/VisActor/VTable/issues/2491)
+- **@visactor/vtable**: add freeze_click event [#2641](https://github.com/VisActor/VTable/issues/2641)
+- **@visactor/vtable**: add columnWidthConfig to set width by dimensions [#2696](https://github.com/VisActor/VTable/issues/2696)

 **🐛 Bug fix**
-
- **@visactor/vtable**: isColumnHeader api judement logic [#2491](https://github.com/VisActor/VTable/issues/2491)
- **@visactor/vtable**: when collapse last group occor error [#2600](https://github.com/VisActor/VTable/issues/2600)
- **@visactor/vtable**: when collapse tree node occor error [#2600](https://github.com/VisActor/VTable/issues/2600)
- **@visactor/vtable**: min aggregator type handle with NaN value [#2627](https://github.com/VisActor/VTable/issues/2627)
- **@visactor/vtable**: when drag row series number cells not scroll [#2647](https://github.com/VisActor/VTable/issues/2647)
- **@visactor/vtable**: rowSeriesNumber when be frozen can render customlayout [#2653](https://github.com/VisActor/VTable/issues/2653)
- **@visactor/vtable**: when has empty tip scrollbar can not be clicked [#2690](https://github.com/VisActor/VTable/issues/2690)
- **@visactor/vtable**: when field set array，record no corresponding field，occur error [#2702](https://github.com/VisActor/VTable/issues/2702)
- **@visactor/vtable**: when has gantt and table same time internal theme should not be changed [#2708](https://github.com/VisActor/VTable/issues/2708)
- **@visactor/vtable**: fix check state update [#2667](https://github.com/VisActor/VTable/issues/2667)
- **@visactor/vtable**: fix list-editor space problem
- **@visactor/vtable**: change pointerupoutside event callback [#2674](https://github.com/VisActor/VTable/issues/2674) [#2659](https://github.com/VisActor/VTable/issues/2659)
- **@visactor/vtable**: add event in react-vtable
- **@visactor/vtable**: add selected_cell event in select-all [#2664](https://github.com/VisActor/VTable/issues/2664)
- **@visactor/vtable**: fix disableRowSeriesNumberSelect in select-all [#2665](https://github.com/VisActor/VTable/issues/2665)
- **@visactor/vtable**: fix title resize in adaptive mode [#2704](https://github.com/VisActor/VTable/issues/2704)
+
+- **@visactor/vtable**: isColumnHeader api judement logic [#2491](https://github.com/VisActor/VTable/issues/2491)
+- **@visactor/vtable**: when collapse last group occor error [#2600](https://github.com/VisActor/VTable/issues/2600)
+- **@visactor/vtable**: when collapse tree node occor error [#2600](https://github.com/VisActor/VTable/issues/2600)
+- **@visactor/vtable**: min aggregator type handle with NaN value [#2627](https://github.com/VisActor/VTable/issues/2627)
+- **@visactor/vtable**: when drag row series number cells not scroll [#2647](https://github.com/VisActor/VTable/issues/2647)
+- **@visactor/vtable**: rowSeriesNumber when be frozen can render customlayout [#2653](https://github.com/VisActor/VTable/issues/2653)
+- **@visactor/vtable**: when has empty tip scrollbar can not be clicked [#2690](https://github.com/VisActor/VTable/issues/2690)
+- **@visactor/vtable**: when field set array，record no corresponding field，occur error [#2702](https://github.com/VisActor/VTable/issues/2702)
+- **@visactor/vtable**: when has gantt and table same time internal theme should not be changed [#2708](https://github.com/VisActor/VTable/issues/2708)
+- **@visactor/vtable**: fix check state update [#2667](https://github.com/VisActor/VTable/issues/2667)
+- **@visactor/vtable**: fix list-editor space problem
+- **@visactor/vtable**: change pointerupoutside event callback [#2674](https://github.com/VisActor/VTable/issues/2674) [#2659](https://github.com/VisActor/VTable/issues/2659)
+- **@visactor/vtable**: add event in react-vtable
+- **@visactor/vtable**: add selected_cell event in select-all [#2664](https://github.com/VisActor/VTable/issues/2664)
+- **@visactor/vtable**: fix disableRowSeriesNumberSelect in select-all [#2665](https://github.com/VisActor/VTable/issues/2665)
+- **@visactor/vtable**: fix title resize in adaptive mode [#2704](https://github.com/VisActor/VTable/issues/2704)

 **🔨 Refactor**
-
- **@visactor/vtable**: custom merge cell ignore check state jude [#2683](https://github.com/VisActor/VTable/issues/2683)
- **@visactor/vtable**: paste cell value should use editor validateValidate api [#2691](https://github.com/VisActor/VTable/issues/2691)
-

+- **@visactor/vtable**: custom merge cell ignore check state jude [#2683](https://github.com/VisActor/VTable/issues/2683)
+- **@visactor/vtable**: paste cell value should use editor validateValidate api [#2691](https://github.com/VisActor/VTable/issues/2691)

 [more detail about v1.10.2](https://github.com/VisActor/VTable/releases/tag/v1.10.2)

@ -125,13 +112,10 @@

 2024-10-23

-
 **🐛 Bug fix**
-
- **@visactor/vtable**: when set rowSeriesNumber then sort icon not update [#2643](https://github.com/VisActor/VTable/issues/2643)
- **@visactor/vtable**: disable cellInnerBorder when no frame border
-

+- **@visactor/vtable**: when set rowSeriesNumber then sort icon not update [#2643](https://github.com/VisActor/VTable/issues/2643)
+- **@visactor/vtable**: disable cellInnerBorder when no frame border

 [more detail about v1.10.1](https://github.com/VisActor/VTable/releases/tag/v1.10.1)

@ -139,7 +123,6 @@

 2024-10-18

-
 **🆕 New feature**

 - **@visactor/vtable**: add maxHeight in menu container [#2602](https://github.com/VisActor/VTable/issues/2602)
@ -162,28 +145,22 @@
 - **@visactor/vtable**: fix row resize mark position when scrolled vertically [#2606](https://github.com/VisActor/VTable/issues/2606)
 - **@visactor/vtable**: fix sort icon update in transpose list-table

-
-
 [more detail about v1.10.0](https://github.com/VisActor/VTable/releases/tag/v1.10.0)

 # v1.9.1

 2024-10-12

-
 **🐛 Bug fix**

 - **@visactor/vtable**: fix sort icon update in merge cell

-
-
 [more detail about v1.9.1](https://github.com/VisActor/VTable/releases/tag/v1.9.1)

 # v1.9.0

 2024-10-11

-
 **🆕 New feature**

 - **@visactor/vtable**: add scrollTo animation function
@ -212,20 +189,16 @@

 2024-10-08

-
 **🐛 Bug fix**

 - **@visactor/vtable**: fix richtext icon update [#2281](https://github.com/VisActor/VTable/issues/2281)

-
-
 [more detail about v1.8.2](https://github.com/VisActor/VTable/releases/tag/v1.8.2)

 # v1.8.1

 2024-09-30

-
 **🔨 Refactor**

 - **@visactor/vue-vtable**: rename vue component name
--- a/docs/assets/changelog/zh/release.md
+++ b/docs/assets/changelog/zh/release.md
@ -2,7 +2,6 @@

 2024-11-15

-
 **🆕 新增功能**

 - **@visactor/vtable**: 增加日历图
@ -11,7 +10,7 @@
 - **@visactor/vtable**: 增加表头高亮插件
 - **@visactor/vtable**: 增加 changing_header_position 事件
 - **@visactor/vtable**: 增加 change_header_position_fail 事件
- **@visactor/vtable**: 增加拖拽高亮标记线
+- **@visactor/vtable-gantt**: 增加拖拽高亮标记线
 - **@visactor/vtable**: 增加树形结构 recalculateColWidths api 参数 [#2817](https://github.com/VisActor/VTable/issues/2817)

 **🐛 功能修复**
@ -24,7 +23,7 @@

 **🔨 功能重构**

- **@visactor/vtable**: 设置 disableSelect 时，selectCell api可调用 [#2799](https://github.com/VisActor/VTable/issues/2799)
+- **@visactor/vtable**: 设置 disableSelect 时，selectCell api 可调用 [#2799](https://github.com/VisActor/VTable/issues/2799)

 [更多详情请查看 v1.11.0](https://github.com/VisActor/VTable/releases/tag/v1.11.0)

@ -32,15 +31,12 @@

 2024-11-11

-
 **🐛 功能修复**

-
 181 / 5,000
+
 - **@visactor/vtable**: 修复数据透视图规范启用选择不起作用 [#2210](https://github.com/VisActor/VTable/issues/2210)
- **@visactor/vtable**: 修复sortState 字段未定义发生错误
-
-
+- **@visactor/vtable**: 修复 sortState 字段未定义发生错误

 [更多详情请查看 v1.10.5](https://github.com/VisActor/VTable/releases/tag/v1.10.5)

@ -48,37 +44,33 @@

 2024-11-07

-
 **🆕 新增功能**

- **@visactor/vtable**：甘特图依赖关系线支持树节点 [#2701](https://github.com/VisActor/VTable/issues/2701)
+- **@visactor/vtable-gantt**：甘特图依赖关系线支持树节点 [#2701](https://github.com/VisActor/VTable/issues/2701)
 - **@visactor/vtable**：在标题上拖动时可以连续选择单元格 [#2751](https://github.com/VisActor/VTable/issues/2751)

 **🐛 功能修复**

- **@visactor/vtable**: 修复当标记线日期小于 minDate 时不应显示 [#2689](https://github.com/VisActor/VTable/issues/2689)
+- **@visactor/vtable-gantt**: 修复当标记线日期小于 minDate 时不应显示 [#2689](https://github.com/VisActor/VTable/issues/2689)
 - **@visactor/vtable**: 修复数据透视表标题图标显示不正确 [#2735](https://github.com/VisActor/VTable/issues/2735)
 - **@visactor/vtable**: 修复当用户设置轴时解析轴配置错误 [#2749](https://github.com/VisActor/VTable/issues/2749)
- **@visactor/vtable**: 修复cellType 设置函数发生错误 [#2754](https://github.com/VisActor/VTable/issues/2754)
+- **@visactor/vtable**: 修复 cellType 设置函数发生错误 [#2754](https://github.com/VisActor/VTable/issues/2754)
 - **@visactor/vtable**: 修复当数据透视表单元格类型设置为图表而非数据单元格时渲染错误[#2758](https://github.com/VisActor/VTable/issues/2758)
 - **@visactor/vtable**: 修复图例问题 [#2764](https://github.com/VisActor/VTable/issues/2764) [#2755](https://github.com/VisActor/VTable/issues/2755)
- **@visactor/vtable**: 修复创建任务计划日期错误 [#2771](https://github.com/VisActor/VTable/issues/2771)
+- **@visactor/vtable-gantt**: 修复创建任务计划日期错误 [#2771](https://github.com/VisActor/VTable/issues/2771)
 - **@visactor/vtable**: 修复数据透视表中的单元格位置 [#2694](https://github.com/VisActor/VTable/issues/2694)
 - **@visactor/vtable**: 修复菜单比例位置问题[#2734](https://github.com/VisActor/VTable/issues/2734)
 - **@visactor/vtable**：修复树冻结行问题 [#2619](https://github.com/VisActor/VTable/issues/2619)

-
 [更多详情请查看 v1.10.4](https://github.com/VisActor/VTable/releases/tag/v1.10.4)

 # v1.10.3

 2024-11-01

-
 **🐛 功能修复**

- **@visactor/vtable**: 修复类型columnWidthConfig定义
-
+- **@visactor/vtable**: 修复类型 columnWidthConfig 定义

 [更多详情请查看 v1.10.3](https://github.com/VisActor/VTable/releases/tag/v1.10.3)

--- a/docs/assets/option/en/table/gantt.md
+++ b/docs/assets/option/en/table/gantt.md
@ -162,3 +162,27 @@ For specific reference, see the configuration in ListTable: [Specific configurat
 Pixel ratio.

 Optional
+
+## dateFormat(string)
+
+The date format of the new schedule. The date data will be added to the date field value in the data record. The default value is 'yyyy-mm-dd'.
+
+Not required
+
+```
+dateFormat?:
+| 'yyyy-mm-dd'
+| 'dd-mm-yyyy'
+| 'mm/dd/yyyy'
+| 'yyyy/mm/dd'
+| 'dd/mm/yyyy'
+| 'yyyy.mm.dd'
+| 'dd.mm.yyyy'
+| 'mm.dd.yyyy';
+```
+
+## underlayBackgroundColor(string)
+
+The fill color of the canvas outside the drawing range is '#fff' by default, and it also matches the background color of the table on the left.
+
+Not required
--- a/docs/assets/option/zh/table/gantt.md
+++ b/docs/assets/option/zh/table/gantt.md
@ -162,3 +162,27 @@
 像素比率。

 非必填
+
+## dateFormat(string)
+
+新建排期的日期格式，日期数据将被添加到数据 record 中日期字段值中，默认为'yyyy-mm-dd'。
+
+非必填
+
+```
+  dateFormat?:
+    | 'yyyy-mm-dd'
+    | 'dd-mm-yyyy'
+    | 'mm/dd/yyyy'
+    | 'yyyy/mm/dd'
+    | 'dd/mm/yyyy'
+    | 'yyyy.mm.dd'
+    | 'dd.mm.yyyy'
+    | 'mm.dd.yyyy';
+```
+
+## underlayBackgroundColor(string)
+
+绘制范围外的 canvas 上填充的颜色，默认为'#fff'，同时也适配到左侧表格的背景色。
+
+非必填