harmony 鸿蒙Interfaces (其他)

  • 2025-06-12
  • 浏览 (4)

Interfaces (其他)

说明:

本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

Configuration9+

创建子窗口或系统窗口时的参数。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.WindowManager.WindowManager.Core

|名称|类型|必填|说明 | |———-|————————–|–|—————————————————————————–| |name |string |是|窗口名字。 | |windowType|WindowType|是|窗口类型。 | |ctx |BaseContext|否|当前应用上下文信息。不设置,则默认为空。
FA模型下不需要使用该参数,即可创建子窗口,使用该参数时会报错。
Stage模型必须使用该参数,用于创建悬浮窗、模态窗或系统窗口。| |displayId|number |否|当前物理屏幕id。不设置,则默认为-1,该参数应为整数。 | |parentId |number |否|父窗口id。不设置,则默认为-1,该参数应为整数。 | |decorEnabled12+|boolean|否|是否显示窗口装饰,仅在windowType为TYPE_DIALOG时生效。true表示显示,false表示不显示。此参数默认值为false。
系统能力: SystemCapability.Window.SessionManager| |title12+|string|否|decorEnabled属性设置为true时,窗口的标题内容。标题显示区域最右端不超过系统三键区域最左端,超过部分以省略号表示。不设置,则默认为空字符串。
系统能力: SystemCapability.Window.SessionManager| |defaultDensityEnabled20+|boolean|否|是否使用系统默认Density,使用系统默认Density之后,窗口不会跟随系统显示大小变化重新布局。
当创建的系统窗口设置此参数为true时,表示当前窗口使用系统默认Density,且不受setDefaultDensityEnabled()setCustomDensity()设置的主窗口的相关影响。
当创建的系统窗口设置此参数为false时,表示当前窗口不使用系统默认Density,且会受到setDefaultDensityEnabled()setCustomDensity()设置的主窗口的相关影响。
默认为false。
系统能力: SystemCapability.Window.SessionManager|

SystemBarProperties

状态栏、三键导航栏的属性。在设置窗口级状态栏、三键导航栏属性时使用。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

名称 类型 必填 说明
statusBarColor string 状态栏背景颜色,为十六进制RGB或ARGB颜色,不区分大小写,例如'#00FF00''#FF00FF00'。默认值:'#66000000'
系统能力: SystemCapability.WindowManager.WindowManager.Core
isStatusBarLightIcon7+ boolean 状态栏图标是否为高亮状态。true表示高亮;false表示不高亮。默认值:false。
系统能力: SystemCapability.WindowManager.WindowManager.Core
statusBarContentColor8+ string 状态栏文字颜色。当设置此属性后,isStatusBarLightIcon属性设置无效。默认值:'#E5FFFFFF'
系统能力: SystemCapability.WindowManager.WindowManager.Core
navigationBarColor string 三键导航栏背景颜色,为十六进制RGB或ARGB颜色,不区分大小写,例如'#00FF00''#FF00FF00'。默认值:'#66000000'
系统能力: SystemCapability.WindowManager.WindowManager.Core
isNavigationBarLightIcon7+ boolean 三键导航栏图标是否为高亮状态。true表示高亮;false表示不高亮。默认值:false。
系统能力: SystemCapability.WindowManager.WindowManager.Core
navigationBarContentColor8+ string 三键导航栏文字颜色。当设置此属性后,isNavigationBarLightIcon属性设置无效。默认值:'#E5FFFFFF'
系统能力: SystemCapability.WindowManager.WindowManager.Core
enableStatusBarAnimation12+ boolean 是否使能状态栏属性变化时动画效果。true表示变化时使能动画效果;false表示没有使能动画效果。默认值:false。
系统能力: SystemCapability.Window.SessionManager
enableNavigationBarAnimation12+ boolean 是否使能三键导航栏属性变化时动画效果。true表示变化时使能动画效果;false表示没有使能动画效果。默认值:false。
系统能力: SystemCapability.Window.SessionManager

StatusBarProperty18+

状态栏的属性。在获取状态栏属性信息时返回。

原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。

名称 类型 必填 说明
contentColor string 状态栏文字颜色,固定为ARGB格式, 如:#E5FFFFFF
系统能力: SystemCapability.Window.SessionManager。

SystemBarStyle12+

状态栏的属性。在设置页面级状态栏属性时使用。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.WindowManager.WindowManager.Core

名称 类型 只读 可选 说明
statusBarContentColor string 状态栏文字颜色。默认值:'#E5FFFFFF'

Rect7+

窗口矩形区域。

