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
    • 更新日志

TextStyle

文本样式

Text style properties

type

  • Readonly: true
  • Type: TEXT

textDecoration

  • Type: TextDecoration | pixso.mixed

设置文本带下划线或带删除线。需要加载字体。

fontName

  • Type: FontName | pixso.mixed

字体系列(例如“Inter”)和字体样式(例如“Regular”)。将此属性设置为不同的值需要加载新字体。

letterSpacing

  • Type: LetterSpacing | pixso.mixed

单个字符之间的间距。需要加载字体。

lineHeight

  • Type: LineHeight | pixso.mixed

一段文本中的行间距。需要加载字体。

paragraphSpacing

  • Type: number

段落之间的垂直距离。 设置此属性需要加载字体。

textCase

  • Type: TextCase | pixso.mixed

覆盖文本节点中原始字符的大小写。需要加载字体。

Base style properties

id

  • Readonly: true
  • Type: string

文档中样式的唯一标识符。可使用这个值在设置图层的fillStyleId、strokeStyleId、textStyleId 等属性上,从而使得图层绑定该样式。

name

  • Type: string

样式名称。

description

  • Type: string

样式的描述

getPluginData

  • Type: getPluginData(key: string): string

获取节点上存储自定义信息,对您的插件来说是私有的。如果要获取字符串以外的值类型,请先通过 JSON.parse 将其解码。

setPluginData

  • Type: setPluginData(key: string, value: string): void

允许您在任何节点上存储自定义信息,对您的插件来说是私有的。如果要存储字符串以外的值类型,请先通过 JSON.stringify 将其编码。

getPluginDataKeys

  • Type: getPluginDataKeys(): string[]

获取当前插件存储信息的所有键名。

getSharedPluginData

  • Type: getSharedPluginData(namespace: string, key: string): string

获取存储在特定命名空间上的共享数据。

setSharedPluginData

  • Type: setSharedPluginData(namespace: string, key: string, value: string): void

这使您可以在任何节点上存储自定义信息。您可以稍后通过使用相同的命名空间和键调用 getSharedPluginData 来检索它。要查找存储在特定命名空间中的节点上的所有数据,请使用 getSharpedPluginDataKeys。

您使用此 API 编写的任何数据都可以被任何插件读取。目的是允许插件相互操作。如果您不希望其他插件能够读取您的数据,请改用 setPluginData。

您还必须提供命名空间参数以避免与其他插件的键冲突。此参数是强制性的,以防止多个插件使用通用键名(如数据)并相互覆盖。我们建议传递一个标识您的插件的值。可以将此命名空间提供给其他插件的作者,以便他们可以从您的插件中读取数据。

namespace 用于标识您的插件并避免与其他插件发生键冲突的唯一字符串。命名空间必须至少包含 3 个字母数字字符。

getSharedPluginDataKeys

  • Type: getSharedPluginDataKeys(namespace: string): string[]

查找存储在特定命名空间中的节点上的所有数据的键名。

Publishable properties

remote

  • Readonly: true
  • Type: boolean

此样式是否来自团队库。远程样式是只读的:尝试更改其属性将抛出。

key

  • Readonly: true
  • Type: string

与 pixso.importStyleByKeyAsync 配合使用。请注意,虽然此键存在于本地和已发布的样式上,但您只能导入已发布的样式。

getLibraryInfoAsync

  • Type: getLibraryInfoAsync(): Promise<{key: string, name: string}>

获取样式所属资源库的 key 值,可通过pixso.getLibraryByKeyAsync(key)获取该资源库的信息。

Prev
PaintStyle
Next
EffectStyle