Home > LIB_Symbol > copy

LIB_Symbol.copy() 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.

Copy Symbol

Signature

function copy(
	symbolUuid: string,
	libraryUuid: string,
	targetLibraryUuid: string,
	targetClassification?: ILIB_ClassificationIndex | Array<string>,
	newSymbolName?: string,
): Promise<string | undefined>;

Parameters

Parameter	Type	Description
symbolUuid	string	Symbol UUID
libraryUuid	string	Library UUID, you can use LIB_LibrariesList APIs in
targetLibraryUuid	string	Target library UUID
targetClassification	ILIB_ClassificationIndex | Array<string>	(Optional) Classification in the target library
newSymbolName	string	(Optional) New symbol name. If a symbol with the same name exists in the target library, the copy will fail

Returns

Promise<string | undefined>

UUID of the new symbol in the target library

Example

// 1. 列出系统库符号（关键字传空 = 列出全部），取一个作为复制来源
const [source] = await eda.lib_Symbol.search('', undefined, [], undefined, 1, 1);

// 2. 获取个人库 UUID
const targetLibraryUuid = await eda.lib_LibrariesList.getPersonalLibraryUuid();

// 3. 从系统库复制到个人库，指定新名称避免同名冲突（分类传 [] = 不分类）
const newName = `嘉立创示例_符号副本_${Date.now()}`;
const copiedUuid = await eda.lib_Symbol.copy(
	source.uuid,
	source.libraryUuid,
	targetLibraryUuid,
	[],
	newName
);

// 创建类保留现场（副本留在个人库中供观察）

console.log('sourceUuid:', source.uuid);
console.log('copiedUuid:', copiedUuid);
console.log('newName:', newName);