diff --git a/README.md b/README.md deleted file mode 100644 index 8e793b32dea767988ff5cee32fbaec211a4f5243..0000000000000000000000000000000000000000 --- a/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# ohos_VTable - -#### 介绍 -VTable的ArkWeb包装 - -#### 软件架构 -软件架构说明 - - -#### 安装教程 - -1. xxxx -2. xxxx -3. xxxx - -#### 使用说明 - -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README_zh.md b/README_zh.md index 4d08dc4a053c8b90defa806206cb5704aac1393f..9d289f31518a6dfa2d1e5465b0856804e7442257 100644 --- a/README_zh.md +++ b/README_zh.md @@ -153,71 +153,29 @@ this.vTableController.clearSelected() ``` ## 接口说明 -接口 - -| 功能名称 | 入参内容 | 功能描述 | -|--------------------|--------------------------------------------------------------------------|------------------------------| -| initTabulator | (headers: IHeaderData[], data: Record[], index?: number \| string) | 初始化表格数据 | -| updateDefinition | (title1: string, title2: string) | 修改表头标题 | -| frozenColumn | (title: string) | 冻结指定标题的列 | -| unfrozenColumn | (title: string) | 取消冻结指定标题的列 | -| frozenRow | (index: number) | 冻结指定索引的行 | -| unfrozenRow | (index: number) | 取消冻结指定索引的行 | -| scrollColumn | (title: string) | 滚动到指定标题的列 | -| scrollRow | (index: number) | 滚动到指定索引的行，可指定位置和额外参数 | -| setRowHeight | (index: number, height: number, force?: boolean) | 改变指定索引行的高度，可选是否强制设置 | -| setColumnWidth | (title: string, width: number) | 改变指定标题列的宽度 | -| setColumnDivider | (borderColor?: string) | 设置纵向分割线样式（颜色），默认样式为实线，默认颜色为黑色 | -| setRowDivider | (borderColor?: string) | 设置横向分割线样式（颜色），默认样式为实线，默认颜色为黑色 | -| getScrollCallback | (callback: (top?: number, left?: number) => void) | 设置滚动回调函数，获取滚动时的顶部和左侧位置 | -| tapHoldCell | (func?: () => void) | 设置单元格长按操作的回调函数 | -| richText | (num: number) | 设置文本大小 | -| changeline | 无参数 | 为单元格设置斜线 | -| setBorder | 无参数 | 为单元格设置内嵌边框 | -| setBackground | (backgroundColor: string) | 设置单元格背景色 | -| setBorderColor | (borderColor: string) | 设置单元格边框颜色 | -| restore | 无参数 | 恢复单元格默认样式 | - - -IHeaderData - -| 字段名称 | 类型 | 功能描述 | -|---------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------| -| title | string \| undefined | 表头显示的标题文本 | -| field | string \| undefined | 对应数据中的字段名，用于绑定列数据 | -| editor | CellInputType \| boolean \| undefined | 单元格编辑类型，可指定编辑组件类型或是否启用编辑 | -| width | number \| undefined | 列的宽度（像素） | -| headerSort | boolean \| undefined | 是否启用表头排序功能 | -| resizable | "header" \| "cell" \| boolean \| undefined | 列宽是否可调整，可选仅表头调整、单元格调整或布尔值控制整体 | -| formatter | FormatType \| string \| undefined | 单元格内容格式化类型，支持内置格式类型或自定义格式字符串 | -| formatterParams | MoneyFormatterParams \| ImageFormatterParams \| LinkFormatterParams \| DateTimeFormatterParams \| TickCrossFormatterParams \| StarFormatterParams \| TrafficFormatterParams \| ProgressFormatterParams \| ArrayFormatterParams \| JSONFormatterParams \| ToggleFormatterParams \| undefined | 单元格格式化器的参数，根据 formatter 类型匹配对应参数类型 | -| titleFormatter | FormatType \| undefined | 表头标题的格式化类型 | -| titleFormatterParams | MoneyFormatterParams \| ImageFormatterParams \| LinkFormatterParams \| DateTimeFormatterParams \| TickCrossFormatterParams \| StarFormatterParams \| TrafficFormatterParams \| ProgressFormatterParams \| ArrayFormatterParams \| JSONFormatterParams \| ToggleFormatterParams \| undefined | 表头标题格式化器的参数，根据 titleFormatter 类型匹配对应参数类型 | -| hozAlign | "left" \| "center" \| "right" \| undefined | 单元格内容的水平对齐方式（左对齐/居中/右对齐） | -| editorParams | InputEditorParams \| TextAreaEditorParams \| NumberEditorParams \| RangeEditorParams \| ProgressEditorParams \| ListEditorParams \| undefined | 单元格编辑器的参数，根据 editor 类型匹配对应参数类型 | - -### 依赖类型说明 -| 类型名称 | 说明 | -|-------------------------|--------------------------| -| CellInputType | 单元格输入类型枚举 | -| FormatType | 格式化类型枚举 | -| MoneyFormatterParams | 金额格式化器参数类型 | -| ImageFormatterParams | 图片格式化器参数类型 | -| LinkFormatterParams | 链接格式化器参数类型 | -| DateTimeFormatterParams | 日期时间格式化器参数类型 | -| TickCrossFormatterParams| 勾选/叉号格式化器参数类型| -| StarFormatterParams | 星级格式化器参数类型 | -| TrafficFormatterParams | 流量格式化器参数类型 | -| ProgressFormatterParams | 进度条格式化器参数类型 | -| ArrayFormatterParams | 数组格式化器参数类型 | -| JSONFormatterParams | JSON格式化器参数类型 | -| ToggleFormatterParams | 开关格式化器参数类型 | -| InputEditorParams | 输入框编辑器参数类型 | -| TextAreaEditorParams | 文本域编辑器参数类型 | -| NumberEditorParams | 数字编辑器参数类型 | -| RangeEditorParams | 范围编辑器参数类型 | -| ProgressEditorParams | 进度条编辑器参数类型 | -| ListEditorParams | 列表编辑器参数类型 | +### 接口 + +| 功能名称 | 入参内容 | 功能描述 | +|-------------------------|-------------------------------------------------------------------------|----------------------------------------| +| initTable | [option](https://visactor.io/vtable/option/ListTable): Record> | 初始化表格数据 | +| updateColumns | [newColumns](https://visactor.io/vtable/option/ListTable#columns): Array> | 修改表头标题 | +| frozenToCol | index: number | 冻结指定标题的列 | +| frozenRow | index: number | 冻结指定索引的行 | +| mergeCell | startCol: number, startRow: number, endCol: number, endRow: number | 合并单元格 | +| unmergeCells | startCol: number, startRow: number, endCol: number, endRow: number | 取消合并单元格 | +| customRender | startCol: number, startRow: number, endCol: number, endRow: number, id: string = 'default',[style](https://visactor.io/vtable/option/ListTable-columns-text#style)?: Record| 自定义渲染 | +| cancelCustomRender | startCol: number, startRow: number, endCol: number, endRow: number | 取消自定义渲染 | +| scrollToCol | colIndex: number | 滚动到指定标题的列 | +| scrollToRow | rowIndex: number | 滚动到指定索引的行，可指定位置和额外参数 | +| setRowHeight | rowIndex: number, height: number | 改变指定索引行的高度，可选是否强制设置 | +| setColWidth | colIndex: number, width: number | 改变指定标题列的宽度 | +| setSplitLineColor | color: string[] | 设置分割线颜色 | +| updateOption | [option](https://visactor.io/vtable/option/ListTable): Record> | 更新表格配置 | +| clearSelected | 无 | 清除选中状态 | +| renderWithRecreateCells | 无 | 重新渲染表格 | +| release | 无 | 释放 | + +