diff --git a/README-zh.md b/README-zh.md index 8f055f7..de4e3eb 100644 --- a/README-zh.md +++ b/README-zh.md @@ -10,10 +10,10 @@ 🚀Luckysheet ,一款纯前端类似excel的在线表格,功能强大、配置简单、完全开源。 ## 相关链接 - | 源码 | 文档 | Demo | 插件Demo | - | ------ | -------- | ------ | ------ | - | [Github](https://github.com/mengshukeji/Luckysheet)| [在线文档](https://mengshukeji.github.io/LuckysheetDocs/zh/) | [在线Demo](https://mengshukeji.github.io/LuckysheetDemo) | [导入Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | - | [Gitee镜像](https://gitee.com/mengshukeji/Luckysheet)| [Gitee在线文档](https://mengshukeji.gitee.io/LuckysheetDocs/zh/) | [Gitee在线Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee导入Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | + | 源码 | 文档 | Demo | 插件Demo | 论坛 | + | ------ | -------- | ------ | ------ | ------ | + | [Github](https://github.com/mengshukeji/Luckysheet)| [在线文档](https://mengshukeji.github.io/LuckysheetDocs/zh/) | [在线Demo](https://mengshukeji.github.io/LuckysheetDemo) | [导入Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [中文论坛](https://support.qq.com/product/288322) | + | [Gitee镜像](https://gitee.com/mengshukeji/Luckysheet)| [Gitee在线文档](https://mengshukeji.gitee.io/LuckysheetDocs/zh/) | [Gitee在线Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee导入Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Gitter](https://gitter.im/mengshukeji/Luckysheet) |  @@ -200,6 +200,7 @@ npm run build - [@danielcai1987](https://github.com/danielcai1987) - [@qq6690876](https://github.com/qq6690876) - [@javahuang](https://github.com/javahuang) +- [@TimerGang](https://github.com/TimerGang) - [@gsw945](https://github.com/gsw945) - [@swen-xiong](https://github.com/swen-xiong) diff --git a/README.md b/README.md index 84110a3..cfc7507 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,10 @@ English| [简体中文](./README-zh.md) 🚀Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source. ## Links - | Source Code | Documentation | Demo | Plugins Demo | - | ------ | -------- | ------ | ------ | - | [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://mengshukeji.github.io/LuckysheetDocs/) | [Online Demo](https://mengshukeji.github.io/LuckysheetDemo) | [Import Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | - | [Gitee Mirror](https://gitee.com/mengshukeji/Luckysheet)| [Gitee Online Documentation](https://mengshukeji.gitee.io/LuckysheetDocs/) | [Gitee Online Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee Import Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | + | Source Code | Documentation | Demo | Plugins Demo | Forum | + | ------ | -------- | ------ | ------ | ------ | + | [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://mengshukeji.github.io/LuckysheetDocs/) | [Online Demo](https://mengshukeji.github.io/LuckysheetDemo) | [Import Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [Chinese Forum](https://support.qq.com/product/288322) | + | [Gitee Mirror](https://gitee.com/mengshukeji/Luckysheet)| [Gitee Online Documentation](https://mengshukeji.gitee.io/LuckysheetDocs/) | [Gitee Online Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee Import Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Gitter](https://gitter.im/mengshukeji/Luckysheet) |  @@ -196,6 +196,7 @@ Create a table - [@danielcai1987](https://github.com/danielcai1987) - [@qq6690876](https://github.com/qq6690876) - [@javahuang](https://github.com/javahuang) +- [@TimerGang](https://github.com/TimerGang) - [@gsw945](https://github.com/gsw945) - [@swen-xiong](https://github.com/swen-xiong) diff --git a/docs/guide/README.md b/docs/guide/README.md index 272dcb4..9e8f407 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -136,6 +136,7 @@ After `npm run build`, all files in the `dist` folder are copied to the project + ``` diff --git a/docs/guide/api.md b/docs/guide/api.md index 927b12b..c78c051 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -541,6 +541,154 @@ Use note: ------------ +### setRowHeight(rowInfo [,setting]) + +(TODO) + +- **Parameter**: + + - {Object} [rowInfo]: Correspondence between number of rows and height + + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Set the height of the specified ~~row~~ + +- **Usage**: + + - Set the height of the first row to 50px and the height of the second row to 60px + + `luckysheet.setRowHeight({0:50,1:60})` + +------------ + +### setColumnWidth(columnInfo [,setting]) + +(TODO) + +- **Parameter**: + + - {Number} [columnInfo]: Correspondence between the number of columns and the width + + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Set the width of the specified column + +- **Usage**: + + - Set the width of the first column to 50px and the width of the second column to 60px + + `luckysheet.setColumnWidth({0:50,1:60})` + +------------ + +### getRowHeight(rowInfo [,setting]) + +(TODO) + +- **Parameter**: + + - {Array} [rowInfo]: The number of rows + + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Get the height of the specified row, get the object corresponding to the number of rows and height + +- **Usage**: + + - The height of the first row is 50px, the height of the second row is 60px, get these values + + `luckysheet.getRowHeight([0,1])` + Return to get + `{0:50,1:60}` + +------------ + +### getColumnWidth(columnInfo [,setting]) + +(TODO) + +- **Parameter**: + + - {Array} [columnInfo]: The number of columns + + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Get the width of the specified column, get the object of the corresponding relationship between the number of columns and the width + +- **Usage**: + + - The width of the first column is 50px, the width of the second column is 60px, get these values + + `luckysheet.getColumnWidth([0,1])` + Return to get + `{0:50,1:60}` + +------------ + +### getDefaultRowHeight([,setting]) + +(TODO) + +- **Parameter**: + + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Get the default row height of the specified worksheet + +- **Usage**: + + - Returns the default row height of the current worksheet + + `luckysheet.getDefaultRowHeight()` + Return to get + `19` + +------------ + +### getDefaultColumnWidth([,setting]) + +(TODO) + +- **Parameter**: + + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Get the default column width of the specified worksheet + +- **Usage**: + + - Returns the default column width of the current worksheet + + `luckysheet.getDefaultColumnWidth()` + Return to get + `73` + +------------ + ## Selection operation ### getRange() @@ -2013,6 +2161,32 @@ Use note: ------------ +### setSheetZoom(zoom [,setting]) + +[todo] + + +- **Parameter**: + + - {Number} [zoom]: Worksheet zoom ratio + + - {PlainObject} [setting]: optional parameters + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Set worksheet zoom ratio + + +- **Usage**: + + - Set the current worksheet zoom ratio to 0.5 + ```js + luckysheet.setSheetZoom(0.5) + ``` + +------------ + ### showGridLines([setting]) - **Parameter**: @@ -2295,6 +2469,63 @@ Use note: ------------ +## Data Verification + +### setDataVerification(option, [setting]) + +[todo] + +- **Parameter**: + + - {Object} [option]: Configuration information for data verification + - {PlainObject} [setting]: optional parameters + + {Array | Object | String} [range]: The selection area for data verification, The format of the supported selection is `"A1:B2"`, `"sheetName!A1:B2"` or `{row:[0,1] ,column:[0,1]}`, can only be a single selection; the default is the current selection + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Specify the worksheet range to set the data verification function and set the parameters + +------------ + +### deleteDataVerification([setting]) + +[todo, to be confirmed whether it is reasonable] + +- **Parameter**: + + - {PlainObject} [setting]: optional parameters + + {Array | Object | String} [range]: The selection area for data verification, The format of the supported selection is `"A1:B2"`, `"sheetName!A1:B2"` or `{row:[0,1] ,column:[0,1]}`, can only be a single selection; the default is the current selection + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Specify the worksheet range to delete the data verification function + +------------ + +## Worksheet Protection + + +### setProtection(option, [setting]) + +[todo] + +- **Parameter**: + + - {Object} [option]: Configuration information for worksheet protection + - {PlainObject} [setting]: optional parameters + + {Number} [order]: Worksheet subscript; the default value is the current worksheet subscript + + {Function} [success]: callback function for the end of the operation + +- **Explanation**: + + Specify the worksheet to set the worksheet protection + +------------ + ## Public method ### transToCellData(data [,setting])
diff --git a/docs/guide/config.md b/docs/guide/config.md index a1c016c..4d9e44d 100644 --- a/docs/guide/config.md +++ b/docs/guide/config.md @@ -743,6 +743,25 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura - {String} [oldColor]: Before modification, the current worksheet color - {String} [newColor]: After modification, the current worksheet color +------------ +### sheetZoomBefore +- Type: Function +- Default: null +- Usage: Before worksheet zoom +- Parameter: + - {Number} [i]: `index` of current worksheet + - {String} [zoom]: Current worksheet zoom ratio + +------------ +### sheetZoomAfter +- Type: Function +- Default: null +- Usage: After worksheet zoom +- Parameter: + - {Number} [i]: `index` of current worksheet + - {String} [oldZoom]: Before modification, the current worksheet zoom ratio + - {String} [newZoom]: After modification, the current worksheet zoom ratio + ------------ ## Workbook diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md index 950d613..0659af5 100644 --- a/docs/zh/guide/README.md +++ b/docs/zh/guide/README.md @@ -137,6 +137,7 @@ npm run build + ``` diff --git a/docs/zh/guide/api.md b/docs/zh/guide/api.md index 514f736..a1753be 100644 --- a/docs/zh/guide/api.md +++ b/docs/zh/guide/api.md @@ -542,6 +542,150 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ------------ +### setRowHeight(rowInfo [,setting]) + +- **参数**: + + - {Object} [rowInfo]: 行数和高度对应关系 + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 设置指定行的高度 + +- **示例**: + + - 设置第一行高度为50px,第二行高度为60px + + `luckysheet.setRowHeight({0:50,1:60})` + +------------ + +### setColumnWidth(columnInfo [,setting]) + +- **参数**: + + - {Number} [columnInfo]: 列数和宽度对应关系 + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 设置指定列的宽度 + +- **示例**: + + - 设置第一列宽度为50px,第二列宽度为60px + + `luckysheet.setColumnWidth({0:50,1:60})` + +------------ + +### getRowHeight(rowInfo [,setting]) + +(TODO) + +- **参数**: + + - {Array} [rowInfo]: 行数 + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 获取指定行的高度,得到行数和高度对应关系的对象 + +- **示例**: + + - 第一行高度为50px,第二行高度为60px,获取这些值 + + `luckysheet.getRowHeight([0,1])` + 返回得到 + `{0:50,1:60}` + +------------ + +### getColumnWidth(columnInfo [,setting]) + +(TODO) + +- **参数**: + + - {Array} [columnInfo]: 列数 + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 获取指定列的宽度,得到列数和宽度对应关系的对象 + +- **示例**: + + - 第一列宽度为50px,第二列宽度为60px,获取这些值 + + `luckysheet.getColumnWidth([0,1])` + 返回得到 + `{0:50,1:60}` + +------------ + +### getDefaultRowHeight([,setting]) + +(TODO) + +- **参数**: + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 获取指定工作表的默认行高 + +- **示例**: + + - 返回当前工作表的默认行高 + + `luckysheet.getDefaultRowHeight()` + 返回得到 + `19` + +------------ + +### getDefaultColumnWidth([,setting]) + +(TODO) + +- **参数**: + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 获取指定工作表的默认列宽 + +- **示例**: + + - 返回当前工作表的默认列宽 + + `luckysheet.getDefaultColumnWidth()` + 返回得到 + `73` + +------------ + ## 选区操作 ### getRange() @@ -1651,8 +1795,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### getAllSheets() -[todo] - - **说明**: 返回所有工作表配置,格式同工作表配置,得到的结果可用于表格初始化时作为options.data使用。 @@ -1922,9 +2064,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### setSheetOrder(orderList [,setting]) -[todo] - - - **参数**: - {Array} [orderList]: 工作表顺序,设置工作表的index和order来指定位置,如: @@ -1959,6 +2098,30 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ------------ +### setSheetZoom(zoom [,setting]) + +- **参数**: + + - {Number} [zoom]: 工作表缩放比例,值范围为0.1 ~ 4; + + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 设置工作表缩放比例 + + +- **示例**: + + - 设置当前工作表缩放比例为0.5 + ```js + luckysheet.setSheetZoom(0.5) + ``` + +------------ + ### showGridLines([setting]) - **参数**: @@ -2019,9 +2182,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### refresh([setting]) -[todo] - - - **参数**: - {PlainObject} [setting]: 可选参数 @@ -2078,27 +2238,22 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### getScreenshot([setting]) -[todo] - - **参数**: - {PlainObject} [setting]: 可选参数 - + {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区 - + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区 - **说明**: - 返回指定选区截图后生成的base64格式的图片 + 返回当前表格指定选区截图后生成的base64格式的图片 ------------ ### setWorkbookName(name [,setting]) -[todo] - - **参数**: - - {Number} [name]: 工作簿名称 + - {String} [name]: 工作簿名称 - {PlainObject} [setting]: 可选参数 + {Function} [success]: 操作结束的回调函数 @@ -2110,9 +2265,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### undo([setting]) -[todo] - - - **参数**: - {PlainObject} [setting]: 可选参数 @@ -2126,9 +2278,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### redo([setting]) -[todo] - - - **参数**: - {PlainObject} [setting]: 可选参数 @@ -2238,6 +2387,67 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ------------ +## 数据验证 + +### setDataVerification(optionItem, [setting]) + +- **参数**: + + - {Object} [optionItem]: 数据验证的配置信息 + + {String} [type]: 类型;值可为`"dropdown"`(下拉列表)、`"checkbox"`(复选框)、`"number"`(数字)、`"number_integer"`(数字-整数)、`"number_decimal"`(数字-小数)、`"text_content"`(文本-内容)、`"text_length"`(文本-长度)、`"date"`(日期)、`"validity"`(有效性); + + {String | Null} [type2]: 条件类型;类型`type`值为`"dropdown"`、`"checkbox"`时,`type2`值可为`null`;类型`type`值为`"number"`、`"number_integer"`、`"number_decimal"`、`"text_length"`时,`type2`值可为`"bw"`(介于)、`"nb"`(不介于)、`"eq"`(等于)、`"ne"`(不等于)、`"gt"`(大于)、`"lt"`(小于)、`"gte"`(大于等于)、`"lte"`(小于等于);类型`type`值为`"text_content"`时,`type2`值可为`"include"`(包括)、`"exclude"`(不包括)、`"equal"`(等于);类型`type`值为`"date"`时,`type2`值可为`"bw"`(介于)、`"nb"`(不介于)、`"eq"`(等于)、`"ne"`(不等于)、`"bf"`(早于)、`"nbf"`(不早于)、`"af"`(晚于)、`"naf"`(不晚于);类型`type`值为`"validity"`时,`type2`值可为`"card"`(身份证号码)、`"phone"`(手机号); + + {String | Number} [value1]: 条件值1;类型`type`值为`"dropdown"`时,`value1`值可为选区或以英文逗号隔开的字符串,如`"1,2,3"`或者`"A1:B2"`;类型`type`值为`"validity"`时,`value1`值可为空;其他类型时`value1`值为数值或字符串; + + {String | Number} [value2]: 条件值2;类型`type`值为`"checkbox"`或者条件类型`type2`值为`"bw"`、`"nb"`时有`value2`值,条件值为数值或日期时,条件值2要大于等于条件值1;其它情况可为空; + + {Boolean} [remote]: 自动远程获取选项;默认为`false`; + + {Boolean} [prohibitInput]: 输入数据无效时禁止输入;默认为`false`; + + {Boolean} [hintShow]: 选中单元格时显示提示语;默认为`false`; + + {String} [hintText]: 提示语文本;`hintShow`为`true`时需配置; + - {PlainObject} [setting]: 可选参数 + + {Object | String} [range]: 数据验证的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 指定工作表范围设置数据验证功能,并设置参数 + +------------ + +### deleteDataVerification([setting]) + +- **参数**: + + - {PlainObject} [setting]: 可选参数 + + {Object | String} [range]: 数据验证的选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 指定工作表范围删除数据验证功能 + +------------ + +## 工作表保护 + + +### setProtection(option, [setting]) + +[todo] + +- **参数**: + + - {Object} [option]: 工作表保护的配置信息 + - {PlainObject} [setting]: 可选参数 + + {Number} [order]: 工作表下标;默认值为当前工作表下标 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 指定工作表设置工作表保护功能 + +------------ + ## 公共方法 ### transToCellData(data [,setting]) @@ -2257,8 +2467,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ### transToData(celldata [,setting]) -[todo] - - **参数**: - {Array} [celldata]: data数据 @@ -2282,6 +2490,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ------------ + ## 旧版API ::: warning diff --git a/docs/zh/guide/config.md b/docs/zh/guide/config.md index 0d804e0..94e2a76 100644 --- a/docs/zh/guide/config.md +++ b/docs/zh/guide/config.md @@ -106,29 +106,114 @@ Luckysheet开放了更细致的自定义配置选项,分别有 ### loadUrl - 类型:String - 默认值:"" -- 作用:配置`loadUrl`的地址,与`loadSheetUrl`配合使用,一般用于大数据量的时候。也可以不用Luckysheet提供的接口参数,使用[data](#data)参数可以提前准备好所有表格数据用于初始化。 - - Luckysheet会通过ajax请求整个表格数据,默认载入status为1的sheet数据中的所有`celldata`,其余的sheet载入除`celldata`字段外的所有字段。但是考虑到一些公式、图表及数据透视表会引用其他sheet的数据,所以前台会加一个判断,如果该当前sheet引用了其他sheet的数据则会通过`loadSheetUrl`配置的接口地址请求数据,把引用到的sheet的数据一并补全。因为 `loadUrl`只负责当前页数据,所以还需要配置`loadSheetUrl`作为异步加载数据的接口。 +- 作用:配置`loadUrl`接口地址,加载所有工作表的配置,并包含当前页单元格数据,与`loadSheetUrl`配合使用。参数为`gridKey`(表格主键)。 + + 源码的请求写法是: + ```js + $.post(loadurl, {"gridKey" : server.gridKey}, function (d) {}) + ``` + > 参见源码 [`src/core.js`](https://github.com/mengshukeji/Luckysheet/blob/master/src/core.js) + + Luckysheet会通过ajax请求(POST)整个表格的数据,默认载入status为1的sheet数据中的`celldata`,其余的sheet载入除`celldata`字段外的所有配置字段。特别是在数据量大的时候,`loadUrl`只负责当前页单元格数据,配置`loadSheetUrl`作为其它工作表异步加载单元格数据的接口,可以提高性能。 + + 一个合格的接口返回的json字符串数据为: + + ```js + "[ + //status为1的sheet页,重点是需要提供初始化的数据celldata + { + "name": "Cell", + "index": "sheet_001", + "order": 0, + "status": 1, + "celldata": [{"r":0,"c":0,"v":{"v":1,"m":"1","ct":{"fa":"General","t":"n"}}}] + }, + //其他status为0的sheet页,无需提供celldata,只需要配置项即可 + { + "name": "Data", + "index": "sheet_002", + "order": 1, + "status": 0 + }, + { + "name": "Picture", + "index": "sheet_003", + "order": 2, + "status": 0 + } + ]" + ``` + 有几个注意点 + + 这是一个字符串,类似于JSON.stringify()处理后的json数据,压缩后的数据便于传输 + + loadUrl是一个post请求,也是为了支持大数据量 + + 考虑到一些公式、图表及数据透视表会引用其他sheet的数据,所以前台会加一个判断,如果该当前sheet引用了其他sheet的数据则会通过`loadSheetUrl`配置的接口地址请求数据,把引用到的sheet的数据一并补全,而不用等切换到其它页的时候再请求 + + 当数据量小的时候,也可以不用Luckysheet提供的此接口,直接使用[data](#data)参数可以提前准备好所有表格数据用于初始化 ------------ ### loadSheetUrl - 类型:String - 默认值:"" -- 作用:配置`loadSheetUrl`的地址,参数为`gridKey`(表格主键) 和 `index`(sheet主键合集,格式为`["sheet_01","sheet_02","sheet_0"]`),返回的数据为sheet的`celldata`字段数据集合。为了加载性能考虑,除了第一次加载当前页的`celldata`数据之外,其余sheet的数据,是在切换到那个sheet页的时候,才会请求那一页的数据。 +- 作用:配置`loadSheetUrl`接口地址,用于异步加载其它单元格数据。参数为`gridKey`(表格主键) 和 `index`(sheet主键合集,格式为`["sheet_01","sheet_02","sheet_0"]`)。 + + 源码的请求写法是: + ```js + $.post(loadSheetUrl, {"gridKey" : server.gridKey, "index": sheetindex.join(",")}, function (d) {}) + ``` + > 参见源码 [`src/controllers/sheetmanage.js`](https://github.com/mengshukeji/Luckysheet/blob/master/src/controllers/sheetmanage.js) + + 返回的数据为sheet的`celldata`字段数据集合。 + + 一个合格的接口返回的json字符串数据为: + + ```js + "{ + "sheet_01": [ + { + "r": 0, + "c": 0, + "v": { "v": 1, "m": "1", "ct": { "fa": "General", "t": "n" } } + } + ], + "sheet_02": [ + { + "r": 0, + "c": 0, + "v": { "v": 1, "m": "1", "ct": { "fa": "General", "t": "n" } } + } + ], + "sheet_0": [ + { + "r": 0, + "c": 0, + "v": { "v": 1, "m": "1", "ct": { "fa": "General", "t": "n" } } + } + ] + }" + ``` + 同`loadUrl`类似,`loadSheetUrl`也要注意这几点: + + 这是一个字符串格式数据 + + 这是一个post请求 + + 这个接口会在两种情况下自动调用,一是在`loadUrl`加载的当前页数据时发现当前工作表引用了其他工作表,二是切换到一个未曾加载过数据的工作表时 ------------ ### allowUpdate - 类型:Boolean - 默认值:false -- 作用:是否允许操作表格后的后台更新,与`updateUrl`配合使用 +- 作用:是否允许操作表格后的后台更新,与`updateUrl`配合使用。如果要开启共享编辑,此参数必须设置为`true`。 ------------ ### updateUrl - 类型:String - 默认值:"" -- 作用:操作表格后的后台更新地址,在`allowUpdate`为`true`时才会有效,此接口也是共享编辑的接口地址。 +- 作用:操作表格后,实时保存数据的websocket地址,此接口也是共享编辑的接口地址。 + + 有个注意点,要想开启共享编辑,必须满足以下四个条件: + + `allowUpdate`为`true` + + 配置了`loadUrl` + + 配置了`loadSheetUrl` + + 配置了`updateUrl` -注意,还需要配置`loadUrl`和`loadSheetUrl`才能生效 + 通过共享编辑功能,可以实现Luckysheet实时保存数据和多人同步数据,每一次操作都会发送不同的参数到后台,具体的操作类型和参数参见[表格操作](/zh/guide/operate.html) ------------ ### updateImageUrl @@ -744,6 +829,25 @@ Luckysheet开放了更细致的自定义配置选项,分别有 - {String} [oldColor]: 修改前当前sheet页颜色 - {String} [newColor]: 修改后当前sheet页颜色 +------------ +### sheetZoomBefore +- 类型:Function +- 默认值:null +- 作用:sheet缩放前 +- 参数: + - {Number} [i]: sheet页的`index` + - {String} [zoom]: 当前sheet页缩放比例 + +------------ +### sheetZoomAfter +- 类型:Function +- 默认值:null +- 作用:sheet缩放后 +- 参数: + - {Number} [i]: sheet页的`index` + - {String} [oldZoom]: 修改前当前sheet页缩放比例 + - {String} [newZoom]: 修改后当前sheet页缩放比例 + ------------ ## 工作簿 diff --git a/docs/zh/guide/operate.md b/docs/zh/guide/operate.md index 01802f4..02db446 100644 --- a/docs/zh/guide/operate.md +++ b/docs/zh/guide/operate.md @@ -1,6 +1,6 @@ # 表格操作 -每一次操作都会保存历史记录,用于撤销和重做,如果在表格初始化的时候设置了`allowUpdate`为`true`和`updateUrl`数据更新地址,则会通过websocket将操作实时更新到后台,并且支持共享编辑。 +每一次操作都会保存历史记录,用于撤销和重做,如果在表格初始化的时候开启了[共享编辑](/zh/guide/config.html#updateurl)功能,则会通过websocket将操作实时更新到后台。 > 源码 [`src/controllers/server.js`](https://github.com/mengshukeji/Luckysheet/blob/master/src/controllers/server.js) 模块实现了后台保存功能 diff --git a/src/controllers/cellFormat.js b/src/controllers/cellFormat.js index 87c69c9..415b794 100644 --- a/src/controllers/cellFormat.js +++ b/src/controllers/cellFormat.js @@ -6,6 +6,7 @@ import menuButton from './menuButton'; import {checkProtectionNotEnable} from './protection'; import { jfrefreshgrid } from '../global/refresh'; import locale from '../locale/locale'; +import { setcellvalue } from '../global/setdata'; let isInitialCellFormatModel = false; @@ -22,9 +23,17 @@ function initialCellFormatModelEvent(){ hidden = hidden==true?1:0; let d = recycleSeletion( - function(cell){ - cell.lo = locked; - cell.hi = hidden; + function(cell, r, c, data){ + if(cell==null){ + setcellvalue(r, c, data, { + lo:locked, + hi:hidden + }); + } + else{ + cell.lo = locked; + cell.hi = hidden; + } }, function(){ alert(local_cellFormat.sheetDataIsNullAlert); @@ -79,7 +88,8 @@ function recycleSeletion(cycleFunction, dataIsNullFunction){ // } // count++; - cycleFunction(cell); + + cycleFunction(cell, r, c, data); } } } @@ -152,12 +162,12 @@ export function openCellFormatModel(){ recycleSeletion( function(cell){ // let cell = data[r][c]; - if(cell.lo==null || cell.lo==1){ + if(cell==null || cell.lo==null || cell.lo==1){ locked = true; lockedCount++; } - if(cell.hi==1){ + if(cell!=null && cell.hi==1){ hidden = true; hiddenCount++; } diff --git a/src/controllers/constant.js b/src/controllers/constant.js index 5cd11a7..8899d90 100644 --- a/src/controllers/constant.js +++ b/src/controllers/constant.js @@ -530,9 +530,6 @@ function rightclickHTML(){ - `; } diff --git a/src/controllers/imageCtrl.js b/src/controllers/imageCtrl.js index 3144047..eb31e58 100644 --- a/src/controllers/imageCtrl.js +++ b/src/controllers/imageCtrl.js @@ -97,19 +97,19 @@ const imageCtrl = { let src = imgItem.src; let imgItemParam = _this.getImgItemParam(imgItem); - let width = imgItemParam.width*Store.zoomRatio; - let height = imgItemParam.height*Store.zoomRatio; - let left = imgItemParam.left*Store.zoomRatio; - let top = imgItemParam.top*Store.zoomRatio; + let width = imgItemParam.width * Store.zoomRatio; + let height = imgItemParam.height * Store.zoomRatio; + let left = imgItemParam.left * Store.zoomRatio; + let top = imgItemParam.top * Store.zoomRatio; let position = imgItemParam.position; let borderWidth = imgItem.border.width; return `