You need to sign in or sign up before continuing.
js-apis-app-ability-configuration.md 2.3 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.app.ability.Configuration (Configuration)
D
donglin 已提交
2 3 4 5 6 7 8

定义环境变化信息。

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

9 10 11 12 13 14
## 导入模块

```ts
import Configuration from '@ohos.app.ability.Configuration'
```

D
donglin 已提交
15 16
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

D
donglin 已提交
17
  | 名称 | 类型 | 可读 | 可写 | 说明 |
D
donglin 已提交
18 19
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
D
merge  
donglin 已提交
20
| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。 |
M
m00512953 已提交
21 22
| direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 |
| screenDensity  | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 |
D
donglin 已提交
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
| displayId  | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice  | boolean | 是 | 否 | 指示指针类型设备是否已连接,如键鼠、触控板等。 |

具体字段描述参考ohos.app.ability.Configuration.d.ts文件

**示例:**
    
  ```ts
  let envCallback = {
     onConfigurationUpdated(config) {
       console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`)
       let language = config.language;
       let colorMode = config.colorMode;
       let direction = config.direction;
       let screenDensity = config.screenDensity;
       let displayId = config.displayId;
       let hasPointerDevice = config.hasPointerDevice;
    }
  };
  try {
    var callbackId = applicationContext.on("environment", envCallback);
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```