Pixso 开放文档
插件 API
官方工具集
  • 中文
  • English
插件 API
官方工具集
  • 中文
  • English
  • 插件 API

    • 简介
    • 预备知识
    • manifest
    • 开发指南
    • 更新日志
    • Plugin API 文档

      • 概述
      • 全局对象

        • pixso
        • pixso.ui
        • pixso.host
        • pixso.mouse
        • pixso.editor
        • pixso.keyboard
        • pixso.fieldset
        • pixso.viewport
        • pixso.vectorEditor
        • pixso.stickyToolbar
        • pixso.clientStorage
        • pixso.serverStorage
      • 节点类型

        • BooleanOperationNode
        • ComponentNode
        • ComponentSetNode
        • DocumentNode
        • EllipseNode
        • FrameNode
        • GroupNode
        • InstanceNode
        • LineNode
        • PageNode
        • PolygonNode
        • RectangleNode
        • SectionNode
        • SliceNode
        • StarNode
        • TextNode
        • VectorNode
      • 样式类型

        • PaintStyle
        • TextStyle
        • EffectStyle
        • GridStyle
      • 数据类型

        • Action
        • ArcData
        • BlendMode
        • CommandItem
        • ComponentProperties-Related
        • Constraints
        • DialogType
        • DocumentationLink
        • Effect
        • EmbedData
        • ExportSettings
        • FontName
        • Guide
        • HandleMirroring
        • HyperlinkTarget
        • Image
        • LayoutGrid
        • LetterSpacing
        • Library
        • LineHeight
        • NodeChangeProperty
        • OverflowDirection
        • Overlay
        • Paint
        • PublishStatus
        • Reaction
        • Rect-related
        • RGB & RGBA
        • StickyToolbar
        • StrokeCap
        • StrokeJoin
        • StyleChangeProperty
        • TextCase
        • TextDecoration
        • TextListOptions
        • ThemeType
        • ToolType
        • Transition
        • Trigger
        • Vector
    • Host API 文档

      • 概述
      • Host API
  • 服务端 API

    • OpenAPI 文档
    • OpenAPI 文档
    • 事件订阅
    • 事件订阅
  • 客户端 API

    • 简介
    • 唤醒客户端
    • Web API
    • 更新日志

Web API

接入说明

该 Api 仅针对Pixso 客户端,打开客户端配置地址,配置好目标地址(温馨提示:开发时,请配置自己的本地地址进行调试),配置完毕,即可对接 Pixso 客户端 API。

web API

web 端内置了一个 Pixso 对象pixsoDesktopJSAPI,所有 API 都基于这个对象上完成

判断是否是 Pixso 客户端

// 是否是 pixso 客户端
const isPixsoDesktop = window.pixsoDesktopJSAPI;

获取当前客户端版本号

// 获取客户端版本号
const version = pixsoDesktopJSAPI.version;

打开 tab 页

// 打开 tab页
pixsoDesktopJSAPI.viewPostMessageToMainProcess("openTab", {
  url,
  title,
  isNewTab,
  icon_type,
});
  • url: string 必填项。打开 Tab URL。打开文件地址:例如:https://pixso.cn/app/editor/_P0wo93-6euk362Skk421g?showQuickFrame=true&icon_type=1&page-id=0%3A1。

  • title: string 非必填项。新开 Tab 页的标题。

  • isNewTab: boolean 默认为 true, 非必填项。是否是新开的 Tab。

  • icon_type: number 默认为 -1, 非必填项。值:-1(无 icon)、1(设计文件)、2(原型文件)、3(白板文件)

关闭 Tab 页面

// 关闭Tab页
pixsoDesktopJSAPI.viewPostMessageToMainProcess("closeView");

打开首页

// 打开首页
pixsoDesktopJSAPI.viewPostMessageToMainProcess("showHomepage");
Prev
唤醒客户端
Next
更新日志