通用布局
实现通用布局的插件。
构造函数
用法
var editor = new window.shimo.sdk.slide.Editor(options) var layouts = new window.shimo.sdk.slide.plugins.Layouts({ editor }) layouts.render(document.getElementById('#layouts'), { editable: true })
参数
名称 | 类型 | 描述 |
---|---|---|
options.editor | Editor | 编辑器实例 |
析构函数
用法
layouts.destroy()
方法列表
render
渲染通用布局插件。
- 返回
Promise
- 用法
render(container, options)
- 参数
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
container | HTMLElement | 必选 | 布局渲染容器 |
options.editable | boolean | 必选 | 是否可编辑 |
options.public | boolean | 必选 | 是否公开 |
options.withPlayButton | boolean | false | 是否在 toolbar 显示播放 button |
options.uploader | UploaderConfig | 必选 | 上传插件的配置 |
options.uploader.container | Element / string | 必选 | 拖拽容器 |
options.uploader.url | string | 必选 | 上传URL |
options.uploader.tokenUrl | string | 可选 | 获取token的URL |
options.uploader.accessToken | string | 可选 | token |
options.uploader.type | 'default' / 'qiniu' | 可选 | 默认为'default' |
options.uploader.paramName | string | 可选 | 上传文件参数名,默认为'file' |
options.uploader.params | Object | 可选 | 上传文件时,接口需要的额外参数 |
ready
插件渲染完毕的Promise。
- 返回
Promise
- 用法
ready().then()
使用
需要注意该插件与其他插件的使用顺序。正确的顺序为:
- 初始化编辑器
- editor = new window.shimo.sdk.slide.Editor
- 初始化幻灯片通用布局插件
- layouts = new window.shimo.sdk.slide.plugins.Layouts
- 初始化并启用协作者通用模块
- collaboration = new window.shimo.sdk.common.Collaboration
- collaboration.start()
- 渲染编辑器及通用布局插件: layouts.render
- 初始化播放器和协作者标记插件:协作者标记插件会更改 editor,使 editor 具备与协作者标记插件互动的功能。
- layouts.render().then(() => { new window.shimo.sdk.slide.plugins.Player({ editor }) new window.shimo.sdk.slide.plugins.Collaborators })