ISCH_PrimitiveComponent.md

ISCH_PrimitiveComponent class

器件图元

Signature

declare class ISCH_PrimitiveComponent implements ISCH_Primitive 

Implements: ISCH_Primitive

Remarks

Properties

Property	Modifiers	Type	Description
async	protected	boolean	异步
designator?	protected	string	(Optional) Component 属性：位号
mirror	protected	boolean	是否镜像
name?	protected	string	(Optional) Component 属性：名称
otherProperty?	protected	{ [key: string]: string | number | boolean; }	(Optional) 其它参数
primitiveId?	protected	string	(Optional) 图元 ID
rotation	protected	number	旋转角度
x	protected	number	坐标 X
y	protected	number	坐标 Y

Methods

Method	Modifiers	Description
done()		(BETA) 将对图元的更改应用到画布
getState_AddIntoBom()		获取属性状态：是否加入 BOM
getState_AddIntoPcb()		获取属性状态：是否转到 PCB
getState_Component()		获取属性状态：关联库器件
getState_ComponentType()		获取属性状态：器件类型
getState_Designator()		获取属性状态：位号
getState_Footprint()		获取属性状态：关联库封装
getState_Manufacturer()		获取属性状态：制造商
getState_ManufacturerId()		获取属性状态：制造商编号
getState_Mirror()		获取属性状态：是否镜像
getState_Name()		获取属性状态：名称
getState_Net()		获取属性状态：网络名称
getState_OtherProperty()		获取属性状态：其它参数
getState_PrimitiveId()		获取属性状态：图元 ID
getState_PrimitiveType()		获取属性状态：图元类型
getState_Rotation()		获取属性状态：旋转角度
getState_SubPartName()		获取属性状态：子部件名称
getState_Supplier()		获取属性状态：供应商
getState_SupplierId()		获取属性状态：供应商编号
getState_Symbol()		获取属性状态：关联库符号
getState_UniqueId()		获取属性状态：唯一 ID
getState_X()		获取属性状态：坐标 X
getState_Y()		获取属性状态：坐标 Y
isAsync()		查询图元是否为异步图元
reset()		(BETA) 将异步图元重置为当前画布状态
setState_AddIntoBom(addIntoBom)		(BETA) 设置属性状态：是否加入 BOM
setState_AddIntoPcb(addIntoPcb)		(BETA) 设置属性状态：是否转到 PCB
setState_Designator(designator)		(BETA) 设置属性状态：位号
setState_Manufacturer(manufacturer)		(BETA) 设置属性状态：制造商
setState_ManufacturerId(manufacturerId)		(BETA) 设置属性状态：制造商编号
setState_Mirror(mirror)		(BETA) 设置属性状态：是否镜像
setState_Name(name)		(BETA) 设置属性状态：名称
setState_Net(net)		(BETA) 设置属性状态：网络名称
setState_OtherProperty(otherProperty)		(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()		将图元转换为同步图元

---

属性详情

async

ISCH_PrimitiveComponent.async property

异步

Signature

protected async: boolean;

designator

ISCH_PrimitiveComponent.designator property

Component 属性：位号

Signature

protected designator?: string;

mirror

ISCH_PrimitiveComponent.mirror property

是否镜像

Signature

protected mirror: boolean;

name

ISCH_PrimitiveComponent.name property

Component 属性：名称

Signature

protected name?: string;

otherproperty

ISCH_PrimitiveComponent.otherProperty property

其它参数

Signature

protected otherProperty?: {
        [key: string]: string | number | boolean;
    };

primitiveid

ISCH_PrimitiveComponent.primitiveId property

图元 ID

Signature

protected primitiveId?: string;

rotation

ISCH_PrimitiveComponent.rotation property

旋转角度

Signature

protected rotation: number;

x

ISCH_PrimitiveComponent.x property

坐标 X

Signature

protected x: number;

y

ISCH_PrimitiveComponent.y property

坐标 Y

Signature

protected y: number;

---

方法详情

done

ISCH_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<ISCH_PrimitiveComponent>;

Returns

Promise<ISCH_PrimitiveComponent>

器件图元对象

getstate_addintobom

ISCH_PrimitiveComponent.getState_AddIntoBom() method

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

Signature

getState_AddIntoBom(): boolean | undefined;

Returns

boolean | undefined

是否加入 BOM

getstate_addintopcb

ISCH_PrimitiveComponent.getState_AddIntoPcb() method

获取属性状态：是否转到 PCB

Signature

getState_AddIntoPcb(): boolean | undefined;

Returns

boolean | undefined

是否转到 PCB

getstate_component

ISCH_PrimitiveComponent.getState_Component() method

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

Signature

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

Returns

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

关联库器件

getstate_componenttype

ISCH_PrimitiveComponent.getState_ComponentType() method

获取属性状态：器件类型

Signature

getState_ComponentType(): ESCH_PrimitiveComponentType;

Returns

ESCH_PrimitiveComponentType

器件类型

getstate_designator

ISCH_PrimitiveComponent.getState_Designator() method

获取属性状态：位号

Signature

getState_Designator(): string | undefined;

Returns

string | undefined

位号

getstate_footprint

ISCH_PrimitiveComponent.getState_Footprint() method

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

Signature

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

Returns

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

关联库封装

getstate_manufacturer

ISCH_PrimitiveComponent.getState_Manufacturer() method

获取属性状态：制造商

Signature

getState_Manufacturer(): string | undefined;

Returns

string | undefined

制造商

getstate_manufacturerid

ISCH_PrimitiveComponent.getState_ManufacturerId() method

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

Signature

getState_ManufacturerId(): string | undefined;

Returns

string | undefined

制造商编号

getstate_mirror

ISCH_PrimitiveComponent.getState_Mirror() method

获取属性状态：是否镜像

Signature

getState_Mirror(): boolean;

Returns

boolean

是否镜像

getstate_name

ISCH_PrimitiveComponent.getState_Name() method

获取属性状态：名称

Signature

getState_Name(): string | undefined;

Returns

string | undefined

名称

getstate_net

ISCH_PrimitiveComponent.getState_Net() method

获取属性状态：网络名称

Signature

getState_Net(): string | undefined;

Returns

string | undefined

网络名称

getstate_otherproperty

ISCH_PrimitiveComponent.getState_OtherProperty() method

获取属性状态：其它参数

Signature

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

Returns

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

其它参数

getstate_primitiveid

ISCH_PrimitiveComponent.getState_PrimitiveId() method

获取属性状态：图元 ID

Signature

getState_PrimitiveId(): string;

Returns

string

图元 ID

getstate_primitivetype

ISCH_PrimitiveComponent.getState_PrimitiveType() method

获取属性状态：图元类型

Signature

getState_PrimitiveType(): ESCH_PrimitiveType;

Returns

ESCH_PrimitiveType

图元类型

getstate_rotation

ISCH_PrimitiveComponent.getState_Rotation() method

获取属性状态：旋转角度

Signature

getState_Rotation(): number;

Returns

number

旋转角度

getstate_subpartname

ISCH_PrimitiveComponent.getState_SubPartName() method

获取属性状态：子部件名称

Signature

getState_SubPartName(): string | undefined;

Returns

string | undefined

子部件名称

getstate_supplier

ISCH_PrimitiveComponent.getState_Supplier() method

获取属性状态：供应商

Signature

getState_Supplier(): string | undefined;

Returns

string | undefined

供应商

getstate_supplierid

ISCH_PrimitiveComponent.getState_SupplierId() method

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

Signature

getState_SupplierId(): string | undefined;

Returns

string | undefined

供应商编号

getstate_symbol

ISCH_PrimitiveComponent.getState_Symbol() method

获取属性状态：关联库符号

Signature

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

Returns

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

关联库符号

getstate_uniqueid

ISCH_PrimitiveComponent.getState_UniqueId() method

获取属性状态：唯一 ID

Signature

getState_UniqueId(): string | undefined;

Returns

string | undefined

唯一 ID

getstate_x

ISCH_PrimitiveComponent.getState_X() method

获取属性状态：坐标 X

Signature

getState_X(): number;

Returns

number

坐标 X

getstate_y

ISCH_PrimitiveComponent.getState_Y() method

获取属性状态：坐标 Y

Signature

getState_Y(): number;

Returns

number

坐标 Y

isasync

ISCH_PrimitiveComponent.isAsync() method

查询图元是否为异步图元

Signature

isAsync(): boolean;

Returns

boolean

是否为异步图元

reset

ISCH_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<ISCH_PrimitiveComponent>;

Returns

Promise<ISCH_PrimitiveComponent>

器件图元对象

setstate_addintobom

ISCH_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 | undefined): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
addIntoBom	boolean | undefined	是否加入 BOM

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_addintopcb

