Browse Source

docs(api): api

api
master
lrz 5 years ago
parent
commit
80bd5a4ccf
  1. 2
      README-zh.md
  2. 2
      README.md
  3. 14
      docs/guide/FAQ.md
  4. 14
      docs/zh/guide/FAQ.md
  5. 80
      docs/zh/guide/api.md
  6. 5
      docs/zh/guide/operate.md
  7. 2
      docs/zh/guide/sheet.md
  8. 4400
      src/demoData/sheetCell.js

2
README-zh.md

@ -150,7 +150,7 @@ npm run build
```
## 加入共建
如果你想为 Luckysheet 实现一个重要功能,需要先撰写 RFC 文档,按照Luckysheet的 RFC(https://github.com/mengshukeji/Luckysheet-rfcs) 机制进行操作,在经过社区讨论完善后才可以进行代码的提交。
如果你想为 Luckysheet 实现一个重要功能,需要先撰写 RFC 文档,按照Luckysheet的 [RFC](https://github.com/mengshukeji/Luckysheet-rfcs) 机制进行操作,在经过社区讨论完善后才可以进行代码的提交。
## 联系
- 欢迎提交 PR 或者 [Issues](https://github.com/mengshukeji/Luckysheet/issues/new/choose)

2
README.md

@ -156,7 +156,7 @@ Create a table
```
## Join the co-construction
If you want to implement an important function for Luckysheet, you need to write an RFC document first, follow Luckysheet's RFC (https://github.com/mengshukeji/Luckysheet-rfcs) to operate, and submit the code after community discussion and improvement.
If you want to implement an important function for Luckysheet, you need to write an RFC document first, follow Luckysheet's [RFC](https://github.com/mengshukeji/Luckysheet-rfcs) to operate, and submit the code after community discussion and improvement.
## Contact
- Welcome to submit PR or [Issues](https://github.com/mengshukeji/Luckysheet/issues/new/choose)

14
docs/guide/FAQ.md

@ -1,6 +1,6 @@
# FAQ
## What is the difference between data and celldata in luckysheetfile?
## **<span style="font-size:20px;">Q</span>** What is the difference between data and celldata in luckysheetfile?
**<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.
@ -18,20 +18,24 @@ luckysheet.buildGridData(luckysheetfile)
------------
## What are the cell types?
## **<span style="font-size:20px;">Q</span>** What are the cell types?
**<span style="font-size:20px;">A</span>**: Refer to [Cell Format List](/zh/guide/cell.html), with examples of available cell formats
------------
## How to use Luckysheet in vue project?
## **<span style="font-size:20px;">Q</span>** How to use Luckysheet in vue project?
**<span style="font-size:20px;">A</span>** : Reference [Luckysheet-vue-demo](https://github.com/Dushusir/vue-demo)
------------
## Why will the formula in the table not be triggered after initialization?
## **<span style="font-size:20px;">Q</span>** Why will the formula in the table not be triggered after initialization?
**<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.
------------
------------
## **<span style="font-size:20px;">Q</span>** Is the remote loading data loadUrl or updateUrl?
**<span style="font-size:20px;">A</span>**: [loadUrl](/zh/guide/config.html#loadurl). Configure loadUrl, Luckysheet will request the entire table data through ajax, and updateUrl will be used as the interface address for collaborative editing in real-time saving.

14
docs/zh/guide/FAQ.md

@ -1,6 +1,6 @@
# FAQ
## luckysheetfile中的data和celldata有什么区别?
## **<span style="font-size:20px;">Q</span>** luckysheetfile中的data和celldata有什么区别?
**<span style="font-size:20px;">A</span>** : 表格初始化时使用一维数组格式的 [celldata](/zh/guide/sheet.html#celldata),初始化完成后转化为二维数组格式的data作为存储更新使用,celldata不再使用。
@ -18,20 +18,26 @@ luckysheet.buildGridData(luckysheetfile)
------------
## 单元格的类型有哪些?
## **<span style="font-size:20px;">Q</span>** 单元格的类型有哪些?
**<span style="font-size:20px;">A</span>** : 参考[单元格格式列表](/zh/guide/cell.html),例举了可用的单元格格式
------------
## 如何在vue项目中使用Luckysheet?
## **<span style="font-size:20px;">Q</span>** 如何在vue项目中使用Luckysheet?
**<span style="font-size:20px;">A</span>** : 参考 [Luckysheet-vue-demo](https://github.com/Dushusir/vue-demo)
------------
## 为什么初始化后表格里面的公式不会被触发?
## **<span style="font-size:20px;">Q</span>** 为什么初始化后表格里面的公式不会被触发?
**<span style="font-size:20px;">A</span>** : 参考 [表格数据格式](/zh/guide/sheet.html#calcchain) ,设置单元格数据对应的calcChain即可。
------------
## **<span style="font-size:20px;">Q</span>** 远端加载数据是loadUrl还是updateUrl?
**<span style="font-size:20px;">A</span>** : [loadUrl](/zh/guide/config.html#loadurl)。配置了loadUrl,Luckysheet会通过ajax请求整个表格数据,而updateUrl会作为协同编辑实时保存的接口地址。
------------

80
docs/zh/guide/api.md

@ -143,7 +143,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
- **示例**:
- 当前工作表查找`"value"`字符串并替换为`"out"`
`luckysheet.find("value", "out)`
`luckysheet.replaces("value", "out)`
------------
@ -1587,14 +1587,46 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### getSheetData()
### getSheetData([setting])
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表索引;默认值为当前工作表索引
- **说明**
快捷获取当前表格的数据,同 `luckysheetfile[i].data`
快捷返回指定工作表的数据,同 `luckysheetfile[i].data`
------------
### getConfig([setting])
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表索引;默认值为当前工作表索引
- **说明**
快捷返回指定工作表的config配置,同 `luckysheetfile[i].config`
------------
### setConfig([setting])
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表索引;默认值为当前工作表索引
+ {Function} [success]: 操作结束的回调函数
- **说明**
快捷设置当前表格config配置
------------
### setSheetAdd([setting])
- **参数**
@ -1948,10 +1980,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
## 公共方法
### transToCellData(data [,setting])<div id='transToCellData'></div>
- **参数**
- {Array} [data]: data数据
@ -1987,6 +2017,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
:::
### getcellvalue([r] [,c] [,data] [,type])
- **参数**
- {Number} [r]:单元格所在行数;可选值;从0开始的整数,0表示第一行
- {Number} [c]:单元格所在列数;可选值;从0开始的整数,0表示第一列
@ -2006,23 +2037,30 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
> 推荐使用新API: <a href='#getCellValue'>getCellValue</a>
------------
### getluckysheetfile()
- **说明**
返回所有表格数据结构的一维数组`luckysheetfile`
> 推荐使用新API: [getLuckysheetfile](#getLuckysheetfile())
------------
### getconfig()
- **说明**
快捷返回当前表格config配置,每个工作表的config信息仍然包含在luckysheetfile。
> 推荐使用新API: [getConfig](#getConfig([setting]))
------------
## getluckysheet_select_save()
### getluckysheet_select_save()
- **说明**
返回当前选区对象的数组,可能存在多个选区。
@ -2031,7 +2069,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## getdatabyselection([range] [,sheetOrder])
### getdatabyselection([range] [,sheetOrder])
- **参数**
- {Object} [range]:选区对象,`object: { row: [r1, r2], column: [c1, c2] }`;默认为当前第一个选区。
- {Number} [sheetOrder]:表格下标,从0开始的整数,0表示第一个表格;默认为当前表格下标。
@ -2045,7 +2084,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## luckysheetrefreshgrid(scrollWidth, scrollHeight)
### luckysheetrefreshgrid(scrollWidth, scrollHeight)
- **参数**
- {Number} [scrollWidth]:横向滚动值。默认为当前横向滚动位置。
- {Number} [scrollHeight]:纵向滚动值。默认为当前纵向滚动位置。
@ -2055,7 +2095,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## setcellvalue(r, c, d, v)
### setcellvalue(r, c, d, v)
- **参数**
- {Number} [r]:单元格所在行数;从0开始的整数,0表示第一行。
- {Number} [c]:单元格所在列数;从0开始的整数,0表示第一列。
@ -2072,7 +2113,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## jfrefreshgrid()
### jfrefreshgrid()
- **说明**
刷新canvas
@ -2081,7 +2123,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## setluckysheet_select_save(v)
### setluckysheet_select_save(v)
- **参数**
- {Array} [v]:要设置的选区值(数组)。符合选区格式规则,如`[{ row: [r1, r2], column: [c1, c2] }]`。
- **说明**
@ -2096,7 +2139,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## selectHightlightShow()
### selectHightlightShow()
- **说明**
高亮当前选区
@ -2105,7 +2149,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## flowdata()
### flowdata()
- **说明**
快捷获取当前表格的数据
@ -2114,7 +2159,8 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
## buildGridData(file)
### buildGridData(file)
- **参数**
- {Object} [file]:[luckysheetfile](/zh/guide/sheet.html)
- **说明**
@ -2124,7 +2170,9 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
> 推荐使用新API:<a href='#transToData'>transToData</a>
------------
## getGridData(data)
### getGridData(data)
- **参数**
- {Array} [data]:工作表的二维数组数据
- **说明**

5
docs/zh/guide/operate.md

@ -9,6 +9,7 @@
以下为所有的支持传输到后台的操作类型,并且以MongoDB做存储示例,讲解如何做前后端交互。
## 格式
- **配置**
配置 `updateUrl` 的地址,发送到后台的参数为json的字符串。
@ -67,10 +68,6 @@
]
```
后台在保存前台推送的数据时,首先需要把参数转换为 `{r:0, c:1:v:100}` 的格式,然后更新 `luckysheetfile[i].celldata` 字段,如果存在该单元格则更新,如果没有则添加,如果存在该单元格但是`v`为null则删除该单元格。
- **前台查看**
可以修改任意单元格的数值,然后到chrome控制台中查看`"t"=="v"`的操作。
## config操作

2
docs/zh/guide/sheet.md

@ -756,7 +756,7 @@ type: "default": 突出显示单元格规则和项目选区规则,
初始化所需要的参数,会从简洁的角度出发来考虑设计,但是本地存储的参数则不同。
Luckysheet在初始化完成之后进行的一系列操作,会将更多本地参数存储在luckysheetfile中,作为本地使用的参数,实现一些类似Store数据中心的作用。
Luckysheet在初始化完成之后进行的一系列操作,会将更多本地参数存储在luckysheetfile中,作为本地使用的参数,实现一些类似Store数据中心的作用。比如,freezen的参数格式也会变化。
此时的luckysheetfile包含很多非初始化使用的本地参数,可用于调试代码、本地状态分析。如下展示了更丰富luckysheetfile信息,可通过方法 `luckysheet.getluckysheetfile()`获得:

4400
src/demoData/sheetCell.js

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save