elink-star
/
luckysheet
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

docs(readme link,api): readme link 

readme link
master
lrz 5 years ago
parent
194dea1767
commit
ae78a07bf9
12 changed files with 254 additions and 51 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      README-zh.md
  2. 2
      docs/.vuepress/config.js
  3. 0
      docs/.vuepress/public/favicon.ico
  4. BIN
      docs/.vuepress/public/img/QQ群二维码.jpg
  5. BIN
      docs/.vuepress/public/img/excel.png
  6. BIN
      docs/.vuepress/public/img/微信二维码.jpg
  7. 6
      docs/guide/FAQ.md
  8. 4
      docs/guide/README.md
  9. 6
      docs/guide/api.md
  10. 6
      docs/zh/guide/FAQ.md
  11. 4
      docs/zh/guide/README.md
  12. 273
      docs/zh/guide/api.md

4
README-zh.md
View File

@ -157,13 +157,13 @@ npm run build
- 添加小编微信,拉你进Luckysheet开发者交流微信群,备注:加群 - 添加小编微信,拉你进Luckysheet开发者交流微信群,备注:加群
<img src="https://minio.cnbabylon.com/public/luckysheet/%E5%BE%AE%E4%BF%A1%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" /> <img src="/docs/.vuepress/public/img/%E5%BE%AE%E4%BF%A1%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" />
或者 或者
- 加入Luckysheet开发者交流QQ群 - 加入Luckysheet开发者交流QQ群
<img src="https://minio.cnbabylon.com/public/luckysheet/QQ%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" /> <img src="/docs/.vuepress/public/img/QQ%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.jpg" width = "200" alt="微信群" align="center" />
[英文社群](./README.md) [英文社群](./README.md)

2
docs/.vuepress/config.js
View File

