# MasterGo 开发者平台

> AI 可读知识库索引 — 面向 LLM 爬虫优化的内容导航

### 指南 (guide)

- [简介](/guide/intro) — 插件继承了 `MasterGo` 的能力。与 `MasterGo` 是基于 `Web` 一样，`MasterGo` 的插件也是基于 `Web` 技术的。因此，想要开发 `MasterGo` 插件需要你至少了解以下技术：
- [开发指南](/guide/setup) — 在 简介/guide/intro 中，我们详细地介绍了插件的运行机制。在本节中，我们将带你从零开始构建一个可运行的插件。我们将要创建的插件能够接收用户输入的数字，并创建指定数量的椭圆图层。本节将涉及以下知识点：
- [教程](/guide/tutorials) — 在本教程中，我们将为你介绍 MasterGo 的主要 API 的使用，以及惯用法。更完整的 API 列表可以查看 API Reference/apis/。

### API 参考 (apis)

- [BooleanOperationNode](/apis/booleanOperationNode) — BooleanOperationNode
- [mg.clientStorage](/apis/clientStorage) — mg.clientStorage
- [mg.codegen](/apis/codegen) — 注意：该对象仅在`研发模式`下可使用
- [ComponentNode](/apis/componentNode) — ComponentNode
- [ComponentSetNode](/apis/componentSetNode) — ComponentSetNode
- [ConnectorNode](/apis/connectorNode) — ConnectorNode
- [DocumentNode](/apis/documentNode) — DocumentNode
- [EllipseNode](/apis/ellipseNode) — EllipseNode
- [FrameNode](/apis/frameNode) — `FrameNode` 即容器节点，用于定义布局的层级结构。容器节点（`FrameNode`）不同于组节点（`GroupNode`），容器节点更类似于图层的”目录“或”文件夹“。另外，容器通常拥有其自身的尺寸，尽管在自动布局的容器中该尺寸由
- [GroupNode](/apis/groupNode) — `GroupNode` 代表一个或者多个图层的编组, 当改变`GroupNode`的圆角、描边、填充等属性时，会作用在编组内所有的图层身上。
- [API Reference](/apis/) — API Reference
- [InstanceNode](/apis/instanceNode) — InstanceNode
- [IntelligentContainerNode](/apis/intelligentContainerNode) — IntelligentContainerNode
- [LineNode](/apis/lineNode) — `LineNode` 相当于一个一维的对象，给它一个描边使该对象可见。`LineNode` 的两个主要属性是它的长度和旋转的角度，在 API 层面分别用 `width` 和 `rotation` 来描述直线的长度和角度。直线的高度 `hei
- [mg](/apis/mastergo) — 下面给出的属性和方法可以通过全局对象 `mg` 来访问。
- [Node Types](/apis/nodeTypes) — 在 教程-节点类型/guide/tutorials.html%E8%8A%82%E7%82%B9%E7%B1%BB%E5%9E%8B 中曾介绍过，MasterGo 文件是由节点树构成的。每个节点都与特定的图层对应，用来描述图层信息。不同类型
- [mg.notify](/apis/notify) — notifymessage: string, options?: NotifyOptions: NotificationHandler
- [PageNode](/apis/pageNode) — `PageNode` 代表页面节点，即 `DocumentNode` 的直接子节点。可以通过 `mg.document.currentPage` 获取当前页面节点。
- [PenNode](/apis/penNode) — `PenNode` 是最通用的用于表示图形的节点，允许你指定单独的顶点，线段和区域。`PenNode` 由设计工具中的钢笔工具、铅笔工具创建。与组节点（`GroupNode`）类似，`PenNode` 的位置和大小会自动适应它的顶点来决定。
- [PolygonNode](/apis/polygonNode) — PolygonNode
- [RectangleNode](/apis/rectangleNode) — RectangleNode
- [SectionNode](/apis/sectionNode) — SectionNode
- [SliceNode](/apis/sliceNode) — `SliceNode` 代表切图图层节点。
- [StarNode](/apis/starNode) — `StarNode` 代表星型图层节点。
- [TextNode](/apis/textNode) — Loading fonts
- [TextSublayerNode](/apis/textSublayerNode) — TextSublayerNode
- [mg.ui](/apis/ui) — `mg.ui` 对象包含了用来操作用户界面并与用户界面进行信息交流的接口。
- [mg.variables](/apis/variables) — mg.variables
- [mg.viewport](/apis/viewport) — mg.viewport
- [mg.WebSocket](/apis/websocket) — mg.WebSocket

### TypeScript 类型 (types)

- [Action](/types/action) — interface Action {
- [ArcData](/types/arcData) — interface ArcData {
- [BlendMode](/types/blend) — type BlendMode =
- [ChildrenMixin](/types/childrenMixin) — ChildrenMixin
- [ComponentPropertiesRelated](/types/componentPropertiesRelated) — ComponentPropertiesRelated
- [ConnectorEndpoint](/types/connectorEndpoint) — ConnectorEndpoint
- [Constraints](/types/constraints) — Constraints
- [DropEvent](/types/dropEvent) — 主线程`drop`事件回调参数
- [Easing](/types/easing) — Easing对象用于描述过渡效果。
- [Effect](/types/effect) — type Effect = ShadowEffect | BlurEffect | LiquidGlassEffect | MotionBlurEffect | ReferenceEffect;
- [ExportSettings](/types/exportSettings) — ExportSettings
- [FlowStartingPoint](/types/flowStartingPoint) — FlowStartingPoint
- [Font](/types/font) — interface Font {
- [Hyperlink](/types/hyperlink) — interface Hyperlink {
- [Image](/types/image) — interface Image {
- [TypeScript Types](/types/) — TypeScript Types
- [LayoutGrid](/types/layoutGrid) — type LayoutGrid = RowsColsLayoutGrid | GridLayoutGrid
- [OverflowDirection](/types/overflowDirection) — OverflowDirection
- [Paint](/types/paint) — type Paint = SolidPaint | GradientPaint | ImagePaint | ReferencePaint
- [Pen](/types/penNetwork) — interface PenNetwork {
- [PenPaths](/types/penPaths) — interface PenPaths {
- [Reaction](/types/reaction) — 用于描述原型交互的相关信息
- [Rect](/types/rect) — interface Rect {
- [RGB](/types/rgb) — interface RGB {
- [SceneNode](/types/sceneNode) — type SceneNode =
- [Style](/types/style) — type Style = PaintStyle | EffectStyle | TextStyle | GridStyle | StrokeWidthStyle | PaddingStyle | SpacingStyle | CornerR
- [TeamLibrary](/types/teamLibrary) — TeamLibrary
- [TextListStyle](/types/textListStyle) — TextListStyle
- [TextSegStyle](/types/textSegStyle) — TextSegStyle
- [Transform](/types/transform) — type Transform = number, number, number, number, number, number
- [Transition](/types/transition) — interface Transition {
- [Trigger](/types/trigger) — Trigger类型表示触发行为，delay表示触发的延时，单位为毫秒，在type不为`AFTER_DELAY`是，dalay为0。
- [UIViewport](/types/uiviewport) — interface UIViewport {
- [User](/types/user) — interface User {

### 插件类型声明 (plugin-typings)

- [Plugin Typings](/plugin-typings/) — Plugin Typings
- [Usages](/plugin-typings/usages) — yarn add @mastergo/plugin-typings

### REST API (rest-api)

- [MasterGo OpenAPI](/rest-api/) — MasterGo OpenAPI

### 研发模式 · 指南 (devmode/guide)

- [开发指南](/devmode/guide/guide) — 在开始之前，你需要对插件的开发有一定的了解，如果还没有，请移步这里/guide/intro。
- [研发模式（DevMode）](/devmode/guide/) — 研发模式（DevMode）

### 研发模式 · 类型 (devmode/types)

- [DSLSettings](/devmode/types/dslsettings) — DSLSettings
- [简介](/devmode/types/) — `DSL`的全称是设计系统语言`Design System Language`, 在MasterGo 中是能表达设计图的代码，通过代码我们能还原出设计图，也就是 `Design To Code, Code To Design`, 详情请见代
- [MGDSLData](/devmode/types/mgdsldata) — interface MGDSLData {
- [MGDSLFile](/devmode/types/mgdslfile) — 虚拟文件，每个组件或者页面是一个`MGDSLFile`，可能包含多个代码文件，例如
- [MGNode](/devmode/types/mgnode) — type MGNode = MGLayerNode | MGOperationNode
- [NodeLayout](/devmode/types/nodelayout) — interface NodeLayout {
- [NodeStyle](/devmode/types/nodestyle) — interface NodeStyle {
- [Token](/devmode/types/token) — `Token`是由画布内自定义样式转化而来的一种以变量的形式存在的标识。

### 研发模式 · 组件模板 (devmode/component-template)

- [Component Prop](/devmode/component-template/component-prop) — Component Prop
- [ComponentTemplate](/devmode/component-template/component-template) — ComponentTemplate
- [Component](/devmode/component-template/component) — type ComponentItem = ComponentOrigin & { id: string; matchName?: string; }
- [开发指南](/devmode/component-template/guide) — 在开始之前，你需要对插件的开发有一定的了解，如果还没有，请移步这里/guide/intro。
- [Icon](/devmode/component-template/icon) — type Icons = {
- [研发模式 · 组件模板](/devmode/component-template/) — 配置模型是一种将已有的代码组件库和设计组件库进行关联的一种方式，他在generate阶段之前运行，根据组件的id进行关联，通过配置（如给出配置方式可以完成完成转换）和解析（如为展示型组件，如表格，列表等，无法通过配置完成映射，可以通过解析方
- [Slot](/devmode/component-template/slot) — ComponentSlot

---

## URL 映射

| 页面标题 | 完整 URL |
|---------|---------|
| 简介 | https://developers.mastergo.com/guide/intro |
| 开发指南 | https://developers.mastergo.com/guide/setup |
| 教程 | https://developers.mastergo.com/guide/tutorials |
| BooleanOperationNode | https://developers.mastergo.com/apis/booleanOperationNode |
| mg.clientStorage | https://developers.mastergo.com/apis/clientStorage |
| mg.codegen | https://developers.mastergo.com/apis/codegen |
| ComponentNode | https://developers.mastergo.com/apis/componentNode |
| ComponentSetNode | https://developers.mastergo.com/apis/componentSetNode |
| ConnectorNode | https://developers.mastergo.com/apis/connectorNode |
| DocumentNode | https://developers.mastergo.com/apis/documentNode |
| EllipseNode | https://developers.mastergo.com/apis/ellipseNode |
| FrameNode | https://developers.mastergo.com/apis/frameNode |
| GroupNode | https://developers.mastergo.com/apis/groupNode |
| API Reference | https://developers.mastergo.com/apis/ |
| InstanceNode | https://developers.mastergo.com/apis/instanceNode |
| IntelligentContainerNode | https://developers.mastergo.com/apis/intelligentContainerNode |
| LineNode | https://developers.mastergo.com/apis/lineNode |
| mg | https://developers.mastergo.com/apis/mastergo |
| Node Types | https://developers.mastergo.com/apis/nodeTypes |
| mg.notify | https://developers.mastergo.com/apis/notify |
| PageNode | https://developers.mastergo.com/apis/pageNode |
| PenNode | https://developers.mastergo.com/apis/penNode |
| PolygonNode | https://developers.mastergo.com/apis/polygonNode |
| RectangleNode | https://developers.mastergo.com/apis/rectangleNode |
| SectionNode | https://developers.mastergo.com/apis/sectionNode |
| SliceNode | https://developers.mastergo.com/apis/sliceNode |
| StarNode | https://developers.mastergo.com/apis/starNode |
| TextNode | https://developers.mastergo.com/apis/textNode |
| TextSublayerNode | https://developers.mastergo.com/apis/textSublayerNode |
| mg.ui | https://developers.mastergo.com/apis/ui |
| mg.variables | https://developers.mastergo.com/apis/variables |
| mg.viewport | https://developers.mastergo.com/apis/viewport |
| mg.WebSocket | https://developers.mastergo.com/apis/websocket |
| Action | https://developers.mastergo.com/types/action |
| ArcData | https://developers.mastergo.com/types/arcData |
| BlendMode | https://developers.mastergo.com/types/blend |
| ChildrenMixin | https://developers.mastergo.com/types/childrenMixin |
| ComponentPropertiesRelated | https://developers.mastergo.com/types/componentPropertiesRelated |
| ConnectorEndpoint | https://developers.mastergo.com/types/connectorEndpoint |
| Constraints | https://developers.mastergo.com/types/constraints |
| DropEvent | https://developers.mastergo.com/types/dropEvent |
| Easing | https://developers.mastergo.com/types/easing |
| Effect | https://developers.mastergo.com/types/effect |
| ExportSettings | https://developers.mastergo.com/types/exportSettings |
| FlowStartingPoint | https://developers.mastergo.com/types/flowStartingPoint |
| Font | https://developers.mastergo.com/types/font |
| Hyperlink | https://developers.mastergo.com/types/hyperlink |
| Image | https://developers.mastergo.com/types/image |
| TypeScript Types | https://developers.mastergo.com/types/ |
| LayoutGrid | https://developers.mastergo.com/types/layoutGrid |
| OverflowDirection | https://developers.mastergo.com/types/overflowDirection |
| Paint | https://developers.mastergo.com/types/paint |
| Pen | https://developers.mastergo.com/types/penNetwork |
| PenPaths | https://developers.mastergo.com/types/penPaths |
| Reaction | https://developers.mastergo.com/types/reaction |
| Rect | https://developers.mastergo.com/types/rect |
| RGB | https://developers.mastergo.com/types/rgb |
| SceneNode | https://developers.mastergo.com/types/sceneNode |
| Style | https://developers.mastergo.com/types/style |
| TeamLibrary | https://developers.mastergo.com/types/teamLibrary |
| TextListStyle | https://developers.mastergo.com/types/textListStyle |
| TextSegStyle | https://developers.mastergo.com/types/textSegStyle |
| Transform | https://developers.mastergo.com/types/transform |
| Transition | https://developers.mastergo.com/types/transition |
| Trigger | https://developers.mastergo.com/types/trigger |
| UIViewport | https://developers.mastergo.com/types/uiviewport |
| User | https://developers.mastergo.com/types/user |
| Plugin Typings | https://developers.mastergo.com/plugin-typings/ |
| Usages | https://developers.mastergo.com/plugin-typings/usages |
| MasterGo OpenAPI | https://developers.mastergo.com/rest-api/ |
| 开发指南 | https://developers.mastergo.com/devmode/guide/guide |
| 研发模式（DevMode） | https://developers.mastergo.com/devmode/guide/ |
| DSLSettings | https://developers.mastergo.com/devmode/types/dslsettings |
| 简介 | https://developers.mastergo.com/devmode/types/ |
| MGDSLData | https://developers.mastergo.com/devmode/types/mgdsldata |
| MGDSLFile | https://developers.mastergo.com/devmode/types/mgdslfile |
| MGNode | https://developers.mastergo.com/devmode/types/mgnode |
| NodeLayout | https://developers.mastergo.com/devmode/types/nodelayout |
| NodeStyle | https://developers.mastergo.com/devmode/types/nodestyle |
| Token | https://developers.mastergo.com/devmode/types/token |
| Component Prop | https://developers.mastergo.com/devmode/component-template/component-prop |
| ComponentTemplate | https://developers.mastergo.com/devmode/component-template/component-template |
| Component | https://developers.mastergo.com/devmode/component-template/component |
| 开发指南 | https://developers.mastergo.com/devmode/component-template/guide |
| Icon | https://developers.mastergo.com/devmode/component-template/icon |
| 研发模式 · 组件模板 | https://developers.mastergo.com/devmode/component-template/ |
| Slot | https://developers.mastergo.com/devmode/component-template/slot |

---

共 87 篇文档