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

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

      • 概述
      • 全局对象

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

        • BooleanOperationNode
        • ComponentNode
        • ComponentSetNode
        • DocumentNode
        • EllipseNode
        • FolderNode
        • 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
    • 更新日志

pixso.codegen

pixso.codegen 为提供了代码生成相关的 API,这些 API 只在研发、历史研发、单画板模式下生效,关于插件如何在这些模式下运行,请看 manifest.editorType 配置。

unit

  • type: unit: "px" | "pt" | "dp" | "rem" | "sp"

获取或修改生成代码的尺寸单位,默认为 px。

language

  • type: language: "CSS" | "swiftUI" | "UIKit" | "XML" | "Compose"

获取或修改生成代码的语言类型,默认为 CSS。

conversionRate

  • type: number

获取或修改生成代码的尺寸比例,默认为 1。

on

on(type: "generatewithcfg", callback: (event: CodegenResultWithConfig) => void): void;

on 方法允许注册代码生成事件的处理函数,当事件发生时会执行该回调函数,事件类型如下:

  • generatewithcfg:画布中选中节点变更、codegen的配置(unit、language、conversionRate)等变更时会触发。

once

once(type: "generatewithcfg", callback: (event: CodegenResultWithConfig) => void): void;

once 方法允许注册代码生成事件的处理函数,当事件发生时会执行该回调函数。与 on 方法的区别在于,通过 once 方法注册的事件处理函数只会执行一次。

off

off(type: "generatewithcfg", callback: (event: CodegenResultWithConfig) => void): void;

移除通过 pixso.codegen.on 或 pixso.codegen.once 绑定的事件处理函数。

Prev
pixso.editor
Next
pixso.keyboard