Home > SYS_FileManager > importProjectByProjectFile

SYS_FileManager.importProjectByProjectFile() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Use project file import project

Signature

function importProjectByProjectFile(
	projectFile: File,
	fileType?:
		| 'JLCEDA'
		| 'JLCEDA Pro'
		| 'EasyEDA'
		| 'EasyEDA Pro'
		| 'Allegro'
		| 'OrCAD'
		| 'EAGLE'
		| 'KiCad'
		| 'PADS'
		| 'LTspice',
	props?: {
		importOption?:
			| undefined
			| ESYS_ImportProjectImportOption.IMPORT_DOCUMENT
			| ESYS_ImportProjectImportOption.EXTRACT_LIBRARIES
			| ESYS_ImportProjectImportOption.IMPORT_DOCUMENT_EXTRACT_LIBRARIES;
		schematicObjectStyle?:
			| undefined
			| ESYS_ImportProjectSchematicObjectStyle.USE_SYSTEM_THEME
			| ESYS_ImportProjectSchematicObjectStyle.USE_SOURCE_FILE_STYLE;
		associateFootprint?: undefined | false | true;
		associate3DModel?: undefined | false | true;
		importFootprintNotesLayer?: undefined | false | true;
	},
	saveTo?:
		| {
			operation: 'New Project';
			newProjectOwnerTeamUuid: string;
			newProjectOwnerFolderUuid?: undefined | string;
			newProjectName?: undefined | string;
			newProjectFriendlyName?: undefined | string;
			newProjectDescription?: undefined | string;
			newProjectCollaborationMode?:
				| undefined
				| EDMT_ProjectCollaborationMode.STRICT
				| EDMT_ProjectCollaborationMode.FREE;
		}
		| { operation: 'Existing Project'; existingProjectUuid: string },
	librariesImportSetting?: {
		ownerTeamUuid: string;
		deviceClassification?: undefined | string[];
		symbolClassification?: undefined | string[];
		footprintClassification?: undefined | string[];
		createDeviceForSingleSymbol?: undefined | false | true;
		updateExistingLibrariesWithTheSameName?: undefined | false | true;
	},
): Promise<IDMT_BriefProjectItem | undefined>;

Parameters

Parameter	Type	Description
projectFile	File	Project file
fileType	'JLCEDA' | 'JLCEDA Pro' | 'EasyEDA' | 'EasyEDA Pro' | 'Allegro' | 'OrCAD' | 'EAGLE' | 'KiCad' | 'PADS' | 'LTspice'	(Optional) File type
props	{ importOption?: undefined | ESYS_ImportProjectImportOption.IMPORT_DOCUMENT | ESYS_ImportProjectImportOption.EXTRACT_LIBRARIES | ESYS_ImportProjectImportOption.IMPORT_DOCUMENT_EXTRACT_LIBRARIES; schematicObjectStyle?: undefined | ESYS_ImportProjectSchematicObjectStyle.USE_SYSTEM_THEME | ESYS_ImportProjectSchematicObjectStyle.USE_SOURCE_FILE_STYLE; associateFootprint?: undefined | false | true; associate3DModel?: undefined | false | true; importFootprintNotesLayer?: undefined | false | true }	(Optional) Import parameters. Refer to the configuration items in the **Import** window of the EDA front end
saveTo	{ operation: 'New Project'; newProjectOwnerTeamUuid: string; newProjectOwnerFolderUuid?: undefined | string; newProjectName?: undefined | string; newProjectFriendlyName?: undefined | string; newProjectDescription?: undefined | string; newProjectCollaborationMode?: undefined | EDMT_ProjectCollaborationMode.STRICT | EDMT_ProjectCollaborationMode.FREE } |	(Optional) Save To project parameter
librariesImportSetting	{ ownerTeamUuid: string; deviceClassification?: undefined | string[]; symbolClassification?: undefined | string[]; footprintClassification?: undefined | string[]; createDeviceForSingleSymbol?: undefined | false | true; updateExistingLibrariesWithTheSameName?: undefined | false | true }	(Optional)

Returns

Promise<IDMT_BriefProjectItem | undefined>

Brief project properties of the imported project

Remarks

Extracting library-related configurations is not supported yet. If the library needs to be extracted, it will be extracted according to the default configuration