1# @ohos.app.ability.StartOptions (StartOptions)
2
3StartOptions可以作为[startAbility()](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)的入参，用于指定目标Ability的窗口模式。
4
5> **说明：**
6>
7> - 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8>
9> - 本模块接口仅可在Stage模型下使用。
10
11## 导入模块
12
13```ts
14import { StartOptions } from '@kit.AbilityKit';
15```
16
17## 属性
18
19**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
20
21| 名称 | 类型 | 只读 | 可选 | 说明 |
22| -------- | -------- | -------- | -------- | -------- |
23| windowMode<sup>12+<sup> | number | 否 | 是 | 启动Ability时的窗口模式，详见[WindowMode](./js-apis-app-ability-abilityConstant.md#windowmode12)。 |
24| displayId | number | 否 | 是 | 屏幕ID模式。默认是0，表示当前屏幕。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
25| withAnimation<sup>11+</sup> | boolean | 否 | 是 | Ability是否具有动画效果。 |
26| windowLeft<sup>11+</sup> | number | 否 | 是 | 窗口左边的位置。 |
27| windowTop<sup>11+</sup> | number | 否 | 是 | 窗口顶部的位置。 |
28| windowWidth<sup>11+</sup> | number | 否 | 是 | 窗口的宽度。 |
29| windowHeight<sup>11+</sup> | number | 否 | 是 | 窗口的高度。 |
30| processMode<sup>12+</sup> | [contextConstant.ProcessMode](js-apis-app-ability-contextConstant.md#processmode12) | 否 | 是 | 进程模式。<br>**约束：**<br>1.仅在平板类设备上生效。<br>2.仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)中生效。<br>3.processMode和startupVisibility必须同时设置。 |
31| startupVisibility<sup>12+</sup> | [contextConstant.StartupVisibility](js-apis-app-ability-contextConstant.md#startupvisibility12) | 是 | 否 | Ability启动后的可见性。<br>**约束：**<br>1.仅在平板类设备上生效。<br>2.仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)中生效。<br>3.processMode和startupVisibility必须同时设置。 |
32| startWindowIcon<sup>14+</sup> | [image.PixelMap](../../reference/apis-image-kit/js-apis-image.md#pixelmap7) | 否 | 是 |  在应用内启动UIAbility时，启动页所显示的图标。如果未配置该字段，则默认采用module.json5文件中startWindowIcon字段的配置。<br>**约束：**<br>1.仅在平板与2in1设备上生效。<br>2.仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)中生效。<br>3.图片数据大小限制为600M。|
33| startWindowBackgroundColor<sup>14+</sup> | string | 否 | 是 |  在应用内启动UIAbility时，启动页所显示的背景颜色。如果未配置该字段，则默认采用module.json5文件中startWindowBackground字段的配置。<br>**约束：**<br>1.仅在平板与2in1设备上生效。<br>2.仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1)中生效。 |
34 
35**示例：**
36
37  ```ts
38  import { UIAbility, Want, StartOptions } from '@kit.AbilityKit';
39  import { BusinessError } from '@kit.BasicServicesKit';
40  import { image } from '@kit.ImageKit';
41
42  export default class EntryAbility extends UIAbility {
43    onForeground() {
44      let want: Want = {
45        deviceId: '',
46        bundleName: 'com.example.myapplication',
47        abilityName: 'EntryAbility'
48      };
49
50      let color = new ArrayBuffer(0);
51      let imagePixelMap: image.PixelMap;
52      image.createPixelMap(color, {
53        size: {
54          height: 100,
55          width: 100
56        }
57      }).then((data) => {
58        imagePixelMap = data;
59        let options: StartOptions = {
60          displayId: 0,
61          startWindowIcon: imagePixelMap,
62          startWindowBackgroundColor: '#00000000'
63        };
64
65        try {
66          this.context.startAbility(want, options, (err: BusinessError) => {
67            if (err.code) {
68              // 处理业务逻辑错误
69              console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
70              return;
71            }
72            // 执行正常业务
73            console.info('startAbility succeed');
74          });
75        } catch (err) {
76          // 处理入参错误异常
77          let code = (err as BusinessError).code;
78          let message = (err as BusinessError).message;
79          console.error(`startAbility failed, code is ${code}, message is ${message}`);
80        }
81      }).catch((err: BusinessError) => {
82        console.error(`createPixelMap failed, code is ${err.code}, message is ${err.message}`);
83      });
84    }
85  }
86  ```
87