diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-state-management.md b/zh-cn/application-dev/reference/arkui-ts/ts-state-management.md index dd14faca8874931c7aa2908e7fc0ffc8585cbc07..faa98edaa5b5426d8118cacd249f9a8d5f5da980 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-state-management.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-state-management.md @@ -2,7 +2,9 @@ 状态管理模块提供了应用程序的数据存储能力、持久化数据管理能力、Ability数据存储能力和应用程序需要的环境状态,其中Ability数据存储从API version9开始支持。 -> 说明:本模块首批接口从API version 7开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。 +> **说明:** +> +> 本模块首批接口从API version 7开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。 ## AppStorage @@ -14,14 +16,14 @@ Link(propName: string): any **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | :--------------------- | -| propName | string | 是 | 要双向绑定的属性名称。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | :---------- | +| propName | string | 是 | 要双向绑定的属性名称。 | **返回值:** -| 类型 | 描述 | -| ----- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ----- | ---------------------------------------- | | @Link | 在具有给定键的数据,则返回到此属性的双向数据绑定,该双向绑定意味着变量或者组件对数据的更改将同步到AppStorage,通过AppStorage对数据的修改将同步到变量或者组件。 | ```ts @@ -36,16 +38,16 @@ SetAndLink\(propName: string, defaultValue: T): SubscribedAbstractProperty\(propName: string, defaultValue: S): SubscribedAbstractProperty\(propName: string): T | undefined **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | ---- | ------------------- | -| propName | string | 是 | 要获取对应的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | ---- | ----------- | +| propName | string | 是 | 要获取对应的key值。 | **返回值:** -| 类型 | 描述 | -| ------------------ | -------------------------- | +| 类型 | 描述 | +| ----------------- | ------------- | | boolean或undefined | 返回属性的属性值是否存在。 | ```ts @@ -148,15 +150,15 @@ Set(propName: string, newValue: T): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ----------------- | -| propName | string | 是 | 要设置的key值。 | -| newValue | T | 是 | 要设置的value值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ----------- | +| propName | string | 是 | 要设置的key值。 | +| newValue | T | 是 | 要设置的value值。 | **返回值:** -| 类型 | 描述 | -| ------- | ----------------------------------------------------- | +| 类型 | 描述 | +| ------- | ----------------------------------- | | boolean | 如果存在key值,设置value值并返回true,否则返回false。 | ```ts @@ -171,16 +173,16 @@ SetOrCreate(propName: string, newValue: T): void **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ------------------------- | -| propName | string | 是 | 要更新或者创建的key值。 | -| newValue | T | 是 | 要更新或者创建的value值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | --------------- | +| propName | string | 是 | 要更新或者创建的key值。 | +| newValue | T | 是 | 要更新或者创建的value值。 | **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------------------------------ | -| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在LocalStorage中创建具有给定默认值的新属性,默认值必须是T类型。不允许undefined 或 null 返回true。 | +| 类型 | 描述 | +| ------- | ---------------------------------------- | +| boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在AppStorage中创建具有给定默认值的新属性,默认值必须是T类型。不允许undefined 或 null 返回true。 | ```ts let simple = AppStorage.SetOrCreate('simpleProp',121); @@ -194,14 +196,14 @@ Delete(propName: string): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | --------------------- | -| propName | string | 是 | 要删除的属性的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ------------ | +| propName | string | 是 | 要删除的属性的key值。 | **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ------- | ---------------------------------------- | | boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 | ```ts @@ -216,8 +218,8 @@ keys(): IterableIterator\ **返回值:** -| 类型 | 描述 | -| -------------- | ---------------------------- | +| 类型 | 描述 | +| -------------- | -------------- | | array\ | 返回包含所有键的字符串数组。 | ```ts @@ -232,8 +234,8 @@ staticClear(): boolean **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ------- | --------------------------------- | | boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 | ```ts @@ -248,14 +250,14 @@ IsMutable(propName: string): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | --------------------- | -| propName | string | 是 | 要查询的属性的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ------------ | +| propName | string | 是 | 要查询的属性的key值。 | **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------ | +| 类型 | 描述 | +| ------- | ------------------ | | boolean | 返回此属性是否存在并且是否可以改变。 | ```ts @@ -270,8 +272,8 @@ Size(): number **返回值:** -| 类型 | 描述 | -| ------ | ------------------ | +| 类型 | 描述 | +| ------ | --------- | | number | 返回键值对的数量。 | ```ts @@ -288,9 +290,9 @@ constructor(initializingProperties?: Object) **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ---------------------- | ------ | ---- | ------------------------------------------------------------ | -| initializingProperties | Object | 否 | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ---------------------- | ------ | ---- | ---------------------------------------- | +| initializingProperties | Object | 否 | object.keys(obj)返回的所有对象属性及其值都将添加到LocalStorage。 | ```ts this.storage = new LocalStorage(); @@ -306,8 +308,8 @@ static GetShared(): LocalStorage **返回值:** -| 类型 | 描述 | -| ----------------------------- | ---------------------- | +| 类型 | 描述 | +| ----------------------------- | ----------------- | | [LocalStorage](#localstorage) | 返回LocalStorage对象。 | ```ts @@ -322,14 +324,14 @@ has(propName: string): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | -------------- | -| propName | string | 是 | 属性的属性值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ------- | +| propName | string | 是 | 属性的属性值。 | **返回值:** -| 类型 | 描述 | -| ------- | -------------------------- | +| 类型 | 描述 | +| ------- | ------------- | | boolean | 返回属性的属性值是否存在。 | ```ts @@ -345,14 +347,14 @@ get\(propName: string): T **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ------------------- | -| propName | string | 是 | 要获取对应的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ----------- | +| propName | string | 是 | 要获取对应的key值。 | **返回值:** -| 类型 | 描述 | -| -------------- | ------------------------------------------------------- | +| 类型 | 描述 | +| -------------- | ---------------------------------------- | | T \| undefined | 当keyvalue存在时,返回keyvalue值。不存在返回undefined。 | ```ts @@ -368,15 +370,15 @@ set\(propName: string, newValue: T): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ----------------- | -| propName | string | 是 | 要设置的key值。 | -| newValue | T | 是 | 要设置的value值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ----------- | +| propName | string | 是 | 要设置的key值。 | +| newValue | T | 是 | 要设置的value值。 | **返回值:** -| 类型 | 描述 | -| ------- | ----------------------------------------------------- | +| 类型 | 描述 | +| ------- | ----------------------------------- | | boolean | 如果存在key值,设置value值并返回true,否则返回false。 | ```ts @@ -392,15 +394,15 @@ setOrCreate\(propName: string, newValue: T): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ----------------------- | -| propName | string | 是 | 要更新或创建的key值。 | -| newValue | T | 是 | 要更新或创建的value值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | -------------- | +| propName | string | 是 | 要更新或创建的key值。 | +| newValue | T | 是 | 要更新或创建的value值。 | **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ------- | ---------------------------------------- | | boolean | 如果已存在与给定键名字相同的属性,更新其值且返回true。如果不存在具有给定名称的属性,在LocalStorage中创建具有给定默认值的新属性,默认值必须是T类型,不允许undefined 或 null 。 | ```ts @@ -416,14 +418,14 @@ link\(propName: string): T **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ---------------------- | -| propName | string | 是 | 要双向绑定的属性名称。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ----------- | +| propName | string | 是 | 要双向绑定的属性名称。 | **返回值:** -| 类型 | 描述 | -| ---- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ---- | ---------------------------------------- | | T | 如果存在具有给定键的属性,返回到此属性的双向绑定,该双向绑定意味着变量或者组件对数据的更改将同步到LocalStorage,然后通过LocalStorage实例同步到任何变量或组件。如果不存在给定键的属性,返回undefined。 | ```ts @@ -439,15 +441,15 @@ setAndLink\(propName: string, defaultValue: T): T **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ------------ | ------ | :--- | -------------------- | -| propName | string | 是 | 要进行创建的key值。 | -| defaultValue | T | 是 | 要进行设置的默认值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ------------ | ------ | :--- | ----------- | +| propName | string | 是 | 要进行创建的key值。 | +| defaultValue | T | 是 | 要进行设置的默认值。 | **返回值:** -| 类型 | 描述 | -| ------------------------------------ | ------------------------------------------------------------ | +| 类型 | 描述 | +| ----- | ---------------------------------------- | | @Link | 与Link接口类似,如果当前的key保存于LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Link返回。 | ```ts @@ -463,14 +465,14 @@ prop\(propName: string): T **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | ----------------------- | -| propName | string | 是 | 要单向数据绑定的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ------------- | +| propName | string | 是 | 要单向数据绑定的key值。 | **返回值:** -| 类型 | 描述 | -| ------------------------------------ | ------------------------------------------------------------ | +| 类型 | 描述 | +| ----- | ---------------------------------------- | | @Prop | 如果存在具有给定键的属性,返回此属性的单向数据绑定。该单向绑定意味着只能通过LocalStorage将属性的更改同步到变量或组件。该方法返回的变量为不可变变量,适用于可变和不可变的状态变量。如果此键的属性不存在则返回undefined。 | ```ts @@ -486,15 +488,15 @@ setAndProp\(propName: string, defaultValue: T): T **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ------------ | ------ | :--- | ------------------------- | -| propName | string | 是 | 要保存的键值对中的key值。 | -| defaultValue | T | 是 | 创建的默认值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ------------ | ------ | :--- | -------------- | +| propName | string | 是 | 要保存的键值对中的key值。 | +| defaultValue | T | 是 | 创建的默认值。 | **返回值:** -| 类型 | 描述 | -| ------------------------------------ | ------------------------------------------------------------ | +| 类型 | 描述 | +| ----- | ---------------------------------------- | | @Prop | 如果当前的key保存与LocalStorage,返回该key值对应的value值。如果该key值未被创建,则创建一个对应的defaultValue的Prop返回。 | ```ts @@ -510,14 +512,14 @@ delete(propName: string): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| -------- | ------ | :--- | --------------------- | -| propName | string | 是 | 要删除的属性的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| -------- | ------ | :--- | ------------ | +| propName | string | 是 | 要删除的属性的key值。 | **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ------- | ---------------------------------------- | | boolean | 删除key指定的键值对,如果存在且删除成功返回true,不存在或删除失败返回false。 | ```ts @@ -533,8 +535,8 @@ keys(): IterableIterator\ **返回值:** -| 类型 | 描述 | -| -------------- | ---------------------------- | +| 类型 | 描述 | +| -------------- | -------------- | | array\ | 返回包含所有键的字符串数组。 | ```ts @@ -550,8 +552,8 @@ size(): number **返回值:** -| 类型 | 描述 | -| ------ | ------------------ | +| 类型 | 描述 | +| ------ | --------- | | number | 返回键值对的数量。 | ```ts @@ -567,8 +569,8 @@ clear(): boolean **返回值:** -| 类型 | 描述 | -| ------- | ------------------------------------------------------------ | +| 类型 | 描述 | +| ------- | --------------------------------- | | boolean | 删除所有的属性,如果当前有状态变量依旧引用此属性,返回false。 | ```ts @@ -586,10 +588,10 @@ constructor(appStorage: AppStorage, storage: Storage) **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ---------- | ---------- | :--- | -------------------------------- | -| appStorage | AppStorage | 是 | 保存所有属性及属性值的单例对象。 | -| storage | Storage | 是 | Storage实例对象。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ---------- | ---------- | :--- | ---------------- | +| appStorage | AppStorage | 是 | 保存所有属性及属性值的单例对象。 | +| storage | Storage | 是 | Storage实例对象。 | ```ts this.persistentstorage = new PersistentStorage(AppStorage,Storage); @@ -603,10 +605,10 @@ PersistProp(key:string,defaultValue:T):void **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ------------ | ------ | :--- | ----------------------- | -| key | string | 是 | 要关联的属性的key值。 | -| defaultValue | T | 是 | 要关联的属性的value值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ------------ | ------ | :--- | -------------- | +| key | string | 是 | 要关联的属性的key值。 | +| defaultValue | T | 是 | 要关联的属性的value值。 | ```ts PersistentStorage.PersistProp("highScore", "0"); @@ -620,9 +622,9 @@ DeleteProp(key: string): void **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ------ | ------ | :--- | --------------------- | -| key | string | 是 | 要取消的属性的key值。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ---- | ------ | :--- | ------------ | +| key | string | 是 | 要取消的属性的key值。 | ```ts PersistentStorage.DeleteProp("highScore"); @@ -636,9 +638,9 @@ PersistProps(properties: {key: string, defaultValue: any}[]): void; **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | -| ------ | ---------------------------------- | :--: | ------------------ | -| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | +| 参数名 | 类型 | 必填 | 参数描述 | +| ---- | ---------------------------------- | :--: | --------- | +| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | ```ts PersistentStorage.PersistProps([{"highScore", "0"},{"wightScore","1"}]); @@ -652,8 +654,8 @@ Keys(): Array **返回值:** -| 类型 | 描述 | -| ------------- | -------------------------- | +| 类型 | 描述 | +| ------------- | ------------- | | Array | 返回所有持久化属性的标记。 | ```ts @@ -684,15 +686,15 @@ EnvProp\(key: string, value: S): boolean **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 | -| ------ | ------ | :--- | --------------- | ----------------- | -| key | string | 是 | 要关联的key值 | 要关联的key值。 | -| value | S | 是 | 要关联的value值 | 要关联的value值。 | +| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 | +| ----- | ------ | :--- | ---------- | ----------- | +| key | string | 是 | 要关联的key值 | 要关联的key值。 | +| value | S | 是 | 要关联的value值 | 要关联的value值。 | **返回值:** -| 类型 | 描述 | -| ------- | ---------------------------------- | +| 类型 | 描述 | +| ------- | ---------------------- | | boolean | 返回该属性在AppStorage中是否存在。 | ```ts @@ -707,9 +709,9 @@ EnvProps(props: {key: string;defaultValue: any}[]): void **参数:** -| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 | -| ------ | ---------------------------------- | :--- | ------------------ | ------------------ | -| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | 要关联的属性数组。 | +| 参数名 | 类型 | 必填 | 参数描述 | 参数描述 | +| ---- | ---------------------------------- | :--- | --------- | --------- | +| key | {key: string, defaultValue: any}[] | 是 | 要关联的属性数组。 | 要关联的属性数组。 | ```ts Environment.EnvProps([{"accessibilityEnabled", "default"},{"accessibilityUnEnabled","undefault"}]); @@ -723,8 +725,8 @@ Keys(): Array **返回值:** -| 类型 | 描述 | -| ------------- | ---------------------- | +| 类型 | 描述 | +| ------------- | ----------- | | Array | 返回关联的系统项数组。 | ```ts diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 10f782a3c3eba4e3eda332af68f51abb897f912b..4e2373e3f033f40e8eeebb742edad5397adc1810 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -490,6 +490,8 @@ - [时间选择弹窗](reference/arkui-ts/ts-methods-timepicker-dialog.md) - [文本选择弹窗](reference/arkui-ts/ts-methods-textpicker-dialog.md) - [菜单](reference/arkui-ts/ts-methods-menu.md) + - [应用级变量的状态管理](reference/arkui-ts/ts-state-management.md) + - [像素单位](reference/arkui-ts/ts-pixel-units.md) - [枚举说明](reference/arkui-ts/ts-appendix-enums.md) - [类型说明](reference/arkui-ts/ts-types.md) - 组件参考(兼容JS的类Web开发范式)