@jlceda/pro-api-types 0.1.170 → 0.1.172

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +561 -47
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -738,8 +738,8 @@ declare class DMT_SelectControl {
738
738
  * 获取当前文档的属性
739
739
  *
740
740
  * @beta
741
- * @remarks 仅在存在打开的工程后生效,将会获取当前打开且拥有最后输入焦点的文档的文档类型、UUID、所属工程的 UUID
742
- * @returns 文档类型、UUID、所属工程的 UUID 组成的对象,如若为 `undefined` 则获取失败
741
+ * @remarks 将会获取当前打开且拥有最后输入焦点的文档的文档类型、UUID、所属工程的 UUID 或所属库的 UUID
742
+ * @returns 文档类型、UUID、所属工程的 UUID、所属库的 UUID 组成的对象,如若为 `undefined` 则获取失败
743
743
  */
744
744
  getCurrentDocumentInfo(): Promise<IDMT_EditorDocumentItem | undefined>;
745
745
  }
@@ -883,6 +883,7 @@ declare class EDA {
883
883
  sys_FileManager: SYS_FileManager;
884
884
  sys_FileSystem: SYS_FileSystem;
885
885
  sys_FontManager: SYS_FontManager;
886
+ sys_HeaderMenu: SYS_HeaderMenu;
886
887
  sys_I18n: SYS_I18n;
887
888
  sys_IFrame: SYS_IFrame;
888
889
  sys_LoadingAndProgressBar: SYS_LoadingAndProgressBar;
@@ -891,6 +892,7 @@ declare class EDA {
891
892
  sys_MessageBox: SYS_MessageBox;
892
893
  sys_MessageBus: SYS_MessageBus;
893
894
  sys_PanelControl: SYS_PanelControl;
895
+ sys_RightClickMenu: SYS_RightClickMenu;
894
896
  sys_Setting: SYS_Setting;
895
897
  sys_ShortcutKey: SYS_ShortcutKey;
896
898
  sys_Storage: SYS_Storage;
@@ -1083,7 +1085,7 @@ declare enum ELIB_LibraryType {
1083
1085
  * @public
1084
1086
  */
1085
1087
  declare enum ELIB_SymbolType {
1086
- /** 元件 */
1088
+ /** 元件符号 */
1087
1089
  COMPONENT = 2,
1088
1090
  /** 网络标识 */
1089
1091
  NET_FLAG = 18,
@@ -1094,7 +1096,13 @@ declare enum ELIB_SymbolType {
1094
1096
  /** 无电气 */
1095
1097
  NON_ELECTRICAL = 21,
1096
1098
  /** 短接标识 */
1097
- SHORT_CIRCUIT_FLAG = 22
1099
+ SHORT_CIRCUIT_FLAG = 22,
1100
+ /** 跨页连接标识 */
1101
+ OFF_PAGE_CONNECTOR = "\u5F00\u53D1\u8BF7\u4FEE\u65391",
1102
+ /** 差分对标识 */
1103
+ DIFFERENTIAL_PAIRS_FLAG = "\u5F00\u53D1\u8BF7\u4FEE\u65392",
1104
+ /** 复用模块符号 */
1105
+ CBB_SYMBOL = "\u5F00\u53D1\u8BF7\u4FEE\u65393"
1098
1106
  }
1099
1107
 
1100
1108
  /**
@@ -1623,7 +1631,7 @@ declare enum ESCH_PrimitiveComponentType {
1623
1631
  * @public
1624
1632
  */
1625
1633
  declare enum ESCH_PrimitiveComponentType_2 {
1626
- /** 元件 */
1634
+ /** 元件符号 */
1627
1635
  COMPONENT = "part",
1628
1636
  /** 图纸 */
1629
1637
  DRAWING = "sheet",
@@ -1636,7 +1644,13 @@ declare enum ESCH_PrimitiveComponentType_2 {
1636
1644
  /** 短接标识 */
1637
1645
  SHORT_CIRCUIT_FLAG = "short_symbol",
1638
1646
  /** 网络标签 */
1639
- NET_LABEL = "netlabel"
1647
+ NET_LABEL = "netlabel",
1648
+ /** 跨页连接标识 */
1649
+ OFF_PAGE_CONNECTOR = "offPageConnector",
1650
+ /** 差分对标识 */
1651
+ DIFFERENTIAL_PAIRS_FLAG = "diffPairsFlag",
1652
+ /** 复用模块符号 */
1653
+ CBB_SYMBOL = "block_symbol"
1640
1654
  }
1641
1655
 
1642
1656
  /**
@@ -1782,6 +1796,32 @@ declare enum ESYS_BottomPanelTab {
1782
1796
  FIND = "findResult"
1783
1797
  }
1784
1798
 
1799
+ /**
1800
+ * 顶部菜单环境
1801
+ *
1802
+ * @public
1803
+ */
1804
+ declare enum ESYS_HeaderMenuEnvironment {
1805
+ /** 主页 */
1806
+ HOME = "home",
1807
+ /** 空白页 */
1808
+ BLANK = "blank",
1809
+ /** 原理图 */
1810
+ SCHEMATIC = "sch",
1811
+ /** 符号(包括 CBB 符号) */
1812
+ SYMBOL = "symbol",
1813
+ /** PCB */
1814
+ PCB = "pcb",
1815
+ /** 封装 */
1816
+ FOOTPRINT = "footprint",
1817
+ /** PCB 预览(包括 2D、3D 预览) */
1818
+ PCB_VIEW = "pcbView",
1819
+ /** 面板 */
1820
+ PANEL = "panel",
1821
+ /** 面板预览 */
1822
+ PANEL_VIEW = "panelView"
1823
+ }
1824
+
1785
1825
  /**
1786
1826
  * 左侧面板标签页
1787
1827
  *
@@ -2057,7 +2097,9 @@ declare interface IDMT_EditorDocumentItem {
2057
2097
  /** 文档 UUID */
2058
2098
  uuid: string;
2059
2099
  /** 文档所属工程 UUID */
2060
- parentProjectUuid: string;
2100
+ parentProjectUuid?: string;
2101
+ /** 库文档所属库 UUID */
2102
+ parentLibraryUuid?: string;
2061
2103
  }
2062
2104
 
2063
2105
  /**
@@ -2151,7 +2193,7 @@ declare interface IDMT_IndicatorMarkerShape {
2151
2193
  */
2152
2194
  startY?: number;
2153
2195
  /**
2154
- * 线�� | 圆弧:终止点 X
2196
+ * 线段 | 圆弧:终止点 X
2155
2197
  */
2156
2198
  endX?: number;
2157
2199
  /**
@@ -2248,6 +2290,8 @@ declare interface IDMT_SchematicItem {
2248
2290
  parentProjectUuid: string;
2249
2291
  /** 所属板子 UUID */
2250
2292
  parentBoardUuid?: string;
2293
+ /** 复用模块原理图关联的模块符号 */
2294
+ cbbSymbol?: ILIB_SymbolItem;
2251
2295
  }
2252
2296
 
2253
2297
  /**
@@ -2370,6 +2414,8 @@ declare interface ILIB_CbbItem {
2370
2414
  classification?: ILIB_ClassificationIndex;
2371
2415
  /** 描述 */
2372
2416
  description?: string;
2417
+ /** 下属板子 */
2418
+ boards: Array<IDMT_BoardItem>;
2373
2419
  }
2374
2420
 
2375
2421
  /**
@@ -2627,6 +2673,237 @@ declare interface ILIB_DeviceSearchItem {
2627
2673
  jlcLibraryCategory?: ELIB_DeviceJlcLibraryCategory;
2628
2674
  }
2629
2675
 
2676
+ /**
2677
+ * 外部库复用模块方法
2678
+ *
2679
+ * @public
2680
+ */
2681
+ declare interface ILIB_ExtendLibraryCbbFunctions extends ILIB_ExtendLibraryFunctions {
2682
+ getList: (props: any) => Promise<any>;
2683
+ }
2684
+
2685
+ /**
2686
+ * 外部库分类索引
2687
+ *
2688
+ * @public
2689
+ * @remarks
2690
+ * 支持外部库使用名称或 UUID 作为分类的唯一 ID 索引
2691
+ */
2692
+ declare interface ILIB_ExtendLibraryClassificationIndex {
2693
+ /** 一级分类名称 */
2694
+ primaryClassificationName?: string;
2695
+ /** 一级分类 UUID */
2696
+ primaryClassificationUuid?: string;
2697
+ /** 二级分类名称 */
2698
+ secondaryClassificationName?: string;
2699
+ /** 二级分类 UUID */
2700
+ secondaryClassificationUuid?: string;
2701
+ }
2702
+
2703
+ /**
2704
+ * 外部库器件方法
2705
+ *
2706
+ * @public
2707
+ */
2708
+ declare interface ILIB_ExtendLibraryDeviceFunctions extends ILIB_ExtendLibraryFunctions {
2709
+ getList: (props: ILIB_ExtendLibrarySearchProperty<{
2710
+ attributes?: {
2711
+ [key: string]: string;
2712
+ };
2713
+ symbolType?: ELIB_SymbolType;
2714
+ }>) => Promise<ILIB_ExtendLibrarySearchResult<ILIB_ExtendLibraryItemIndex & {
2715
+ classification?: ILIB_ExtendLibraryClassificationIndex;
2716
+ symbol?: ILIB_ExtendLibraryItem & {
2717
+ symbolType: ELIB_SymbolType;
2718
+ };
2719
+ footprint?: ILIB_ExtendLibraryItem;
2720
+ model3d?: ILIB_ExtendLibraryItem;
2721
+ value?: string;
2722
+ supplierPart?: string;
2723
+ manufacturer?: string;
2724
+ description?: string;
2725
+ }>>;
2726
+ /**
2727
+ * 获取支持的符号类型
2728
+ *
2729
+ * @returns 符号类型数组
2730
+ */
2731
+ getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
2732
+ }
2733
+
2734
+ /**
2735
+ * 外部库封装方法
2736
+ *
2737
+ * @public
2738
+ */
2739
+ declare interface ILIB_ExtendLibraryFootprintFunctions extends ILIB_ExtendLibraryFunctions {
2740
+ getList: (props: ILIB_ExtendLibrarySearchProperty<{}>) => Promise<ILIB_ExtendLibrarySearchResult<ILIB_ExtendLibraryItem & {
2741
+ classification?: ILIB_ExtendLibraryClassificationIndex;
2742
+ description?: string;
2743
+ version?: string;
2744
+ updateTime?: number;
2745
+ createTime?: number;
2746
+ creator?: ILIB_ExtendLibraryUserIndex;
2747
+ modifier?: ILIB_ExtendLibraryUserIndex;
2748
+ owner?: ILIB_ExtendLibraryUserIndex;
2749
+ }>>;
2750
+ }
2751
+
2752
+ /**
2753
+ * 外部库方法
2754
+ *
2755
+ * @public
2756
+ */
2757
+ declare interface ILIB_ExtendLibraryFunctions {
2758
+ /**
2759
+ * 获取详细信息
2760
+ *
2761
+ * @param uuid - UUID
2762
+ * @returns 库元素详细信息
2763
+ */
2764
+ getDetail: (uuid: string) => Promise<any>;
2765
+ /**
2766
+ * 获取分类树
2767
+ *
2768
+ * @returns 分类树
2769
+ */
2770
+ getClassificationTree: () => Promise<Array<{
2771
+ name: string;
2772
+ uuid?: string;
2773
+ children?: Array<{
2774
+ name: string;
2775
+ uuid?: string;
2776
+ }> | undefined;
2777
+ }>>;
2778
+ /**
2779
+ * 获取列表
2780
+ *
2781
+ * @param props - 搜索参数
2782
+ * @returns 库元素列表
2783
+ */
2784
+ getList: (props: ILIB_ExtendLibrarySearchProperty<any>) => Promise<ILIB_ExtendLibrarySearchResult<any>>;
2785
+ }
2786
+
2787
+ /**
2788
+ * 外部库元素
2789
+ *
2790
+ * @public
2791
+ * @remarks
2792
+ * 此处需要传递 `url` 或 `data` 字段,如若同时传入,则取 `data` 的数据,忽略 `url` 字段
2793
+ *
2794
+ * 如若仅传入 `url` 字段,将会对其发起请求并尝试获取其库文件
2795
+ *
2796
+ * `data` 的数据可为 Blob 格式或 DataURL 格式
2797
+ */
2798
+ declare interface ILIB_ExtendLibraryItem extends ILIB_ExtendLibraryItemIndex {
2799
+ /** 库文件地址 */
2800
+ url?: string;
2801
+ /** 库文件数据 */
2802
+ data?: string | Blob;
2803
+ }
2804
+
2805
+ /**
2806
+ * 外部库元素索引
2807
+ *
2808
+ * @public
2809
+ * @remarks
2810
+ * 支持外部库使用名称或 UUID 作为元素的唯一 ID 索引
2811
+ *
2812
+ * 正常情况下,希望每个库都拥有 UUID,但可能部分系统开发时不存在 UUID 字段(或可以做类似用途的字段)
2813
+ *
2814
+ * 此处仅传入 `name` 字段时,将把 `name` 做唯一 ID 用途,不可有重名的数据
2815
+ *
2816
+ * 如若传入 `uuid` 和 `name` 字段,则只有 `uuid` 不可重复
2817
+ */
2818
+ declare interface ILIB_ExtendLibraryItemIndex {
2819
+ /** 库 UUID */
2820
+ uuid?: string;
2821
+ /** 库名称 */
2822
+ name: string;
2823
+ }
2824
+
2825
+ /**
2826
+ * 外部库搜索参数
2827
+ *
2828
+ * @public
2829
+ */
2830
+ declare interface ILIB_ExtendLibrarySearchProperty<T> {
2831
+ /** 页数 */
2832
+ page?: number;
2833
+ /** 单页条目数 */
2834
+ pageSize?: number;
2835
+ /** 查询参数 */
2836
+ query: T & {
2837
+ wd?: string;
2838
+ listByTitles?: Array<string>;
2839
+ classification?: ILIB_ExtendLibraryClassificationIndex;
2840
+ };
2841
+ }
2842
+
2843
+ /**
2844
+ * 外部库搜索结果
2845
+ *
2846
+ * @public
2847
+ */
2848
+ declare interface ILIB_ExtendLibrarySearchResult<T> {
2849
+ /** 总条目数 */
2850
+ count: number;
2851
+ /** 结果列表 */
2852
+ lists: Array<T>;
2853
+ /** 当前页数 */
2854
+ page: number;
2855
+ /** 单页条目数 */
2856
+ pageSize: number;
2857
+ /** 总页数 */
2858
+ totalPage: number;
2859
+ }
2860
+
2861
+ /**
2862
+ * 外部库符号方法
2863
+ *
2864
+ * @public
2865
+ */
2866
+ declare interface ILIB_ExtendLibrarySymbolFunctions extends ILIB_ExtendLibraryFunctions {
2867
+ getList: (props: ILIB_ExtendLibrarySearchProperty<{
2868
+ symbolType?: ELIB_SymbolType;
2869
+ }>) => Promise<ILIB_ExtendLibrarySearchResult<ILIB_ExtendLibraryItem & {
2870
+ symbolType: ELIB_SymbolType;
2871
+ } & {
2872
+ classification?: ILIB_ExtendLibraryClassificationIndex;
2873
+ description?: string;
2874
+ version?: string;
2875
+ updateTime?: number;
2876
+ createTime?: number;
2877
+ creator?: ILIB_ExtendLibraryUserIndex;
2878
+ modifier?: ILIB_ExtendLibraryUserIndex;
2879
+ owner?: ILIB_ExtendLibraryUserIndex;
2880
+ }>>;
2881
+ /**
2882
+ * 获取支持的符号类型
2883
+ *
2884
+ * @returns 符号类型数组
2885
+ */
2886
+ getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
2887
+ }
2888
+
2889
+ /**
2890
+ * 外部库用户索引
2891
+ *
2892
+ * @public
2893
+ * @remarks
2894
+ * 支持外部库使用名称或关联的嘉立创 EDA 系统内用户 UUID 作为用户的唯一 ID 索引
2895
+ *
2896
+ * 如若希望关联嘉立创 EDA 的用户,请传入该用户的 UUID,将会自动读取用户的名称(如若用户存在)
2897
+ *
2898
+ * 如若仅希望显示用户名称,可以传入 `name` 字段
2899
+ */
2900
+ declare interface ILIB_ExtendLibraryUserIndex {
2901
+ /** 用户名称 */
2902
+ name?: string;
2903
+ /** 嘉立创 EDA 系统内的用户 UUID */
2904
+ uuid?: string;
2905
+ }
2906
+
2630
2907
  /**
2631
2908
  * 封装属性
2632
2909
  *
@@ -2744,6 +3021,8 @@ declare interface ILIB_SymbolItem {
2744
3021
  uuid: string;
2745
3022
  /** 所属库 UUID */
2746
3023
  libraryUuid: string;
3024
+ /** 所属复用模块 UUID,仅复用模块符号存在该属性 */
3025
+ cbbUuid?: string;
2747
3026
  /** 符号名称 */
2748
3027
  name: string;
2749
3028
  /** 分类 */
@@ -3201,7 +3480,7 @@ declare class IPCB_PrimitiveArc implements IPCB_Primitive {
3201
3480
  * 设置属性状态:是否锁定
3202
3481
  *
3203
3482
  * @beta
3204
- * @param primitiveLock - 是否锁定
3483
+ * @param primitiveLock - ��否锁定
3205
3484
  * @returns 圆弧线图元对象
3206
3485
  */
3207
3486
  setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveArc;
@@ -3859,7 +4138,7 @@ declare class IPCB_PrimitiveComponent implements IPCB_Primitive {
3859
4138
  * 设置属性状态:位号
3860
4139
  *
3861
4140
  * @beta
3862
- * @param designator - 位号
4141
+ * @param designator - 位��
3863
4142
  * @returns 器件图元对象
3864
4143
  */
3865
4144
  setState_Designator(designator: string | undefined): IPCB_PrimitiveComponent;
@@ -7071,6 +7350,47 @@ declare class ISCH_PrimitiveBus implements ISCH_Primitive {
7071
7350
  done(): Promise<ISCH_PrimitiveBus>;
7072
7351
  }
7073
7352
 
7353
+ /**
7354
+ * 复用模块符号图元
7355
+ *
7356
+ * @public
7357
+ */
7358
+ declare class ISCH_PrimitiveCbbSymbolComponent extends ISCH_PrimitiveComponent_2 {
7359
+ /**
7360
+ * 关联复用模块
7361
+ *
7362
+ */
7363
+ private cbb;
7364
+ /** 关联复用模块符号 */
7365
+ private cbbSymbol;
7366
+ /* Excluded from this release type: __constructor */
7367
+ /* Excluded from this release type: create */
7368
+ /**
7369
+ * 获取属性状态:关联复用模块
7370
+ *
7371
+ * @public
7372
+ * @returns 关联复用模块
7373
+ */
7374
+ getState_Cbb(): {
7375
+ libraryUuid: string;
7376
+ uuid: string;
7377
+ };
7378
+ /**
7379
+ * 获取属性状态:关联复用模块符号
7380
+ *
7381
+ * @public
7382
+ * @returns 关联复用模块符号
7383
+ */
7384
+ getState_CbbSymbol(): {
7385
+ libraryUuid: string;
7386
+ cbbUuid: string;
7387
+ uuid: string;
7388
+ };
7389
+ /* Excluded from this release type: reset */
7390
+ /* Excluded from this release type: done */
7391
+ /* Excluded from this release type: setState_CbbSymbol */
7392
+ }
7393
+
7074
7394
  /**
7075
7395
  * 圆图元
7076
7396
  *
@@ -7607,7 +7927,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
7607
7927
  * 设置属性状态:其它参数
7608
7928
  *
7609
7929
  * @beta
7610
- * @param otherProperty - 其它参数
7930
+ * @param otherProperty - 其它参���
7611
7931
  * @returns 器件图元对象
7612
7932
  */
7613
7933
  setState_OtherProperty(otherProperty: {
@@ -7660,7 +7980,19 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
7660
7980
  */
7661
7981
  declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
7662
7982
  /** 异步 */
7663
- private async;
7983
+ protected async: boolean;
7984
+ /** 坐标 X */
7985
+ protected x: number;
7986
+ /** 坐标 Y */
7987
+ protected y: number;
7988
+ /** 旋转角度 */
7989
+ protected rotation: number;
7990
+ /** 是否镜像 */
7991
+ protected mirror: boolean;
7992
+ /** Component 属性:位号 */
7993
+ protected designator?: string;
7994
+ /** Component 属性:名称 */
7995
+ protected name?: string;
7664
7996
  /** 图元类型 */
7665
7997
  private readonly primitiveType;
7666
7998
  /** 器件类型 */
@@ -7669,30 +8001,24 @@ declare class ISCH_PrimitiveComponent_2 implements ISCH_Primitive {
7669
8001
  private primitiveId?;
7670
8002
  /** 关联库器件 */
7671
8003
  private component;
7672
- /** 坐标 X */
7673
- private x;
7674
- /** 坐标 Y */
7675
- private y;
7676
8004
  /** 子图块名称 */
7677
8005
  private partId?;
7678
- /** 旋转角度 */
7679
- private rotation;
7680
- /** 是否镜像 */
7681
- private mirror;
7682
8006
  /** Component 属性:是否加入 BOM */
7683
8007
  private addIntoBom?;
7684
8008
  /** Component 属性:是否转到 PCB */
7685
8009
  private addIntoPcb?;
7686
8010
  /** NetPort 和 NetFlag 属性:网络名称 */
7687
8011
  private net?;
7688
- /** 关联库符号 UUID */
8012
+ /**
8013
+ * 关联库符号
8014
+ *
8015
+ */
7689
8016
  private symbol?;
7690
- /** 关联库封装 UUID */
8017
+ /**
8018
+ * 关联库封装
8019
+ *
8020
+ */
7691
8021
  private footprint?;
7692
- /** Component 属性:位号 */
7693
- private designator?;
7694
- /** Component 属性:名称 */
7695
- private name?;
7696
8022
  /** Component 属性:唯一 ID */
7697
8023
  private uniqueId?;
7698
8024
  /** Component 属性:制造商 */
@@ -8202,7 +8528,7 @@ declare class ISCH_PrimitivePin implements ISCH_Primitive {
8202
8528
  * 设置属性状态:引脚编号
8203
8529
  *
8204
8530
  * @beta
8205
- * @param pinNumber - 引脚编号
8531
+ * @param pinNumber - 引脚编���
8206
8532
  * @returns 引脚图元对象
8207
8533
  */
8208
8534
  setState_PinNumber(pinNumber: string): ISCH_PrimitivePin;
@@ -8882,7 +9208,7 @@ declare class ISCH_PrimitiveText implements ISCH_Primitive {
8882
9208
  * 设置属性状态:字体大小
8883
9209
  *
8884
9210
  * @beta
8885
- * @param fontSize - 字体大小
9211
+ * @param fontSize - 字体��小
8886
9212
  * @returns 文本图元对象
8887
9213
  */
8888
9214
  setState_FontSize(fontSize: number | null): ISCH_PrimitiveText;
@@ -9117,6 +9443,88 @@ declare interface ISYS_FileSystemFileList {
9117
9443
  fullPath: string;
9118
9444
  }
9119
9445
 
9446
+ /**
9447
+ * 顶部菜单项
9448
+ *
9449
+ * @public
9450
+ */
9451
+ declare interface ISYS_HeaderMenus {
9452
+ /** 主页 */
9453
+ home?: Array<ISYS_HeaderMenuTopMenuItem>;
9454
+ /** 空白页 */
9455
+ blank?: Array<ISYS_HeaderMenuTopMenuItem>;
9456
+ /** 原理图 */
9457
+ schematic?: Array<ISYS_HeaderMenuTopMenuItem>;
9458
+ /**
9459
+ * 原理图
9460
+ *
9461
+ * @deprecated 请使用 `schematic` 替代 `sch`
9462
+ */
9463
+ sch?: Array<ISYS_HeaderMenuTopMenuItem>;
9464
+ /** 符号(包括 CBB 符号) */
9465
+ symbol?: Array<ISYS_HeaderMenuTopMenuItem>;
9466
+ /** PCB */
9467
+ pcb?: Array<ISYS_HeaderMenuTopMenuItem>;
9468
+ /** 封装 */
9469
+ footprint?: Array<ISYS_HeaderMenuTopMenuItem>;
9470
+ /** PCB 预览(包括 2D、3D 预览) */
9471
+ pcbView?: Array<ISYS_HeaderMenuTopMenuItem>;
9472
+ /** 面板 */
9473
+ panel?: Array<ISYS_HeaderMenuTopMenuItem>;
9474
+ /** 面板预览 */
9475
+ panelView?: Array<ISYS_HeaderMenuTopMenuItem>;
9476
+ }
9477
+
9478
+ /**
9479
+ * 顶部二级菜单项
9480
+ *
9481
+ * @public
9482
+ */
9483
+ declare interface ISYS_HeaderMenuSub1MenuItem {
9484
+ /** 菜单项 ID,不可重复 */
9485
+ id: string;
9486
+ /** 菜单项标题 */
9487
+ title: string;
9488
+ /** 菜单项图标 */
9489
+ icon?: string;
9490
+ /** 注册方法名称(需要在扩展入口文件导出该方法) */
9491
+ registerFn?: string;
9492
+ /** 子菜单项 */
9493
+ menuItems?: Array<ISYS_HeaderMenuSub2MenuItem | null>;
9494
+ }
9495
+
9496
+ /**
9497
+ * 顶部三级菜单项
9498
+ *
9499
+ * @public
9500
+ */
9501
+ declare interface ISYS_HeaderMenuSub2MenuItem {
9502
+ /** 菜单项 ID,不可重复 */
9503
+ id: string;
9504
+ /** 菜单项标题 */
9505
+ title: string;
9506
+ /** 菜单项图标 */
9507
+ icon?: string;
9508
+ /** 注册方法名称(需要在扩展入口文件导出该方法) */
9509
+ registerFn?: string;
9510
+ }
9511
+
9512
+ /**
9513
+ * 顶部一级菜单项
9514
+ *
9515
+ * @public
9516
+ */
9517
+ declare interface ISYS_HeaderMenuTopMenuItem {
9518
+ /** 菜单项 ID,不可重复 */
9519
+ id: string;
9520
+ /** 菜单项标题 */
9521
+ title: string;
9522
+ /** 注册方法名称(需要在扩展入口文件导出该方法) */
9523
+ registerFn?: string;
9524
+ /** 子菜单项 */
9525
+ menuItems?: Array<ISYS_HeaderMenuSub1MenuItem | null>;
9526
+ }
9527
+
9120
9528
  /**
9121
9529
  * 语言数据键值对
9122
9530
  *
@@ -9173,6 +9581,24 @@ declare interface ISYS_MultilingualLanguagesData {
9173
9581
  [language: string]: ISYS_LanguageKeyValuePairs;
9174
9582
  }
9175
9583
 
9584
+ /**
9585
+ * 右键菜单项
9586
+ *
9587
+ * @public
9588
+ */
9589
+ declare interface ISYS_RightClickMenuItem {
9590
+ /** 菜单项 ID,不可重复 */
9591
+ id: string;
9592
+ /** 菜单项标题 */
9593
+ title?: string;
9594
+ /** 菜单项图标 */
9595
+ icon?: string;
9596
+ /** 注册方法名称(需要在扩展入口文件导出该方法) */
9597
+ registerFn?: string;
9598
+ /** 子菜单项 */
9599
+ menuItems?: Array<ISYS_RightClickMenuItem | null>;
9600
+ }
9601
+
9176
9602
  /**
9177
9603
  * 窗口事件监听可移除对象
9178
9604
  *
@@ -9338,7 +9764,7 @@ declare class LIB_Cbb {
9338
9764
  * 在编辑器打开复用模块工程
9339
9765
  *
9340
9766
  * @beta
9341
- * @remarks 本操作将会在 EDA 前端打开模块工程,如若原先已打开其它工程且有未保存的变更,执行本操作将直接丢失所有未保存的数据
9767
+ * @remarks 本操作将会在 EDA 前端打开模块工程,如若原先已打开其它工程且��未保存的变更,执行本操作将直接丢失所有未保存的数据
9342
9768
  * @param cbbUuid - 复用模块 UUID
9343
9769
  * @param libraryUuid - 库 UUID,可以使用 {@link LIB_LibrariesList} 内的接口获取
9344
9770
  */
@@ -9427,14 +9853,14 @@ declare class LIB_Classification {
9427
9853
  * @param libraryType - 库类型
9428
9854
  * @returns 分类信息组成的树结构数据
9429
9855
  */
9430
- getAllClassificationTree(libraryUuid: string, libraryType: ELIB_LibraryType): Promise<{
9856
+ getAllClassificationTree(libraryUuid: string, libraryType: ELIB_LibraryType): Promise<Array<{
9431
9857
  name: string;
9432
9858
  uuid: string;
9433
- children?: {
9859
+ children?: Array<{
9434
9860
  name: string;
9435
9861
  uuid: string;
9436
- }[] | undefined;
9437
- }[]>;
9862
+ }> | undefined;
9863
+ }>>;
9438
9864
  /**
9439
9865
  * 删除指定 UUID 的分类
9440
9866
  *
@@ -9715,17 +10141,20 @@ declare class LIB_Footprint {
9715
10141
  * @remarks 此处所有接口都基于编辑器当前工作区环境,如需切换到其他工作区,请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
9716
10142
  */
9717
10143
  declare class LIB_LibrariesList {
10144
+ /** 扩展 UUID */
10145
+ private extensionUuid?;
10146
+ /* Excluded from this release type: __constructor */
9718
10147
  /**
9719
10148
  * 获取系统库的 UUID
9720
10149
  *
9721
- * @beta
10150
+ * @public
9722
10151
  * @returns 系统库的 UUID
9723
10152
  */
9724
10153
  getSystemLibraryUuid(): Promise<string | undefined>;
9725
10154
  /**
9726
10155
  * 获取个人库的 UUID
9727
10156
  *
9728
- * @beta
10157
+ * @public
9729
10158
  * @remarks 将会获取当前编辑器工作区下的个人库的 UUID,在私有部署环境下不存在个人库,此接口将永远返回 `undefined`
9730
10159
  * @returns 个人库的 UUID
9731
10160
  */
@@ -9733,7 +10162,7 @@ declare class LIB_LibrariesList {
9733
10162
  /**
9734
10163
  * 获取工程库的 UUID
9735
10164
  *
9736
- * @beta
10165
+ * @public
9737
10166
  * @remarks 在未打开工程的情况下调用将返回 `undefined`
9738
10167
  * @returns 工程库的 UUID
9739
10168
  */
@@ -9741,7 +10170,7 @@ declare class LIB_LibrariesList {
9741
10170
  /**
9742
10171
  * 获取收藏库的 UUID
9743
10172
  *
9744
- * @beta
10173
+ * @public
9745
10174
  * @remarks 将会获取当前编辑器工作区下的收藏库的 UUID
9746
10175
  * @returns 收藏库的 UUID
9747
10176
  */
@@ -9749,11 +10178,12 @@ declare class LIB_LibrariesList {
9749
10178
  /**
9750
10179
  * 获取所有库的列表
9751
10180
  *
9752
- * @beta
10181
+ * @public
9753
10182
  * @remarks 此处不会获取到系统库、个人库、工程库、收藏库的信息,如需获取它们的信息,请使用 {@link LIB_LibrariesList.getSystemLibraryUuid | getSystemLibraryUuid}、{@link LIB_LibrariesList.getPersonalLibraryUuid | getPersonalLibraryUuid}、{@link LIB_LibrariesList.getProjectLibraryUuid | getProjectLibraryUuid}、{@link LIB_LibrariesList.getFavoriteLibraryUuid | getFavoriteLibraryUuid} 接口
9754
10183
  * @returns 库信息列表
9755
10184
  */
9756
10185
  getAllLibrariesList(): Promise<Array<ILIB_LibraryInfo>>;
10186
+ /* Excluded from this release type: registerExtendLibrary */
9757
10187
  }
9758
10188
 
9759
10189
  /**
@@ -10798,7 +11228,7 @@ declare class PCB_ManufactureData {
10798
11228
  */
10799
11229
  uploadBomTemplateFile(templateFile: File, template?: string): Promise<string | undefined>;
10800
11230
  /**
10801
- * 获取 BOM 模板���件
11231
+ * 获取 BOM 模板文件
10802
11232
  *
10803
11233
  * @beta
10804
11234
  * @param template - BOM 模板名称
@@ -11955,7 +12385,7 @@ declare class PCB_PrimitivePad implements IPCB_PrimitiveAPI {
11955
12385
  * @beta
11956
12386
  * @remarks 如若传入多个图元 ID,任意图元 ID 未匹配到不影响其它图元的返回,即可能返回少于传入的图元 ID 数量的图元对象
11957
12387
  * @param primitiveIds - 焊盘的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
11958
- * @returns 焊盘图��对象,空数组表示获取失败
12388
+ * @returns 焊盘图元对象,空数组表示获取失败
11959
12389
  */
11960
12390
  get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePad>>;
11961
12391
  /**
@@ -13301,6 +13731,8 @@ declare class SCH_PrimitiveComponent3 implements ISCH_PrimitiveAPI {
13301
13731
  * @returns 器件图元对象
13302
13732
  */
13303
13733
  createShortCircuitFlag(x: number, y: number, rotation?: number, mirror?: boolean): Promise<ISCH_PrimitiveComponent_2 | undefined>;
13734
+ /* Excluded from this release type: createCbbSymbol */
13735
+ /* Excluded from this release type: placeCbbSchematicPage */
13304
13736
  /**
13305
13737
  * 删除器件
13306
13738
  *
@@ -14341,9 +14773,20 @@ declare class SYS_FileSystem {
14341
14773
  *
14342
14774
  * @beta
14343
14775
  * @param filenameExtensions - 文件扩展名
14776
+ * @param multiFiles - 是否允许读取多文件
14777
+ * @returns File 格式文件数组
14778
+ */
14779
+ openReadFileDialog(filenameExtensions?: string | Array<string>, multiFiles?: true): Promise<Array<File> | undefined>;
14780
+ /**
14781
+ * 打开读入文件窗口
14782
+ *
14783
+ * @beta
14784
+ * @param filenameExtensions - 文件扩展名
14785
+ * @param multiFiles - 是否允许读取多文件
14344
14786
  * @returns File 格式文件
14345
14787
  */
14346
- openReadFileDialog(filenameExtensions?: string | Array<string>): Promise<File | undefined>;
14788
+ openReadFileDialog(filenameExtensions?: string | Array<string>, multiFiles?: false): Promise<File | undefined>;
14789
+ /* Excluded from this release type: openReadFolderDialog */
14347
14790
  /**
14348
14791
  * 保存文件
14349
14792
  *
@@ -14496,6 +14939,41 @@ declare class SYS_FontManager {
14496
14939
  deleteFont(fontName: string): Promise<boolean>;
14497
14940
  }
14498
14941
 
14942
+ /**
14943
+ * 系统 / 顶部菜单类
14944
+ *
14945
+ * @public
14946
+ */
14947
+ declare class SYS_HeaderMenu {
14948
+ /** 扩展 UUID */
14949
+ private extensionUuid?;
14950
+ /* Excluded from this release type: __constructor */
14951
+ /**
14952
+ * 导入顶部菜单数据
14953
+ *
14954
+ * @public
14955
+ * @param headerMenus - 顶部菜单数据
14956
+ */
14957
+ insertHeaderMenus(headerMenus: ISYS_HeaderMenus): Promise<void>;
14958
+ /**
14959
+ * 移除顶部菜单数据
14960
+ *
14961
+ * @public
14962
+ */
14963
+ removeHeaderMenus(): void;
14964
+ /**
14965
+ * 替换顶部菜单数据
14966
+ *
14967
+ * @public
14968
+ * @remarks 本接口相当于同时执行了 {@link SYS_HeaderMenu.removeHeaderMenus | 移除} 和 {@link SYS_HeaderMenu.insertHeaderMenus | 导入} 操作
14969
+ * @param headerMenus - 顶部菜单数据
14970
+ */
14971
+ replaceHeaderMenus(headerMenus: ISYS_HeaderMenus): Promise<void>;
14972
+ /* Excluded from this release type: removeSystemHeaderMenuItem */
14973
+ /* Excluded from this release type: insertSystemHeaderMenuItem */
14974
+ /* Excluded from this release type: insertSystemHeaderMenus */
14975
+ }
14976
+
14499
14977
  /**
14500
14978
  * 系统 / 多语言类
14501
14979
  *
@@ -15078,6 +15556,18 @@ declare class SYS_PanelControl {
15078
15556
  isBottomPanelLocked(): Promise<boolean>;
15079
15557
  }
15080
15558
 
15559
+ /**
15560
+ * 系统 / 右键菜单类
15561
+ *
15562
+ * @public
15563
+ */
15564
+ declare class SYS_RightClickMenu {
15565
+ /** 扩展 UUID */
15566
+ private extensionUuid?;
15567
+ /* Excluded from this release type: __constructor */
15568
+ /* Excluded from this release type: changeMenu */
15569
+ }
15570
+
15081
15571
  /**
15082
15572
  * 系统 / 设置类
15083
15573
  *
@@ -15087,6 +15577,7 @@ declare class SYS_Setting {
15087
15577
  /**
15088
15578
  * 全局恢复默认设置
15089
15579
  *
15580
+ * @beta
15090
15581
  * @remarks 将所有 EDA 设置恢复到默认状态,本操作将会丢失所有设置项,在调用时请特别注意
15091
15582
  * @returns 操作是否成功
15092
15583
  */
@@ -15222,7 +15713,7 @@ declare class SYS_Timer {
15222
15713
  private extensionUuid?;
15223
15714
  /* Excluded from this release type: __constructor */
15224
15715
  /**
15225
- * 设置循环定时��
15716
+ * 设置循环定时器
15226
15717
  *
15227
15718
  * @public
15228
15719
  * @remarks 如果遇到 ID 重复的定时器,则之前设置的定时器将被清除
@@ -15292,7 +15783,20 @@ declare class SYS_ToastMessage {
15292
15783
  * @public
15293
15784
  */
15294
15785
  declare class SYS_Tool {
15295
- /* Excluded from this release type: netlistComparison */
15786
+ /**
15787
+ * 网表对比
15788
+ *
15789
+ * @beta
15790
+ * @param netlist1 - 网表 1,可以为当前工程内�� PCB 和原理图的 UUID、网表的文件数据
15791
+ * @param netlist2 - 网表 2,可以为当前工程内的 PCB 和原理图的 UUID、网表的文件数据
15792
+ * @returns 网表对比结果
15793
+ */
15794
+ netlistComparison(netlist1: string | File, netlist2: string | File): Promise<Array<{
15795
+ type: 'Net' | 'Component';
15796
+ object: string;
15797
+ netlist1Name: Array<string>;
15798
+ netlist2Name: Array<string>;
15799
+ }>>;
15296
15800
  }
15297
15801
 
15298
15802
  /**
@@ -15425,7 +15929,7 @@ declare class SYS_Window {
15425
15929
  /**
15426
15930
  * 打开资源窗口
15427
15931
  *
15428
- * @beta
15932
+ * @public
15429
15933
  * @param url - 欲加载资源的 URL 或路径
15430
15934
  * @param target - 上下文目标
15431
15935
  */
@@ -15433,7 +15937,7 @@ declare class SYS_Window {
15433
15937
  /**
15434
15938
  * 新增事件监听
15435
15939
  *
15436
- * @beta
15940
+ * @public
15437
15941
  * @param type - 事件类型,当前支持 `blur` `focus`
15438
15942
  * @param listener - 事件监听回调
15439
15943
  * @param options - 可选参数
@@ -15448,11 +15952,21 @@ declare class SYS_Window {
15448
15952
  /**
15449
15953
  * 移除事件监听
15450
15954
  *
15451
- * @beta
15955
+ * @public
15452
15956
  * @param removableObject - 窗口事件监听可移除对象
15453
15957
  */
15454
15958
  removeEventListener(removableObject: ISYS_WindowEventListenerRemovableObject): void;
15455
- /* Excluded from this release type: openUI */
15959
+ /**
15960
+ * 打开 UI 窗口
15961
+ *
15962
+ * @public
15963
+ * @remarks 非公开接口使用提醒:本接口按原样提供,不提供参数的额外文档,参数可能在任何版本出现破坏性更改并不另行通知
15964
+ * @param uiName - UI 名称
15965
+ * @param args - 可选参数对象
15966
+ */
15967
+ openUI(uiName: string, args?: {
15968
+ [key: string]: any;
15969
+ }): Promise<void>;
15456
15970
  /**
15457
15971
  * 获取当前主题
15458
15972
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jlceda/pro-api-types",
3
- "version": "0.1.170",
3
+ "version": "0.1.172",
4
4
  "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
5
5
  "typings": "index.d.ts",
6
6
  "keywords": [