系统能力: SystemCapability.WindowManager.WindowManager.Core

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

名称 类型 可读 可写 说明
left number 矩形区域的左边界,单位为px,该参数为整数。
top number 矩形区域的上边界,单位为px,该参数应为整数。
width number 矩形区域的宽度,单位为px,该参数应为整数。
height number 矩形区域的高度,单位为px,该参数应为整数。

AvoidArea7+

窗口内容规避区域。如系统栏区域、刘海屏区域、手势区域、软键盘区域等与窗口内容重叠时,需要窗口内容避让的区域。在规避区无法响应用户点击事件。

除此之外还需注意规避区域的如下约束,具体为:

  • 底部手势区域中非底部导航条区域支持点击、长按事件透传,不支持拖入。

  • 左右侧边手势区域支持点击、长按以及上下滑动事件透传,不支持拖入。

  • 底部导航条区域支持长按、点击、拖入事件响应,不支持事件向下透传。

系统能力: SystemCapability.WindowManager.WindowManager.Core

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

名称 类型 可读 可写 说明
visible9+ boolean 规避区域是否可见。true表示可见;false表示不可见。
leftRect Rect 屏幕左侧的矩形区。
topRect Rect 屏幕顶部的矩形区。
rightRect Rect 屏幕右侧的矩形区。
bottomRect Rect 屏幕底部的矩形区。

Size7+

窗口大小。

系统能力: SystemCapability.WindowManager.WindowManager.Core

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

名称 类型 可读 可写 说明
width number 窗口宽度,单位为px,该参数应为整数。
height number 窗口高度,单位为px,该参数应为整数。

RectChangeOptions12+

窗口矩形(窗口位置及窗口大小)变化返回的值及变化原因。

系统能力: SystemCapability.Window.SessionManager

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

名称 类型 可读 可写 说明
rect Rect 窗口矩形变化后的值。
reason RectChangeReason 窗口矩形变化的原因。

AvoidAreaOptions12+

系统规避区变化后返回当前规避区域以及规避区域类型。

系统能力: SystemCapability.WindowManager.WindowManager.Core

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

名称 类型 可读 可写 说明
type AvoidAreaType 系统规避区变化后返回的规避区域类型。
area AvoidArea 系统规避区变化后返回的规避区域。

WindowProperties

窗口属性。

系统能力: SystemCapability.WindowManager.WindowManager.Core

名称 类型 只读 可选 说明
windowRect7+ Rect 窗口尺寸,可在页面生命周期onPageShow或应用生命周期onForeground阶段获取。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
drawableRect11+ Rect 窗口内的可绘制区域尺寸,其中左边界上边界是相对于窗口计算。在Stage模型下,需要在调用loadContent()setUIContent()加载页面内容后使用该接口。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
type7+ WindowType 窗口类型。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
isFullScreen boolean 是否全屏,默认为false。true表示全屏;false表示非全屏。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
isLayoutFullScreen7+ boolean 窗口是否为沉浸式且处于全屏模式(不在悬浮窗、分屏等场景下),默认为false。true表示沉浸式且处于全屏模式;false表示非沉浸式或非全屏模式。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
focusable7+ boolean 窗口是否可聚焦,默认为true。true表示可聚焦;false表示不可聚焦。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
touchable7+ boolean 窗口是否可触摸,默认为true。true表示可触摸;false表示不可触摸。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
brightness number 屏幕亮度。该参数为浮点数,可设置的亮度范围为[0.0, 1.0],其取1.0时表示最大亮度值。如果窗口没有设置亮度值,表示亮度跟随系统,此时获取到的亮度值为-1。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
dimBehindValue(deprecated) number 靠后窗口的暗度值。该参数为浮点数,取值范围为[0.0, 1.0],其取1.0表示最暗。
- 说明: 从API version 9开始废弃。
- 从API version 7开始支持。当前无可替代接口。
isKeepScreenOn boolean 屏幕是否常亮,默认为false。true表示常亮;false表示不常亮。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
isPrivacyMode7+ boolean 隐私模式,默认为false。true表示模式开启;false表示模式关闭。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
isRoundCorner(deprecated) boolean 窗口是否为圆角。默认为false。true表示圆角;false表示非圆角。
- 说明: 从API version 9开始废弃。
- 从API version 7开始支持。当前无可替代接口。
isTransparent7+ boolean 窗口背景是否透明。默认为false。true表示透明;false表示不透明。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
id9+ number 窗口ID,默认值为0,该参数应为整数。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
displayId12+ number 窗口所在屏幕ID,默认返回主屏幕ID,该参数应为整数。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
name18+ string 窗口名字,默认为空字符串。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。

