编辑器
表格编辑器类,提供了获取内容、设置内容、操作表格的方法。
构造函数
用法
const editor = new window.shimo.sdk.sheet.Editor({ editable: true, commentable: true, uploadConfig: { origin: file.config.uploadOrigin, server: shimo.uploadServer, token: shimo.uploadToken, }, localeConfig: { locale: 'zh-CN', }, spellCheck: true, user: shimo.user, });
参数options
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
options.editable | Boolean | 否 | true | 设置表格是否只读 |
options.commentable | Boolean | 否 | true | 是否允许单元格评论 |
options.spellCheck | Boolean | 否 | false | 是否开启拼写检查 |
options.disableRenderOptimization | Boolean | 否 | false | 是否禁用表格渲染优化 |
options.localeConfig | Object | 否 | 无 | 国际化相关配置,如果未传,默认使用中文(zh-CN) |
options.localeConfig.fetchLocaleSync | String | 否 | 无 | 获取翻译资源的方式 |
options.localeConfig.locale | String | 否 | 无 | 设置当前要使用的语言,eg: 'en-US' |
options.uploadConfig | Object | 是 | 无 | 上传图片配置 |
options.uploadConfig.origin | String | 是 | 无 | 上传服务的地址 |
options.uploadConfig.server | String | 是 | 无 | 存储服务类型, eg, 'oss', 'aws' |
options.uploadConfig.token | String | 是 | 无 | 上传服务鉴权秘钥 |
options.downloadConfig | Object | 是 | 无 | 下载图片配置 |
options.downloadConfig.origin | String | 是 | 无 | 下载服务的地址 |
options.user | Object | 是 | 无 | 当前登录用户 |
属性列表
名称 | 类型 | 描述 |
---|---|---|
isRendered | Boolean | 表格是否渲染成功 |
spread | Spread | 工作簿实例 |
方法列表
render
渲染表格。
- 返回
undefined
- 用法
render(options)
- 参数
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
options.content | string | 无 | 表格内容 |
options.container | HTMLElement | 无 | 表格渲染容器 |
options.activeSheetId | string | 无 | 需激活的工作表 ID |
getContent
获取表格内容。
- 返回
Promise<string>
- 用法
editor.getContent().then(function(content) {
console.log(content);
});
destroy
销毁表格编辑器实例。
- 返回
undefined
- 用法
destroy()
- 参数
undo
撤销上一步操作。
- 返回
Promise<undefined>
- 用法
editor.undo().then(function() {
console.log("undo successed!");
});
- 参数
redo
重新应用上一步操作。
- 返回
Promise<undefined>
- 用法
editor.redo().then(function() {
console.log("redo successed!");
});
- 参数
getLocale
获取当前语言。
- 返回
string
- 用法
const currentLocale = editor.getLocale(); // eg: en-US、zh-CN、ja-JP
- 参数
updateOptions
修改表格是否可编辑,是否可评论
- 返回
undefined
- 用法
editor.updateOptions({ editable: false, commentable: false }); // 将表格变为不能编辑,不能评论
- 参数
名称 类型 默认值 描述 editable
Boolean
无 设置表格是否可编辑 commentable
Boolean
无 设置表格是否可评论