IPCB_PrimitiveObject.md

IPCB_PrimitiveObject class

二进制内嵌对象图元

Signature

declare class IPCB_PrimitiveObject implements IPCB_Primitive 

Implements: IPCB_Primitive

Remarks

Methods

Method	Modifiers	Description
done()		(BETA) 将对图元的更改应用到画布
getState_BinaryData()		获取属性状态：二进制数据
getState_FileName()		获取属性状态：文件名
getState_Height()		获取属性状态：高
getState_Layer()		获取属性状态：层
getState_Mirror()		获取属性状态：是否水平镜像
getState_PrimitiveId()		获取属性状态：图元 ID
getState_PrimitiveLock()		获取属性状态：是否锁定
getState_PrimitiveType()		获取属性状态：图元类型
getState_Rotation()		获取属性状态：旋转角度
getState_TopLeftX()		获取属性状态：左上点 X
getState_TopLeftY()		获取属性状态：左上点 Y
getState_Width()		获取属性状态：宽
isAsync()		查询图元是否为异步图元
reset()		(BETA) 将异步图元重置为当前画布状态
setState_BinaryData(binaryData)		设置属性状态：二进制数据
setState_FileName(fileName)		设置属性状态：文件名
setState_Height(height)		设置属性状态：高
setState_Layer(layer)		(BETA) 设置属性状态：层
setState_Mirror(mirror)		设置属性状态：是否水平镜像
setState_PrimitiveLock(primitiveLock)		(BETA) 设置属性状态：是否锁定
setState_Rotation(rotation)		设置属性状态：旋转角度
setState_TopLeftX(topLeftX)		设置属性状态：左上点 X
setState_TopLeftY(topLeftY)		设置属性状态：左上点 Y
setState_Width(width)		设置属性状态：宽
toAsync()		将图元转换为异步图元
toSync()		将图元转换为同步图元

---

方法详情

done

IPCB_PrimitiveObject.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_PrimitiveObject>;

Returns

Promise<IPCB_PrimitiveObject>

二进制内嵌对象图元对象

getstate_binarydata

IPCB_PrimitiveObject.getState_BinaryData() method

获取属性状态：二进制数据

Signature

getState_BinaryData(): string;

Returns

string

二进制数据

getstate_filename

IPCB_PrimitiveObject.getState_FileName() method

获取属性状态：文件名

Signature

getState_FileName(): string;

Returns

string

文件名

getstate_height

IPCB_PrimitiveObject.getState_Height() method

获取属性状态：高

Signature

getState_Height(): number;

Returns

number

高

getstate_layer

IPCB_PrimitiveObject.getState_Layer() method

获取属性状态：层

Signature

getState_Layer(): TPCB_LayersOfObject | undefined;

Returns

TPCB_LayersOfObject | undefined

层

getstate_mirror

IPCB_PrimitiveObject.getState_Mirror() method

获取属性状态：是否水平镜像

Signature

getState_Mirror(): boolean;

Returns

boolean

是否水平镜像

getstate_primitiveid

IPCB_PrimitiveObject.getState_PrimitiveId() method

获取属性状态：图元 ID

Signature

getState_PrimitiveId(): string;

Returns

string

图元 ID

getstate_primitivelock

IPCB_PrimitiveObject.getState_PrimitiveLock() method

获取属性状态：是否锁定

Signature

getState_PrimitiveLock(): boolean;

Returns

boolean

是否锁定

getstate_primitivetype

IPCB_PrimitiveObject.getState_PrimitiveType() method

获取属性状态：图元类型

Signature

getState_PrimitiveType(): EPCB_PrimitiveType;

Returns

EPCB_PrimitiveType

图元类型

getstate_rotation

IPCB_PrimitiveObject.getState_Rotation() method

获取属性状态：旋转角度

Signature

getState_Rotation(): number;

Returns

number

旋转角度

getstate_topleftx

IPCB_PrimitiveObject.getState_TopLeftX() method

获取属性状态：左上点 X

Signature

getState_TopLeftX(): number | undefined;

Returns

number | undefined

左上点 X

getstate_toplefty

IPCB_PrimitiveObject.getState_TopLeftY() method

获取属性状态：左上点 Y

Signature

getState_TopLeftY(): number | undefined;

Returns

number | undefined

左上点 Y

getstate_width

IPCB_PrimitiveObject.getState_Width() method

获取属性状态：宽

Signature

getState_Width(): number;

Returns

number

宽

isasync

IPCB_PrimitiveObject.isAsync() method

查询图元是否为异步图元

Signature

isAsync(): boolean;

Returns

boolean

是否为异步图元

reset

IPCB_PrimitiveObject.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_PrimitiveObject>;

Returns

Promise<IPCB_PrimitiveObject>

二进制内嵌对象图元对象

setstate_binarydata

IPCB_PrimitiveObject.setState_BinaryData() method

设置属性状态：二进制数据

Signature

setState_BinaryData(binaryData: string): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
binaryData	string	二进制数据

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_filename

IPCB_PrimitiveObject.setState_FileName() method

设置属性状态：文件名

Signature

setState_FileName(fileName: string): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
fileName	string	文件名

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_height

IPCB_PrimitiveObject.setState_Height() method

设置属性状态：高

Signature

setState_Height(height: number): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
height	number	高

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_layer

IPCB_PrimitiveObject.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_LayersOfObject): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfObject	层

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_mirror

IPCB_PrimitiveObject.setState_Mirror() method

设置属性状态：是否水平镜像

Signature

setState_Mirror(mirror: boolean): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
mirror	boolean	是否水平镜像

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_primitivelock

IPCB_PrimitiveObject.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_PrimitiveObject;

Parameters

Parameter	Type	Description
primitiveLock	boolean	是否锁定

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_rotation

IPCB_PrimitiveObject.setState_Rotation() method

设置属性状态：旋转角度

Signature

setState_Rotation(rotation: number): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
rotation	number	旋转角度

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_topleftx

IPCB_PrimitiveObject.setState_TopLeftX() method

设置属性状态：左上点 X

Signature

setState_TopLeftX(topLeftX: number): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
topLeftX	number	左上点 X

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_toplefty

IPCB_PrimitiveObject.setState_TopLeftY() method

设置属性状态：左上点 Y

Signature

setState_TopLeftY(topLeftY: number): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
topLeftY	number	左上点 Y

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

setstate_width

IPCB_PrimitiveObject.setState_Width() method

设置属性状态：宽

Signature

setState_Width(width: number): IPCB_PrimitiveObject;

Parameters

Parameter	Type	Description
width	number	宽

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

toasync

IPCB_PrimitiveObject.toAsync() method

将图元转换为异步图元

Signature

toAsync(): IPCB_PrimitiveObject;

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象

tosync

IPCB_PrimitiveObject.toSync() method

将图元转换为同步图元

Signature

toSync(): IPCB_PrimitiveObject;

Returns

IPCB_PrimitiveObject

二进制内嵌对象图元对象