@ecan-bi/sheet 0.0.9 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/dist/index.es.js +98538 -64
  2. package/dist/index.es.js.map +1 -1
  3. package/dist/index.umd.js +4149 -1
  4. package/dist/index.umd.js.map +1 -1
  5. package/dist/style.css +4 -0
  6. package/package.json +29 -6
  7. package/types/luckysheet/config.d.ts +78 -0
  8. package/types/luckysheet/controllers/cellDatePickerCtrl.d.ts +4 -0
  9. package/types/luckysheet/controllers/cellFormat.d.ts +1 -0
  10. package/types/luckysheet/controllers/conditionformat.d.ts +47 -0
  11. package/types/luckysheet/controllers/constant.d.ts +142 -0
  12. package/types/luckysheet/controllers/controlHistory.d.ts +5 -0
  13. package/types/luckysheet/controllers/dropCell.d.ts +95 -0
  14. package/types/luckysheet/controllers/expendPlugins.d.ts +4 -0
  15. package/types/luckysheet/controllers/filter.d.ts +5 -0
  16. package/types/luckysheet/controllers/formulaBar.d.ts +1 -0
  17. package/types/luckysheet/controllers/handler.d.ts +1 -0
  18. package/types/luckysheet/controllers/ifFormulaGenerator.d.ts +12 -0
  19. package/types/luckysheet/controllers/imageUpdateCtrl.d.ts +1 -0
  20. package/types/luckysheet/controllers/inlineString.d.ts +25 -0
  21. package/types/luckysheet/controllers/insertFormula.d.ts +9 -0
  22. package/types/luckysheet/controllers/keyboard.d.ts +1 -0
  23. package/types/luckysheet/controllers/listener.d.ts +1 -0
  24. package/types/luckysheet/controllers/locationCell.d.ts +10 -0
  25. package/types/luckysheet/controllers/luckysheetConfigsetting.d.ts +36 -0
  26. package/types/luckysheet/controllers/matrixOperation.d.ts +1 -0
  27. package/types/luckysheet/controllers/mobile.d.ts +1 -0
  28. package/types/luckysheet/controllers/orderBy.d.ts +1 -0
  29. package/types/luckysheet/controllers/postil.d.ts +27 -0
  30. package/types/luckysheet/controllers/print.d.ts +2 -0
  31. package/types/luckysheet/controllers/protection.d.ts +10 -0
  32. package/types/luckysheet/controllers/resize.d.ts +10 -0
  33. package/types/luckysheet/controllers/rowColumnOperation.d.ts +9 -0
  34. package/types/luckysheet/controllers/searchReplace.d.ts +10 -0
  35. package/types/luckysheet/controllers/select.d.ts +7 -0
  36. package/types/luckysheet/controllers/selection.d.ts +14 -0
  37. package/types/luckysheet/controllers/sheetBar.d.ts +1 -0
  38. package/types/luckysheet/controllers/sheetMove.d.ts +5 -0
  39. package/types/luckysheet/controllers/sheetSearch.d.ts +1 -0
  40. package/types/luckysheet/controllers/splitColumn.d.ts +10 -0
  41. package/types/luckysheet/controllers/toolbar.d.ts +42 -0
  42. package/types/luckysheet/controllers/updateCell.d.ts +10 -0
  43. package/types/luckysheet/controllers/zoom.d.ts +4 -0
  44. package/types/luckysheet/core.d.ts +41 -0
  45. package/types/luckysheet/expendPlugins/chart/plugin.d.ts +4 -0
  46. package/types/luckysheet/expendPlugins/print/plugin.d.ts +1 -0
  47. package/types/luckysheet/function/func.d.ts +10 -0
  48. package/types/luckysheet/function/functionImplementation.d.ts +451 -0
  49. package/types/luckysheet/function/functionlist.d.ts +2 -0
  50. package/types/luckysheet/function/matrix_methods.d.ts +1 -0
  51. package/types/luckysheet/global/analysis.d.ts +8 -0
  52. package/types/luckysheet/global/api.d.ts +1193 -0
  53. package/types/luckysheet/global/array.d.ts +8 -0
  54. package/types/luckysheet/global/border.d.ts +2 -0
  55. package/types/luckysheet/global/browser.d.ts +15 -0
  56. package/types/luckysheet/global/cleargridelement.d.ts +1 -0
  57. package/types/luckysheet/global/count.d.ts +1 -0
  58. package/types/luckysheet/global/createdom.d.ts +1 -0
  59. package/types/luckysheet/global/createsheet.d.ts +1 -0
  60. package/types/luckysheet/global/cursorPos.d.ts +7 -0
  61. package/types/luckysheet/global/datecontroll.d.ts +7 -0
  62. package/types/luckysheet/global/draw.d.ts +3 -0
  63. package/types/luckysheet/global/dynamicArray.d.ts +4 -0
  64. package/types/luckysheet/global/editor.d.ts +11 -0
  65. package/types/luckysheet/global/extend.d.ts +13 -0
  66. package/types/luckysheet/global/format.d.ts +5 -0
  67. package/types/luckysheet/global/func_methods.d.ts +25 -0
  68. package/types/luckysheet/global/getRowlen.d.ts +16 -0
  69. package/types/luckysheet/global/getdata.d.ts +13 -0
  70. package/types/luckysheet/global/json.d.ts +5 -0
  71. package/types/luckysheet/global/loading.d.ts +2 -0
  72. package/types/luckysheet/global/location.d.ts +6 -0
  73. package/types/luckysheet/global/method.d.ts +10 -0
  74. package/types/luckysheet/global/refresh.d.ts +8 -0
  75. package/types/luckysheet/global/rhchInit.d.ts +2 -0
  76. package/types/luckysheet/global/scroll.d.ts +1 -0
  77. package/types/luckysheet/global/setdata.d.ts +2 -0
  78. package/types/luckysheet/global/sort.d.ts +4 -0
  79. package/types/luckysheet/global/tooltip.d.ts +12 -0
  80. package/types/luckysheet/global/validate.d.ts +23 -0
  81. package/types/luckysheet/index.d.ts +2 -0
  82. package/types/luckysheet/locale/en.d.ts +1216 -0
  83. package/types/luckysheet/locale/es.d.ts +1194 -0
  84. package/types/luckysheet/locale/locale.d.ts +12 -0
  85. package/types/luckysheet/locale/zh.d.ts +1235 -0
  86. package/types/luckysheet/locale/zh_tw.d.ts +1249 -0
  87. package/types/luckysheet/methods/get.d.ts +11 -0
  88. package/types/luckysheet/methods/set.d.ts +6 -0
  89. package/types/luckysheet/plugins/js/jquery-mousewheel.d.ts +8 -0
  90. package/types/luckysheet/plugins/js/spectrum.d.ts +1 -0
  91. package/types/luckysheet/store/index.d.ts +145 -0
  92. package/types/luckysheet/utils/chartUtil.d.ts +20 -0
  93. package/types/luckysheet/utils/polyfill.d.ts +5 -0
  94. package/types/luckysheet/utils/util.d.ts +87 -0
