Class PluginContext

constructor

• new PluginContext(manifest: PluginManifest): PluginContext

  Parameters

  • manifest: PluginManifest

  Returns PluginContext

Readonlymanifest

Readonlyengine

registerCommand

• registerCommand(
      name: string,
      description: string,
      commandClass: CommandClass,
      options?: CommandOptions,
  ): void

  注册命令

  Parameters

  • name: string

    命令名称 (大写)

  • description: string

    命令描述

  • commandClass: CommandClass

    命令类

  • Optionaloptions: CommandOptions

    命令选项

  Returns void

unregisterCommand

• unregisterCommand(name: string): void

  注销命令

  Parameters

  • name: string

    命令名称

  Returns void

executeCommand

• executeCommand(name: string): Promise<void>

  执行命令

  Parameters

  • name: string

    命令名称

  Returns Promise<void>

getRegisteredCommands

• getRegisteredCommands(): string[]

  获取插件已注册的命令列表

  Returns string[]

  命令名称数组

registerIcon

• registerIcon(commandName: string, svgContent: string): void

  注册命令图标

  Parameters

  • commandName: string

    命令名称

  • svgContent: string

    SVG 内容

  Returns void

addRibbonButton

• addRibbonButton(
      tabId: string,
      groupId: string,
      button: RibbonButtonConfig,
      position?: "primary" | "more",
  ): void

  添加 Ribbon 按钮到现有组

  Parameters

  • tabId: string

    标签页ID

  • groupId: string

    组ID

  • button: RibbonButtonConfig

    按钮配置

  • position: "primary" | "more" = 'primary'

    插入位置 ('primary' | 'more')

  Returns void

removeRibbonButton

• removeRibbonButton(tabId: string, groupId: string, commandName: string): void

  从 Ribbon 移除按钮

  Parameters

  • tabId: string

    标签页ID

  • groupId: string

    组ID

  • commandName: string

    命令名称

  Returns void

addRibbonGroup

• addRibbonGroup(tabId: string, group: RibbonGroupConfig): void

  添加 Ribbon 组

  Parameters

  • tabId: string

    标签页ID

  • group: RibbonGroupConfig

    组配置

  Returns void

removeRibbonGroup

• removeRibbonGroup(tabId: string, groupId: string): void

  从 Ribbon 移除组

  Parameters

  • tabId: string

    标签页ID

  • groupId: string

    组ID

  Returns void

addRibbonTab

• addRibbonTab(tab: RibbonTabConfig, afterTabId?: string): void

  添加 Ribbon 标签页

  Parameters

  • tab: RibbonTabConfig

    标签页配置

  • OptionalafterTabId: string

    可选，在指定标签页后插入；不指定则添加到末尾

  Returns void

removeRibbonTab

• removeRibbonTab(tabId: string): void

  从 Ribbon 移除标签页

  Parameters

  • tabId: string

    标签页ID

  Returns void

addMenu

• addMenu(config: MenuConfig2): boolean

  添加主菜单（如果不存在）

  Parameters

  • config: MenuConfig2

    主菜单配置

  Returns boolean

  是否新创建了菜单

removeMenu

• removeMenu(menuId: string): void

  移除主菜单

  Parameters

  • menuId: string

    菜单ID

  Returns void

addMenuItem

• addMenuItem(menuId: string, item: MenuItemConfig): void

  添加菜单项

  Parameters

  • menuId: string

    菜单ID（如 'tool', 'edit', 'view', 'plugins' 等）

  • item: MenuItemConfig

    菜单项配置

  Returns void

removeMenuItem

• removeMenuItem(menuId: string, command: string): void

  移除菜单项

  Parameters

  • menuId: string

    菜单ID

  • command: string

    命令名称

  Returns void

on

• on(event: string, handler: EventHandler): void

  监听事件

  Parameters

  • event: string

    事件名称

  • handler: EventHandler

    事件处理函数

  Returns void

off

• off(event: string, handler: EventHandler): void

  取消监听事件

  Parameters

  • event: string

    事件名称

  • handler: EventHandler

    事件处理函数

  Returns void

once

• once(event: string, handler: EventHandler): void

  监听一次事件

  Parameters

  • event: string

    事件名称

  • handler: EventHandler

    事件处理函数

  Returns void

getStorageItem

• getStorageItem<T>(key: string): T

  获取插件存储的数据

  Type Parameters

  • T

  Parameters

  • key: string

    键名

  Returns T

setStorageItem

• setStorageItem<T>(key: string, value: T): void

  设置插件存储的数据

  Type Parameters

  • T

  Parameters

  • key: string

    键名

  • value: T

    值

  Returns void

removeStorageItem

• removeStorageItem(key: string): void

  移除插件存储的数据

  Parameters

  • key: string

    键名

  Returns void