DecorButtonStyle14+

系统装饰栏按钮样式。

系统能力: SystemCapability.Window.SessionManager

原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。

名称 类型 可读 可写 说明
colorMode ConfigurationConstant.ColorMode 颜色模式。深色模式下按钮颜色适配为浅色,浅色模式下按钮颜色适配为深色。未设置则默认跟随系统颜色模式。
buttonBackgroundSize number 按钮高亮显示时的大小,取值范围20vp-40vp,默认值28vp。
spacingBetweenButtons number 按钮间距,取值范围8vp-24vp,默认值12vp。
closeButtonRightMargin number 关闭按钮右侧距窗口边距,取值范围6vp-22vp,默认值20vp。
buttonIconSize20+ number 按键icon的大小,取值范围16vp-24vp,默认值20vp。
buttonBackgroundCornerRadius20+ number 按键背板圆角半径,取值范围4vp-8vp,默认值4vp。

WindowLimits11+

窗口尺寸限制参数。可以通过setWindowLimits设置窗口尺寸限制,并且可以通过getWindowLimits获得当前的窗口尺寸限制。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 可读 可写 说明
maxWidth number 窗口的最大宽度。单位为px,该参数为整数。值默认为0,表示该属性不发生变化。下限值为0,上限值为系统限定的最大宽度。
maxHeight number 窗口的最大高度。单位为px,该参数为整数。值默认为0,表示该属性不发生变化。下限值为0,上限值为系统限定的最大高度。
minWidth number 窗口的最小宽度。单位为px,该参数为整数。值默认为0,表示该属性不发生变化。下限值为0,上限值为系统限定的最小宽度。
minHeight number 窗口的最小高度。单位为px,该参数为整数。值默认为0,表示该属性不发生变化。下限值为0,上限值为系统限定的最小高度。

TitleButtonRect11+

标题栏上的最小化、最大化、关闭按钮矩形区域,该区域位置坐标相对窗口右上角。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 可读 可写 说明
right number 矩形区域的右边界,单位为vp,该参数为整数。
top number 矩形区域的上边界,单位为vp,该参数为整数。
width number 矩形区域的宽度,单位为vp,该参数为整数。
height number 矩形区域的高度,单位为vp,该参数为整数。

MoveConfiguration15+

窗口移动选项。

原子化服务API: 从API version 15开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 必填 说明
displayId number 目标屏幕ID,该参数应为整数,输入非整数时将向下取整。填入该参数时,将移动到相对于目标屏幕左上角的指定位置。此参数不填或传入目标屏幕ID不存在时,将移动到相对于当前屏幕左上角的指定位置。

WindowDensityInfo15+

窗口所在显示设备和窗口自定义的显示密度信息,是与像素单位无关的缩放系数,即显示大小缩放系数。

原子化服务API: 从API version 15开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 可读 可写 说明
systemDensity number 窗口所在屏幕的系统显示大小缩放系数,跟随用户设置变化,该参数变化范围为0.5-4.0。
defaultDensity number 窗口所在屏幕的系统默认显示大小缩放系数,跟随窗口所在屏幕变化,该参数变化范围为0.5-4.0。
customDensity number 窗口自定义设置的显示大小缩放系数,该参数取值范围为0.5-4.0。未设置该参数时,将跟随系统显示大小缩放系数变化。

WindowLayoutInfo15+

窗口布局信息。

原子化服务API: 从API version 15开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 必填 说明
windowRect15+ Rect 窗口尺寸,窗口在屏幕上的实际位置和大小。

KeyboardInfo18+

软键盘窗口信息。

系统能力: SystemCapability.Window.SessionManager

名称 类型 必填 说明
beginRect18+ Rect 动画开始前软键盘的位置和大小。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
endRect18+ Rect 动画结束后软键盘的位置和大小。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
animated20+ boolean 当前是否有显示/隐藏动画,true表示有动画,false表示没有。
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。
config20+ WindowAnimationConfig 动画配置信息。
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

ShowWindowOptions20+

显示子窗口或系统窗口时的参数。

系统能力: SystemCapability.Window.SessionManager

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

名称 类型 必填 说明
focusOnShow boolean 窗口调用showWindow()显示时是否自动获焦,默认为true。该参数对主窗、模态窗、dialog窗口不生效。

WindowAnimationConfig20+

