ViewObject abstract class

ViewObject是Gesti画布内显示的基类,而组件则是它的实现类。

Properties(属性)

属性类型描述
rectRect视图对象的矩形边界。
valueany视图对象的值。
familyViewObjectFamily视图对象所属的家族。
originFamilyViewObjectFamily视图对象原始的家族。
namestring视图对象的名称。
positionVector视图对象的位置。
sizeSize视图对象的大小。
widthnumber视图对象的宽度。
heightnumber视图对象的高度。
positionXnumber视图对象的水平位置。
positionYnumber视图对象的垂直位置。
scaleWidthnumber视图对象的宽度缩放比例。
scaleHeightnumber视图对象的高度缩放比例。
absoluteScalenumber视图对象的绝对缩放比例。
mountedboolean视图对象是否已挂载到画布上。
idstring视图对象的唯一标识符。
keystring | number视图对象的键值。
selectedboolean视图对象是否被选中。
disabledboolean视图对象是否被禁用。
isLockboolean视图对象是否被锁定。
allButtonsArray<BaseButton>视图对象上的所有按钮数组。
angleDisabledboolean视图对象是否禁用旋转。

Methods(方法)

方法参数返回类型描述
getBaseInfo-Promise<ViewObjectExportBaseInfo>获取视图对象的基础信息,包含按钮信息。
getBaseInfoSync-ViewObjectExportBaseInfo获取视图对象的基础信息,不包含按钮信息。
setNamename: stringvoid设置视图对象的名称。
setIdid: stringvoid设置视图对象的唯一标识符。
lock-void锁定视图对象。
unLock-void解锁视图对象。
hide-void隐藏视图对象。
installButtonbutton: Buttonvoid安装单个按钮。
installMultipleButtonsbuttons: Array<Button>void安装多个按钮。
unInstallButtonbuttons: Array<Button>void卸载指定数组中的按钮。
setDecorationoption: BoxDecorationOptionvoid设置视图对象的装饰样式。
setSizesize:{width?: number; height?: number}void设置视图对象的大小。
setPositionx: number, y: numbervoid设置视图对象的位置。
setOpacityopacity: numbervoid设置视图对象的不透明度。
toBackground-void将视图对象设置为背景。
unBackground-void取消视图对象的背景设置。
getLayer-number获取视图对象所在的层级。
setLayerlayer: numbervoid设置视图对象所在的层级(已废弃)。
forceUpdate-void强制刷新画布。
toCenteraxis?: CenterAxisvoid将视图对象水平垂直居中。
getButtonByIdid: stringPromise <ButtonType | undefined>通过 id 获取视图对象上的按钮。
getButtonByIdSyncid: stringButtonType | undefined同步方式通过 id 获取视图对象上的按钮。
setSelectedBorderoption: SelectedBorderStylevoid设置视图对象被选中时边框的样式。
useCache-void启用视图对象的缓存。
unUseCache-void禁用视图对象的缓存。
makeFixed-void使视图对象固定。
makeUnfixed-void解除视图对象的固定状态。
setScaleConstraintsValueConstraints<number>void约束缩放倍数

useCache是一个实验性的 API,它基于 OffScreenCanvas 用于交互时的优化。目前仅支持 Vue、React 和 H5 浏览器端,但不支持 Uniapp。