Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5ba16b40
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
5ba16b40
编写于
2年前
作者:
O
openharmony_ci
提交者:
Gitee
2年前
浏览文件
操作
浏览文件
下载
差异文件
!3748 API样板化-window的优化修改:需同步翻译
Merge pull request !3748 from 葛亚芳/master
上级
f3f436e3
24a2a3e1
无相关合并请求
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
41 addition
and
41 deletion
+41
-41
zh-cn/application-dev/reference/apis/js-apis-window.md
zh-cn/application-dev/reference/apis/js-apis-window.md
+41
-41
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-window.md
浏览文件 @
5ba16b40
...
...
@@ -10,7 +10,7 @@
import
window
from
'
@ohos.window
'
;
```
## WindowType<sup>7+</sup>
<a name="windowtype"></a>
## WindowType<sup>7+</sup>
窗口类型。
...
...
@@ -21,7 +21,7 @@ import window from '@ohos.window';
| TYPE_APP | 0 | 表示应用子窗口。 |
| TYPE_SYSTEM_ALERT | 1 | 表示系统告警窗口。 |
## AvoidAreaType<sup>7+</sup>
<a name="avoidareatype"></a>
## AvoidAreaType<sup>7+</sup>
窗口内容需要规避区域的类型。
...
...
@@ -32,7 +32,7 @@ import window from '@ohos.window';
| TYPE_SYSTEM | 0 | 表示系统默认区域。 |
| TYPE_CUTOUT | 1 | 表示刘海屏区域。 |
## WindowMode<sup>7+</sup>
<a name="windowmode"></a>
## WindowMode<sup>7+</sup>
窗口模式。
...
...
@@ -48,7 +48,7 @@ import window from '@ohos.window';
| SECONDARY | 4 | 表示APP分屏多窗口次要模式。 |
| FLOATING | 5 | 表示APP自由悬浮形式窗口模式。 |
## SystemBarProperties
<a name="systembarproperties"></a>
## SystemBarProperties
状态栏导航栏的属性。
...
...
@@ -63,7 +63,7 @@ import window from '@ohos.window';
| isNavigationBarLightIcon
<sup>
7+
</sup>
| boolean | 否 | 否 | 导航栏图标是否为高亮状态。 |
| navigationBarContentColor
<sup>
8+
</sup>
| string | 否 | 是 | 导航栏文字颜色。 |
## SystemBarRegionTint
<sup>8+</sup><a name="systembartegiontint"></a
>
## SystemBarRegionTint
<sup>8+</sup
>
单个导航栏或状态栏回调信息。
...
...
@@ -79,7 +79,7 @@ import window from '@ohos.window';
| backgroundColor | string | 是 | 是 | 系统栏背景颜色,为16进制RGB或ARGB颜色,例如"
\#
00FF00"或"
\#
FF00FF00"。 |
| contentColor | string | 是 | 是 | 系统栏文字颜色。 |
## SystemBarTintState
<sup>8+</sup><a name="systembartintstate"></a
>
## SystemBarTintState
<sup>8+</sup
>
当前系统栏回调信息集合。
...
...
@@ -87,12 +87,12 @@ import window from '@ohos.window';
**系统能力**
:以下各项对应的系统能力均为SystemCapability.WindowManager.WindowManager.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---------- | -------------------------------------------------- | ---- | ---- | -------------------------- |
| displayId | number | 是 | 否 | 当前物理屏幕id。 |
| regionTint | Array
<
[
SystemBarRegionTint
](
#systembar
tegiontint
)
>
| 是 | 是 | 当前改变所有的系统栏信息。 |
| 名称 | 参数类型
| 可读 | 可写 | 说明 |
| ---------- | --------------------------------------------------
-
| ---- | ---- | -------------------------- |
| displayId | number
| 是 | 否 | 当前物理屏幕id。 |
| regionTint | Array
<
[
SystemBarRegionTint
](
#systembar
regiontint8
)
>
| 是 | 是 | 当前改变所有的系统栏信息。 |
## Rect<sup>7+</sup>
<a name="rect"></a>
## Rect<sup>7+</sup>
矩形。
...
...
@@ -105,7 +105,7 @@ import window from '@ohos.window';
| width | number | 是 | 是 | 矩形区域的宽度。 |
| height | number | 是 | 是 | 矩形区域的高度。 |
## AvoidArea<sup>7+</sup>
<a name="avoidarea"></a>
## AvoidArea<sup>7+</sup>
表示窗口内容规避区域。
...
...
@@ -118,7 +118,7 @@ import window from '@ohos.window';
| rightRect |
[
Rect
](
#rect
)
| 是 | 是 | 屏幕右侧的矩形区。 |
| bottomRect |
[
Rect
](
#rect
)
| 是 | 是 | 屏幕底部的矩形区。 |
## Size<sup>7+</sup>
<a name="size"></a>
## Size<sup>7+</sup>
窗口大小。
...
...
@@ -129,7 +129,7 @@ import window from '@ohos.window';
| width | number | 是 | 是 | 窗口宽度。 |
| height | number | 是 | 是 | 窗口高度。 |
## WindowProperties
<a name="windowproperties"></a>
## WindowProperties
窗口属性。
...
...
@@ -147,10 +147,10 @@ import window from '@ohos.window';
| dimBehindValue
<sup>
7+
</sup>
| number | 是 | 是 | 靠后窗口的暗度值,取值范围为0~1,1表示最暗。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮,默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isPrivacyMode
<sup>
7+
</sup>
| boolean | 是 | 是 | 隐私模式,默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isRoundCorner
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否为圆角。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isRoundCorner
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否为圆角。
默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| isTransparent
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否透明。默认为false。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
## ColorSpace<sup>8+</sup>
<a name="colorspace"></a>
## ColorSpace<sup>8+</sup>
色域模式。
...
...
@@ -301,7 +301,7 @@ create(ctx: Context, id: string, type: WindowType): Promise<Window>
});
```
## window.find<sup>7+</sup>
<a name="window-find"></a>
## window.find<sup>7+</sup>
find(id: string, callback: AsyncCallback
<
Window
>
): void
...
...
@@ -363,7 +363,7 @@ find(id: string): Promise<Window>
});
```
## window.getTopWindow
<a name="window-gettopwindow"></a>
## window.getTopWindow
getTopWindow(callback: AsyncCallback
<
Window
>
): void
...
...
@@ -494,7 +494,7 @@ on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): v
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听;
|
| type | string | 是 |
监听事件,固定为'systemBarTintChange',即导航栏、状态栏属性变化事件。
|
| callback | Callback
<
[SystemBarTintState](#systembartintstate)
>
| 是 | 回调返回监听到的信息。 |
-
示例
...
...
@@ -520,7 +520,7 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >)
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'systemBarTintChange'时表示监听类型为导航栏、状态栏属性变化监听;
|
| type | string | 是 |
监听事件,固定为'systemBarTintChange',即导航栏、状态栏属性变化事件。
|
| callback | Callback
<
[SystemBarTintState](#systembartintstate)
>
| 否 | 回调返回监听到的信息。 |
-
示例
...
...
@@ -532,7 +532,7 @@ off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState >)
## Window
下列API示例中都需使用
[
getTopWindow()
](
#window
-gettopwindow
)
、
[
create()
](
#windowcreate7
)
、
[
find()
](
#window-find
)
等先获取到Window实例,再通过此实例调用对应方法。
下列API示例中都需使用
[
getTopWindow()
](
#window
gettopwindow
)
、
[
create()
](
#windowcreate7
)
、
[
find()
](
#windowfind7
)
等先获取到Window实例,再通过此实例调用对应方法。
### hide<sup>7+</sup>
...
...
@@ -1363,10 +1363,10 @@ on(type: 'windowSizeChange', callback: Callback<Size>): void
-
参数
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ----------------------------- | ---- | --------------------------------------------------------
----
|
| type | string | 是 |
设置监听类型。
<br/>
-
type为'windowSizeChange'时表示监听类型为窗口尺寸变化监听;
|
| callback | Callback
<
[Size](#size)
>
| 是 | 回调返回监听到的信息。
|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 |
监听事件,固定为'windowSizeChange',即窗口尺寸变化事件。
|
| callback | Callback
<
[Size](#size)
>
| 是 | 回调返回监听到的信息。 |
-
示例
...
...
@@ -1387,14 +1387,14 @@ off(type: 'windowSizeChange', callback?: Callback<Size >): void
-
参数
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ----------------------------- | ---- | --------------------------------------------------------
----
|
| type | string | 是 |
设置监听类型。
<br/>
-
type为'windowSizeChange'
<sup>
7+
</sup>
时表示监听类型为窗口尺寸变化监听;
|
| callback | Callback
<
[Size](#size)
>
| 否 | 回调返回监听到的信息。
|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | -------------------------------------------------------- |
| type | string | 是 |
监听事件,固定为'windowSizeChange',即窗口尺寸变化事件。
|
| callback | Callback
<
[Size](#size)
>
| 否 | 回调返回监听到的信息。 |
-
示例
```
```
js
var
type
=
'
windowSizeChange
'
;
windowClass
.
off
(
type
);
```
...
...
@@ -1411,7 +1411,7 @@ on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听
。 |
| type | string | 是 |
监听事件,固定为'systemAvoidAreaChange',即系统窗口规避区变化事件
。 |
| callback | Callback
<
[AvoidArea](#avoidarea)
>
| 是 | 回调返回监听到的信息。 |
-
示例
...
...
@@ -1435,12 +1435,12 @@ off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'systemAvoidAreaChange'时表示监听类型为系统窗口规避区变化监听
。 |
| type | string | 是 |
监听事件,固定为'systemAvoidAreaChange',即系统窗口规避区变化事件
。 |
| callback | Callback
<
[AvoidArea](#avoidarea)
>
| 否 | 回调返回监听到的信息。 |
-
示例
```
```
js
var
type
=
'
systemAvoidAreaChange
'
;
windowClass
.
off
(
type
);
```
...
...
@@ -1459,7 +1459,7 @@ on(type: 'keyboardHeightChange', callback: Callback<number>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听
。 |
| type | string | 是 |
监听事件,固定为'keyboardHeightChange',即键盘高度变化事件
。 |
| callback | Callbacknumber
>
| 是 | 回调返回监听到的信息。 |
-
示例
...
...
@@ -1485,12 +1485,12 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听
。 |
| type | string | 是 |
监听事件,固定为'keyboardHeightChange',即键盘高度变化事件
。 |
| callback | Callback
<
number
>
| 否 | 回调返回监听到的信息。 |
-
示例
```
```
js
var
type
=
'
keyboardHeightChange
'
;
windowClass
.
off
(
type
);
```
...
...
@@ -1537,7 +1537,7 @@ isSupportWideGamut(): Promise<boolean>
-
示例
```
```
js
let
promise
=
windowClass
.
isSupportWideGamut
();
promise
.
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in checking whether the window support WideGamut. Data:
'
+
JSON
.
stringify
(
data
))
...
...
@@ -1577,7 +1577,7 @@ setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void
setColorSpace(colorSpace:ColorSpace): Promise
<
void
>
设置当前窗口为广色域模式或默认色域模式,使用
p
romise方式作为异步方法。
设置当前窗口为广色域模式或默认色域模式,使用
P
romise方式作为异步方法。
**系统能力**
:SystemCapability.WindowManager.WindowManager.Core
...
...
@@ -2165,7 +2165,7 @@ setTouchable(isTouchable: boolean): Promise<void>
});
```
## WindowStageEventType<sup>9+</sup>
<a name="windowstageeventtype9"></a>
## WindowStageEventType<sup>9+</sup>
WindowStage生命周期。
...
...
@@ -2429,7 +2429,7 @@ on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'windowStageEvent'时表示监听类型为WindowStage生命周期变化监听
。 |
| type | string | 是 |
监听事件,固定为'windowStageEvent',即WindowStage生命周期变化事件
。 |
| callback | Callback
<
[WindowStageEventType](#windowstageeventtype9)
>
| 是 | 回调返回监听到的信息。 |
-
示例
...
...
@@ -2458,7 +2458,7 @@ off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType&g
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 |
设置监听类型。
<br/>
-
type为'windowStageEvent'时表示监听类型为WindowStage生命周期变化监听
。 |
| type | string | 是 |
监听事件,固定为'windowStageEvent',即WindowStage生命周期变化事件
。 |
| callback | Callback
<
[WindowStageEventType](#windowstageeventtype9)
>
| 否 | 回调返回监听到的信息。 |
-
示例
...
...
This diff is collapsed.
Click to expand it.
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录
反馈
建议
客服
返回
顶部