IPCB_PrimitiveComponent.md

IPCB_PrimitiveComponent class

器件图元

Signature

declare class IPCB_PrimitiveComponent implements IPCB_Primitive 

Implements: IPCB_Primitive

Remarks

Methods

Method	Modifiers	Description
done()		(BETA) 将对图元的更改应用到画布
getAllPins()		(BETA) 获取器件关联的所有焊盘
getState_AddIntoBom()		获取属性状态：是否加入 BOM
getState_Component()		获取属性状态：关联库器件
getState_Designator()		获取属性状态：位号
getState_Footprint()		获取属性状态：关联库封装
getState_Layer()		获取属性状态：层
getState_Manufacturer()		获取属性状态：制造商
getState_ManufacturerId()		获取属性状态：制造商编号
getState_Model3D()		获取属性状态：关联库 3D 模型
getState_Name()		获取属性状态：名称
getState_OtherProperty()		获取属性状态：其它参数
getState_Pads()		获取属性状态：焊盘
getState_PrimitiveId()		获取属性状态：图元 ID
getState_PrimitiveLock()		获取属性状态：是否锁定
getState_PrimitiveType()		获取属性状态：图元类型
getState_Rotation()		获取属性状态：旋转角度
getState_Supplier()		获取属性状态：供应商
getState_SupplierId()		获取属性状态：供应商编号
getState_UniqueId()		获取属性状态：唯一 ID
getState_X()		获取属性状态：坐标 X
getState_Y()		获取属性状态：坐标 Y
isAsync()		查询图元是否为异步图元
reset()		(BETA) 将异步图元重置为当前画布状态
setState_AddIntoBom(addIntoBom)		(BETA) 设置属性状态：是否加入 BOM
setState_Designator(designator)		(BETA) 设置属性状态：位号
setState_Layer(layer)		(BETA) 设置属性状态：层
setState_Manufacturer(manufacturer)		(BETA) 设置属性状态：制造商
setState_ManufacturerId(manufacturerId)		(BETA) 设置属性状态：制造商编号
setState_Name(name)		(BETA) 设置属性状态：名称
setState_OtherProperty(otherProperty)		(BETA) 设置属性状态：其它参数
setState_PrimitiveLock(primitiveLock)		(BETA) 设置属性状态：是否锁定
setState_Rotation(rotation)		(BETA) 设置属性状态：旋转角度
setState_Supplier(supplier)		(BETA) 设置属性状态：供应商
setState_SupplierId(supplierId)		(BETA) 设置属性状态：供应商编号
setState_UniqueId(uniqueId)		(BETA) 设置属性状态：唯一 ID
setState_X(x)		(BETA) 设置属性状态：坐标 X
setState_Y(y)		(BETA) 设置属性状态：坐标 Y
toAsync()		将图元转换为异步图元
toSync()		将图元转换为同步图元

---

方法详情

done

IPCB_PrimitiveComponent.done() 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.

将对图元的更改应用到画布

Signature

done(): Promise<IPCB_PrimitiveComponent>;

Returns

Promise<IPCB_PrimitiveComponent>

器件图元对象

getallpins

IPCB_PrimitiveComponent.getAllPins() 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.

获取器件关联的所有焊盘

Signature

getAllPins(): Promise<Array<IPCB_PrimitiveComponentPad>>;

Returns

Promise<Array<IPCB_PrimitiveComponentPad>>

器件焊盘图元数组

getstate_addintobom

IPCB_PrimitiveComponent.getState_AddIntoBom() method

获取属性状态：是否加入 BOM

Signature

getState_AddIntoBom(): boolean;

Returns

boolean

是否加入 BOM

getstate_component

IPCB_PrimitiveComponent.getState_Component() method

获取属性状态：关联库器件

Signature

getState_Component(): {
        libraryUuid: string;
        uuid: string;
        name?: string;
    } | undefined;

Returns

{ libraryUuid: string; uuid: string; name?: string; } | undefined

关联库器件

getstate_designator

IPCB_PrimitiveComponent.getState_Designator() method

获取属性状态：位号

