未验证 提交 227e14d6 编写于 作者: O openharmony_ci 提交者: Gitee

!5352 纯净markdown,无需翻译

Merge pull request !5352 from zengyawen/OpenHarmony-3.1-Release
# Animation<a name="EN-US_TOPIC_0000001127125026"></a> # Animation
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import<a name="s0e7b1e85a4274f58a8206e0b065bd80c"></a> ## Modules to Import
**requestAnimationFrame**: none **requestAnimationFrame**: none
...@@ -15,67 +15,29 @@ ...@@ -15,67 +15,29 @@
import animator from '@ohos.animator'; import animator from '@ohos.animator';
``` ```
## Required Permissions<a name="section11257113618419"></a> ## Required Permissions
None None
## requestAnimationFrame<a name="s298a3cf59a3b470dbb0742706102ced7"></a> ## requestAnimationFrame
requestAnimationFrame\(handler\[, \[ ...args\]\]\): number requestAnimationFrame\(handler\[, \[ ...args\]\]\): number
Requests an animation frame. Requests an animation frame.
- Parameters - Parameters
<a name="t87748b0ba4e648079d53f9deccf4bfb2"></a> | Name | Type | Mandatory | Description |
<table><thead align="left"><tr id="rc5033ad045c14c2e806d59041aab002c"><th class="cellrowborder" valign="top" width="12%" id="mcps1.1.5.1.1"><p id="acf783ab6043e4ee1a7bb73b73a091e0b"><a name="acf783ab6043e4ee1a7bb73b73a091e0b"></a><a name="acf783ab6043e4ee1a7bb73b73a091e0b"></a>Name</p> | ------- | ----------- | --------- | ------------------------------------------------------------ |
</th> | handler | Function | Yes | Handler used to request a frame. When **requestAnimationFrame** calls the **handler**, the timestamp is passed to the first parameter to indicate the time when **requestAnimationFrame** starts to execute the callback. |
<th class="cellrowborder" valign="top" width="9%" id="mcps1.1.5.1.2"><p id="a6736505551534b819d5a6376065a25f6"><a name="a6736505551534b819d5a6376065a25f6"></a><a name="a6736505551534b819d5a6376065a25f6"></a>Type</p> | ...args | Array\<any> | No | Additional parameter, which is passed to the **handler** as a parameter during function callback. |
</th>
<th class="cellrowborder" valign="top" width="9%" id="mcps1.1.5.1.3"><p id="ac15c2a3de0e046af917cf09b48b3b46d"><a name="ac15c2a3de0e046af917cf09b48b3b46d"></a><a name="ac15c2a3de0e046af917cf09b48b3b46d"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="70%" id="mcps1.1.5.1.4"><p id="aeb94b88e78974288bab1b4940b50c840"><a name="aeb94b88e78974288bab1b4940b50c840"></a><a name="aeb94b88e78974288bab1b4940b50c840"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="r95c56d5cd62d4b518c3e7a3f158ed7fe"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="a7af41aec9a404f418202d90c61774825"><a name="a7af41aec9a404f418202d90c61774825"></a><a name="a7af41aec9a404f418202d90c61774825"></a>handler</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.2 "><p id="aed6ae868d61349afa8f0e250108f8e47"><a name="aed6ae868d61349afa8f0e250108f8e47"></a><a name="aed6ae868d61349afa8f0e250108f8e47"></a>Function</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.3 "><p id="ab72ac8cc02e34da4b717ca144fc521c1"><a name="ab72ac8cc02e34da4b717ca144fc521c1"></a><a name="ab72ac8cc02e34da4b717ca144fc521c1"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="ac53e6549d32f413e9c51cd8a53f4650a"><a name="ac53e6549d32f413e9c51cd8a53f4650a"></a><a name="ac53e6549d32f413e9c51cd8a53f4650a"></a>Handler used to request a frame. When <strong id="b83691144121"><a name="b83691144121"></a><a name="b83691144121"></a>requestAnimationFrame</strong> calls the <strong id="b17229515216"><a name="b17229515216"></a><a name="b17229515216"></a>handler</strong>, the timestamp is passed to the first parameter to indicate the time when <strong id="b1559713311312"><a name="b1559713311312"></a><a name="b1559713311312"></a>requestAnimationFrame</strong> starts to execute the callback.</p>
</td>
</tr>
<tr id="row8497154383016"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p1497174316302"><a name="p1497174316302"></a><a name="p1497174316302"></a>...args</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.2 "><p id="p1649714393019"><a name="p1649714393019"></a><a name="p1649714393019"></a>Array&lt;any&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.3 "><p id="p12498154363014"><a name="p12498154363014"></a><a name="p12498154363014"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p049816437303"><a name="p049816437303"></a><a name="p049816437303"></a>Additional parameter, which is passed to the <strong id="b9292174942"><a name="b9292174942"></a><a name="b9292174942"></a>handler</strong> as a parameter during function callback.</p>
</td>
</tr>
</tbody>
</table>
- Return values - Return values
<a name="table1430416594311"></a> | Type | Description |
<table><thead align="left"><tr id="row230485973113"><th class="cellrowborder" valign="top" width="12.18%" id="mcps1.1.3.1.1"><p id="p430405913312"><a name="p430405913312"></a><a name="p430405913312"></a>Type</p> | ------ | ----------- |
</th> | number | Request ID. |
<th class="cellrowborder" valign="top" width="87.82%" id="mcps1.1.3.1.2"><p id="p830413599312"><a name="p830413599312"></a><a name="p830413599312"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row130435914317"><td class="cellrowborder" valign="top" width="12.18%" headers="mcps1.1.3.1.1 "><p id="p4305759143119"><a name="p4305759143119"></a><a name="p4305759143119"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="87.82%" headers="mcps1.1.3.1.2 "><p id="p130555923110"><a name="p130555923110"></a><a name="p130555923110"></a>Request ID.</p>
</td>
</tr>
</tbody>
</table>
- Example - Example
``` ```
...@@ -125,7 +87,7 @@ Requests an animation frame. ...@@ -125,7 +87,7 @@ Requests an animation frame.
``` ```
## cancelAnimationFrame<a name="section114651915245"></a> ## cancelAnimationFrame
cancelAnimationFrame\(requestId: number\): void cancelAnimationFrame\(requestId: number\): void
...@@ -133,29 +95,10 @@ Cancels the animation frame request. ...@@ -133,29 +95,10 @@ Cancels the animation frame request.
- Parameters - Parameters
<a name="table25491571214"></a> | Name | Type | Mandatory | Description |
<table><thead align="left"><tr id="row1954910577117"><th class="cellrowborder" valign="top" width="12%" id="mcps1.1.5.1.1"><p id="p1854918574119"><a name="p1854918574119"></a><a name="p1854918574119"></a>Name</p> | --------- | ------ | --------- | ------------------------ |
</th> | requestId | number | Yes | ID of the frame request. |
<th class="cellrowborder" valign="top" width="9%" id="mcps1.1.5.1.2"><p id="p17549195713119"><a name="p17549195713119"></a><a name="p17549195713119"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="9%" id="mcps1.1.5.1.3"><p id="p1654910571912"><a name="p1654910571912"></a><a name="p1654910571912"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="70%" id="mcps1.1.5.1.4"><p id="p185491057813"><a name="p185491057813"></a><a name="p185491057813"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row05492571017"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p11549057812"><a name="p11549057812"></a><a name="p11549057812"></a>requestId</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.2 "><p id="p1454910571915"><a name="p1454910571915"></a><a name="p1454910571915"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.3 "><p id="p195491657811"><a name="p195491657811"></a><a name="p195491657811"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p165492579116"><a name="p165492579116"></a><a name="p165492579116"></a>ID of the frame request.</p>
</td>
</tr>
</tbody>
</table>
- Example - Example
``` ```
...@@ -209,224 +152,52 @@ Cancels the animation frame request. ...@@ -209,224 +152,52 @@ Cancels the animation frame request.
``` ```
## createAnimator<a name="section333714110229"></a> ## createAnimator
createAnimator\(options\[...\]\): void createAnimator\(options\[...\]\): void
Creates an animation object. Creates an animation object.
- Parameters - Parameters
| Name | Type | Mandatory | Description |
| ------- | ------ | --------- | ------------------------------------------------------------ |
| options | Object | Yes | Attributes of the **Animator** to be created. For details, see the options table. |
<a name="table1210814218489"></a> - Description of options
<table><thead align="left"><tr id="row16108162112483"><th class="cellrowborder" valign="top" width="12.030000000000001%" id="mcps1.1.5.1.1"><p id="p9108102124816"><a name="p9108102124816"></a><a name="p9108102124816"></a>Name</p>
</th> | Name | Type | Mandatory | Description |
<th class="cellrowborder" valign="top" width="8.97%" id="mcps1.1.5.1.2"><p id="p15108921134810"><a name="p15108921134810"></a><a name="p15108921134810"></a>Type</p> | ---------- | ------ | --------- | ------------------------------------------------------------ |
</th> | duration | number | No | Duration for playing an animation, in milliseconds. The default value is **0**. |
<th class="cellrowborder" valign="top" width="9%" id="mcps1.1.5.1.3"><p id="p610832174811"><a name="p610832174811"></a><a name="p610832174811"></a>Mandatory</p> | easing | string | No | Animation easing curve. The default value is **ease**. |
</th> | delay | number | No | Animation delay duration, in milliseconds. The default value is **0**, indicating that there is no delay. |
<th class="cellrowborder" valign="top" width="70%" id="mcps1.1.5.1.4"><p id="p20109102115481"><a name="p20109102115481"></a><a name="p20109102115481"></a>Description</p> | fill | string | No | Animation start/stop mode. The default value is **none**. |
</th> | direction | string | No | Animation playback mode. The default value is **normal**. |
</tr> | iterations | number | No | Number of times that an animation is played. The default value is **1**. If this parameter is set to **0**, the animation is not played. If this parameter is set to **-1**, the animation is played for an unlimited number of times. |
</thead> | begin | number | No | Start point of the animation easing. If this parameter is not set, the default value **0** is used. |
<tbody><tr id="row111091721194810"><td class="cellrowborder" valign="top" width="12.030000000000001%" headers="mcps1.1.5.1.1 "><p id="p191091121114816"><a name="p191091121114816"></a><a name="p191091121114816"></a>options</p> | end | number | No | End point of the animation easing. If this parameter is not set, the default value **1** is used. |
</td>
<td class="cellrowborder" valign="top" width="8.97%" headers="mcps1.1.5.1.2 "><p id="p51091212484"><a name="p51091212484"></a><a name="p51091212484"></a>Object</p>
</td>
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.1.5.1.3 "><p id="p17109112111489"><a name="p17109112111489"></a><a name="p17109112111489"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p9109221104814"><a name="p9109221104814"></a><a name="p9109221104814"></a>Attributes of the <strong id="b12693720715"><a name="b12693720715"></a><a name="b12693720715"></a>Animator</strong> to be created. For details, see the options table.</p>
</td>
</tr>
</tbody>
</table>
- Description of options
<a name="table185831411112210"></a>
<table><thead align="left"><tr id="row13579511112217"><th class="cellrowborder" valign="top" width="12%" id="mcps1.1.5.1.1"><p id="p6578111142211"><a name="p6578111142211"></a><a name="p6578111142211"></a>Name</p>
</th>
<th class="cellrowborder" valign="top" width="10%" id="mcps1.1.5.1.2"><p id="p8578811182212"><a name="p8578811182212"></a><a name="p8578811182212"></a>Type</p>
</th>
<th class="cellrowborder" valign="top" width="8%" id="mcps1.1.5.1.3"><p id="p557961122219"><a name="p557961122219"></a><a name="p557961122219"></a>Mandatory</p>
</th>
<th class="cellrowborder" valign="top" width="70%" id="mcps1.1.5.1.4"><p id="p14579101116224"><a name="p14579101116224"></a><a name="p14579101116224"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row125801711102218"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p1857912118220"><a name="p1857912118220"></a><a name="p1857912118220"></a>duration</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p45798110229"><a name="p45798110229"></a><a name="p45798110229"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p35793112223"><a name="p35793112223"></a><a name="p35793112223"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p17580011172219"><a name="p17580011172219"></a><a name="p17580011172219"></a>Duration for playing an animation, in milliseconds. The default value is <strong id="b1125162610819"><a name="b1125162610819"></a><a name="b1125162610819"></a>0</strong>.</p>
</td>
</tr>
<tr id="row55801511172212"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p14580711152210"><a name="p14580711152210"></a><a name="p14580711152210"></a>easing</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p19580141112217"><a name="p19580141112217"></a><a name="p19580141112217"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p658021122212"><a name="p658021122212"></a><a name="p658021122212"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p18580121112212"><a name="p18580121112212"></a><a name="p18580121112212"></a>Animation easing curve. The default value is <strong id="b188750351389"><a name="b188750351389"></a><a name="b188750351389"></a>ease</strong>.</p>
</td>
</tr>
<tr id="row558071118228"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p1580111117227"><a name="p1580111117227"></a><a name="p1580111117227"></a>delay</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p6580111102215"><a name="p6580111102215"></a><a name="p6580111102215"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p1258016113229"><a name="p1258016113229"></a><a name="p1258016113229"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p858021152215"><a name="p858021152215"></a><a name="p858021152215"></a>Animation delay duration, in milliseconds. The default value is <strong id="b76079311298"><a name="b76079311298"></a><a name="b76079311298"></a>0</strong>, indicating that there is no delay.</p>
</td>
</tr>
<tr id="row1358151113223"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p1358119115228"><a name="p1358119115228"></a><a name="p1358119115228"></a>fill</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p15581211132210"><a name="p15581211132210"></a><a name="p15581211132210"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p1458171119226"><a name="p1458171119226"></a><a name="p1458171119226"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p185811411172213"><a name="p185811411172213"></a><a name="p185811411172213"></a>Animation start/stop mode. The default value is <strong id="b758714215913"><a name="b758714215913"></a><a name="b758714215913"></a>none</strong>. For details, see <a href="../../nottoctopics/en-us_topic_0000001173164765.md#p886655314713">animation-fill-mode</a>.</p>
</td>
</tr>
<tr id="row18581811142219"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p75817112225"><a name="p75817112225"></a><a name="p75817112225"></a>direction</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p1258118115221"><a name="p1258118115221"></a><a name="p1258118115221"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p17581211122213"><a name="p17581211122213"></a><a name="p17581211122213"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p195811211152214"><a name="p195811211152214"></a><a name="p195811211152214"></a>Animation playback mode. The default value is <strong id="b599714386107"><a name="b599714386107"></a><a name="b599714386107"></a>normal</strong>. For details, see <a href="../../nottoctopics/en-us_topic_0000001173164765.md#p2611151295818">animation-direction</a>.</p>
</td>
</tr>
<tr id="row55821511122210"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p16581171118226"><a name="p16581171118226"></a><a name="p16581171118226"></a>iterations</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p1582151113228"><a name="p1582151113228"></a><a name="p1582151113228"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p205821311132214"><a name="p205821311132214"></a><a name="p205821311132214"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p1458201118221"><a name="p1458201118221"></a><a name="p1458201118221"></a>Number of times that an animation is played. The default value is <strong id="b11868105418107"><a name="b11868105418107"></a><a name="b11868105418107"></a>1</strong>. If this parameter is set to <strong id="b10384143101114"><a name="b10384143101114"></a><a name="b10384143101114"></a>0</strong>, the animation is not played. If this parameter is set to <strong id="b1196115711115"><a name="b1196115711115"></a><a name="b1196115711115"></a>-1</strong>, the animation is played for an unlimited number of times.</p>
</td>
</tr>
<tr id="row1958211116223"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p205821811152213"><a name="p205821811152213"></a><a name="p205821811152213"></a>begin</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p10582211122219"><a name="p10582211122219"></a><a name="p10582211122219"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p758281111223"><a name="p758281111223"></a><a name="p758281111223"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p105820113229"><a name="p105820113229"></a><a name="p105820113229"></a>Start point of the animation easing. If this parameter is not set, the default value <strong id="b10935111319129"><a name="b10935111319129"></a><a name="b10935111319129"></a>0</strong> is used.</p>
</td>
</tr>
<tr id="row12583191192217"><td class="cellrowborder" valign="top" width="12%" headers="mcps1.1.5.1.1 "><p id="p55828118227"><a name="p55828118227"></a><a name="p55828118227"></a>end</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.1.5.1.2 "><p id="p1958231192220"><a name="p1958231192220"></a><a name="p1958231192220"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="8%" headers="mcps1.1.5.1.3 "><p id="p8582811132216"><a name="p8582811132216"></a><a name="p8582811132216"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.1.5.1.4 "><p id="p195831211122216"><a name="p195831211122216"></a><a name="p195831211122216"></a>End point of the animation easing. If this parameter is not set, the default value <strong id="b86451784138"><a name="b86451784138"></a><a name="b86451784138"></a>1</strong> is used.</p>
</td>
</tr>
</tbody>
</table>
- animator interfaces - animator interfaces
<a name="table10586161118228"></a> | Name | Type | Description |
<table><thead align="left"><tr id="row16584611182210"><th class="cellrowborder" valign="top" width="15.57%" id="mcps1.1.4.1.1"><p id="p658331152213"><a name="p658331152213"></a><a name="p658331152213"></a>Name</p> | ------- | ------- | ------------------------------------------------------------ |
</th> | update | options | Updates the animation parameters. The input parameters are the same as those of **createAnimator**. |
<th class="cellrowborder" valign="top" width="11.899999999999999%" id="mcps1.1.4.1.2"><p id="p11583131119222"><a name="p11583131119222"></a><a name="p11583131119222"></a>Type</p> | play | - | Starts an animation. |
</th> | finish | - | Ends an animation. |
<th class="cellrowborder" valign="top" width="72.53%" id="mcps1.1.4.1.3"><p id="p6583311102210"><a name="p6583311102210"></a><a name="p6583311102210"></a>Description</p> | pause | - | Pauses an animation. |
</th> | cancel | - | Cancels an animation. |
</tr> | reverse | - | Reverses an animation. |
</thead>
<tbody><tr id="row2584511152213"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p1658451192210"><a name="p1658451192210"></a><a name="p1658451192210"></a>update</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p458481114225"><a name="p458481114225"></a><a name="p458481114225"></a>options</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p15584161112214"><a name="p15584161112214"></a><a name="p15584161112214"></a>Updates the animation parameters. The input parameters are the same as those of <strong id="b15428258171314"><a name="b15428258171314"></a><a name="b15428258171314"></a>createAnimator</strong>.</p>
</td>
</tr>
<tr id="row1758471118228"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p9584181118221"><a name="p9584181118221"></a><a name="p9584181118221"></a>play</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p115841811122215"><a name="p115841811122215"></a><a name="p115841811122215"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p758411111224"><a name="p758411111224"></a><a name="p758411111224"></a>Starts an animation.</p>
</td>
</tr>
<tr id="row155855111221"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p205845117227"><a name="p205845117227"></a><a name="p205845117227"></a>finish</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p1584181122217"><a name="p1584181122217"></a><a name="p1584181122217"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p12585101192212"><a name="p12585101192212"></a><a name="p12585101192212"></a>Ends an animation.</p>
</td>
</tr>
<tr id="row85851611122215"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p858561115223"><a name="p858561115223"></a><a name="p858561115223"></a>pause</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p3585711102215"><a name="p3585711102215"></a><a name="p3585711102215"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p1758510114227"><a name="p1758510114227"></a><a name="p1758510114227"></a>Pauses an animation.</p>
</td>
</tr>
<tr id="row8585611102219"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p5585201172218"><a name="p5585201172218"></a><a name="p5585201172218"></a>cancel</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p458511117225"><a name="p458511117225"></a><a name="p458511117225"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p17585911122213"><a name="p17585911122213"></a><a name="p17585911122213"></a>Cancels an animation.</p>
</td>
</tr>
<tr id="row1358612115227"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p1858571119222"><a name="p1858571119222"></a><a name="p1858571119222"></a>reverse</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p9585161152215"><a name="p9585161152215"></a><a name="p9585161152215"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p458641172220"><a name="p458641172220"></a><a name="p458641172220"></a>Reverses an animation.</p>
</td>
</tr>
</tbody>
</table>
- **animator** supported events: - **animator** supported events:
<a name="table4588511132210"></a> | Name | Type | Description |
<table><thead align="left"><tr id="row19586141116227"><th class="cellrowborder" valign="top" width="15.57%" id="mcps1.1.4.1.1"><p id="p15586101111222"><a name="p15586101111222"></a><a name="p15586101111222"></a>Name</p> | ------ | ------ | ----------------------------------- |
</th> | frame | number | The frame is requested. |
<th class="cellrowborder" valign="top" width="11.899999999999999%" id="mcps1.1.4.1.2"><p id="p1858671142217"><a name="p1858671142217"></a><a name="p1858671142217"></a>Type</p> | cancel | - | The animation is forcibly canceled. |
</th> | finish | - | The animation playback is complete. |
<th class="cellrowborder" valign="top" width="72.53%" id="mcps1.1.4.1.3"><p id="p1658681118229"><a name="p1658681118229"></a><a name="p1658681118229"></a>Description</p> | repeat | - | The animation replays. |
</th>
</tr>
</thead>
<tbody><tr id="row19587611102214"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p15866114221"><a name="p15866114221"></a><a name="p15866114221"></a>frame</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p135862119221"><a name="p135862119221"></a><a name="p135862119221"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p4586191119224"><a name="p4586191119224"></a><a name="p4586191119224"></a>The frame is requested.</p>
</td>
</tr>
<tr id="row15587161162211"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p2058731119223"><a name="p2058731119223"></a><a name="p2058731119223"></a>cancel</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p058751172212"><a name="p058751172212"></a><a name="p058751172212"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p1587121102211"><a name="p1587121102211"></a><a name="p1587121102211"></a>The animation is forcibly canceled.</p>
</td>
</tr>
<tr id="row65871211192213"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p8587141192219"><a name="p8587141192219"></a><a name="p8587141192219"></a>finish</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p8587211152212"><a name="p8587211152212"></a><a name="p8587211152212"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p135870119227"><a name="p135870119227"></a><a name="p135870119227"></a>The animation playback is complete.</p>
</td>
</tr>
<tr id="row175881011182210"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.1.4.1.1 "><p id="p2587511182210"><a name="p2587511182210"></a><a name="p2587511182210"></a>repeat</p>
</td>
<td class="cellrowborder" valign="top" width="11.899999999999999%" headers="mcps1.1.4.1.2 "><p id="p17587511192218"><a name="p17587511192218"></a><a name="p17587511192218"></a>-</p>
</td>
<td class="cellrowborder" valign="top" width="72.53%" headers="mcps1.1.4.1.3 "><p id="p10587811202211"><a name="p10587811202211"></a><a name="p10587811202211"></a>The animation replays.</p>
</td>
</tr>
</tbody>
</table>
- Example - Example
``` ```
...@@ -474,6 +245,4 @@ Creates an animation object. ...@@ -474,6 +245,4 @@ Creates an animation object.
this.animator.play(); this.animator.play();
} }
} }
``` ```
\ No newline at end of file
# Battery Info<a name="EN-US_TOPIC_0000001121409574"></a> # Battery Info
>![](../../public_sys-resources/icon-note.gif) **NOTE:** >![](../../public_sys-resources/icon-note.gif) **NOTE:**
>The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. >The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
The Battery Info module provides APIs for querying the charger type, battery health status, and battery charging status. The Battery Info module provides APIs for querying the charger type, battery health status, and battery charging status.
## Modules to Import<a name="section199443271307"></a> ## Modules to Import
```js ```js
import batteryInfo from '@ohos.batteryInfo'; import batteryInfo from '@ohos.batteryInfo';
...@@ -16,264 +16,63 @@ import batteryInfo from '@ohos.batteryInfo'; ...@@ -16,264 +16,63 @@ import batteryInfo from '@ohos.batteryInfo';
SystemCapability.PowerManager.BatteryManager SystemCapability.PowerManager.BatteryManager
## Attributes<a name="section0536924123914"></a> ## Attributes
Describes battery information. Describes battery information.
<a name="table20633101642315"></a> | Name | Type | Readable | Writable | Description |
<table><thead align="left"><tr id="row663331618238"><th class="cellrowborder" valign="top" width="21.58%" id="mcps1.1.6.1.1"><p id="a3d0fc780cc904c1cbab7991251622f65"><a name="a3d0fc780cc904c1cbab7991251622f65"></a><a name="a3d0fc780cc904c1cbab7991251622f65"></a>Name</p> | ----------------------------- | ----------------------------------------- | -------- | -------- | ------------------------------------------------------------ |
</th> | batterySOC | number | Yes | No | Battery state of charge (SoC) of the current device, in unit of percentage. |
<th class="cellrowborder" valign="top" width="21.349999999999998%" id="mcps1.1.6.1.2"><p id="ac1f1afc248084f8fb51242b648bc34de"><a name="ac1f1afc248084f8fb51242b648bc34de"></a><a name="ac1f1afc248084f8fb51242b648bc34de"></a>Type</p> | chargingStatus | [BatteryChargeState](#batterychargestate) | Yes | No | Battery charging state of the current device. |
</th> | healthStatus | [BatteryHealthState](#batteryhealthstate) | Yes | No | Battery health state of the current device. |
<th class="cellrowborder" valign="top" width="6.950000000000001%" id="mcps1.1.6.1.3"><p id="p15118503351"><a name="p15118503351"></a><a name="p15118503351"></a>Readable</p> | pluggedType | [BatteryPluggedType](#batterypluggertype) | Yes | No | Charger type of the current device. |
</th> | voltage | number | Yes | No | Battery voltage of the current device, in unit of microvolt. |
<th class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.1.6.1.4"><p id="p13804175213358"><a name="p13804175213358"></a><a name="p13804175213358"></a>Writable</p> | technology | string | Yes | No | Battery technology of the current device. |
</th> | batteryTemperature | number | Yes | No | Battery temperature of the current device, in unit of 0.1°C. |
<th class="cellrowborder" valign="top" width="42.6%" id="mcps1.1.6.1.5"><p id="afec895de33f94e3c87ee7acc20190a17"><a name="afec895de33f94e3c87ee7acc20190a17"></a><a name="afec895de33f94e3c87ee7acc20190a17"></a>Description</p> | isBatteryPresent<sup>7+</sup> | boolean | Yes | No | Whether the battery is supported or present. |
</th>
</tr>
</thead>
<tbody><tr id="row188481425182510"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p938441717208"><a name="p938441717208"></a><a name="p938441717208"></a>batterySOC</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p6354841201511"><a name="p6354841201511"></a><a name="p6354841201511"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p71155043513"><a name="p71155043513"></a><a name="p71155043513"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p188058527352"><a name="p188058527352"></a><a name="p188058527352"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p103961315181818"><a name="p103961315181818"></a><a name="p103961315181818"></a>Battery state of charge (SoC) of the current device, in unit of percentage.</p>
</td>
</tr>
<tr id="row0461622112513"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p5354124120158"><a name="p5354124120158"></a><a name="p5354124120158"></a>chargingStatus</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p10354541181520"><a name="p10354541181520"></a><a name="p10354541181520"></a><a href="#section629045815408">BatteryChargeState</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p11113502356"><a name="p11113502356"></a><a name="p11113502356"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p280555253510"><a name="p280555253510"></a><a name="p280555253510"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p238673617568"><a name="p238673617568"></a><a name="p238673617568"></a>Battery charging state of the current device.</p>
</td>
</tr>
<tr id="row09415619242"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p1435434117152"><a name="p1435434117152"></a><a name="p1435434117152"></a>healthStatus</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p3354114131518"><a name="p3354114131518"></a><a name="p3354114131518"></a><a href="#section1636311513419">BatteryHealthState</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p16111250153517"><a name="p16111250153517"></a><a name="p16111250153517"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p38051525356"><a name="p38051525356"></a><a name="p38051525356"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p1365563875614"><a name="p1365563875614"></a><a name="p1365563875614"></a>Battery health state of the current device.</p>
</td>
</tr>
<tr id="row56471975243"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p1835534116158"><a name="p1835534116158"></a><a name="p1835534116158"></a>pluggedType</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p235584114153"><a name="p235584114153"></a><a name="p235584114153"></a><a href="#section1861134715488">BatteryPluggedType</a></p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p111125093513"><a name="p111125093513"></a><a name="p111125093513"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p198051752183511"><a name="p198051752183511"></a><a name="p198051752183511"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p19264101622016"><a name="p19264101622016"></a><a name="p19264101622016"></a>Charger type of the current device.</p>
</td>
</tr>
<tr id="row4536161934520"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p14355174151513"><a name="p14355174151513"></a><a name="p14355174151513"></a>voltage</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p7355741201519"><a name="p7355741201519"></a><a name="p7355741201519"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p1811195013354"><a name="p1811195013354"></a><a name="p1811195013354"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p1580585263519"><a name="p1580585263519"></a><a name="p1580585263519"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p127111826172018"><a name="p127111826172018"></a><a name="p127111826172018"></a>Battery voltage of the current device, in unit of microvolt.</p>
</td>
</tr>
<tr id="row597319245451"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p153551941141517"><a name="p153551941141517"></a><a name="p153551941141517"></a>technology</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p535514113154"><a name="p535514113154"></a><a name="p535514113154"></a>string</p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p3111650133514"><a name="p3111650133514"></a><a name="p3111650133514"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p1680575273515"><a name="p1680575273515"></a><a name="p1680575273515"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p9298104612205"><a name="p9298104612205"></a><a name="p9298104612205"></a>Battery technology of the current device.</p>
</td>
</tr>
<tr id="row4978143312456"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p7355114151515"><a name="p7355114151515"></a><a name="p7355114151515"></a>batteryTemperature</p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p143551941201510"><a name="p143551941201510"></a><a name="p143551941201510"></a>number</p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p14694205103613"><a name="p14694205103613"></a><a name="p14694205103613"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p980518523359"><a name="p980518523359"></a><a name="p980518523359"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p7843573202"><a name="p7843573202"></a><a name="p7843573202"></a>Battery temperature of the current device, in unit of 0.1°C.</p>
</td>
</tr>
<tr id="row115952572810"><td class="cellrowborder" valign="top" width="21.58%" headers="mcps1.1.6.1.1 "><p id="p959152510281"><a name="p959152510281"></a><a name="p959152510281"></a>isBatteryPresent<sup id="sup15407935624"><a name="sup15407935624"></a><a name="sup15407935624"></a>7+</sup></p>
</td>
<td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.1.6.1.2 "><p id="p659025192819"><a name="p659025192819"></a><a name="p659025192819"></a>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="6.950000000000001%" headers="mcps1.1.6.1.3 "><p id="p1012195020357"><a name="p1012195020357"></a><a name="p1012195020357"></a>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.1.6.1.4 "><p id="p9805105213352"><a name="p9805105213352"></a><a name="p9805105213352"></a>No</p>
</td>
<td class="cellrowborder" valign="top" width="42.6%" headers="mcps1.1.6.1.5 "><p id="p15590255280"><a name="p15590255280"></a><a name="p15590255280"></a>Whether the battery is supported or present.</p>
</td>
</tr>
</tbody>
</table>
- Example **Example**
```js ```js
import batteryInfo from '@ohos.batteryInfo'; import batteryInfo from '@ohos.batteryInfo';
var batterySoc = batteryInfo.batterySOC; var batterySoc = batteryInfo.batterySOC;
``` ```
## BatteryPluggedType<a name="section1861134715488"></a> ## BatteryPluggedType
Enumerates charger types. Enumerates charger types.
<a name="table144441452192814"></a> | Name | Default Value | Description |
<table><thead align="left"><tr id="row12444145210288"><th class="cellrowborder" valign="top" width="31.703170317031702%" id="mcps1.1.4.1.1"><p id="p162914100272"><a name="p162914100272"></a><a name="p162914100272"></a>Name</p> | -------- | ------------- | ---------------- |
</th> | NONE | 0 | Unknown type |
<th class="cellrowborder" valign="top" width="35.253525352535256%" id="mcps1.1.4.1.2"><p id="p044416523286"><a name="p044416523286"></a><a name="p044416523286"></a>Default Value</p> | AC | 1 | AC charger |
</th> | USB | 2 | USB charger |
<th class="cellrowborder" valign="top" width="33.043304330433045%" id="mcps1.1.4.1.3"><p id="p1044495252810"><a name="p1044495252810"></a><a name="p1044495252810"></a>Description</p> | WIRELESS | 3 | Wireless charger |
</th>
</tr>
</thead>
<tbody><tr id="row18444115215284"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p954122310283"><a name="p954122310283"></a><a name="p954122310283"></a>NONE</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p0527233288"><a name="p0527233288"></a><a name="p0527233288"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p12372352812"><a name="p12372352812"></a><a name="p12372352812"></a>Unknown type</p>
</td>
</tr>
<tr id="row55389918289"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p15381795285"><a name="p15381795285"></a><a name="p15381795285"></a>AC</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p45381291281"><a name="p45381291281"></a><a name="p45381291281"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p1953979102813"><a name="p1953979102813"></a><a name="p1953979102813"></a>AC charger</p>
</td>
</tr>
<tr id="row928621592815"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p1328691518288"><a name="p1328691518288"></a><a name="p1328691518288"></a>USB</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p1728616154286"><a name="p1728616154286"></a><a name="p1728616154286"></a>2</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p188591922163215"><a name="p188591922163215"></a><a name="p188591922163215"></a>USB charger</p>
</td>
</tr>
<tr id="row3954122652810"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p1995412614284"><a name="p1995412614284"></a><a name="p1995412614284"></a>WIRELESS</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p395402620286"><a name="p395402620286"></a><a name="p395402620286"></a>3</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p235192423214"><a name="p235192423214"></a><a name="p235192423214"></a>Wireless charger</p>
</td>
</tr>
</tbody>
</table>
## BatteryChargeState<a name="section629045815408"></a>
## BatteryChargeState
Enumerates charging states. Enumerates charging states.
<a name="table1368716015365"></a> | Name | Default Value | Description |
<table><thead align="left"><tr id="row106884010367"><th class="cellrowborder" valign="top" width="31.703170317031702%" id="mcps1.1.4.1.1"><p id="p468816023615"><a name="p468816023615"></a><a name="p468816023615"></a>Name</p> | ------- | ------------- | --------------------------------- |
</th> | NONE | 0 | Unknown state. |
<th class="cellrowborder" valign="top" width="35.253525352535256%" id="mcps1.1.4.1.2"><p id="p15688505362"><a name="p15688505362"></a><a name="p15688505362"></a>Default Value</p> | ENABLE | 1 | The battery is being charged. |
</th> | DISABLE | 2 | The battery is not being charged. |
<th class="cellrowborder" valign="top" width="33.043304330433045%" id="mcps1.1.4.1.3"><p id="p1068830103619"><a name="p1068830103619"></a><a name="p1068830103619"></a>Description</p> | FULL | 3 | The battery is fully charged. |
</th>
</tr>
</thead>
<tbody><tr id="row1868880113613"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p1392942212399"><a name="p1392942212399"></a><a name="p1392942212399"></a>NONE</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p968880103613"><a name="p968880103613"></a><a name="p968880103613"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p16911819163919"><a name="p16911819163919"></a><a name="p16911819163919"></a>Unknown state.</p>
</td>
</tr>
<tr id="row17688180173620"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p12928922193920"><a name="p12928922193920"></a><a name="p12928922193920"></a>ENABLE</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p86893003614"><a name="p86893003614"></a><a name="p86893003614"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p9910201913391"><a name="p9910201913391"></a><a name="p9910201913391"></a>The battery is being charged.</p>
</td>
</tr>
<tr id="row1868914011367"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p4926152211394"><a name="p4926152211394"></a><a name="p4926152211394"></a>DISABLE</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p186891001361"><a name="p186891001361"></a><a name="p186891001361"></a>2</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p1210733413414"><a name="p1210733413414"></a><a name="p1210733413414"></a>The battery is not being charged.</p>
</td>
</tr>
<tr id="row068911018360"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p1992542211392"><a name="p1992542211392"></a><a name="p1992542211392"></a>FULL</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p46895023619"><a name="p46895023619"></a><a name="p46895023619"></a>3</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p3614135154120"><a name="p3614135154120"></a><a name="p3614135154120"></a>The battery is fully charged.</p>
</td>
</tr>
</tbody>
</table>
## BatteryHealthState<a name="section1636311513419"></a> ## BatteryHealthState
Enumerates battery health states. Enumerates battery health states.
<a name="table1646153519380"></a> | Name | Default Value | Description |
<table><thead align="left"><tr id="row1847203533813"><th class="cellrowborder" valign="top" width="31.703170317031702%" id="mcps1.1.4.1.1"><p id="p44743514381"><a name="p44743514381"></a><a name="p44743514381"></a>Name</p> | ----------- | ------------- | ------------------------------------ |
</th> | UNKNOWN | 0 | Unknown state. |
<th class="cellrowborder" valign="top" width="35.253525352535256%" id="mcps1.1.4.1.2"><p id="p164783513817"><a name="p164783513817"></a><a name="p164783513817"></a>Default Value</p> | GOOD | 1 | The battery is in the healthy state. |
</th> | OVERHEAT | 2 | The battery is overheated. |
<th class="cellrowborder" valign="top" width="33.043304330433045%" id="mcps1.1.4.1.3"><p id="p447153533816"><a name="p447153533816"></a><a name="p447153533816"></a>Description</p> | OVERVOLTAGE | 3 | The battery voltage is over high. |
</th> | COLD | 4 | The battery temperature is low. |
</tr> | DEAD | 5 | The battery is dead. |
</thead>
<tbody><tr id="row10475355385"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p9268513193910"><a name="p9268513193910"></a><a name="p9268513193910"></a>UNKNOWN</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p147113523813"><a name="p147113523813"></a><a name="p147113523813"></a>0</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p840231793914"><a name="p840231793914"></a><a name="p840231793914"></a>Unknown state.</p>
</td>
</tr>
<tr id="row114716352387"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p426781333915"><a name="p426781333915"></a><a name="p426781333915"></a>GOOD</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p44843519383"><a name="p44843519383"></a><a name="p44843519383"></a>1</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p540191793918"><a name="p540191793918"></a><a name="p540191793918"></a>The battery is in the healthy state.</p>
</td>
</tr>
<tr id="row8481935183816"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p82651913183910"><a name="p82651913183910"></a><a name="p82651913183910"></a>OVERHEAT</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p184818358383"><a name="p184818358383"></a><a name="p184818358383"></a>2</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p2399117183918"><a name="p2399117183918"></a><a name="p2399117183918"></a>The battery is overheated.</p>
</td>
</tr>
<tr id="row1448163593819"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p10235161343911"><a name="p10235161343911"></a><a name="p10235161343911"></a>OVERVOLTAGE</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p34863518387"><a name="p34863518387"></a><a name="p34863518387"></a>3</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p203691717193914"><a name="p203691717193914"></a><a name="p203691717193914"></a>The battery voltage is over high.</p>
</td>
</tr>
<tr id="row2096919723911"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p12970127203916"><a name="p12970127203916"></a><a name="p12970127203916"></a>COLD</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p17970572396"><a name="p17970572396"></a><a name="p17970572396"></a>4</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p20970177153913"><a name="p20970177153913"></a><a name="p20970177153913"></a>The battery temperature is low.</p>
</td>
</tr>
<tr id="row497017143917"><td class="cellrowborder" valign="top" width="31.703170317031702%" headers="mcps1.1.4.1.1 "><p id="p19710712394"><a name="p19710712394"></a><a name="p19710712394"></a>DEAD</p>
</td>
<td class="cellrowborder" valign="top" width="35.253525352535256%" headers="mcps1.1.4.1.2 "><p id="p997117733916"><a name="p997117733916"></a><a name="p997117733916"></a>5</p>
</td>
<td class="cellrowborder" valign="top" width="33.043304330433045%" headers="mcps1.1.4.1.3 "><p id="p13971137153918"><a name="p13971137153918"></a><a name="p13971137153918"></a>The battery is dead.</p>
</td>
</tr>
</tbody>
</table>
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册