Home > SYS_FileManager > importProjectByProjectFile

SYS_FileManager.importProjectByProjectFile() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

使用工程文件导入工程

签名

function importProjectByProjectFile(
	projectFile: File,
	fileType?: 'Altium Designer' | 'Protel',
	props?: {
		importOption?: ESYS_ImportProjectImportOption;
		viaSolderMaskExpansion?: ESYS_ImportProjectViaSolderMaskExpansion;
		boardOutlineSource?: ESYS_ImportProjectBoardOutlineSource;
		schematicObjectStyle?: ESYS_ImportProjectSchematicObjectStyle;
		associateFootprint?: boolean;
		associate3DModel?: boolean;
		importFootprintNotesLayer?: boolean;
	},
	saveTo?:
		| {
			operation: 'New Project';
			newProjectOwnerTeamUuid: IDMT_TeamItem['uuid'];
			newProjectOwnerFolderUuid?: IDMT_FolderItem['uuid'];
			newProjectName?: string;
			newProjectFriendlyName?: string;
			newProjectDescription?: string;
			newProjectCollaborationMode?: EDMT_ProjectCollaborationMode;
		}
		| { operation: 'Existing Project'; existingProjectUuid: IDMT_BriefProjectItem['uuid'] }
		| { operation: 'Offline Client Local Path'; folderPath: string },
	librariesImportSetting?: {
		ownerTeamUuid: IDMT_TeamItem['uuid'];
		deviceClassification?: Array<string>;
		symbolClassification?: Array<string>;
		footprintClassification?: Array<string>;
		createDeviceForSingleSymbol?: boolean;
		updateExistingLibrariesWithTheSameName?: boolean;
	},
): Promise<IDMT_BriefProjectItem | undefined>;

参数名

参数	类型	描述
projectFile	File	工程文件
fileType	'Altium Designer' | 'Protel'	（可选） 文件类型
props	{ importOption?: ESYS_ImportProjectImportOption; viaSolderMaskExpansion?: ESYS_ImportProjectViaSolderMaskExpansion; boardOutlineSource?: ESYS_ImportProjectBoardOutlineSource; schematicObjectStyle?: ESYS_ImportProjectSchematicObjectStyle; associateFootprint?: boolean; associate3DModel?: boolean; importFootprintNotesLayer?: boolean }	（可选） 导入参数，参考 EDA 前端 **导入** 窗口内的配置项
saveTo	{ operation: 'New Project'; newProjectOwnerTeamUuid: IDMT_TeamItem['uuid']; newProjectOwnerFolderUuid?: IDMT_FolderItem['uuid']; newProjectName?: string; newProjectFriendlyName?: string; newProjectDescription?: string; newProjectCollaborationMode?: EDMT_ProjectCollaborationMode } | { operation: 'Existing Project'; existingProjectUuid: IDMT_BriefProjectItem['uuid'] } |	（可选） 保存到工程参数 Offline Client Local Path 仅离线客户端可用，该形态在 folderPath 下创建客户端本地工程， 同名工程已存在时报错不覆盖，该形态需要启用扩展的外部交互权限，如若未启用将始终 throw Error
librariesImportSetting	{ ownerTeamUuid: IDMT_TeamItem['uuid']; deviceClassification?: Array<string>; symbolClassification?: Array<string>; footprintClassification?: Array<string>; createDeviceForSingleSymbol?: boolean; updateExistingLibrariesWithTheSameName?: boolean }	（可选） 库导入配置

返回值

Promise<IDMT_BriefProjectItem | undefined>

导入的工程的简略工程属性

Offline Client Local Path 形态的字段语义（客户端本地工程）： - uuid 为客户端本地工程标识（工程文件绝对路径的 SHA-256），可用于打开工程、在客户端工程列表中定位； - friendlyName 为本地工程名； - teamUuid 填充的是本地用户 UUID（离线客户端无团队概念，语义为工程归属者）； - folderUuid 恒为 undefined（离线客户端无文件夹概念）

备注

暂不支持提取库的相关配置，如果需求提取库，将会按照默认配置提取