ViewObject abstract class
ViewObject
是Gesti画布内显示的基类,而组件则是它的实现类。
Properties(属性)
属性 | 类型 | 描述 |
---|---|---|
rect | Rect | 视图对象的矩形边界。 |
value | any | 视图对象的值。 |
family | ViewObjectFamily | 视图对象所属的家族。 |
originFamily | ViewObjectFamily | 视图对象原始的家族。 |
name | string | 视图对象的名称。 |
position | Vector | 视图对象的位置。 |
size | Size | 视图对象的大小。 |
width | number | 视图对象的宽度。 |
height | number | 视图对象的高度。 |
positionX | number | 视图对象的水平位置。 |
positionY | number | 视图对象的垂直位置。 |
scaleWidth | number | 视图对象的宽度缩放比例。 |
scaleHeight | number | 视图对象的高度缩放比例。 |
absoluteScale | number | 视图对象的绝对缩放比例。 |
mounted | boolean | 视图对象是否已挂载到画布上。 |
id | string | 视图对象的唯一标识符。 |
key | string | number | 视图对象的键值。 |
selected | boolean | 视图对象是否被选中。 |
disabled | boolean | 视图对象是否被禁用。 |
isLock | boolean | 视图对象是否被锁定。 |
allButtons | Array<BaseButton> | 视图对象上的所有按钮数组。 |
angleDisabled | boolean | 视图对象是否禁用旋转。 |
Methods(方法)
方法 | 参数 | 返回类型 | 描述 |
---|---|---|---|
getBaseInfo | - | Promise<ViewObjectExportBaseInfo> | 获取视图对象的基础信息,包含按钮信息。 |
getBaseInfoSync | - | ViewObjectExportBaseInfo | 获取视图对象的基础信息,不包含按钮信息。 |
setName | name: string | void | 设置视图对象的名称。 |
setId | id: string | void | 设置视图对象的唯一标识符。 |
lock | - | void | 锁定视图对象。 |
unLock | - | void | 解锁视图对象。 |
hide | - | void | 隐藏视图对象。 |
installButton | button: Button | void | 安装单个按钮。 |
installMultipleButtons | buttons: Array<Button> | void | 安装多个按钮。 |
unInstallButton | buttons: Array<Button> | void | 卸载指定数组中的按钮。 |
setDecoration | option: BoxDecorationOption | void | 设置视图对象的装饰样式。 |
setSize | size:{width?: number; height?: number} | void | 设置视图对象的大小。 |
setPosition | x: number, y: number | void | 设置视图对象的位置。 |
setOpacity | opacity: number | void | 设置视图对象的不透明度。 |
toBackground | - | void | 将视图对象设置为背景。 |
unBackground | - | void | 取消视图对象的背景设置。 |
getLayer | - | number | 获取视图对象所在的层级。 |
setLayer | layer: number | void | 设置视图对象所在的层级(已废弃)。 |
forceUpdate | - | void | 强制刷新画布。 |
toCenter | axis?: CenterAxis | void | 将视图对象水平垂直居中。 |
getButtonById | id: string | Promise <ButtonType | undefined> | 通过 id 获取视图对象上的按钮。 |
getButtonByIdSync | id: string | ButtonType | undefined | 同步方式通过 id 获取视图对象上的按钮。 |
setSelectedBorder | option: SelectedBorderStyle | void | 设置视图对象被选中时边框的样式。 |
useCache | - | void | 启用视图对象的缓存。 |
unUseCache | - | void | 禁用视图对象的缓存。 |
makeFixed | - | void | 使视图对象固定。 |
makeUnfixed | - | void | 解除视图对象的固定状态。 |
setScaleConstraints | ValueConstraints<number> | void | 约束缩放倍数 |
useCache
是一个实验性的 API,它基于 OffScreenCanvas 用于交互时的优化。目前仅支持 Vue、React 和 H5 浏览器端,但不支持 Uniapp。