Class CommandDefinition

constructor

• new CommandDefinition(
      name?: string,
      description: string,
      commandSymbol: new (...args: unknown[]) => unknown,
      options?: CommandOptions,
  ): CommandDefinition

  构造函数

  Parameters

  • name: string = ""

    命令名称

  • description: string

    命令描述

  • commandSymbol: new (...args: unknown[]) => unknown

    命令符号

  • options: CommandOptions = ...

    命令选项

  Returns CommandDefinition

name

description

link

_iconFileName

helpRootAdress

symbol

op

iconFileName_old

• get iconFileName_old(): string

  获取旧版图标文件名

  Returns string

  图标文件名

  Deprecated

  请使用 getIconSvg() 方法获取内联 SVG

iconFileName

• get iconFileName(): string

  获取图标文件名

  Returns string

  图标文件名

  Deprecated

  请使用 getIconSvg() 方法获取内联 SVG

getHelpLink

• getHelpLink(): string

  获取帮助链接

  Returns string

  帮助链接

setIcon

• setIcon(svg: string): this

  设置自定义 SVG 图标

  Parameters

  • svg: string

    SVG 图标内容

  Returns this

  this，支持链式调用

  Example

  const cmd = new CommandDefinition("MYCOMMAND", "描述", MyClass);
  cmd.setIcon('<svg viewBox="0 0 24 24">...</svg>');
  Copy

getIconSvg

• getIconSvg(): string

  获取图标 SVG 内容

  Returns string

  SVG 内容，如果没有图标则返回 undefined

  Remarks

  优先级：

  1. 自定义设置的图标 (_customIconSvg)
  2. 通过 overrideSvgFileName 指定的图标
  3. 默认按命令名称查找的图标

  Example

  const svg = cmd.getIconSvg();
  if (svg) {
    iconElement.innerHTML = svg;
  }
  Copy

hasIcon

• hasIcon(): boolean

  检查命令是否有图标

  Returns boolean

  是否有图标

  Example

  if (cmd.hasIcon()) {
    showIcon(cmd.getIconSvg());
  } else {
    showPlaceholder();
  }
  Copy

getIconDataUrl

• getIconDataUrl(): string

  获取图标作为 Data URL

  Returns string

  Data URL 字符串，如果没有图标则返回 undefined

  Example

  const dataUrl = cmd.getIconDataUrl();
  if (dataUrl) {
    imgElement.src = dataUrl;
  }
  Copy

createIconElement

• createIconElement(className?: string): HTMLElement

  创建图标 HTML 元素

  Parameters

  • OptionalclassName: string

    可选的 CSS 类名

  Returns HTMLElement

  HTML 元素，如果没有图标则返回 null

  Example

  const iconEl = cmd.createIconElement('command-icon');
  if (iconEl) {
    toolbar.appendChild(iconEl);
  }
  Copy

clearIcon

• clearIcon(): void

  清除自定义图标

  Returns void

  Remarks

  清除后将回退到默认图标查找逻辑