WebCAD-Lib-TS API 文档 - v1.0.0
    Preparing search index...

    Class RibbonConfigManager

    Ribbon 配置管理器

    Index

    Constructors

    Methods

    • 设置 Ribbon 配置

      Parameters

      Returns void

    • 从 JSON URL 加载配置

      Parameters

      • url: string

      Returns Promise<void>

    • 保存固定状态到 localStorage

      Parameters

      • groupId: string
      • pinned: boolean

      Returns void

    • 从 localStorage 加载固定状态

      Parameters

      • groupId: string

      Returns boolean

    • 重置为默认配置

      Returns void

    • 刷新 Ribbon UI 通知 RibbonBar 重新渲染以反映配置变更

      Returns void

    • 增量修改当前 Ribbon 配置(就地修改,兼容 PluginContext 直接操作模式)

      Parameters

      • patch: {
            removeTabs?: string[];
            addTabs?: { tab: RibbonTabConfig; before?: string; after?: string }[];
            modifyTabs?: Record<
                string,
                {
                    removeGroups?: string[];
                    addGroups?: (RibbonGroupConfig & { before?: string; after?: string })[];
                    modifyGroups?: Record<
                        string,
                        {
                            removePrimaryButtons?: string[];
                            removeMoreButtons?: string[];
                            addPrimaryButtons?: (
                                RibbonButtonConfig & { before?: string; after?: string }
                            )[];
                            addMoreButtons?: (
                                RibbonButtonConfig & { before?: string; after?: string }
                            )[];
                        },
                    >;
                },
            >;
        }

        增量配置

        • OptionalremoveTabs?: string[]

          要移除的标签页 ID 列表

        • OptionaladdTabs?: { tab: RibbonTabConfig; before?: string; after?: string }[]

          要添加的标签页(含 before/after 定位)

        • OptionalmodifyTabs?: Record<
              string,
              {
                  removeGroups?: string[];
                  addGroups?: (RibbonGroupConfig & { before?: string; after?: string })[];
                  modifyGroups?: Record<
                      string,
                      {
                          removePrimaryButtons?: string[];
                          removeMoreButtons?: string[];
                          addPrimaryButtons?: (
                              RibbonButtonConfig & { before?: string; after?: string }
                          )[];
                          addMoreButtons?: (
                              RibbonButtonConfig & { before?: string; after?: string }
                          )[];
                      },
                  >;
              },
          >

          对已有标签页的修改(key 为标签页 ID)

      Returns void