插件 / 文档介绍 / 介绍

介绍

欢迎使用摹客DT插件 API。
插件是社区创建的应用程序,用于扩展摹客DT的功能。插件可以在摹客DT的文件中执行一项或多项用户操作,得益于插件,用户可以自定义操作体验或者创建更高效的工作方式。

1. 文件结构

摹客DT中的每个文件都由节点树组成,节点树的根部都是一个DocumentNode,每个 DocumentNode都会存在一个或者多个Page来对应文件中的页面,所以DocumentNode是我们访问和浏览文件内容的唯一方式。


2. 插件API

插件API支持读取写入功能,允许开发人员查看、创建和修改摹客DT的文件内容。在摹客DT中,可以通过摹客DT的全局对象来访问大部分插件 API 。插件能解析摹客DT文件的全部内容,包含图层面板上所有图层及与图层相关的所有属性,如颜色、坐标、内容等,但插件 API 不允许你访问项目之外的文件内容,如:
  • 来自其他团队的资源库;
    来自URL访问的外部字体或网络字体;
    来自其他文件的元数据。


3. 核心API

围绕一组固定的受控端点,我们构建了插件 API,通过插件 API 能提供额外的功能,包括手动或自动执行一系列功能或事件的辅助功能。在整个过程中,我们保留了核心插件 API,不仅可以降低了错误代码混入API 的风险,还可以帮助开发人员更好地维护插件。

4. 基于浏览器

摹客DT是一款基于浏览器的软件,所以你可以在任意操作系统(MacOS、Windows、Linux 等)上运行。摹客DT的插件也是由Web提供的技术支持,运行<iframe>意味着你可以访问浏览器 API,包括发出网络请求、打开文件以及使用<canvas>WebGLWebAssembly等功能。