Signature

getState_Designator(): string | undefined;

Returns

string | undefined

位号

getstate_footprint

IPCB_PrimitiveComponent.getState_Footprint() method

获取属性状态：关联库封装

Signature

getState_Footprint(): {
        libraryUuid: string;
        uuid: string;
        name?: string;
    } | undefined;

Returns

{ libraryUuid: string; uuid: string; name?: string; } | undefined

关联库封装

getstate_layer

IPCB_PrimitiveComponent.getState_Layer() method

获取属性状态：层

Signature

getState_Layer(): TPCB_LayersOfComponent;

Returns

TPCB_LayersOfComponent

层

getstate_manufacturer

IPCB_PrimitiveComponent.getState_Manufacturer() method

获取属性状态：制造商

Signature

getState_Manufacturer(): string | undefined;

Returns

string | undefined

制造商

getstate_manufacturerid

IPCB_PrimitiveComponent.getState_ManufacturerId() method

获取属性状态：制造商编号

Signature

getState_ManufacturerId(): string | undefined;

Returns

string | undefined

制造商编号

getstate_model3d

IPCB_PrimitiveComponent.getState_Model3D() method

获取属性状态：关联库 3D 模型

Signature

getState_Model3D(): {
        libraryUuid: string;
        uuid: string;
        name?: string;
    } | undefined;

Returns

{ libraryUuid: string; uuid: string; name?: string; } | undefined

关联库 3D 模型

getstate_name

IPCB_PrimitiveComponent.getState_Name() method

获取属性状态：名称

Signature

getState_Name(): string | undefined;

Returns

string | undefined

名称

getstate_otherproperty

IPCB_PrimitiveComponent.getState_OtherProperty() method

获取属性状态：其它参数

Signature

getState_OtherProperty(): {
        [key: string]: string | number | boolean;
    } | undefined;

Returns

{ [key: string]: string | number | boolean; } | undefined

其它参数

getstate_pads

IPCB_PrimitiveComponent.getState_Pads() method

获取属性状态：焊盘

Signature

getState_Pads(): Array<{
        primitiveId: string;
        net: string;
        padNumber: string;
    }> | undefined;

Returns

Array<{ primitiveId: string; net: string; padNumber: string; }> | undefined

焊盘

getstate_primitiveid

IPCB_PrimitiveComponent.getState_PrimitiveId() method

获取属性状态：图元 ID

Signature

getState_PrimitiveId(): string;

Returns

string

图元 ID

getstate_primitivelock

IPCB_PrimitiveComponent.getState_PrimitiveLock() method

获取属性状态：是否锁定

Signature

getState_PrimitiveLock(): boolean;

Returns

boolean

是否锁定

getstate_primitivetype

IPCB_PrimitiveComponent.getState_PrimitiveType() method

获取属性状态：图元类型

Signature

getState_PrimitiveType(): EPCB_PrimitiveType;

Returns

EPCB_PrimitiveType

图元类型

getstate_rotation

IPCB_PrimitiveComponent.getState_Rotation() method

获取属性状态：旋转角度

Signature

getState_Rotation(): number;

Returns

number

旋转角度

getstate_supplier

IPCB_PrimitiveComponent.getState_Supplier() method

获取属性状态：供应商

Signature

getState_Supplier(): string | undefined;

Returns

string | undefined

供应商

getstate_supplierid

IPCB_PrimitiveComponent.getState_SupplierId() method

获取属性状态：供应商编号

Signature

getState_SupplierId(): string | undefined;

Returns

string | undefined

供应商编号

getstate_uniqueid

IPCB_PrimitiveComponent.getState_UniqueId() method

获取属性状态：唯一 ID

Signature

getState_UniqueId(): string | undefined;

Returns

string | undefined

唯一 ID

getstate_x

IPCB_PrimitiveComponent.getState_X() method

获取属性状态：坐标 X

Signature

getState_X(): number;

Returns

number

坐标 X

getstate_y

IPCB_PrimitiveComponent.getState_Y() method

获取属性状态：坐标 Y

Signature