窗口动画参数配置。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 必填 说明
curve WindowAnimationCurve 动画曲线类型。
duration number 动画播放的时长,单位毫秒(ms)。
默认值:0,最大值:3000。
根据动画曲线类型决定是否必填。
param WindowAnimationCurveParam 动画曲线参数,根据动画曲线类型决定是否必填。

WindowInfo18+

当前窗口的详细信息。

系统能力: SystemCapability.Window.SessionManager

名称 类型 只读 可选 说明
rect Rect 窗口尺寸。
bundleName string 应用Bundle的名称。
abilityName string Ability的名称。
windowId number 窗口ID。
windowStatusType WindowStatusType 窗口模式枚举。
isFocused boolean 窗口是否获焦。true表示窗口获焦;false表示窗口未获焦。

TransitionAnimation20+

窗口转场动画配置。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 必填 说明
config WindowAnimationConfig 本次转场动画配置。
opacity number 不透明度,转场动画作用的窗口属性,值为0时窗口完全透明。当动画类型为WindowTransitionType.DESTROY时,代表动画终点的不透明度。取值范围0~1,在动画结束时恢复为1。

Callback15+

(data: T)15+

(data: T): V;

通用回调函数。

开发者在使用时,可自定义data的参数类型,回调函数返回对应类型的信息。

原子化服务API: 从API version 15开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

参数:

参数名 类型 必填 说明
data T 回调函数调用时需要传入T类型的参数。

返回值:

类型 说明
V 回调函数需要返回V类型的返回值。

RotationChangeInfo19+

窗口旋转变化时的窗口信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 只读 可选 说明
type RotationChangeType 窗口旋转事件类型。
orientation number 窗口显示方向。
- 0表示竖屏。
- 1表示反向横屏。
- 2表示反向竖屏。
- 3表示横屏。
开发者在使用时,需要注意该方向与display对象的属性orientation含义不一致。
displayId number 窗口所在屏幕Id。
displayRect Rect 窗口所在屏幕旋转后的矩形区域大小。

RotationChangeResult19+

应用在窗口旋转变化时返回的信息,系统会根据此信息改变当前窗口矩形区域大小。当返回主窗口旋转变化的信息时,系统不改变主窗口的大小。 应用窗口与系统窗口大小存在限制,具体限制与相关规则可见resize

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

名称 类型 只读 可选 说明
rectType RectType 窗口矩形区域坐标系类型。
windowRect Rect 相对于屏幕或父窗坐标系的窗口矩形区域信息。

RotationChangeCallback19+

(info: T)19+

(info: T): U;

旋转事件通知通用回调函数。

开发者在使用时,回调函数参数类型为RotationChangeInfo,返回值类型为RotationChangeResult|void。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Window.SessionManager

参数:

参数名 类型 必填 说明
info T 回调函数调用时系统传入RotationChangeInfo类型的参数。

返回值:

类型 说明
U 回调函数需要返回RotationChangeResult|void类型的返回值。

SubWindowOptions11+

子窗口创建参数。

系统能力: SystemCapability.Window.SessionManager

名称 类型 只读 可选 说明
title11+ string 子窗口标题。标题显示区域最右端不超过系统三键区域最左端,超过部分以省略号表示。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
decorEnabled11+ boolean 子窗口是否显示装饰。true表示子窗口显示装饰,false表示子窗口不显示装饰。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
isModal12+ boolean 子窗口是否启用模态属性。true表示子窗口启用模态属性,false表示子窗口禁用模态属性。不设置,则默认为false。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
modalityType14+ ModalityType 子窗口模态类型,仅当子窗口启用模态属性时生效。WINDOW_MODALITY表示子窗口模态类型为模窗口子窗,APPLICATION_MODALITY表示子窗口模态类型为模应用子窗。不设置,则默认为WINDOW_MODALITY。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
windowRect18+ Rect 子窗口矩形区域,其中子窗存在大小限制,具体参考resize()方法。不设置,此窗口在显示时默认为全屏大小。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
zLevel18+ number 子窗口层级级别,仅当子窗口未启用模态属性,即未设置isModal时生效。该参数是整数,取值范围为[-10000, 10000],浮点数输入将向下取整。不设置,则默认为0。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
maximizeSupported19+ boolean 子窗口是否支持最大化特性。此接口仅可在2in1设备下使用。true表示子窗口支持最大化,false表示子窗口不支持最大化。不设置,则默认为false。
原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。
outlineEnabled20+ boolean 子窗口是否显示描边。此接口仅可在2in1设备下使用。true表示子窗口显示描边,false表示子窗口不显示描边。不设置,则默认为false。
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI(方舟UI框架)

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset

0  赞