Browse Source

feat(api): add some api functions

master
swen-xiong 5 years ago
parent
commit
37910abea3
  1. 34
      docs/zh/guide/api.md
  2. 1271
      src/global/api.js
  3. 11
      src/global/editor.js

34
docs/zh/guide/api.md

@ -10,6 +10,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
## 单元格操作
### getCellValue(row, column [,setting])<div id='getCellValue'></div>
- [x] $\color{#FF3030}已实现$
- **参数**
@ -38,6 +39,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setCellValue(row, column, value [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -62,6 +64,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### clearCell(row, column [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -83,6 +86,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### deleteCell(move, row, column [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
- {String} [move]: 删除后,右侧还是下方的单元格移动
@ -110,6 +114,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setCellFormat(row, column, attr, value [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -152,6 +157,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### find(content [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -174,6 +180,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### replace(content, replaceContent [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -200,6 +207,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
## 行和列操作
### setHorizontalFrozen(isRange [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -232,6 +240,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setVerticalFrozen(isRange [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -260,6 +269,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setBothFrozen(isRange [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -288,6 +298,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### cancelFrozen([setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -308,6 +319,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### insertRow(row [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -331,6 +343,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### insertColumn( column [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -354,6 +367,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### deleteRow(rowStart, rowEnd [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -379,6 +393,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### deleteColumn(columnStart, columnEnd [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -404,6 +419,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### hideRow(rowStart, rowEnd [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -429,6 +445,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### hideColumn(columnStart, columnEnd [,setting])(TODO)
- [x] $\color{#FF3030}已实现$
- **参数**
@ -454,6 +471,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### showRow(rowStart, rowEnd [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -477,6 +495,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### showColumn(columnStart, columnEnd [,setting])(TODO)
- [x] $\color{#FF3030}已实现$
- **参数**
@ -502,6 +521,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
## 选区操作
### getRange()
- [x] $\color{#FF3030}已实现$
- **说明**
@ -524,6 +544,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### getRangeValue([setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -656,6 +677,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### getRangeJson(title [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -701,6 +723,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### getRangeArray(dimensional [,setting])
- [ ] $\color{green} TODO$
- **参数**
@ -796,6 +819,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### getRangeDiagonal(type [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -875,6 +899,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### getRangeBoolean([setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -942,6 +967,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setRangeValue(data [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -1006,6 +1032,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setRangeFormat(attr, value [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -1071,6 +1098,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setRangeMerge(type [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -1124,6 +1152,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### cancelRangeMerge( [setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -1145,6 +1174,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setRangeSort(type [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -1173,6 +1203,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------
### setRangeSortMulti(title, sort [,setting])
- [x] $\color{#FF3030}已实现$
- **参数**
@ -1191,7 +1222,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
- **示例**:
- 设置当前工作表当前选区为自定义排序,数据具有标题行,且按第一列升序第二列降序的规则进行排序
`luckysheet.setRangeSortMulti(true,{sort:[{ i:0,sort:'asc' },{ i:1,sort:'des' }]})`
`luckysheet.setRangeSortMulti(true,[{ i:0,sort:'asc' },{ i:1,sort:'des' }])`
------------
@ -1536,7 +1567,6 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
+ `"newMatrix"`: 生产新矩阵
- {PlainObject} [setting]: 可选参数
+ {Array | Object | String} [range]: 选区范围,支持选区的格式为`"A1:B2"`、`"sheetName!A1:B2"`或者`{row:[0,1],column:[0,1]}`,只能为单个选区;默认为当前选区
+ {Number} [order]: 工作表索引;默认值为当前工作表索引
+ {Function} [success]: 操作结束的回调函数
- **说明**

1271
src/global/api.js

File diff suppressed because it is too large

11
src/global/editor.js

@ -60,12 +60,19 @@ const editor = {
_this.deepCopyFlowDataCache = $.extend(true, [], flowData);
}
},
controlHandler: function (dataChe) {
/**
* @param {Array} dataChe
* @param {Object} range 是否指定选区默认为当前选区
* @since Add range parameter. Update by siwei@2020-09-10.
*/
controlHandler: function (dataChe, range) {
let _this = this;
let d = _this.deepCopyFlowData(Store.flowdata);//取数据
let last = Store.luckysheet_select_save[Store.luckysheet_select_save.length - 1];
// let last = Store.luckysheet_select_save[Store.luckysheet_select_save.length - 1];
let last = range || Store.luckysheet_select_save[Store.luckysheet_select_save.length - 1];
let curR = last["row"] == null ? 0 : last["row"][0];
let curC = last["column"] == null ? 0 : last["column"][0];
let rlen = dataChe.length, clen = dataChe[0].length;

Loading…
Cancel
Save