diff --git a/docs/guide/api.md b/docs/guide/api.md index f9ea705..434c4d1 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -2512,8 +2512,6 @@ Use note: ### setWorkbookName(name [,setting]) -[todo] - - **Parameter**: - {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]) [todo] diff --git a/docs/zh/guide/api.md b/docs/zh/guide/api.md index fb9493d..f4e4c01 100644 --- a/docs/zh/guide/api.md +++ b/docs/zh/guide/api.md @@ -2448,6 +2448,19 @@ Luckysheet针对常用的数据操作需求,开放了主要功能的API,开 ------------ +### getWorkbookName([,setting]) + +- **参数**: + + - {PlainObject} [setting]: 可选参数 + + {Function} [success]: 操作结束的回调函数 + +- **说明**: + + 获取工作簿名称 + +------------ + ### undo([setting]) - **参数**: diff --git a/src/global/api.js b/src/global/api.js index 321d1af..566c003 100644 --- a/src/global/api.js +++ b/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; +} + /** * 撤销当前操作,返回刚刚撤销的操作对象