getState_Y(): number;

Returns

number

坐标 Y

isasync

IPCB_PrimitiveComponent.isAsync() method

查询图元是否为异步图元

Signature

isAsync(): boolean;

Returns

boolean

是否为异步图元

reset

IPCB_PrimitiveComponent.reset() 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.

将异步图元重置为当前画布状态

Signature

reset(): Promise<IPCB_PrimitiveComponent>;

Returns

Promise<IPCB_PrimitiveComponent>

器件图元对象

setstate_addintobom

IPCB_PrimitiveComponent.setState_AddIntoBom() 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.

设置属性状态：是否加入 BOM

Signature

setState_AddIntoBom(addIntoBom: boolean): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
addIntoBom	boolean	是否加入 BOM

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_designator

IPCB_PrimitiveComponent.setState_Designator() 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.

设置属性状态：位号

Signature

setState_Designator(designator: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
designator	string | undefined	位号

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_layer

IPCB_PrimitiveComponent.setState_Layer() 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.

设置属性状态：层

Signature

setState_Layer(layer: TPCB_LayersOfComponent): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfComponent	层

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_manufacturer

IPCB_PrimitiveComponent.setState_Manufacturer() 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.

设置属性状态：制造商

Signature

setState_Manufacturer(manufacturer: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
manufacturer	string | undefined	制造商

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_manufacturerid

IPCB_PrimitiveComponent.setState_ManufacturerId() 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.

设置属性状态：制造商编号

Signature

setState_ManufacturerId(manufacturerId: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
manufacturerId	string | undefined	制造商编号

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_name

IPCB_PrimitiveComponent.setState_Name() 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.

设置属性状态：名称

Signature

setState_Name(name: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
name	string | undefined	名称

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_otherproperty

IPCB_PrimitiveComponent.setState_OtherProperty() 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.

设置属性状态：其它参数

Signature

setState_OtherProperty(otherProperty: {
        [key: string]: string | number | boolean;
    }): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
otherProperty	{ [key: string]: string | number | boolean; }	其它参数

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_primitivelock

IPCB_PrimitiveComponent.setState_PrimitiveLock() 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.

设置属性状态：是否锁定

Signature

setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
primitiveLock	boolean	是否锁定

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_rotation

IPCB_PrimitiveComponent.setState_Rotation() 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.

设置属性状态：旋转角度

Signature

setState_Rotation(rotation: number): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
rotation	number	旋转角度

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_supplier

IPCB_PrimitiveComponent.setState_Supplier() 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.

设置属性状态：供应商

Signature

setState_Supplier(supplier: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
supplier	string | undefined	供应商

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_supplierid

IPCB_PrimitiveComponent.setState_SupplierId() 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.

设置属性状态：供应商编号

Signature

setState_SupplierId(supplierId: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
supplierId	string | undefined	供应商编号

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_uniqueid

IPCB_PrimitiveComponent.setState_UniqueId() 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.

设置属性状态：唯一 ID

Signature

setState_UniqueId(uniqueId: string | undefined): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
uniqueId	string | undefined	唯一 ID

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_x

IPCB_PrimitiveComponent.setState_X() 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.

设置属性状态：坐标 X

Signature

setState_X(x: number): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
x	number	坐标 X

Returns

IPCB_PrimitiveComponent

器件图元对象

setstate_y

IPCB_PrimitiveComponent.setState_Y() 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.

设置属性状态：坐标 Y

Signature

setState_Y(y: number): IPCB_PrimitiveComponent;

Parameters

Parameter	Type	Description
y	number	坐标 Y

Returns

IPCB_PrimitiveComponent

器件图元对象

toasync

IPCB_PrimitiveComponent.toAsync() method

将图元转换为异步图元

Signature

toAsync(): IPCB_PrimitiveComponent;

Returns

IPCB_PrimitiveComponent

器件图元对象

tosync

IPCB_PrimitiveComponent.toSync() method

将图元转换为同步图元

Signature

toSync(): IPCB_PrimitiveComponent;

Returns

IPCB_PrimitiveComponent

器件图元对象