Browse Source

feat(api add): getRowHeight getColumnWidth getDefaultRowHeight getDefaultColumnWidth

master
wpxp123456 5 years ago
parent
commit
a72f38b641
  1. 26
      docs/zh/guide/api.md
  2. 130
      src/global/api.js

26
docs/zh/guide/api.md

@ -588,11 +588,9 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
### getRowHeight(rowInfo [,setting])
(TODO)
- **参数**
- {Array} [rowInfo]: 行数
- {Array} [rowInfo]: 行号下标组成的组;行号下标从0开始;
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
@ -600,7 +598,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
- **说明**
获取指定行的高度,得到行数和高度对应关系的对象
获取指定工作表指定行的高度,得到行号和高度对应关系的对象(第一行行号为0)
- **示例**:
@ -614,11 +612,9 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
### getColumnWidth(columnInfo [,setting])
(TODO)
- **参数**
- {Array} [columnInfo]: 列数
- {Array} [columnInfo]: 列号下标组成的组;列号下标从0开始;
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
@ -626,7 +622,7 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
- **说明**
获取指定列的宽度,得到列数和宽度对应关系的对象
获取指定工作表指定列的宽度,得到列号和宽度对应关系的对象(第一列列号为0)
- **示例**:
@ -640,21 +636,18 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
### getDefaultRowHeight([,setting])
(TODO)
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
+ {Function} [success]: 操作结束的回调函数
- **说明**
获取指定工作表的默认行高
获取工作表的默认行高
- **示例**:
- 返回当前工作表的默认行高
- 返回工作表的默认行高
`luckysheet.getDefaultRowHeight()`
返回得到
@ -664,21 +657,18 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
### getDefaultColumnWidth([,setting])
(TODO)
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
+ {Function} [success]: 操作结束的回调函数
- **说明**
获取指定工作表的默认列宽
获取工作表的默认列宽
- **示例**:
- 返回当前工作表的默认列宽
- 返回工作表的默认列宽
`luckysheet.getDefaultColumnWidth()`
返回得到

130
src/global/api.js

@ -1285,6 +1285,136 @@ export function setColumnWidth(columnInfo, options = {}) {
}
/**
* 获取指定工作表指定行的高度得到行号和高度对应关系的对象
* @param {Array} rowInfo 行号下标组成的数组行号下标从0开始
* @param {Object} options 可选参数
* @param {Number} options.order 工作表索引默认值为当前工作表索引
* @param {Function} options.success 操作结束的回调函数
*/
export function getRowHeight(rowInfo, options = {}) {
if(getObjType(rowInfo) != 'array' || rowInfo.length == 0){
return tooltip.info("The rowInfo parameter is invalid.", "");
}
let {
order = getSheetIndex(Store.currentSheetIndex),
success
} = {...options}
let file = Store.luckysheetfile[order];
if(file == null){
return tooltip.info("The order parameter is invalid.", "");
}
let cfg = $.extend(true, {}, file.config);
let rowlen = cfg["rowlen"] || {};
let rowlenObj = {};
rowInfo.forEach((item) => {
if(parseInt(item) >= 0){
let size = rowlen[parseInt(item)] || Store.defaultrowlen;
rowlenObj[parseInt(item)] = size;
}
})
setTimeout(() => {
if (success && typeof success === 'function') {
success()
}
}, 1)
return rowlenObj;
}
/**
* 获取指定工作表指定列的宽度得到列号和宽度对应关系的对象
* @param {Array} columnInfo 行号下标组成的数组行号下标从0开始
* @param {Object} options 可选参数
* @param {Number} options.order 工作表索引默认值为当前工作表索引
* @param {Function} options.success 操作结束的回调函数
*/
export function getColumnWidth(columnInfo, options = {}) {
if(getObjType(columnInfo) != 'array' || columnInfo.length == 0){
return tooltip.info("The columnInfo parameter is invalid.", "");
}
let {
order = getSheetIndex(Store.currentSheetIndex),
success
} = {...options}
let file = Store.luckysheetfile[order];
if(file == null){
return tooltip.info("The order parameter is invalid.", "");
}
let cfg = $.extend(true, {}, file.config);
let columnlen = cfg["columnlen"] || {};
let columnlenObj = {};
columnInfo.forEach((item) => {
if(parseInt(item) >= 0){
let size = columnlen[parseInt(item)] || Store.defaultcollen;
columnlenObj[parseInt(item)] = size;
}
})
setTimeout(() => {
if (success && typeof success === 'function') {
success()
}
}, 1)
return columnlenObj;
}
/**
* 获取工作表的默认行高
* @param {Object} options 可选参数
* @param {Function} options.success 操作结束的回调函数
*/
export function getDefaultRowHeight(options = {}) {
let {
success
} = {...options}
setTimeout(() => {
if (success && typeof success === 'function') {
success()
}
}, 1)
return Store.defaultrowlen;
}
/**
* 获取工作表的默认列宽
* @param {Object} options 可选参数
* @param {Function} options.success 操作结束的回调函数
*/
export function getDefaultColumnWidth(options = {}) {
let {
success
} = {...options}
setTimeout(() => {
if (success && typeof success === 'function') {
success()
}
}, 1)
return Store.defaultcollen;
}
/**
* 返回当前选区对象的数组可能存在多个选区
* 每个选区的格式为row/column信息组成的对象{row:[0,1],column:[0,1]}

Loading…
Cancel
Save