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

pixso.stickyToolbar

pixso.stickyToolbar 是图层悬浮工具栏的抽象对象,悬浮工具栏默认处于关闭状态,需通过 pixso.stickyToolbar.open(tools) 开启。 开启后在画布上选中单个图层时,悬浮工具栏将会展示在图层的周边,悬浮工具栏的菜单项可通过 tools 参数进行配置。

此外,pixso.stickyToolbar 对象上的 on 和 once 方法还可以监听菜单上的鼠标触发事件,如鼠标点击、移入、移出。

open

  • Type: open(tools: ToolItem[]): void
  • Type Declaration: ToolItem

开启图层悬浮工具栏。

close

  • Type: close(): void

关闭图层悬浮工具栏。

position

  • Type: StickyToolbarPosition
  • Type Declaration: StickyToolbarPosition

悬浮工具栏的定位设置,默认为TOP_CENTER。

display

  • Type: StickyToolbarDisplay
  • Type Declaration: StickyToolbarDisplay

悬浮工具栏的展示条件设置,默认为 SELECT ,即选中图层时显示工具栏;当设置为 HOVER_SELECT 时,则需要鼠标悬浮到选中图层时才显示;

on

on(type: "trigger", callback: (event: StickyToolbarEvent) => void): void;

on 方法允许注册监听图层悬浮工具栏特定事件的处理函数,当事件发生时会执行该回调函数,事件类型如下:

  • trigger:图层悬浮工具栏菜单项的鼠标触发事件,如鼠标点击、移入、移出, 可通过 event.type 属性区分鼠标触发事件类型。

once

once(type: "trigger", callback: (event: StickyToolbarEvent) => void): void;

once 方法允许注册监听图层悬浮工具栏特定事件的处理函数,当事件发生时会执行该回调函数。与 on 方法的区别在于,通过 once 方法注册的事件处理函数只会执行一次。

off

off(type: "trigger", callback: (event: StickyToolbarEvent) => void): void;

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

Prev
pixso.vectorEditor
Next
pixso.clientStorage