文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
API参考应用框架ArkUI(方舟UI框架)C API头文件native_node.hArkUI_NodeAttributeType(XComponent组件相关属性)

ArkUI_NodeAttributeType(XComponent组件相关属性)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. enum ArkUI_NodeAttributeType

概述

定义ArkUI在Native侧可以设置或获取的XComponent组件相关属性集合,包括组件ID、组件类型、Surface宽高、Surface显示区域以及是否支持图像分析等属性,适用于需要在Native侧对XComponent组件的渲染区域和行为进行自定义配置与获取的场景。

起始版本: 12

相关模块: ArkUI_NativeModule

所在头文件: native_node.h

NODE_XCOMPONENT_ID

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. NODE_XCOMPONENT_ID = MAX_NODE_SCOPE_NUM * ARKUI_NODE_XCOMPONENT = 12000

XComponent组件的ID,支持属性设置和属性获取接口。

作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。

起始版本: 12

参数:

展开
参数项 描述
.string XComponent组件的ID内容,用于唯一标识该组件。

返回:

展开
类型 说明
.string XComponent组件的ID内容,用于唯一标识该组件。

NODE_XCOMPONENT_TYPE

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. NODE_XCOMPONENT_TYPE = 12001

XComponent组件的类型,仅支持属性获取接口。

XComponent组件的类型需要在组件创建时通过ArkUI_NodeType中的ARKUI_NODE_XCOMPONENT或者ARKUI_NODE_XCOMPONENT_TEXTURE明确,不允许后续修改。

使用setAttribute接口尝试修改XComponent组件的类型时会发生绘制内容异常。

作为属性获取方法返回值ArkUI_AttributeItem格式如下。

起始版本: 12

返回:

展开
类型 说明
.value[0].i32 XComponent组件的类型,参数类型为ArkUI_XComponentType,具体枚举值及其与数字的对应关系请参见该枚举定义。

NODE_XCOMPONENT_SURFACE_SIZE

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. NODE_XCOMPONENT_SURFACE_SIZE = 12002

XComponent组件所持有的Surface的宽高,仅支持属性获取接口。

使用setAttribute接口尝试修改Surface的宽高时,该设置不会生效。

作为属性获取方法返回值ArkUI_AttributeItem格式如下。

起始版本: 12

返回:

展开
类型 说明
.value[0].u32 宽度数值,单位为px。
.value[1].u32 高度数值,单位为px。

NODE_XCOMPONENT_SURFACE_RECT

Phone18+PC/2in118+Tablet18+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. NODE_XCOMPONENT_SURFACE_RECT = 12003

XComponent组件所持有的Surface显示区域,支持属性设置和属性获取接口。适用于需要在XComponent组件内指定局部区域进行渲染的场景,例如视频画面裁剪显示、画中画局部渲染等。

作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。

起始版本: 18

参数:

展开
参数项 描述
.value[0].i32 Surface显示区域相对于XComponent组件左上角的x轴坐标,单位为px。
.value[1].i32 Surface显示区域相对于XComponent组件左上角的y轴坐标,单位为px。
.value[2].i32 Surface显示区域的宽度,单位为px,取值必须为正整数。传入0或负数时设置不生效。
.value[3].i32 Surface显示区域的高度,单位为px,取值必须为正整数。传入0或负数时设置不生效。

返回:

展开
类型 说明
.value[0].i32 Surface显示区域相对于XComponent组件左上角的x轴坐标,单位为px。
.value[1].i32 Surface显示区域相对于XComponent组件左上角的y轴坐标,单位为px。
.value[2].i32 Surface显示区域的宽度,单位为px,取值应为非负整数。
.value[3].i32 Surface显示区域的高度,单位为px。

NODE_XCOMPONENT_ENABLE_ANALYZER

Phone18+PC/2in118+Tablet18+TV19+Wearable18+
收起
自动换行
深色代码主题
复制
  1. NODE_XCOMPONENT_ENABLE_ANALYZER = 12004

XComponent组件是否支持图像分析的属性,支持属性设置和属性获取接口。开启后可对组件中显示的图像进行内容识别分析,适用于相机预览实时识别、图像内容理解等场景。

作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。

起始版本: 18

参数:

展开
参数项 描述
.value[0].i32 是否支持图像分析,1表示支持图像分析,0表示不支持图像分析,默认值:0。传入非0和非1的值时按0处理。

返回:

展开
类型 说明
.value[0].i32 是否支持图像分析,1表示支持图像分析,0表示不支持图像分析。
在 API参考 中进行搜索
请输入您想要搜索的关键词