Skip to content
On this page

sdk使用指南

使用方式

  1. 引入sdk
js
<script src="http://cdn.turntip.vip/sdk/flowmix-doc.umd.js"></script>
  1. 在项目中使用
js
const sdk = new FlowmixDocx({
      hold: '#root',
      toolBars: ["aiText"]
  })

一个完整的案例:

html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
    <script src="http://cdn.turntip.vip/sdk/flowmix-doc.umd.js"></script>
</head>
<body>
    <div id="root" style="height:100vh"></div>
    <script>
        const sdk = new FlowmixDocx({
            hold: '#root',
            toolBars: ["aiText"]
        })
    </script>
</body>
</html>

demo案例展示

API文档

属性说明类型可选值默认值
hold挂载的元素string--
toolBars配置隐藏工具栏展示的工具项string[]--
theme编辑器默认主题'light' | 'dark'-light
outline是否展示文档大纲,默认展示boolean-true
token配置请求的 token 参数string--
baseurl配置请求的基础url路径string--
getDocApi文档数据获取接口,GETstring--
saveDocApi文档数据保存/更新接口,PUTstring--
uploadApi文件/资源上传接口,POSTstring--
ai2TextApiai 文生文接口string--
getBoardApi获取在线白板数据接口string--
saveBoardApi在线白板数据保存接口string--
parseDocApidoc 解析接口string--
ocrApi图片 ocr 识别接口string--
sdkPathsdk 地址,默认不对外暴露string--

当然整套设计机制包括文档数据流转模式都在源码中体现, 私有化后会统一提供技术培训服务.

专注 | 高效 | 深耕可视化场景