Browse Source

docs(config): english doc

1.edit config.md english doc 2.add donate qrcode and link
master
lrz 5 years ago
parent
commit
beb390e6a3
  1. 14
      README-zh.md
  2. 15
      README.md
  3. 1
      docs/guide/FAQ.md
  4. 909
      docs/guide/config.md
  5. 1
      docs/zh/guide/FAQ.md
  6. 68
      docs/zh/guide/config.md

14
README-zh.md

@ -21,10 +21,6 @@
- excel导入导出库: [Luckyexcel](https://github.com/mengshukeji/Luckyexcel)
- 图表插件: [chartMix](https://github.com/mengshukeji/chartMix)
## 支持
Luckysheet是MIT许可的开源项目,其持续的开发完全有赖于许多出色支持者的支持。如果您想加入他们,请考虑:
- [kickstarter](https://www.kickstarter.com/projects/luckysheet/luckysheet)
## 特性
### 🛠️格式设置
@ -206,6 +202,16 @@ npm run build
- [@gsw945](https://github.com/gsw945)
- [@swen-xiong](https://github.com/swen-xiong)
## 捐赠
如果你感觉这个项目对你有用或者有所启发,可以请作者喝杯果汁:
| 微信 | 支付宝 |
|---|---|
| <img src="https://minio.cnbabylon.com/public/luckysheet/wechat.jpg" width="140" />| <img src="https://minio.cnbabylon.com/public/luckysheet/alipay.jpg" width="130" /> |
[Paypal Me](https://www.paypal.me/wbfsa)
## 版权信息
[MIT](http://opensource.org/licenses/MIT)

15
README.md

@ -27,10 +27,6 @@ English| [简体中文](./README-zh.md)
- Excel import and export library: [Luckyexcel](https://github.com/mengshukeji/Luckyexcel)
- Chart plugin: [chartMix](https://github.com/mengshukeji/chartMix)
## Support
Luckysheet is an MIT-licensed open source project with its ongoing development made possible entirely by the support of many awesome backers. If you'd like to join them, please consider:
- [kickstarter](https://www.kickstarter.com/projects/luckysheet/luckysheet)
## Features
### 🛠️Formatting
@ -203,6 +199,17 @@ Create a table
- [@gsw945](https://github.com/gsw945)
- [@swen-xiong](https://github.com/swen-xiong)
## Donate
If you find this project useful, you can buy author a glass of juice:
| WeChat | Alipay |
|---|---|
| <img src="https://minio.cnbabylon.com/public/luckysheet/wechat.jpg" width="140" />| <img src="https://minio.cnbabylon.com/public/luckysheet/alipay.jpg" width="130" /> |
[Paypal Me](https://www.paypal.me/wbfsa)
## License
[MIT](http://opensource.org/licenses/MIT)

1
docs/guide/FAQ.md

@ -42,6 +42,7 @@ luckysheet.buildGridData(luckysheetfile)
## **<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.
Note: Initial data needs to be configured with loadUrl and loadSheetUrl parameters, while for collaborative editing, in addition to the configuration of loadUrl and loadSheetUrl, updateUrl and allowUpdate must be configured to take effect.
------------

909
docs/guide/config.md

File diff suppressed because it is too large

1
docs/zh/guide/FAQ.md

@ -42,6 +42,7 @@ luckysheet.buildGridData(luckysheetfile)
## **<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会作为协同编辑实时保存的接口地址。
注意:初始化数据需要配置loadUrl和loadSheetUrl参数,而协同编辑则在配置loadUrl和loadSheetUrl的基础上,还要配置updateUrl和allowUpdate才能生效。
------------

68
docs/zh/guide/config.md

@ -22,7 +22,7 @@ luckysheet.create(options)
这里的`options`配置项会作用于整个表格,特别的,单个sheet的配置则需要在`options.data`数组中,分别设置对应更详细的参数,参考[工作表配置](/zh/guide/sheet.html)
针对个性化的需求,除了允许配置名称栏([showinfobar](#showinfobar))、工具栏([showtoolbar](#showtoolbar))、底部sheet页([showsheetbar](#showsheetbar))、底部计数栏([showstatisticBar](#showstatisticBar))之外,
针对个性化的需求,除了允许配置信息栏([showinfobar](#showinfobar))、工具栏([showtoolbar](#showtoolbar))、底部sheet页([showsheetbar](#showsheetbar))、底部计数栏([showstatisticBar](#showstatisticBar))之外,
Luckysheet开放了更细致的自定义配置选项,分别有
- 自定义工具栏([showtoolbarConfig](#showtoolbarConfig))
@ -30,7 +30,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 自定义计数栏([showstatisticBarConfig](#showstatisticBarConfig))
- 自定义添加行和回到顶部([sheetBottomConfig](#sheetBottomConfig))
- 自定义单元格右键菜单([cellRightClickConfig](#cellRightClickConfig))
- 自定义sheet页右击菜单([sheetRightClickConfig](#sheetRightClickConfig))
- 自定义底部sheet页右击菜单([sheetRightClickConfig](#sheetRightClickConfig))
## 配置项
@ -56,7 +56,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 网格线 [showGridLines](#showGridLines)
- 工具栏 [showtoolbar](#showtoolbar)
- 自定义工具栏[showtoolbarConfig](#showtoolbarConfig)
- 名称栏 [showinfobar](#showinfobar)
- 信息栏 [showinfobar](#showinfobar)
- 底部sheet页 [showsheetbar](#showsheetbar)
- 自定义底部sheet页 [showsheetbarConfig](#showsheetbarConfig)
- 底部计数栏 [showstatisticBar](#showstatisticBar)
@ -103,13 +103,15 @@ Luckysheet开放了更细致的自定义配置选项,分别有
### loadUrl
- 类型:String
- 默认值:""
- 作用:配置`loadUrl`的地址,Luckysheet会通过ajax请求整个表格数据,默认载入status为1的sheet数据中的所有`celldata`,其余的sheet载入除`celldata`字段外的所有字段。但是考虑到一些公式、图表及数据透视表会引用其他sheet的数据,所以前台会加一个判断,如果该当前sheet引用了其他sheet的数据则把引用到的sheet的数据一并补全。
- 作用:配置`loadUrl`的地址,与`loadSheetUrl`配合使用,一般用于大数据量的时候。也可以不用Luckysheet提供的接口参数,使用[data](#data)参数可以提前准备好所有表格数据用于初始化。
Luckysheet会通过ajax请求整个表格数据,默认载入status为1的sheet数据中的所有`celldata`,其余的sheet载入除`celldata`字段外的所有字段。但是考虑到一些公式、图表及数据透视表会引用其他sheet的数据,所以前台会加一个判断,如果该当前sheet引用了其他sheet的数据则会通过`loadSheetUrl`配置的接口地址请求数据,把引用到的sheet的数据一并补全。因为 `loadUrl`只负责当前页数据,所以还需要配置`loadSheetUrl`作为异步加载数据的接口。
------------
### loadSheetUrl
- 类型:String
- 默认值:""
- 作用:配置`loadSheetUrl`的地址,参数为`gridKey`(表格主键) 和 `index`(sheet主键合集,格式为`[1,2,3]`),返回的数据为sheet的`celldata`字段数据集合
- 作用:配置`loadSheetUrl`的地址,参数为`gridKey`(表格主键) 和 `index`(sheet主键合集,格式为`["sheet_01","sheet_02","sheet_0"]`),返回的数据为sheet的`celldata`字段数据集合。为了加载性能考虑,除了第一次加载当前页的`celldata`数据之外,其余sheet的数据,是在切换到那个sheet页的时候,才会请求那一页的数据。
------------
### allowUpdate
@ -121,7 +123,9 @@ Luckysheet开放了更细致的自定义配置选项,分别有
### updateUrl
- 类型:String
- 默认值:""
- 作用:操作表格后的后台更新地址,在`allowUpdate`为`true`时才会有效
- 作用:操作表格后的后台更新地址,在`allowUpdate`为`true`时才会有效,此接口也是共享编辑的接口地址。
注意,还需要配置`loadUrl`和`loadSheetUrl`才能生效
------------
### updateImageUrl
@ -181,7 +185,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
### showtoolbar
- 类型:Boolean
- 默认值:true
- 作用:是否第二列显示工具栏
- 作用:是否显示工具栏
------------
### showtoolbarConfig
@ -232,7 +236,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
### showinfobar
- 类型:Boolean
- 默认值:true
- 作用:是否显示顶部名称
- 作用:是否显示顶部信息
------------
### showsheetbar
@ -376,18 +380,18 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 格式:
```json
{
copy: false, // '复制'
copyAs: false, // '复制为'
paste: false, // '粘贴'
insert: false, // '插入'
delete: false, // '删除'
hide: false, // '隐藏'
deleteCell: false, // '删除单元格'
clear: false, // '清除内容'
matrix: false, // '矩阵操作选区'
sort: false, // '排序选区'
filter: false, //'筛选选区'
chart: false // '图表生成'
copy: false, // 复制
copyAs: false, // 复制为
paste: false, // 粘贴
insert: false, // 插入
delete: false, // 删除
hide: false, // 隐藏
deleteCell: false, // 删除单元格
clear: false, // 清除内容
matrix: false, // 矩阵操作选区
sort: false, // 排序选区
filter: false, // 筛选选区
chart: false // 图表生成
}
------------
@ -401,8 +405,8 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 格式:
```json
{
delete: false, // '删除'
copy: false, // '复制'
delete: false, // 删除
copy: false, // 复制
rename: false, //重命名
color: false, //更改颜色
hide: false, //隐藏
@ -652,8 +656,8 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 默认值:null
- 作用:sheet移动前
- 参数:
- {Number} [i]: 当前sheet页的index
- {Number} [order]: 当前sheet页order
- {Number} [i]: 当前sheet页的`index`
- {Number} [order]: 当前sheet页`order`
------------
### sheetMoveAfter
@ -661,9 +665,9 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 默认值:null
- 作用:sheet移动后
- 参数:
- {Number} [i]: 当前sheet页的index
- {Number} [oldOrder]: 修改前当前sheet页order
- {Number} [newOrder]: 修改后当前sheet页order
- {Number} [i]: 当前sheet页的`index`
- {Number} [oldOrder]: 修改前当前sheet页`order`
- {Number} [newOrder]: 修改后当前sheet页`order`
------------
### sheetDeleteBefore
@ -687,7 +691,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 默认值:null
- 作用:sheet修改名称前
- 参数:
- {Number} [i]: sheet页的index
- {Number} [i]: sheet页的`index`
- {String} [name]: 当前sheet页名称
------------
@ -706,7 +710,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 默认值:null
- 作用:sheet修改颜色前
- 参数:
- {Number} [i]: sheet页的index
- {Number} [i]: sheet页的`index`
- {String} [color]: 当前sheet页颜色
------------
@ -715,7 +719,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
- 默认值:null
- 作用:sheet修改颜色后
- 参数:
- {Number} [i]: sheet页的index
- {Number} [i]: sheet页的`index`
- {String} [oldColor]: 修改前当前sheet页颜色
- {String} [newColor]: 修改后当前sheet页颜色
@ -742,7 +746,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
### workbookDestroyBefore
- 类型:Function
- 默认值:null
- 作用:表格创建之后触发
- 作用:表格销毁之前触发
- 参数:
- {Object} [book]: 整个工作簿的配置(options)
@ -750,7 +754,7 @@ Luckysheet开放了更细致的自定义配置选项,分别有
### workbookDestroyAfter
- 类型:Function
- 默认值:null
- 作用:表格创建之后触发
- 作用:表格销毁之后触发
- 参数:
- {Object} [book]: 整个工作簿的配置(options)

Loading…
Cancel
Save