createDesign(创建设计)

根据现有模板创建作品,该方法为 2.0 版本添加


创建作品的方式主要有3种

1.根据现有的模板创建

const editor = window.gaoding.createTemplateEditor({
    appId: '在稿定开放平台应用详情里查看',
});
editor.createDesign({
    // 模板ID
    templateId: 'xxxx',
    // 可同时带入模板中心页选中分类的id,编辑器左侧栏的模板列表将会同步为该分类下的模板
    // 同时传递分类ID的能力需要sdk版本2.2.4及以上
    categoryId: 'xxxx',
})

2.根据模板分类创建

const editor = window.gaoding.createTemplateEditor({
    appId: '在稿定开放平台应用详情里查看',
});
editor.createDesign({
    // 模板分类ID
    categoryId: 'xxxx',
})

3.自定义空白画布

const editor = window.gaoding.createTemplateEditor({
    appId: '在稿定开放平台应用详情里查看',
});
editor.createDesign({
    size: {
        width: 500,
        height: 300,
    }
})

参数

templateId

版本: 2.0+

类型: string | number

模板ID,可以基于该模板进行创建设计

categoryId

版本: 2.0+

类型: string | number

模板分类ID,控制当前作品的设计类型,具体分类信息查看 开放模板分类

size

版本: 2.0+

类型: {width: number; height: number;}

配置空白画布的尺寸。但有 templateId 该参数不生效

fileTypes

版本: 2.0+

类型: string[]

控制导出文件的格式类型。 目前支持的格式类型有 'jpg' | 'png' | 'gif' | 'video' | 'ppt' | 'pdf'

如果 fileTypes 传递的导出类型不符当前模板的导出格式时,将会显示该模板默认的导出格式类型选项。

比如 fileTypes 传递的是 gif 但是当前使用的是个图片模板。 那么导出类型还是只会展示 jpg png

editor.createDesign({
    fileTypes: ['png', 'ppt']
})

disableModules

版本: 2.0+

类型: string[]

该方法用于隐藏编辑器对应模块。目前支持的隐藏模块如下

模块名

说明

panel.template

左侧模板面板

panel.element

左侧元素面板

panel.text

左侧文字面板

panel.photo

左侧图片面板

panel.my-resource

左侧我的面板

panel.component

左侧组件面板

panel.chart

左侧图标面板

// 隐藏模板面板和我的面板
editor.createDesign({
    disableModules: ['panel.template', 'panel.my-resource']
})

okText

版本: 2.1+

类型: string

默认: '保存'

自定义编辑器右上角按钮的文案

返回结果

类型: Promise<false | { files: Blob[]; workId: string; title: string; type: string; }>

如果返回 false 标识用户关闭了编辑器的默认弹窗

files 为导出的文件数组。 workId 为作品ID, 开放者可以通过这个ID进行二次编辑

title 为该设计作品的标题。 type为导出文件的类型 有 png jpg ppt

注意项: 因为返回的是一个 Promise, 所以不管用户完成多少次, 返回的只有第一次导出的结果。 如果要持续对用户导出结果做出处理。请使用 editor.onSave 方法。