@@ -0,0 +1,1193 @@
1
+ /**
2
+ * 获取单元格的值
3
+ * @param {Number} row 单元格所在行数;从0开始的整数,0表示第一行
4
+ * @param {Number} column 单元格所在列数;从0开始的整数,0表示第一列
5
+ * @param {Object} options 可选参数
6
+ * @param {String} options.type 单元格的值类型,可以设置为原始值"v"或者显示值"m";默认值为'v',表示获取单元格的实际值
7
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
8
+ */
9
+ export function getCellValue(row: number, column: number, options?: {
10
+ type: string;
11
+ order: number;
12
+ }): any;
13
+ /**
14
+ * 设置单元格的值
15
+ *
16
+ * 关键点:如果设置了公式,则需要更新公式链insertUpdateFunctionGroup,如果设置了不是公式,判断之前是公式,则需要清除公式delFunctionGroup
17
+ *
18
+ * @param {Number} row 单元格所在行数;从0开始的整数,0表示第一行
19
+ * @param {Number} column 单元格所在列数;从0开始的整数,0表示第一列
20
+ * @param {Object | String | Number} value 要设置的值;可以为字符串或数字,或为符合Luckysheet单元格格式的对象
21
+ * @param {Object} options 可选参数
22
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
23
+ * @param {Boolean} options.isRefresh 是否刷新界面;默认为`true`
24
+ * @param {Function} options.success 操作结束的回调函数
25
+ */
26
+ export function setCellValue(row: number, column: number, value: any | string | number, options?: {
27
+ order: number;
28
+ isRefresh: boolean;
29
+ success: Function;
30
+ }): void;
31
+ /**
32
+ * 清除指定工作表指定单元格的内容,返回清除掉的数据,不同于删除单元格的功能,不需要设定单元格移动情况
33
+ * @param {Number} row 单元格所在行数;从0开始的整数,0表示第一行
34
+ * @param {Number} column 单元格所在列数;从0开始的整数,0表示第一列
35
+ * @param {Object} options 可选参数
36
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
37
+ * @param {Function} options.success 操作结束的回调函数
38
+ */
39
+ export function clearCell(row: number, column: number, options?: {
40
+ order: number;
41
+ success: Function;
42
+ }): void;
43
+ /**
44
+ * 删除指定工作表指定单元格,返回删除掉的数据,同时,指定是右侧单元格左移还是下方单元格上移
45
+ * @param {String} move 删除后,右侧还是下方的单元格移动。可选值为 'left'、'up'
46
+ * @param {Number} row 单元格所在行数;从0开始的整数,0表示第一行
47
+ * @param {Number} column 单元格所在列数;从0开始的整数,0表示第一列
48
+ * @param {Object} options 可选参数
49
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
50
+ * @param {Function} options.success 操作结束的回调函数
51
+ */
52
+ export function deleteCell(move: string, row: number, column: number, options?: {
53
+ order: number;
54
+ success: Function;
55
+ }): void;
56
+ /**
57
+ * 设置某个单元格的属性,如果要设置单元格的值或者同时设置多个单元格属性,推荐使用setCellValue
58
+ * @param {Number} row 单元格所在行数;从0开始的整数,0表示第一行
59
+ * @param {Number} column 单元格所在列数;从0开始的整数,0表示第一列
60
+ * @param {String} attr
61
+ * @param {Number | String | Object} value 具体的设置值,一个属性会对应多个值,参考 单元格属性表的值示例,特殊情况:如果属性类型attr是单元格格式ct,则设置值value应提供ct.fa,比如设置A1单元格的格式为百分比格式:luckysheet.setCellFormat(0, 0, "ct", "0.00%")
62
+ * @param {Object} options 可选参数
63
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
64
+ * @param {Function} options.success 操作结束的回调函数, callback参数为改变后的cell对象
65
+ */
66
+ export function setCellFormat(row: number, column: number, attr: string, value: number | string | any, options?: {
67
+ order: number;
68
+ success: Function;
69
+ }): void | TypeError;
70
+ /**
71
+ * 查找一个工作表中的指定内容,返回查找到的内容组成的单元格一位数组,数据格式同celldata
72
+ * @param {String} content 要查找的内容 可以为正则表达式(不包含前后'/')
73
+ * @param {Object} options 可选参数
74
+ * @param {Boolean} options.isRegularExpression 是否正则表达式匹配;默认为 false. 注意:正则中的规则需要转义,如\S需要写成 \\S
75
+ * @param {Boolean} options.isWholeWord 是否整词匹配;默认为 false
76
+ * @param {Boolean} options.isCaseSensitive 是否区分大小写匹配;默认为 false
77
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
78
+ * @param {String} options.type 单元格属性;默认值为m
79
+ */
80
+ export function find(content: string, options?: {
81
+ isRegularExpression: boolean;
82
+ isWholeWord: boolean;
83
+ isCaseSensitive: boolean;
84
+ order: number;
85
+ type: string;
86
+ }): void | any[];
87
+ /**
88
+ * 查找一个工作表中的指定内容并替换成新的内容,返回替换后的内容组成的单元格一位数组,数据格式同celldata。
89
+ * @param {String} content 要查找的内容
90
+ * @param {String} replaceContent 要替换的内容
91
+ * @param {Object} options 可选参数
92
+ * @param {Boolean} options.isRegularExpression 是否正则表达式匹配;默认为 false
93
+ * @param {Boolean} options.isWholeWord 是否整词匹配;默认为 false
94
+ * @param {Boolean} options.isCaseSensitive 是否区分大小写匹配;默认为 false
95
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
96
+ * @param {Function} options.success 操作结束的回调函数, callback参数为替换后的cell集合
97
+ */
98
+ export function replace(content: string, replaceContent: string, options?: {
99
+ isRegularExpression: boolean;
100
+ isWholeWord: boolean;
101
+ isCaseSensitive: boolean;
102
+ order: number;
103
+ success: Function;
104
+ }): void | any[];
105
+ /**
106
+ * 手动触发退出编辑模式
107
+ * @param {Object} options 可选参数
108
+ * @param {Function} options.success 操作结束的回调函数
109
+ */
110
+ export function exitEditMode(options?: {
111
+ success: Function;
112
+ }): void;
113
+ /**
114
+ * 手动触发进入编辑模式
115
+ * @param {Object} options 可选参数
116
+ * @param {Function} options.success 操作结束的回调函数
117
+ */
118
+ export function enterEditMode(options?: {
119
+ success: Function;
120
+ }): void;
121
+ /**
122
+ * 冻结首行
123
+ * 若设置冻结的sheet不是当前sheet页,只设置参数不渲染
124
+ * @param {Number | String} order 工作表索引
125
+ */
126
+ export function frozenFirstRow(order: number | string): void;
127
+ /**
128
+ * 冻结首列
129
+ * 若设置冻结的sheet不是当前sheet页,只设置参数不渲染
130
+ * @param {Number | String} order 工作表索引
131
+ */
132
+ export function frozenFirstColumn(order: number | string): void;
133
+ /**
134
+ * 冻结行选区
135
+ * @param {Object} range 行选区范围的focus单元格的行列值构成的对象;格式为{ row_focus:0, column_focus:0 }
136
+ * @param {Number | String} order 工作表索引
137
+ */
138
+ export function frozenRowRange(range: any, order: number | string): void;
139
+ /**
140
+ * 冻结列选区
141
+ * @param {Object} range 列选区范围的focus单元格的行列值构成的对象;格式为{ row_focus:0, column_focus:0 }
142
+ * @param {Number | String} order 工作表索引
143
+ */
144
+ export function frozenColumnRange(range: any, order: number | string): void;
145
+ /**
146
+ * 取消冻结
147
+ * @param {Number | String} order
148
+ */
149
+ export function cancelFrozen(order: number | string): void;
150
+ /**
151
+ * 冻结行操作。特别注意,只有在isRange设置为true的时候,才需要设置setting中的range,且与一般的range格式不同。
152
+ * @param {Boolean} isRange 是否冻结行到选区 true-冻结行到选区 false-冻结首行
153
+ * @param {Object} options 可选参数
154
+ * @param {Object} options.range isRange为true的时候设置,开启冻结的单元格位置,格式为{ row_focus:0, column_focus:0 },意为当前激活的单元格的行数和列数;默认从当前选区最后的一个选区中取得
155
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
156
+ * @param {Function} options.success 操作结束的回调函数
157
+ */
158
+ export function setHorizontalFrozen(isRange: boolean, options?: {
159
+ range: any;
160
+ order: number;
161
+ success: Function;
162
+ }): void;
163
+ /**
164
+ * 冻结列操作。特别注意,只有在isRange设置为true的时候,才需要设置setting中的range,且与一般的range格式不同。
165
+ * @param {Boolean} isRange 是否冻结列到选区 true-冻结列到选区 false-冻结首列
166
+ * @param {Object} options 可选参数
167
+ * @param {Object} options.range isRange为true的时候设置,开启冻结的单元格位置,格式为{ row_focus:0, column_focus:0 },意为当前激活的单元格的行数和列数;默认从当前选区最后的一个选区中取得
168
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
169
+ * @param {Function} options.success 操作结束的回调函数
170
+ */
171
+ export function setVerticalFrozen(isRange: boolean, options?: {
172
+ range: any;
173
+ order: number;
174
+ success: Function;
175
+ }): void;
176
+ /**
177
+ * 冻结行列操作。特别注意,只有在isRange设置为true的时候,才需要设置setting中的range,且与一般的range格式不同。
178
+ * @param {Boolean} isRange 是否冻结行列到选区 true-冻结行列到选区 false-冻结首行列
179
+ * @param {Object} options 可选参数
180
+ * @param {Object} options.range isRange为true的时候设置,开启冻结的单元格位置,格式为{ row_focus:0, column_focus:0 },意为当前激活的单元格的行数和列数;默认从当前选区最后的一个选区中取得
181
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
182
+ * @param {Function} options.success 操作结束的回调函数
183
+ */
184
+ export function setBothFrozen(isRange: boolean, options?: {
185
+ range: any;
186
+ order: number;
187
+ success: Function;
188
+ }): void;
189
+ /**
190
+ * 在第index行或列的位置,插入number行或列
191
+ * @param {String} type 插入行或列 row-行 column-列
192
+ * @param {Number} index 在第几行插入空白行,从0开始
193
+ * @param {Object} options 可选参数
194
+ * @param {Number} options.number 插入的空白行数;默认为 1
195
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
196
+ * @param {Function} options.success 操作结束的回调函数
197
+ */
198
+ export function insertRowOrColumn(type: string, index?: number, options?: {
199
+ number: number;
200
+ order: number;
201
+ success: Function;
202
+ }): void;
203
+ /**
204
+ * 在第index行或列的位置,插入number行或列
205
+ * @param {String} type 插入行或列 row-行 column-列
206
+ * @param {Number} index 在第几行插入空白行,从0开始
207
+ * @param {Object} options 可选参数
208
+ * @param {Number} options.number 插入的空白行数;默认为 1
209
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
210
+ * @param {Function} options.success 操作结束的回调函数
211
+ */
212
+ export function insertRowBottomOrColumnRight(type: string, index?: number, options?: {
213
+ number: number;
214
+ order: number;
215
+ success: Function;
216
+ }): void;
217
+ /**
218
+ * 在第row行的位置,插入number行空白行
219
+ * @param {Number} row 在第几行插入空白行,从0开始
220
+ * @param {Object} options 可选参数
221
+ * @param {Number} options.number 插入的空白行数;默认为 1
222
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
223
+ * @param {Function} options.success 操作结束的回调函数
224
+ */
225
+ export function insertRow(row?: number, options?: {
226
+ number: number;
227
+ order: number;
228
+ success: Function;
229
+ }): void;
230
+ /**
231
+ * 在第row行的位置,插入number行空白行
232
+ * @param {Number} row 在第几行插入空白行,从0开始
233
+ * @param {Object} options 可选参数
234
+ * @param {Number} options.number 插入的空白行数;默认为 1
235
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
236
+ * @param {Function} options.success 操作结束的回调函数
237
+ */
238
+ export function insertRowBottom(row?: number, options?: {
239
+ number: number;
240
+ order: number;
241
+ success: Function;
242
+ }): void;
243
+ /**
244
+ * 在第column列的位置,插入number列空白列
245
+ * @param {Number} column 在第几列插入空白列,从0开始
246
+ * @param {Object} options 可选参数
247
+ * @param {Number} options.number 插入的空白列数;默认为 1
248
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
249
+ * @param {Function} options.success 操作结束的回调函数
250
+ */
251
+ export function insertColumn(column?: number, options?: {
252
+ number: number;
253
+ order: number;
254
+ success: Function;
255
+ }): void;
256
+ /**
257
+ * 在第column列的位置,插入number列空白列
258
+ * @param {Number} column 在第几列插入空白列,从0开始
259
+ * @param {Object} options 可选参数
260
+ * @param {Number} options.number 插入的空白列数;默认为 1
261
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
262
+ * @param {Function} options.success 操作结束的回调函数
263
+ */
264
+ export function insertColumnRight(column?: number, options?: {
265
+ number: number;
266
+ order: number;
267
+ success: Function;
268
+ }): void;
269
+ /**
270
+ * 删除指定的行或列。删除行列之后,行列的序号并不会变化,下面的行(右侧的列)会补充到上(左)面,注意观察数据是否被正确删除即可。
271
+ * @param {String} type 删除行或列 row-行 column-列
272
+ * @param {Number} startIndex 要删除的起始行或列
273
+ * @param {Number} endIndex 要删除的结束行或列
274
+ * @param {Object} options 可选参数
275
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
276
+ * @param {Function} options.success 操作结束的回调函数
277
+ */
278
+ export function deleteRowOrColumn(type: string, startIndex: number, endIndex: number, options?: {
279
+ order: number;
280
+ success: Function;
281
+ }): void;
282
+ /**
283
+ * 删除指定的行。
284
+ * @param {Number} rowStart 要删除的起始行
285
+ * @param {Number} rowEnd 要删除的结束行
286
+ * @param {Object} options 可选参数
287
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
288
+ * @param {Function} options.success 操作结束的回调函数
289
+ */
290
+ export function deleteRow(rowStart: number, rowEnd: number, options?: {
291
+ order: number;
292
+ success: Function;
293
+ }): void;
294
+ /**
295
+ * 删除指定的列。
296
+ * @param {Number} columnStart 要删除的起始列
297
+ * @param {Number} columnEnd 要删除的结束列
298
+ * @param {Object} options 可选参数
299
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
300
+ * @param {Function} options.success 操作结束的回调函数
301
+ */
302
+ export function deleteColumn(columnStart: number, columnEnd: number, options?: {
303
+ order: number;
304
+ success: Function;
305
+ }): void;
306
+ /**
307
+ * 隐藏行或列
308
+ * @param {String} type 隐藏行或列 row-隐藏行 column-隐藏列
309
+ * @param {Number} startIndex 起始行或列
310
+ * @param {Number} endIndex 结束行或列
311
+ * @param {Object} options 可选参数
312
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
313
+ * @param {Function} options.success 操作结束的回调函数
314
+ */
315
+ export function hideRowOrColumn(type: string, startIndex: number, endIndex: number, options?: {
316
+ order: number;
317
+ success: Function;
318
+ }): void;
319
+ /**
320
+ * 显示隐藏的行或列
321
+ * @param {String} type 显示行或列 row-显示行 column-显示列
322
+ * @param {Number} startIndex 起始行或列
323
+ * @param {Number} endIndex 结束行或列
324
+ * @param {Object} options 可选参数
325
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
326
+ * @param {Function} options.success 操作结束的回调函数
327
+ */
328
+ export function showRowOrColumn(type: string, startIndex: number, endIndex: number, options?: {
329
+ order: number;
330
+ success: Function;
331
+ }): void;
332
+ /**
333
+ * 隐藏行
334
+ * @param {Number} startIndex 起始行
335
+ * @param {Number} endIndex 结束行
336
+ * @param {Object} options 可选参数
337
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
338
+ * @param {Function} options.success 操作结束的回调函数
339
+ */
340
+ export function hideRow(startIndex: number, endIndex: number, options?: {
341
+ order: number;
342
+ success: Function;
343
+ }): void;
344
+ /**
345
+ * 显示行
346
+ * @param {Number} startIndex 起始行
347
+ * @param {Number} endIndex 结束行
348
+ * @param {Object} options 可选参数
349
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
350
+ * @param {Function} options.success 操作结束的回调函数
351
+ */
352
+ export function showRow(startIndex: number, endIndex: number, options?: {
353
+ order: number;
354
+ success: Function;
355
+ }): void;
356
+ /**
357
+ * 隐藏列
358
+ * @param {Number} startIndex 起始列
359
+ * @param {Number} endIndex 结束列
360
+ * @param {Object} options 可选参数
361
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
362
+ * @param {Function} options.success 操作结束的回调函数
363
+ */
364
+ export function hideColumn(startIndex: number, endIndex: number, options?: {
365
+ order: number;
366
+ success: Function;
367
+ }): void;
368
+ /**
369
+ * 显示列
370
+ * @param {Number} startIndex 起始列
371
+ * @param {Number} endIndex 结束列
372
+ * @param {Object} options 可选参数
373
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
374
+ * @param {Function} options.success 操作结束的回调函数
375
+ */
376
+ export function showColumn(startIndex: number, endIndex: number, options?: {
377
+ order: number;
378
+ success: Function;
379
+ }): void;
380
+ /**
381
+ * 设置指定行的高度。优先级最高,高于默认行高和用户自定义行高。
382
+ * @param {Object} rowInfo 行数和高度对应关系
383
+ * @param {Object} options 可选参数
384
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
385
+ * @param {Function} options.success 操作结束的回调函数
386
+ */
387
+ export function setRowHeight(rowInfo: any, options?: {
388
+ order: number;
389
+ success: Function;
390
+ }): void;
391
+ /**
392
+ * 设置指定列的宽度
393
+ * @param {Object} columnInfo 行数和高度对应关系
394
+ * @param {Object} options 可选参数
395
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
396
+ * @param {Function} options.success 操作结束的回调函数
397
+ */
398
+ export function setColumnWidth(columnInfo: any, options?: {
399
+ order: number;
400
+ success: Function;
401
+ }): void;
402
+ /**
403
+ * 获取指定工作表指定行的高度,得到行号和高度对应关系的对象
404
+ * @param {Array} rowInfo 行号下标组成的数组;行号下标从0开始;
405
+ * @param {Object} options 可选参数
406
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
407
+ * @param {Function} options.success 操作结束的回调函数
408
+ */
409
+ export function getRowHeight(rowInfo: any[], options?: {
410
+ order: number;
411
+ success: Function;
412
+ }): void | {};
413
+ /**
414
+ * 获取指定工作表指定列的宽度,得到列号和宽度对应关系的对象
415
+ * @param {Array} columnInfo 行号下标组成的数组;行号下标从0开始;
416
+ * @param {Object} options 可选参数
417
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
418
+ * @param {Function} options.success 操作结束的回调函数
419
+ */
420
+ export function getColumnWidth(columnInfo: any[], options?: {
421
+ order: number;
422
+ success: Function;
423
+ }): void | {};
424
+ /**
425
+ * 获取工作表的默认行高
426
+ * @param {Object} options 可选参数
427
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
428
+ * @param {Function} options.success 操作结束的回调函数
429
+ */
430
+ export function getDefaultRowHeight(options?: {
431
+ order: number;
432
+ success: Function;
433
+ }): any;
434
+ /**
435
+ * 获取工作表的默认列宽
436
+ * @param {Object} options 可选参数
437
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
438
+ * @param {Function} options.success 操作结束的回调函数
439
+ */
440
+ export function getDefaultColWidth(options?: {
441
+ order: number;
442
+ success: Function;
443
+ }): any;
444
+ /**
445
+ * 返回当前选区对象的数组,可能存在多个选区。
446
+ * 每个选区的格式为row/column信息组成的对象{row:[0,1],column:[0,1]}
447
+ * @returns {Array}
448
+ */
449
+ export function getRange(): any[];
450
+ /**
451
+ * 返回表示指定区域内所有单元格位置的数组,区别getRange方法,该方法以cell单元格(而非某块连续的区域)为单位来组织选区的数据
452
+ * @param {Array} range 可选参数,默认为当前选中区域
453
+ * @returns {Array} 对象数组
454
+ */
455
+ export function getRangeWithFlatten(range: any[]): any[];
456
+ /**
457
+ * 返回表示指定区域内所有单元格内容的对象数组
458
+ * @param {Array} range 可选参数,默认为当前选中区域扁平化后的对象,结构形如[{r:0,c:0},{r:0,c:1}...]
459
+ * @returns {Array} 对象数组
460
+ */
461
+ export function getRangeValuesWithFlatte(range: any[]): any[];
462
+ /**
463
+ * 返回对应当前选区的坐标字符串数组,可能存在多个选区。
464
+ * 每个选区可能是单个单元格(如 A1)或多个单元格组成的矩形区域(如 D9:E12)
465
+ * @returns {Array}
466
+ */
467
+ export function getRangeAxis(): any[];
468
+ /**
469
+ * 返回指定工作表指定范围的单元格二维数组数据,每个单元格为一个对象
470
+ * @param {Object} options 可选参数
471
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
472
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
473
+ */
474
+ export function getRangeValue(options?: {
475
+ range: any | string;
476
+ order: number;
477
+ }): any[][];
478
+ /**
479
+ * 复制指定工作表指定单元格区域的数据,返回包含`<table>`html格式的数据,可用于粘贴到excel中保持单元格样式。
480
+ * @param {Object} options 可选参数
481
+ * @param {Array | Object | String} options.range 选区范围
482
+ * @param {order} options.order 工作表下标
483
+ */
484
+ export function getRangeHtml(options?: {
485
+ range: any[] | any | string;
486
+ order: any;
487
+ }): string | void;
488
+ /**
489
+ * 复制指定工作表指定单元格区域的数据,返回一维、二维或者自定义行列数的二维数组的数据。只有在dimensional设置为custom的时候,才需要设置setting中的row和column
490
+ * @param {String} dimensional 数组维度。可选值为:oneDimensional-一维数组;twoDimensional-二维数组; custom-自定义行列数的二维数组
491
+ * @param {Object} options 可选参数
492
+ * @param {Number} options.row dimensional为custom的时候设置,多维数组的行数
493
+ * @param {Number} options.column dimensional为custom的时候设置,多维数组的列数
494
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
495
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
496
+ */
497
+ export function getRangeArray(dimensional: string, options?: {
498
+ row: number;
499
+ column: number;
500
+ range: any | string;
501
+ order: number;
502
+ }): void | any[];
503
+ /**
504
+ * 复制指定工作表指定单元格区域的数据,返回json格式的数据
505
+ * @param {Boolean} isFirstRowTitle 是否首行为标题
506
+ * @param {Object} options 可选参数
507
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
508
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
509
+ */
510
+ export function getRangeJson(isFirstRowTitle: boolean, options?: {
511
+ range: any | string;
512
+ order: number;
513
+ }): {}[];
514
+ /**
515
+ *
516
+ * @param {String} type 对角线还是对角线偏移 "normal"-对角线 "anti"-反对角线
517
+ "offset"-对角线偏移
518
+ * @param {Object} options 可选参数
519
+ * @param {Number} options.column type为offset的时候设置,对角偏移的列数
520
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
521
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
522
+ */
523
+ export function getRangeDiagonal(type: string, options?: {
524
+ column: number;
525
+ range: any | string;
526
+ order: number;
527
+ }): void;
528
+ /**
529
+ * 复制指定工作表指定单元格区域的数据,返回布尔值的数据
530
+ * @param {Object} options 可选参数
531
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
532
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
533
+ */
534
+ export function getRangeBoolean(options?: {
535
+ range: any | string;
536
+ order: number;
537
+ }): void;
538
+ /**
539
+ * 指定工作表选中一个或多个选区为选中状态并选择是否高亮,支持多种格式设置。
540
+ * @param {Array | Object | String} range 选区范围
541
+ * @param {Object} options 可选参数
542
+ * @param {Boolean} options.show 是否显示高亮选中效果;默认值为 `true`
543
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
544
+ * @param {Function} options.success 操作结束的回调函数
545
+ */
546
+ export function setRangeShow(range: any[] | any | string, options?: {
547
+ show: boolean;
548
+ order: number;
549
+ success: Function;
550
+ }): void;
551
+ /**
552
+ * 将一个单元格数组数据赋值到指定的区域,数据格式同getRangeValue方法取到的数据。
553
+ * @param {Array[Array]} data 要赋值的单元格二维数组数据,每个单元格的值,可以为字符串或数字,或为符合Luckysheet格式的对象
554
+ * @param {Object} options 可选参数
555
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
556
+ * @param {Boolean} options.isRefresh 是否刷新界面;默认为true
557
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
558
+ * @param {Function} options.success 操作结束的回调函数
559
+ */
560
+ export function setRangeValue(data: any, options?: {
561
+ range: any | string;
562
+ isRefresh: boolean;
563
+ order: number;
564
+ success: Function;
565
+ }): void;
566
+ /**
567
+ * 设置指定范围的单元格格式,一般用作处理格式,赋值操作推荐使用setRangeValue方法
568
+ * @param {String} attr 要赋值的单元格二维数组数据,每个单元格的值,可以为字符串或数字,或为符合Luckysheet格式的对象
569
+ * @param {Number | String | Object} value 具体的设置值
570
+ * @param {Object} options 可选参数
571
+ * @param {Object | String} options.range 设置参数的目标选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
572
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
573
+ */
574
+ export function setSingleRangeFormat(attr: string, value: number | string | any, options?: {
575
+ range: any | string;
576
+ order: number;
577
+ }): string;
578
+ /**
579
+ * 设置指定范围的单元格格式,一般用作处理格式。支持多选区设置
580
+ * @param {String} attr 要赋值的单元格二维数组数据,每个单元格的值,可以为字符串或数字,或为符合Luckysheet格式的对象
581
+ * @param {Number | String | Object} value 具体的设置值
582
+ * @param {Object} options 可选参数
583
+ * @param {Array | Object | String} options.range 设置参数的目标选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
584
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
585
+ * @param {Function} options.success 操作结束的回调函数
586
+ */
587
+ export function setRangeFormat(attr: string, value: number | string | any, options?: {
588
+ range: any[] | any | string;
589
+ order: number;
590
+ success: Function;
591
+ }): false | void;
592
+ /**
593
+ * 为指定索引的工作表,选定的范围开启或关闭筛选功能
594
+ * @param {String} type 打开还是关闭筛选功能 open-打开筛选功能,返回当前筛选的范围对象;close-关闭筛选功能,返回关闭前筛选的范围对象
595
+ * @param {Object} options 可选参数
596
+ * @param {Object | String} options.range 选区范围
597
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
598
+ * @param {Object} options.success 操作结束的回调函数
599
+ */
600
+ export function setRangeFilter(type: string, options?: {
601
+ range: any | string;
602
+ order: number;
603
+ success: any;
604
+ }): void | {
605
+ row: any;
606
+ column: any;
607
+ };
608
+ /**
609
+ * 为指定索引的工作表,选定的范围设定合并单元格
610
+ * @param {String} type 合并类型 all-全部合并 horizontal-水平合并 vertical-垂直合并
611
+ * @param {Object} options 可选参数
612
+ * @param {Object | String} options.range 选区范围
613
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
614
+ * @param {Object} options.success 操作结束的回调函数
615
+ */
616
+ export function setRangeMerge(type: string, options?: {
617
+ range: any | string;
618
+ order: number;
619
+ success: any;
620
+ }): void;
621
+ /**
622
+ * 为指定索引的工作表,选定的范围取消合并单元格
623
+ * @param {Object} options 可选参数
624
+ * @param {Array | Object | String} options.range 选区范围
625
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
626
+ * @param {Object} options.success 操作结束的回调函数
627
+ */
628
+ export function cancelRangeMerge(options?: {
629
+ range: any[] | any | string;
630
+ order: number;
631
+ success: any;
632
+ }): void;
633
+ /**
634
+ * 为指定索引的工作表,选定的范围开启排序功能,返回选定范围排序后的数据。
635
+ * @param {String} type 排序类型 asc-升序 desc-降序
636
+ * @param {Object} options 可选参数
637
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
638
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
639
+ * @param {Function} options.success 操作结束的回调函数
640
+ */
641
+ export function setRangeSort(type: string, options?: {
642
+ range: any | string;
643
+ order: number;
644
+ success: Function;
645
+ }): void;
646
+ /**
647
+ * 为指定索引的工作表,选定的范围开启多列自定义排序功能,返回选定范围排序后的数据。
648
+ * @param {Boolean} hasTitle 数据是否具有标题行
649
+ * @param {Array} sort 列设置,设置需要排序的列索引和排序方式,格式如:[{ i:0,sort:'asc' },{ i:1,sort:'des' }]
650
+ * @param {Object} options 可选参数
651
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
652
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
653
+ * @param {Function} options.success 操作结束的回调函数
654
+ */
655
+ export function setRangeSortMulti(hasTitle: boolean, sort: any[], options?: {
656
+ range: any | string;
657
+ order: number;
658
+ success: Function;
659
+ }): void;
660
+ /**
661
+ * 为指定索引的工作表,选定的范围开启条件格式,根据设置的条件格式规则突出显示部分单元格,返回开启条件格式后的数据。
662
+ * @param {String} conditionName 条件格式规则类型
663
+ * @param {Object} conditionValue 可以设置条件单元格或者条件值
664
+ * @param {Object} options 可选参数
665
+ * @param {Object} options.format 颜色设置
666
+ * @param {Array | Object | String} options.cellrange 选区范围
667
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
668
+ * @param {Function} options.success 操作结束的回调函数
669
+ */
670
+ export function setRangeConditionalFormatDefault(conditionName: string, conditionValue: any, options?: {
671
+ format: any;
672
+ cellrange: any[] | any | string;
673
+ order: number;
674
+ success: Function;
675
+ }): void;
676
+ /**
677
+ * 为指定索引的工作表,选定的范围开启条件格式,返回开启条件格式后的数据。
678
+ * @param {String} type 条件格式规则类型
679
+ * @param {Object} options 可选参数
680
+ * @param {Array | String} options.format 颜色设置
681
+ * @param {Array | Object | String} options.cellrange 选区范围
682
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
683
+ * @param {Function} options.success 操作结束的回调函数
684
+ */
685
+ export function setRangeConditionalFormat(type: string, options?: {
686
+ format: any[] | string;
687
+ cellrange: any[] | any | string;
688
+ order: number;
689
+ success: Function;
690
+ }): void;
691
+ /**
692
+ * 为指定下标的工作表,删除条件格式规则,返回被删除的条件格式规则
693
+ * @param {Number} itemIndex 条件格式规则索引
694
+ * @param {Object} options 可选参数
695
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
696
+ * @param {Function} options.success 操作结束的回调函数
697
+ */
698
+ export function deleteRangeConditionalFormat(itemIndex: number, options?: {
699
+ order: number;
700
+ success: Function;
701
+ }): any;
702
+ /**
703
+ * 清除指定工作表指定单元格区域的内容,不同于删除选区的功能,不需要设定单元格移动情况
704
+ * @param {Object} options 可选参数
705
+ * @param {Array | Object | String} options.range 要清除的选区范围
706
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
707
+ * @param {Function} options.success 操作结束的回调函数
708
+ */
709
+ export function clearRange(options?: {
710
+ range: any[] | any | string;
711
+ order: number;
712
+ success: Function;
713
+ }): void;
714
+ /**
715
+ * 删除指定工作表指定单元格区域,返回删除掉的数据,同时,指定是右侧单元格左移还是下方单元格上移
716
+ * @param {String} move 删除后,单元格左移/上移
717
+ * @param {Object} options 可选参数
718
+ * @param {Object | String} options.range 要删除的选区范围
719
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
720
+ * @param {Function} options.success 操作结束的回调函数
721
+ */
722
+ export function deleteRange(move: string, options?: {
723
+ range: any | string;
724
+ order: number;
725
+ success: Function;
726
+ }): void;
727
+ /**
728
+ * 指定工作表指定单元格区域的数据进行矩阵操作,返回操作成功后的结果数据
729
+ * @param {String} type 矩阵操作的类型
730
+ * @param {Object} options 可选参数
731
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
732
+ * @param {Function} options.success 操作结束的回调函数
733
+ */
734
+ export function matrixOperation(type: string, options?: {
735
+ range: any | string;
736
+ success: Function;
737
+ }): void;
738
+ /**
739
+ * 指定工作表指定单元格区域的数据进行矩阵计算,返回计算成功后的结果数据
740
+ * @param {String} type 计算方式
741
+ * @param {Number} number 计算数值
742
+ * @param {Object} options 可选参数
743
+ * @param {Object | String} options.range 选区范围,支持选区的格式为"A1:B2"、"sheetName!A1:B2"或者{row:[0,1],column:[0,1]},只能为单个选区;默认为当前选区
744
+ * @param {Function} options.success 操作结束的回调函数
745
+ */
746
+ export function matrixCalculation(type: string, number: number, options?: {
747
+ range: any | string;
748
+ success: Function;
749
+ }): void;
750
+ /**
751
+ * 新增一个sheet,返回新增的工作表对象
752
+ * @param {Object} options 可选参数
753
+ * @param {Object} options.sheetObject 新增的工作表的数据;默认值为空对象
754
+ * @param {Number} options.order 新增的工作表索引;默认值为最后一个索引位置
755
+ * @param {Function} options.success 操作结束的回调函数
756
+ */
757
+ export function setSheetAdd(options?: {
758
+ sheetObject: any;
759
+ order: number;
760
+ success: Function;
761
+ }): void | {
762
+ name: string;
763
+ color: string;
764
+ status: string;
765
+ order: string;
766
+ index: string;
767
+ celldata: any[];
768
+ row: number;
769
+ column: number;
770
+ config: {};
771
+ pivotTable: any;
772
+ isPivotTable: boolean;
773
+ };
774
+ /**
775
+ * 删除指定下标的工作表,返回已删除的工作表对象
776
+ * @param {Object} options 可选参数
777
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
778
+ * @param {Function} options.success 操作结束的回调函数
779
+ */
780
+ export function setSheetDelete(options?: {
781
+ order: number;
782
+ success: Function;
783
+ }): any;
784
+ /**
785
+ * 复制指定下标的工作表到指定下标位置
786
+ * @param {Object} options 可选参数
787
+ * @param {Number} options.targetOrder 新复制的工作表目标下标位置;默认值为当前工作表下标的下一个下标位置(递增)
788
+ * @param {Number} options.order 被复制的工作表下标;默认值为当前工作表下标
789
+ * @param {Function} options.success 操作结束的回调函数
790
+ */
791
+ export function setSheetCopy(options?: {
792
+ targetOrder: number;
793
+ order: number;
794
+ success: Function;
795
+ }): any;
796
+ /**
797
+ * 隐藏指定下标的工作表,返回被隐藏的工作表对象
798
+ * @param {Object} options 可选参数
799
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
800
+ * @param {Function} options.success 操作结束的回调函数
801
+ */
802
+ export function setSheetHide(options?: {
803
+ order: number;
804
+ success: Function;
805
+ }): any;
806
+ /**
807
+ * 取消隐藏指定下标的工作表,返回被取消隐藏的工作表对象
808
+ * @param {Object} options 可选参数
809
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
810
+ * @param {Function} options.success 操作结束的回调函数
811
+ */
812
+ export function setSheetShow(options?: {
813
+ order: number;
814
+ success: Function;
815
+ }): any;
816
+ /**
817
+ * 设置指定下标的工作表为当前工作表(激活态),即切换到指定的工作表,返回被激活的工作表对象
818
+ * @param {Number} order 要激活的工作表下标
819
+ * @param {Object} options 可选参数
820
+ * @param {Function} options.success 操作结束的回调函数
821
+ */
822
+ export function setSheetActive(order: number, options?: {
823
+ success: Function;
824
+ }): any;
825
+ /**
826
+ * 修改工作表名称
827
+ * @param {String} name 工作表名称
828
+ * @param {Object} options 可选参数
829
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
830
+ * @param {Function} options.success 操作结束的回调函数
831
+ */
832
+ export function setSheetName(name: string, options?: {
833
+ order: number;
834
+ success: Function;
835
+ }): void;
836
+ /**
837
+ * 设置工作表名称处的颜色
838
+ * @param {String} color 工作表颜色
839
+ * @param {Object} options 可选参数
840
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
841
+ * @param {Function} options.success 操作结束的回调函数
842
+ */
843
+ export function setSheetColor(color: string, options?: {
844
+ order: number;
845
+ success: Function;
846
+ }): void;
847
+ /**
848
+ * 指定工作表向左边或右边移动一个位置,或者指定索引,返回指定的工作表对象
849
+ * @param {String | Number} type 工作表移动方向或者移动的目标索引
850
+ * @param {Object} options 可选参数
851
+ * @param {Number} options.order 工作表索引;默认值为当前工作表索引
852
+ * @param {Function} options.success 操作结束的回调函数
853
+ */
854
+ export function setSheetMove(type: string | number, options?: {
855
+ order: number;
856
+ success: Function;
857
+ }): void;
858
+ /**
859
+ * 重新排序所有工作表的位置,指定工作表顺序的数组。
860
+ * @param {Array} orderList 工作表顺序,设置工作表的index和order来指定位置
861
+ * @param {Object} options 可选参数
862
+ * @param {Function} options.success 操作结束的回调函数
863
+ */
864
+ export function setSheetOrder(orderList: any[], options?: {
865
+ success: Function;
866
+ }): void;
867
+ /**
868
+ * 设置工作表缩放比例
869
+ * @param {Number} zoom 工作表缩放比例,值范围为0.1 ~ 4;
870
+ * @param {Object} options 可选参数
871
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
872
+ * @param {Function} options.success 操作结束的回调函数
873
+ */
874
+ export function setSheetZoom(zoom: number, options?: {
875
+ order: number;
876
+ success: Function;
877
+ }): void;
878
+ /**
879
+ * 显示指定下标工作表的网格线,返回操作的工作表对象
880
+ * @param {Object} options 可选参数
881
+ * @param {Number} options.order 需要显示网格线的工作表下标;默认值为当前工作表下标
882
+ * @param {Function} options.success 操作结束的回调函数
883
+ */
884
+ export function showGridLines(options?: {
885
+ order: number;
886
+ success: Function;
887
+ }): any;
888
+ /**
889
+ * 隐藏指定下标工作表的网格线,返回操作的工作表对象
890
+ * @param {Object} options 可选参数
891
+ * @param {Number} options.order 需要显示网格线的工作表下标;默认值为当前工作表下标
892
+ * @param {Function} options.success 操作结束的回调函数
893
+ */
894
+ export function hideGridLines(options?: {
895
+ order: number;
896
+ success: Function;
897
+ }): any;
898
+ /**
899
+ * 刷新canvas
900
+ * @param {Object} options 可选参数
901
+ * @param {Function} options.success 操作结束的回调函数
902
+ */
903
+ export function refresh(options?: {
904
+ success: Function;
905
+ }): void;
906
+ /**
907
+ * 滚动当前工作表位置
908
+ * @param {Object} options 可选参数
909
+ * @param {Number} options.scrollLeft 横向滚动值
910
+ * @param {Number} options.scrollTop 纵向滚动值
911
+ * @param {Number} options.targetRow 纵向滚动到指定的行号
912
+ * @param {Number} options.targetColumn 横向滚动到指定的列号
913
+ * @param {Function} options.success 操作结束的回调函数
914
+ */
915
+ export function scroll(options?: {
916
+ scrollLeft: number;
917
+ scrollTop: number;
918
+ targetRow: number;
919
+ targetColumn: number;
920
+ success: Function;
921
+ }): void;
922
+ /**
923
+ * 根据窗口大小自动resize画布
924
+ * @param {Object} options 可选参数
925
+ * @param {Function} options.success 操作结束的回调函数
926
+ */
927
+ export function resize(options?: {
928
+ success: Function;
929
+ }): void;
930
+ /**
931
+ * 返回指定选区截图后生成的base64格式的图片
932
+ * @param {Object} options 可选参数
933
+ * @param {Object | String} options.range 选区范围,只能为单个选区;默认为当前选区
934
+ */
935
+ export function getScreenshot(options?: {
936
+ range: any | string;
937
+ }): any;
938
+ /**
939
+ * 设置工作簿名称
940
+ * @param {String} name 工作簿名称
941
+ * @param {Object} options 可选参数
942
+ * @param {Function} options.success 操作结束的回调函数
943
+ */
944
+ export function setWorkbookName(name: string, options?: {
945
+ success: Function;
946
+ }): void;
947
+ /**
948
+ * 获取工作簿名称
949
+ * @param {Object} options 可选参数
950
+ * @param {Function} options.success 操作结束的回调函数
951
+ * @returns {String} 返回工作簿名称,如果读取失败则返回空字符串并弹窗提示
952
+ */
953
+ export function getWorkbookName(options?: {
954
+ success: Function;
955
+ }): string;
956
+ /**
957
+ * 撤销当前操作,返回刚刚撤销的操作对象
958
+ * @param {Object} options 可选参数
959
+ * @param {Function} options.success 操作结束的回调函数
960
+ */
961
+ export function undo(options?: {
962
+ success: Function;
963
+ }): any;
964
+ /**
965
+ * 重做当前操作,返回刚刚重做的操作对象
966
+ * @param {Object} options 可选参数
967
+ * @param {Function} options.success 操作结束的回调函数
968
+ */
969
+ export function redo(options?: {
970
+ success: Function;
971
+ }): any;
972
+ /**
973
+ * 返回所有工作表配置
974
+ */
975
+ export function getAllSheets(): any;
976
+ /**
977
+ * 根据index获取sheet页配置
978
+ *
979
+ * @param {Object} options 可选参数
980
+ * @param {String} options.index 工作表index
981
+ * @param {Number} options.order 工作表order
982
+ * @param {String} options.name 工作表name
983
+ */
984
+ export function getSheet(options?: {
985
+ index: string;
986
+ order: number;
987
+ name: string;
988
+ }): any;
989
+ /**
990
+ * 快捷返回指定工作表的数据
991
+ * @param {Object} options 可选参数
992
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
993
+ */
994
+ export function getSheetData(options?: {
995
+ order: number;
996
+ }): any;
997
+ /**
998
+ * 快捷返回指定工作表的config配置
999
+ * @param {Object} options 可选参数
1000
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1001
+ */
1002
+ export function getConfig(options?: {
1003
+ order: number;
1004
+ }): any;
1005
+ /**
1006
+ * 快捷设置指定工作表config配置
1007
+ * @param {Object} options 可选参数
1008
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1009
+ * @param {Function} options.success 操作结束的回调函数
1010
+ */
1011
+ export function setConfig(cfg: any, options?: {
1012
+ order: number;
1013
+ success: Function;
1014
+ }): void;
1015
+ /**
1016
+ * 返回所有表格数据结构的一维数组luckysheetfile
1017
+ */
1018
+ export function getLuckysheetfile(): any;
1019
+ /**
1020
+ * 指定工作表范围设置数据验证功能,并设置参数
1021
+ * @param {Object} optionItem 数据验证的配置信息
1022
+ * @param {String} optionItem.type 类型
1023
+ * @param {String | Null} optionItem.type2 条件类型
1024
+ * @param {String | Number} optionItem.value1 条件值1
1025
+ * @param {String | Number} optionItem.value2 条件值2
1026
+ * @param {Boolean} optionItem.checked 选中状态
1027
+ * @param {Boolean} optionItem.remote 自动远程获取选项
1028
+ * @param {Boolean} optionItem.prohibitInput 输入数据无效时禁止输入
1029
+ * @param {Boolean} optionItem.hintShow 选中单元格时显示提示语
1030
+ * @param {String} optionItem.hintText 提示语文本
1031
+ * @param {Object} options 可选参数
1032
+ * @param {Array | Object | String} options.range 选区范围;默认为当前选区
1033
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1034
+ * @param {Function} options.success 操作结束的回调函数
1035
+ */
1036
+ export function setDataVerification(optionItem: {
1037
+ type: string;
1038
+ type2: string | null;
1039
+ value1: string | number;
1040
+ value2: string | number;
1041
+ checked: boolean;
1042
+ remote: boolean;
1043
+ prohibitInput: boolean;
1044
+ hintShow: boolean;
1045
+ hintText: string;
1046
+ }, options?: {
1047
+ range: any[] | any | string;
1048
+ order: number;
1049
+ success: Function;
1050
+ }): void;
1051
+ /**
1052
+ * 指定工作表范围删除数据验证功能
1053
+ * @param {Object} options 可选参数
1054
+ * @param {Array | Object | String} options.range 选区范围;默认为当前选区
1055
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1056
+ * @param {Function} options.success 操作结束的回调函数
1057
+ */
1058
+ export function deleteDataVerification(options?: {
1059
+ range: any[] | any | string;
1060
+ order: number;
1061
+ success: Function;
1062
+ }): void;
1063
+ /**
1064
+ * 在指定的工作表中指定单元格位置插入图片
1065
+ * @param {String} src 图片src
1066
+ * @param {Object} options 可选参数
1067
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1068
+ * @param {Number} options.rowIndex 要插入图片的单元格行下标;默认为0
1069
+ * @param {Number} options.colIndex 要插入图片的单元格列下标;默认为0
1070
+ * @param {Function} options.success 操作结束的回调函数
1071
+ */
1072
+ export function insertImage(src: string, options?: {
1073
+ order: number;
1074
+ rowIndex: number;
1075
+ colIndex: number;
1076
+ success: Function;
1077
+ }): void;
1078
+ /**
1079
+ * 删除指定工作表中的图片
1080
+ * @param {Object} options 可选参数
1081
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1082
+ * @param {String | Array} options.idList 要删除图片的id集合,也可为字符串`"all"`,all为所有的字符串;默认为`"all"`
1083
+ * @param {Function} options.success 操作结束的回调函数
1084
+ */
1085
+ export function deleteImage(options?: {
1086
+ order: number;
1087
+ idList: string | any[];
1088
+ success: Function;
1089
+ }): void;
1090
+ /**
1091
+ * 获取指定工作表的图片配置
1092
+ * @param {Object} options 可选参数
1093
+ * @param {Number} options.order 工作表下标;默认值为当前工作表下标
1094
+ * @param {Function} options.success 操作结束的回调函数
1095
+ */
1096
+ export function getImageOption(options?: {
1097
+ order: number;
1098
+ success: Function;
1099
+ }): any;
1100
+ /**
1101
+ * data => celldata ,data二维数组数据转化成 {r, c, v}格式一维数组
1102
+ *
1103
+ * @param {Array} data 二维数组数据
1104
+ * @param {Object} options 可选参数
1105
+ * @param {Function} options.success 操作结束的回调函数
1106
+ */
1107
+ export function transToCellData(data: any[], options?: {
1108
+ success: Function;
1109
+ }): {
1110
+ r: number;
1111
+ c: number;
1112
+ v: any;
1113
+ }[];
1114
+ /**
1115
+ * celldata => data ,celldata一维数组数据转化成表格所需二维数组
1116
+ *
1117
+ * @param {Array} celldata 二维数组数据
1118
+ * @param {Object} options 可选参数
1119
+ * @param {Function} options.success 操作结束的回调函数
1120
+ */
1121
+ export function transToData(celldata: any[], options?: {
1122
+ success: Function;
1123
+ }): any;
1124
+ /**
1125
+ * 导出的json字符串可以直接当作`luckysheet.create(options)`初始化工作簿时的参数`options`使用
1126
+ *
1127
+ */
1128
+ export function toJson(): any;
1129
+ /**
1130
+ * 传入目标语言,切换到对应的语言界面
1131
+ * @param {String} lang 可选参数;暂支持`"zh"`、`"en"`、`"es"`;默认为`"zh"`;
1132
+ */
1133
+ export function changLang(lang?: string): void;
1134
+ /**
1135
+ * 关闭websocket连接
1136
+ */
1137
+ export function closeWebsocket(): void;
1138
+ /**
1139
+ * 根据范围字符串转换为range数组
1140
+ * @param {String} txt 范围字符串
1141
+ */
1142
+ export function getRangeByTxt(txt: string): {
1143
+ column: any;
1144
+ row: any;
1145
+ };
1146
+ /**
1147
+ * 根据范围数组转换为范围字符串
1148
+ * @param {Object | Array} range 范围数组
1149
+ */
1150
+ export function getTxtByRange(range?: any | any[]): string;
1151
+ /**
1152
+ * 初始化分页器
1153
+ * @param {Object} config 分页器配置
1154
+ * @param {Number} config.pageIndex 当前的页码
1155
+ * @param {Number} config.pageSize 每页显示多少条数据
1156
+ * @param {Array} config.selectOption 选择每页的条数
1157
+ * @param {Number} config.total 总条数
1158
+ */
1159
+ export function pagerInit(config: {
1160
+ pageIndex: number;
1161
+ pageSize: number;
1162
+ selectOption: any[];
1163
+ total: number;
1164
+ }): void;
1165
+ /**
1166
+ * 刷新公式
1167
+ * @param {Function} success 回调函数
1168
+ */
1169
+ export function refreshFormula(success: Function): void;
1170
+ /**
1171
+ * 更新sheet数据
1172
+ * @param {Array} data 工作簿配置,可以包含多个表
1173
+ * @param {Object} options 可选参数
1174
+ * @param {Function} options.success 操作结束的回调函数
1175
+ *
1176
+ */
1177
+ export function updataSheet(options?: {
1178
+ success: Function;
1179
+ }): void;
1180
+ /**
1181
+ * 刷新状态栏的状态
1182
+ * @param {Array} data 操作数据
1183
+ * @param {Number} r 指定的行
1184
+ * @param {Number} c 指定的列
1185
+ * @param {Function} success 回调函数
1186
+ */
1187
+ export function refreshMenuButtonFocus(data: any[], r: number, c: number, success: Function): void;
1188
+ /**
1189
+ * 检查选区内所有cell指定类型的状态是否满足条件(主要是粗体、斜体、删除线和下划线等等)
1190
+ * @param {String} type 类型
1191
+ * @param {String} status 目标状态值
1192
+ */
1193
+ export function checkTheStatusOfTheSelectedCells(type: string, status: string): boolean;