Browse Source

Merge pull request #469 from flowerField/master

add api getWorkbookName
master
文顶顶 5 years ago
committed by GitHub
parent
commit
3b1edf9d75
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 15
      docs/guide/api.md
  2. 13
      docs/zh/guide/api.md
  3. 33
      src/global/api.js

15
docs/guide/api.md

@ -2512,8 +2512,6 @@ Use note:
### setWorkbookName(name [,setting]) ### setWorkbookName(name [,setting])
[todo]
- **Parameter** - **Parameter**
- {Number} [name]: Workbook name - {Number} [name]: Workbook name
@ -2526,6 +2524,19 @@ Use note:
------------ ------------
### getWorkbookName(name [,setting])
- **Parameter**
- {PlainObject} [setting]: optional parameters
+ {Function} [success]: callback function for the end of the operation
- **Explanation**
get workbook name
------------
### undo([setting]) ### undo([setting])
[todo] [todo]

13
docs/zh/guide/api.md

@ -2448,6 +2448,19 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开
------------ ------------
### getWorkbookName([,setting])
- **参数**
- {PlainObject} [setting]: 可选参数
+ {Function} [success]: 操作结束的回调函数
- **说明**
获取工作簿名称
------------
### undo([setting]) ### undo([setting])
- **参数** - **参数**

33
src/global/api.js

@ -5630,6 +5630,39 @@ export function setWorkbookName(name, options = {}) {
} }
} }
/**
* 获取工作簿名称
* @param {Object} options 可选参数
* @param {Function} options.success 操作结束的回调函数
* @returns {String} 返回工作簿名称如果读取失败则返回空字符串并弹窗提示
*/
export function getWorkbookName(options = {}) {
let name = "";
let element = $("#luckysheet_info_detail_input");
if(element.length == 0){
tooltip.info('Failed to get workbook name, label loading failed!');
return name;
}
name = $.trim(element.val());
let {
success
} = {...options}
setTimeout(() => {
if (success && typeof success === 'function') {
success()
}
}, 1)
return name;
}
/** /**
* 撤销当前操作返回刚刚撤销的操作对象 * 撤销当前操作返回刚刚撤销的操作对象

Loading…
Cancel
Save