Browse Source

docs(api): api

api
master
lrz 5 years ago
parent
commit
83b07e41e5
  1. 13
      docs/zh/guide/api.md
  2. 10
      docs/zh/guide/config.md
  3. 4
      docs/zh/guide/sheet.md

13
docs/zh/guide/api.md

@ -132,7 +132,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
- 边框设置时,attr为`"bd"`,value为一个key/value对象,需要同时设置边框类型:`borderType`/边框粗细:`style`/边框颜色:`color`/,比如设置A1单元格的边框为所有/红色/细:
`luckysheet.setCellAttr(0, 0, "bd", {borderType: "border-right",style: "1", color: "#ff0000"})`
`luckysheet.setCellFormat(0, 0, "bd", {borderType: "border-right",style: "1", color: "#ff0000"})`
完整可选的设置参数如下:
@ -501,12 +501,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
## 选区操作
### getRange([setting])
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表索引;默认值为当前工作表索引
### getRange()
- **说明**
@ -533,7 +528,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区
+ {Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区
+ {Number} [order]: 工作表索引;默认值为当前工作表索引
- **说明**
@ -2160,7 +2155,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
返回当前选区对象的数组,可能存在多个选区。
> 推荐使用新API: [getRange](#getRange([setting]))
> 推荐使用新API: [getRange](#getRange())
------------

10
docs/zh/guide/config.md

@ -401,6 +401,16 @@ Luckysheet开放了更细致的自定义配置选项,分别有
钩子函数统一配置在`options.hook`下,可以分别针对单元格、sheet页、表格创建配置hook。
------------
### cellRenderAfter
- 类型:Function
- 默认值:null
- 作用:单元格渲染结束后触发
- 参数:
- {Number} [r]: 单元格所在行数
- {Number} [c]: 单元格所在列数
- {Object} [v]: 单元格对象
------------
### cellHover
- 类型:Function

4
docs/zh/guide/sheet.md

@ -622,7 +622,7 @@ options.data示例如下:
"cellColor": "#ff0000"
},
"conditionName": "betweenness", //类型
"conditionRange": [
"conditionRange": [ //条件值所在单元格
{
"row": [ 4, 4 ],
"column": [ 2, 2 ]
@ -633,7 +633,7 @@ options.data示例如下:
}
],
"conditionValue": [ 2, 4
]
] //自定义传入的条件值
},
{
"type": "dataBar",

Loading…
Cancel
Save