插件 / API文档 / PluginAPI:插件扩展API

PluginAPI:插件扩展API

以下是针对全局对象 mockplus 可以用的方法和属性。


apiVersion'1.0.0'  [readonly] 
运行此插件的DT API 版本。


editorType 'DT'  [readonly] 
编辑器类型。


colorSpaceColorSpace  
颜色空间。


currentPagePage
当前编辑页面。


rootDocumentNode [readonly] 
整个DT项目的根节点(文档节点)。该节点内包含其它节点, 例如:  页面节点、图层节点、资源、以及一些通用操作。


uiUIAPI [readonly] 
插件界面 API接口,此属性包含创建和修改插件UI的方法。


currentUserUser [readonly]
当前用户,此属性包含有关当前用户的详细信息。


clientStorageClientStorageAPI [readonly] 
客户端缓存,此属性包含在用户本地计算机上存储数据的方法。

librariesReadonlyArray<Library> [readonly] 
资源库。




findLayerById(id: string): Layer | null
通过图层ID查询图层。


findPageById(id: string): Page | null
通过页面ID查询页面。


showUI(html: string, options?: ShowUIOptions): void
显示UI面板。


notify(message: string, options?: { timeout: number, error: boolean }): void
显示界面通知信息。


closePlugin(message?: string): void
关闭插件。



on(type: EventType, callback: (event?: any) => void): void
监听事件。


once(type: EventType, callback: (event?: any) => void): void
监听事件。


off(type: EventType, callback: (event?: any) => void): void
监听事件。



createPage(): Page
创建页面。


createSymbolPage(): Page
创建组件页面。


createRectangle(): Path
创建矩形。


createTriangle(): Path
创建三角形。


createEllipse(): Path
创建圆形。


createPolygon(): Path
创建多边形。


createStar(): Path
创建星形。


createLine(): Path
创建线条。


createText(): Text
创建文本。


createSlice(): Slice
创建切片。


createHotspot(): Hotspot
创建热区。


createArtboard(): Artboard
创建画板。


createImage(): Image
创建图片。



createSymbolMaster(layers: Layer[], parent?: Page): SymbolMaster | undefined
创建组件。


createSymbolInstance(master: SymbolMaster | SharedSymbolStyle): SymbolInstance | undefined
创建组件实例。



group(layers: Layer[], parent?: Group | Frame | Page, index?: number): Group | null
编组图层。


flatten(layers: ShapeGroup[]): (ShapeGroup | Path)[] | null
扁平化图层。


outline(layers: (ShapeGroup | Path)[]): (ShapeGroup | Path)[] | null
轮廓化图层。




union(layers: (ShapeGroup | Path)[], parent?: Group | Frame | Page, index?: number): ShapeGroup | null
创建合并复合路径。



exclude(layers:  (ShapeGroup | Path)[], parent?: Group | Frame | Page, index?: number): ShapeGroup | null
创建排除复合路径。



intersect(layers:  (ShapeGroup | Path)[], parent?: Group | Frame | Page, index?: number): ShapeGroup | null
创建相交复合路径。



subtract(layers:  (ShapeGroup | Path)[], parent?: Group | Frame | Page, index?: number): ShapeGroup | null
创建减去复合路径。



commitUndo(): void
提交操作。


triggerUndo(): void
撤销操作。


triggerRedo(): void
重做操作。



createNodeFromSvg(svg: string): Promise<Layer[]>
通过SVG创建图层。


getSVGString(layer: Layer): string
获取图层SVG信息。




createImageData(data: Uint8Array): Promise<ImageData>
创建ImageData信息。


getImageDataByHash(hash: string): ImageData
通过hash获取ImageData信息。




loadFontAsync(postscript: string): Promise<void>
加载字体。


listAvailableFonts(): FontFamily[]
加载可用字体列表。




createColorStyle(color: Color): SharedColorStyle | null
创建颜色资源。


createTextStyle(layer: Text): SharedTextStyle | null
创建文本资源。


createLayerStyle(layer: Path | ShapeGroup | Image): SharedLayerStyle | null
创建图层资源。


findResourceById(resourceID: string): SharedColorStyle | SharedLayerStyle | SharedTextStyle | SharedSymbolStyle | null
通过ID查询资源。