Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

Commit

Permalink
feat(api add): getRowHeight getColumnWidth getDefaultRowHeight getDef…
Browse files Browse the repository at this point in the history
…aultColumnWidth
  • Loading branch information
wpxp123456 committed Oct 22, 2020
1 parent d4cea27 commit a72f38b
Show file tree
Hide file tree
Showing 2 changed files with 138 additions and 18 deletions.
26 changes: 8 additions & 18 deletions docs/zh/guide/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,19 +588,17 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开

### getRowHeight(rowInfo [,setting])

(TODO)

- **参数**

- {Array} [rowInfo]: 行数
- {Array} [rowInfo]: 行号下标组成的数组;行号下标从0开始;

- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
+ {Function} [success]: 操作结束的回调函数

- **说明**

获取指定行的高度,得到行数和高度对应关系的对象
获取指定工作表指定行的高度,得到行号和高度对应关系的对象(第一行行号为0)

- **示例**:

Expand All @@ -614,19 +612,17 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开

### getColumnWidth(columnInfo [,setting])

(TODO)

- **参数**

- {Array} [columnInfo]: 列数
- {Array} [columnInfo]: 列号下标组成的数组;列号下标从0开始;

- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
+ {Function} [success]: 操作结束的回调函数

- **说明**

获取指定列的宽度,得到列数和宽度对应关系的对象
获取指定工作表指定列的宽度,得到列号和宽度对应关系的对象(第一列列号为0)

- **示例**:

Expand All @@ -640,21 +636,18 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开

### getDefaultRowHeight([,setting])

(TODO)

- **参数**

- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
+ {Function} [success]: 操作结束的回调函数

- **说明**

获取指定工作表的默认行高
获取工作表的默认行高

- **示例**:

- 返回当前工作表的默认行高
- 返回工作表的默认行高

`luckysheet.getDefaultRowHeight()`
返回得到
Expand All @@ -664,21 +657,18 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开

### getDefaultColumnWidth([,setting])

(TODO)

- **参数**

- {PlainObject} [setting]: 可选参数
+ {Number} [order]: 工作表下标;默认值为当前工作表下标
+ {Function} [success]: 操作结束的回调函数

- **说明**

获取指定工作表的默认列宽
获取工作表的默认列宽

- **示例**:

- 返回当前工作表的默认列宽
- 返回工作表的默认列宽

`luckysheet.getDefaultColumnWidth()`
返回得到
Expand Down
130 changes: 130 additions & 0 deletions src/global/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -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]}
Expand Down

0 comments on commit a72f38b

Please sign in to comment.