@ -84,7 +84,7 @@ module.exports = {
'/zh/guide/': [ '/zh/guide/': [
'', '',
'config', 'config',
'data', 'sheet',
'cell', 'cell',
'operate', 'operate',
'api', 'api',

0
docs/.vuepress/public/img/favicon.ico → docs/.vuepress/public/favicon.ico
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
docs/.vuepress/public/img/QQ群二维码.jpg
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 398 KiB

BIN
docs/.vuepress/public/img/excel.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.0 KiB

BIN
docs/.vuepress/public/img/微信二维码.jpg
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 39 KiB

6
docs/guide/FAQ.md
View File

@ -2,7 +2,7 @@
## What is the difference between data and celldata in luckysheetfile? ## What is the difference between data and celldata in luckysheetfile?
**<span style="font-size:20px;">A</span>**: Use one-dimensional array format [celldata](https://mengshukeji.github.io/LuckysheetDocs/guide/data.html), after the initialization is completed, the data converted into a two-dimensional array format is used for storage and update, and celldata is no longer used. **<span style="font-size:20px;">A</span>**: Use one-dimensional array format [celldata](/zh/guide/sheet.html#celldata), after the initialization is completed, the data converted into a two-dimensional array format is used for storage and update, and celldata is no longer used.
If you need to take out data as initial data, you need to execute `luckysheet.getGridData(data)` to convert it to celldata data. If you need to take out data as initial data, you need to execute `luckysheet.getGridData(data)` to convert it to celldata data.
Among them, the celldata in `{ r, c, v }` format is converted to a two-dimensional array using `luckysheet.buildGridData(luckysheetfile)`, and the input parameter is the table data object `luckysheetfile` Among them, the celldata in `{ r, c, v }` format is converted to a two-dimensional array using `luckysheet.buildGridData(luckysheetfile)`, and the input parameter is the table data object `luckysheetfile`
@ -20,7 +20,7 @@ luckysheet.buildGridData(luckysheetfile)
## What are the cell types? ## What are the cell types?
**<span style="font-size:20px;">A</span>**: Refer to [Cell Format List](https://mengshukeji.github.io/LuckysheetDocs/guide/format.html), with examples of available cell formats **<span style="font-size:20px;">A</span>**: Refer to [Cell Format List](/zh/guide/cell.html), with examples of available cell formats
------------ ------------
@ -32,6 +32,6 @@ luckysheet.buildGridData(luckysheetfile)
## Why will the formula in the table not be triggered after initialization? ## Why will the formula in the table not be triggered after initialization?
**<span style="font-size:20px;">A</span>** : Refer to [Table data format](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/data.html#calcchain) ,just set the calcChain corresponding to the cell data. **<span style="font-size:20px;">A</span>** : Refer to [Table data format](/zh/guide/sheet.html#calcchain) ,just set the calcChain corresponding to the cell data.
------------ ------------

4
docs/guide/README.md
View File

@ -6,7 +6,7 @@ Luckysheet is an online spreadsheet like excel that is powerful, simple to confi
## Demo ## Demo
[Online demo](https://mengshukeji.github.io/LuckysheetDemo/) [Online demo](https://mengshukeji.github.io/LuckysheetDemo/)
![Demo](https://minio.cnbabylon.com/public/luckysheet/LuckysheetDemo.gif) ![Demo](/img/LuckysheetDemo.gif)
## Features ## Features
@ -153,7 +153,7 @@ An example of a Luckysheet file is as follows, the table contains 3 sheets:`
luckysheetfile = [{sheet1 settings}, {sheet2 settings}, {sheet3 settings}]` luckysheetfile = [{sheet1 settings}, {sheet2 settings}, {sheet3 settings}]`
Equivalent to 3 sheets of excel Equivalent to 3 sheets of excel
![excel sheet](https://minio.cnbabylon.com/public/luckysheet/excel.png) ![excel sheet](/docs/.vuepress/public/img/excel.png)
An example of a sheet in the file is as follows: An example of a sheet in the file is as follows:
```javascript ```javascript

6
docs/guide/api.md
View File

@ -9,7 +9,7 @@ The new API is being sorted out, please use it with caution!
- {Object} [options]:All configuration information of the table - {Object} [options]:All configuration information of the table
- **Usage**： - **Usage**：
Initialize a luckysheet, which can contain multiple worksheets, refer to [Configuration List](https://mengshukeji.github.io/LuckysheetDocs/guide/config.html) Initialize a luckysheet, which can contain multiple worksheets, refer to [Configuration List](/zh/guide/config.html)
------------ ------------
## luckysheet.getcellvalue([r] [,c] [,data] [,type]) ## luckysheet.getcellvalue([r] [,c] [,data] [,type])
@ -33,7 +33,7 @@ The new API is being sorted out, please use it with caution!
## luckysheet.getluckysheetfile() ## luckysheet.getluckysheetfile()
- **Usage**： - **Usage**：
Returns a one-dimensional array of all table data structures[luckysheetfile](https://mengshukeji.github.io/LuckysheetDocs/guide/data.html), `luckysheet.getluckysheetfile()[0]` can get all the information of the first worksheet. Returns a one-dimensional array of all table data structures[luckysheetfile](/zh/guide/data.html), `luckysheet.getluckysheetfile()[0]` can get all the information of the first worksheet.
------------ ------------
## luckysheet.getconfig() ## luckysheet.getconfig()
@ -131,7 +131,7 @@ The new API is being sorted out, please use it with caution!
------------ ------------
## luckysheet.buildGridData(file) ## luckysheet.buildGridData(file)
- **Parameter**： - **Parameter**：
- {Object} [file]：[luckysheetfile](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/data.html#%E8%8E%B7%E5%8F%96%E8%A1%A8%E6%A0%BC%E6%95%B0%E6%8D%AE) - {Object} [file]：[luckysheetfile](/zh/guide/sheet.html)
- **Usage**： - **Usage**：
Generate a two-dimensional array that the table can recognize Generate a two-dimensional array that the table can recognize

6
docs/zh/guide/FAQ.md
View File

@ -2,7 +2,7 @@
## luckysheetfile中的data和celldata有什么区别？ ## luckysheetfile中的data和celldata有什么区别？
**<span style="font-size:20px;">A</span>** : 表格初始化时使用一维数组格式的 [celldata](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/data.html#celldata)，初始化完成后转化为二维数组格式的data作为存储更新使用，celldata不再使用。 **<span style="font-size:20px;">A</span>** : 表格初始化时使用一维数组格式的 [celldata](/zh/guide/sheet.html#celldata)，初始化完成后转化为二维数组格式的data作为存储更新使用，celldata不再使用。
如果需要将data拿出来作为初始化数据，则需要执行 `luckysheet.getGridData(data)`转换为celldata数据。 如果需要将data拿出来作为初始化数据，则需要执行 `luckysheet.getGridData(data)`转换为celldata数据。
其中`{ r, c, v }`格式的celldata转换为二维数组使用的是`luckysheet.buildGridData(luckysheetfile)`，传入参数为表格数据对象`luckysheetfile` 其中`{ r, c, v }`格式的celldata转换为二维数组使用的是`luckysheet.buildGridData(luckysheetfile)`，传入参数为表格数据对象`luckysheetfile`
@ -20,7 +20,7 @@ luckysheet.buildGridData(luckysheetfile)
## 单元格的类型有哪些？ ## 单元格的类型有哪些？
**<span style="font-size:20px;">A</span>** : 参考[单元格格式列表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E6%A0%BC%E5%BC%8F),例举了可用的单元格格式 **<span style="font-size:20px;">A</span>** : 参考[单元格格式列表](/zh/guide/cell.html),例举了可用的单元格格式
------------ ------------
@ -32,6 +32,6 @@ luckysheet.buildGridData(luckysheetfile)
## 为什么初始化后表格里面的公式不会被触发？ ## 为什么初始化后表格里面的公式不会被触发？
**<span style="font-size:20px;">A</span>** : 参考 [表格数据格式](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/data.html#calcchain) ,设置单元格数据对应的calcChain即可。 **<span style="font-size:20px;">A</span>** : 参考 [表格数据格式](/zh/guide/sheet.html#calcchain) ,设置单元格数据对应的calcChain即可。
------------ ------------

4
docs/zh/guide/README.md
View File

@ -6,7 +6,7 @@ Luckysheet ，一款纯前端类似excel的在线表格，功能强大、配置
## Demo ## Demo
[在线demo](https://mengshukeji.github.io/LuckysheetDemo/) [在线demo](https://mengshukeji.github.io/LuckysheetDemo/)
![演示](https://minio.cnbabylon.com/public/luckysheet/LuckysheetDemo.gif) ![演示](/img/LuckysheetDemo.gif)
## 特性 ## 特性
@ -153,7 +153,7 @@ npm run build
luckysheetfile = [ {sheet1设置}, {sheet2设置}, {sheet3设置} ]` luckysheetfile = [ {sheet1设置}, {sheet2设置}, {sheet3设置} ]`
相当于excel的3个sheet 相当于excel的3个sheet
![excel sheet](https://minio.cnbabylon.com/public/luckysheet/excel.png) ![excel sheet](/img/excel.png)
文件中的一个sheet的数据`luckysheetfile[0]`的结构如下： 文件中的一个sheet的数据`luckysheetfile[0]`的结构如下：
```json ```json

273
docs/zh/guide/api.md
View File

@ -12,11 +12,11 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
### getCellValue(row, column [,setting]) ### getCellValue(row, column [,setting])
- **参数**： - **参数**：
- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行 - {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列 - {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
- {PlainObject} [setting]: 可选参数 - {PlainObject} [setting]: 可选参数
+ {String} [type]: 单元格的值，可以设置为"v"：原始值 或者"m"：显示值；默认值为'v',表示获取单元格的实际值 + {String} [type]: 单元格的值类型，可以设置为原始值"v"或者显示值"m"；默认值为'v',表示获取单元格的实际值
+ {Number} [order]: 工作表索引；默认值为当前工作表索引 + {Number} [order]: 工作表索引；默认值为当前工作表索引
- **说明**： - **说明**：
@ -39,32 +39,34 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
### setCellValue(row, column, value [,setting]) ### setCellValue(row, column, value [,setting])
- **参数**： - **参数**：
    - {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
    - {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列 - {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
    - {Object | String | Number} [value]: 要设置的值；可以为字符串或数字，或为符合Luckysheet单元格格式的对象，参考 [单元格属性表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8) - {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
    - {PlainObject} [setting]: 可选参数 - {Object | String | Number} [value]: 要设置的值；可以为字符串或数字，或为符合Luckysheet单元格格式的对象，参考 [单元格属性表](/zh/guide/cell.html)
        + {Number} [order]: 工作表索引；默认值为当前工作表索引 - {PlainObject} [setting]: 可选参数
        + {Function} [success]: 操作结束的回调函数 + {Number} [order]: 工作表索引；默认值为当前工作表索引
+ {Function} [success]: 操作结束的回调函数
- **说明**： - **说明**：
    设置某个单元格的值，也可以设置整个单元格对象，用于同时设置多个单元格属性 设置某个单元格的值，也可以设置整个单元格对象，用于同时设置多个单元格属性
- **示例**: - **示例**:
    - 设置当前工作表"A1"单元格的值为"abc" - 设置当前工作表"A1"单元格的值为"abc"
    `luckysheet.setCellValue(0, 0, 'abc');`      `luckysheet.setCellValue(0, 0, 'abc');`
------------ ------------
### setCellFormat(row, column, attr, value [,setting]) ### setCellFormat(row, column, attr, value [,setting])
- **参数**： - **参数**：
- {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行 - {Number} [row]: 单元格所在行数；从0开始的整数，0表示第一行
- {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列 - {Number} [column]: 单元格所在列数；从0开始的整数，0表示第一列
- {String} [attr]: 属性类型，参考 [单元格属性表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8)的属性值 - {String} [attr]: 属性类型，参考 [单元格属性表](/zh/guide/cell.html)的属性值
- {String | Number | Object} [value]: 具体的设置值，一个属性会对应多个值，参考 [单元格属性表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8)的值示例，特殊情况：如果属性类型`attr`是单元格格式`ct`，则设置值`value`应提供`ct.fa`，比如设置A1单元格的格式为百分比格式： - {String | Number | Object} [value]: 具体的设置值，一个属性会对应多个值，参考 [单元格属性表](/zh/guide/cell.html)的值示例，特殊情况：如果属性类型`attr`是单元格格式`ct`，则设置值`value`应提供`ct.fa`，比如设置A1单元格的格式为百分比格式：
`luckysheet.setCellFormat(0, 0, "ct", "0.00%")` `luckysheet.setCellFormat(0, 0, "ct", "0.00%")`
@ -109,12 +111,16 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
+ {Boolean} [isWholeWord]: 是否整词匹配；默认为 `false` + {Boolean} [isWholeWord]: 是否整词匹配；默认为 `false`
+ {Boolean} [isCaseSensitive]: 是否区分大小写匹配；默认为 `false` + {Boolean} [isCaseSensitive]: 是否区分大小写匹配；默认为 `false`
+ {Number} [order]: 工作表索引；默认值为当前工作表索引 + {Number} [order]: 工作表索引；默认值为当前工作表索引
+ {Function} [success]: 操作结束的回调函数
- **说明**： - **说明**：
查找一个工作表中的指定内容，返回查找到的内容组成的单元格一位数组，数据格式同`celldata`。 查找一个工作表中的指定内容，返回查找到的内容组成的单元格一位数组，数据格式同`celldata`。
- **示例**:
- 当前工作表查找`"value"`字符串
`luckysheet.find("value")`
------------ ------------
### replace(content, replaceContent [,setting]) ### replace(content, replaceContent [,setting])
@ -134,6 +140,11 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
查找一个工作表中的指定内容并替换成新的内容，返回替换后的内容组成的单元格一位数组，数据格式同`celldata`。 查找一个工作表中的指定内容并替换成新的内容，返回替换后的内容组成的单元格一位数组，数据格式同`celldata`。
- **示例**:
- 当前工作表查找`"value"`字符串并替换为`"out"`
`luckysheet.find("value", "out)`
------------ ------------
## 行和列操作 ## 行和列操作
@ -141,6 +152,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
### setHorizontalFrozen(isRange [,setting]) ### setHorizontalFrozen(isRange [,setting])
- **参数**： - **参数**：
- {Boolean} [isRange]: 是否冻结行到选区 - {Boolean} [isRange]: 是否冻结行到选区
`isRange`可能的值有： `isRange`可能的值有：
@ -157,11 +169,22 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`。 特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`。
- **示例**:
- 冻结首行
`luckysheet.setHorizontalFrozen(false)`
- 冻结到`B5`选区
`luckysheet.setHorizontalFrozen(true, { range: 'B5' })`
------------ ------------
### setVerticalFrozen(isRange [,setting]) ### setVerticalFrozen(isRange [,setting])
- **参数**： - **参数**：
- {Boolean} [isRange]: 是否冻结列到选区 - {Boolean} [isRange]: 是否冻结列到选区
`isRange`可能的值有： `isRange`可能的值有：
@ -178,11 +201,18 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`。 特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`。
- **示例**:
- 冻结首列
`luckysheet.setVerticalFrozen(false)`
------------ ------------
### setBothFrozen(isRange [,setting]) ### setBothFrozen(isRange [,setting])
- **参数**： - **参数**：
- {Boolean} [isRange]: 是否冻结行列到选区 - {Boolean} [isRange]: 是否冻结行列到选区
`isRange`可能的值有： `isRange`可能的值有：
@ -199,6 +229,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`。 特别注意，只有在`isRange`设置为`true`的时候，才需要设置`setting`中的`range`。
- **示例**:
- 冻结行列
`luckysheet.setBothFrozen(false)`
------------ ------------
### cancelFrozen([setting]) ### cancelFrozen([setting])
@ -213,13 +249,19 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
取消冻结操作 取消冻结操作
- **示例**:
- 取消冻结
`luckysheet.cancelFrozen()`
------------ ------------
### insertRow( row [,setting]) ### insertRow( row [,setting])
- **参数**： - **参数**：
- {Number} [row]: 在第几行插入空白行 - {Number} [row]: 在第几行插入空白行，从0开始
- {PlainObject} [setting]: 可选参数 - {PlainObject} [setting]: 可选参数
+ {Number} [number]: 插入的空白行数；默认为 1 + {Number} [number]: 插入的空白行数；默认为 1
@ -230,6 +272,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
在第`row`行的位置，插入`number`行空白行 在第`row`行的位置，插入`number`行空白行
- **示例**:
- 在第2行的位置插入1行空白行
`luckysheet.insertRow(1)`
------------ ------------
### insertColumn( column [,setting]) ### insertColumn( column [,setting])
@ -247,6 +295,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
在第`column`列的位置，插入`number`列空白列 在第`column`列的位置，插入`number`列空白列
- **示例**:
- 在第1列的位置插入3行空白行
`luckysheet.insertRow(0, { number: 3 })`
------------ ------------
### deleteRow(rowStart, rowEnd [,setting]) ### deleteRow(rowStart, rowEnd [,setting])
@ -264,7 +318,13 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
删除指定的行 删除指定的行
特别提醒，删除行之后，行的序号并不会变化，注意观察数据是否被正确删除即可。 特别提醒，删除行之后，行的序号并不会变化，下面的行会补充到上面，注意观察数据是否被正确删除即可。
- **示例**:
- 删除2-4行
`luckysheet.deleteRow(1, 3)`
------------ ------------
@ -283,7 +343,13 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
删除指定的列 删除指定的列
特别提醒，删除列之后，列的序号并不会变化，注意观察数据是否被正确删除即可。 特别提醒，删除列之后，列的序号并不会变化，右边的列会补充到左边，注意观察数据是否被正确删除即可。
- **示例**:
- 删除2-4列
`luckysheet.deleteColumn(1, 3)`
------------ ------------
@ -304,6 +370,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
特别提醒，隐藏行之后，行的序号会变化。 特别提醒，隐藏行之后，行的序号会变化。
- **示例**:
- 隐藏2-4行
`luckysheet.hideRow(1, 3)`
------------ ------------
### hideColumn(columnStart, columnEnd [,setting])(TODO) ### hideColumn(columnStart, columnEnd [,setting])(TODO)
@ -323,6 +395,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
特别提醒，隐藏列之后，列的序号会变化。 特别提醒，隐藏列之后，列的序号会变化。
- **示例**:
- 隐藏2-4列
`luckysheet.hideColumn(1, 3)`
------------ ------------
### showRow(rowStart, rowEnd [,setting]) ### showRow(rowStart, rowEnd [,setting])
@ -340,6 +418,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
显示指定的行 显示指定的行
- **示例**:
- 显示2-4行
`luckysheet.showRow(1, 3)`
------------ ------------
### showColumn(columnStart, columnEnd [,setting])(TODO) ### showColumn(columnStart, columnEnd [,setting])(TODO)
@ -357,6 +441,12 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
显示指定的列 显示指定的列
- **示例**:
- 显示2-4列
`luckysheet.showColumn(1, 3)`
------------ ------------
## 选区操作 ## 选区操作
@ -379,7 +469,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
`luckysheet.getRange()` `luckysheet.getRange()`
则返回结果为： 则返回结果为：
``` ```json
[ [
{ "row": [0,1], "column": [0,1] }, { "row": [0,1], "column": [0,1] },
{ "row": [3,4], "column": [1,2] } { "row": [3,4], "column": [1,2] }
@ -400,7 +490,87 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
返回指定工作表指定范围的单元格二维数组数据，每个单元格为一个对象。 返回指定工作表指定范围的单元格二维数组数据，每个单元格为一个对象。
[单元格对象格式参考](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8) [单元格对象格式参考](/zh/guide/cell.html)
- **示例**:
- 当前选区为"A1:B2"，执行
`luckysheet.getRangeValue()`
则返回结果为：
```json
[
[
{
"v": "vaule1",
"ct": {
"fa": "General",
"t": "g"
},
"m": "vaule1",
"bg": "rgba(255,255,255)",
"bl": 0,
"it": 0,
"ff": 1,
"fs": 11,
"fc": "rgb(51, 51, 51)",
"ht": 1,
"vt": 0
},
{
"v": "value3",
"ct": {
"fa": "General",
"t": "g"
},
"m": "value3",
"bg": "rgba(255,255,255)",
"bl": 0,
"it": 0,
"ff": 1,
"fs": 11,
"fc": "rgb(51, 51, 51)",
"ht": 1,
"vt": 0
}
],
[
{
"v": "vaule2",
"ct": {
"fa": "General",
"t": "g"
},
"m": "vaule2",
"bg": "rgba(255,255,255)",
"bl": 0,
"it": 0,
"ff": 1,
"fs": 11,
"fc": "rgb(51, 51, 51)",
"ht": 1,
"vt": 0
},
{
"v": "value4",
"ct": {
"fa": "General",
"t": "g"
},
"m": "value4",
"bg": "rgba(255,255,255)",
"bl": 0,
"it": 0,
"ff": 1,
"fs": 11,
"fc": "rgb(51, 51, 51)",
"ht": 1,
"vt": 0
}
]
]
```
------------ ------------
@ -418,6 +588,38 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
特别注意，如果复制多个选区，这几个选区必须有相同的行或者相同的列才能复制，复制出的结果也会自动合并成衔接的数组，比如，多选`"C18:C20"` / `"E18:E20"` / `"G18:H20"`是允许的，但是多选`"C18:C20"` / `"E18:E21"`是不允许的 特别注意，如果复制多个选区，这几个选区必须有相同的行或者相同的列才能复制，复制出的结果也会自动合并成衔接的数组，比如，多选`"C18:C20"` / `"E18:E20"` / `"G18:H20"`是允许的，但是多选`"C18:C20"` / `"E18:E21"`是不允许的
- **示例**:
- 当前选区为"A1:B2"，执行
`luckysheet.getRangeHtml()`
则返回结果为：
```html
<table data-type="luckysheet_copy_action_table">
<colgroup width="72px">
</colgroup>
<colgroup width="72px">
</colgroup>
<tr>
<td style="height:19px;">
value1
</td>
<td style="">
value3
</td>
</tr>
<tr>
<td style="height:19px;">
value2
</td>
<td style="">
value4
</td>
</tr>
</table>
```
------------ ------------
### getRangeJson(title [,setting]) ### getRangeJson(title [,setting])
@ -502,7 +704,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
------------ ------------
### setRangeShow(range[,setting]) ### setRangeShow(range [,setting])<div id='setRangeShow'></div>
- **参数**： - **参数**：
@ -545,7 +747,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
- **参数**： - **参数**：
- {Array} [data]: 要赋值的单元格二维数组数据，每个单元格的值，可以为字符串或数字，或为符合Luckysheet格式的对象，参考 [单元格属性表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8) - {Array} [data]: 要赋值的单元格二维数组数据，每个单元格的值，可以为字符串或数字，或为符合Luckysheet格式的对象，参考 [单元格属性表](/zh/guide/cell.html)
- {PlainObject} [setting]: 可选参数 - {PlainObject} [setting]: 可选参数
+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区 + {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，只能为单个选区；默认为当前选区
+ {Number} [order]: 工作表索引；默认值为当前工作表索引 + {Number} [order]: 工作表索引；默认值为当前工作表索引
@ -562,8 +764,8 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
- **参数**： - **参数**：
- {String} [attr]: 属性类型， - {String} [attr]: 属性类型，
参考 [单元格属性表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8)的属性值 参考 [单元格属性表](/zh/guide/cell.html)的属性值
- {String | Number | Object} [value]: 具体的设置值，一个属性会对应多个值，参考 [单元格属性表](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8)的值示例，特殊情况：如果属性类型`attr`是单元格格式`ct`，则设置值`value`应提供`ct.fa`，比如设置`"A1:B2"`单元格的格式为百分比格式： - {String | Number | Object} [value]: 具体的设置值，一个属性会对应多个值，参考 [单元格属性表](/zh/guide/cell.html)的值示例，特殊情况：如果属性类型`attr`是单元格格式`ct`，则设置值`value`应提供`ct.fa`，比如设置`"A1:B2"`单元格的格式为百分比格式：
`luckysheet.setRangeFormat("ct", "0.00%", {range:"A1:B2"})` `luckysheet.setRangeFormat("ct", "0.00%", {range:"A1:B2"})`
@ -992,7 +1194,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
+ `"bottom"`: 活动单元格下移 + `"bottom"`: 活动单元格下移
- {PlainObject} [setting]: 可选参数 - {PlainObject} [setting]: 可选参数
+ {Array} [data]: 赋值到range区域的单元格二维数组数据，[单元格对象格式参考](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/format.html#%E5%8D%95%E5%85%83%E6%A0%BC%E5%B1%9E%E6%80%A7%E8%A1%A8)；默认值为空数组，即插入空白的区域 + {Array} [data]: 赋值到range区域的单元格二维数组数据，[单元格对象格式参考](/zh/guide/cell.html)；默认值为空数组，即插入空白的区域
+ {Array | Object | String} [range]: 要插入的位置，选区范围，支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，默认为当前选区 + {Array | Object | String} [range]: 要插入的位置，选区范围，支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`，默认为当前选区
当未设置data数据时，允许多个选区组成的数组，插入的空白区域即为这些选区的区域， 当未设置data数据时，允许多个选区组成的数组，插入的空白区域即为这些选区的区域，
@ -1450,7 +1652,8 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
## 公共方法 ## 公共方法
### transToCellData(data[,setting]) ### transToCellData(data [,setting])<div id='transToCellData'></div>
- **参数**： - **参数**：
@ -1465,7 +1668,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
------------ ------------
### transToData(celldata[,setting]) ### transToData(celldata [,setting])<div id='transToData'></div>
- **参数**： - **参数**：
@ -1545,7 +1748,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
luckysheet.selectHightlightShow(); luckysheet.selectHightlightShow();
``` ```
> 推荐使用新API： [setRangeShow](#setRangeShow(range[,setting])) > 推荐使用新API：<a href='#setRangeShow'>setRangeShow</a>
------------ ------------
@ -1554,7 +1757,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
高亮当前选区 高亮当前选区
> 推荐使用新API： [setRangeShow](#setRangeShow(range[,setting])) > 推荐使用新API：<a href='#setRangeShow'>setRangeShow</a>
------------ ------------
@ -1563,18 +1766,18 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
快捷获取当前表格的数据 快捷获取当前表格的数据
> 推荐使用新API： [getSheetData](#getSheetData()) > 推荐使用新API：[getSheetData](#getSheetData())
------------ ------------
## buildGridData(file) ## buildGridData(file)
- **参数**： - **参数**：
- {Object} [file]：[luckysheetfile](https://mengshukeji.github.io/LuckysheetDocs/zh/guide/data.html#%E8%8E%B7%E5%8F%96%E8%A1%A8%E6%A0%BC%E6%95%B0%E6%8D%AE) - {Object} [file]：[luckysheetfile](/zh/guide/sheet.html)
- **说明**： - **说明**：
生成表格可以识别的二维数组 生成表格可以识别的二维数组
> 推荐使用新API： [transToData](#transToCellData([setting])) > 推荐使用新API：<a href='#transToData'>transToData</a>
------------ ------------
## getGridData(data) ## getGridData(data)
@ -1584,7 +1787,7 @@ Luckysheet针对常用的数据操作需求，开放了主要功能的API，开
二维数组数据转化成 `{r, c, v}` 格式 一维数组 二维数组数据转化成 `{r, c, v}` 格式 一维数组
> 推荐使用新API： [transToCellData](#transToCellData([setting])) > 推荐使用新API：<a href='#transToCellData'>transToCellData</a>
------------ ------------
## destroy() ## destroy()

Write Preview
Loading…
Cancel
Save