ISCH_PrimitiveComponent.setState_AddIntoPcb() 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.

设置属性状态：是否转到 PCB

Signature

setState_AddIntoPcb(addIntoPcb: boolean | undefined): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
addIntoPcb	boolean | undefined	是否转到 PCB

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_designator

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
designator	string | undefined	位号

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_manufacturer

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
manufacturer	string | undefined	制造商

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_manufacturerid

ISCH_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): ISCH_PrimitiveComponent;

Parameters

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

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_mirror

ISCH_PrimitiveComponent.setState_Mirror() 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_Mirror(mirror: boolean): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
mirror	boolean	是否镜像

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_name

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
name	string | undefined	名称

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_net

ISCH_PrimitiveComponent.setState_Net() 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_Net(net: string | undefined): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
net	string | undefined	网络名称

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_otherproperty

ISCH_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;
    }): ISCH_PrimitiveComponent;

Parameters

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

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_rotation

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
rotation	number	旋转角度

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_supplier

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
supplier	string | undefined	供应商

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_supplierid

ISCH_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): ISCH_PrimitiveComponent;

Parameters

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

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_uniqueid

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
uniqueId	string | undefined	唯一 ID

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_x

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
x	number	坐标 X

Returns

ISCH_PrimitiveComponent

器件图元对象

setstate_y

ISCH_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): ISCH_PrimitiveComponent;

Parameters

Parameter	Type	Description
y	number	坐标 Y

Returns

ISCH_PrimitiveComponent

器件图元对象

toasync

ISCH_PrimitiveComponent.toAsync() method

将图元转换为异步图元

Signature

toAsync(): ISCH_PrimitiveComponent;

Returns

ISCH_PrimitiveComponent

圆弧线图元对象

tosync

ISCH_PrimitiveComponent.toSync() method

将图元转换为同步图元

Signature

toSync(): ISCH_PrimitiveComponent;

Returns

ISCH_PrimitiveComponent

圆弧线图元对象