# 非线性容器PlainArray

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。


## 导入模块

```
import plainarray from '@ohos.plainarray'  
```


## 权限

无

## PlainArray


### 属性

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | PlainArray 的元素个数 |


### constructor

constructor()

constructor是PlainArray的构造函数。

- 参数：
  | 参数名 | 类型 | 可读 | 可写 | 说明 |
  | -------- | -------- | -------- | -------- | -------- |
  | 无 | 无 | 是 | 否 | 无 |

- 示例：
  ```
  let plainarray = new PlainArray();
  ```


### isEmpty

isEmpty(): boolean 

判断该容器是否为空

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 为空返回true, 不为空返回false |

- 示例:
  ```
  const plainarray = new PlainArray();
  plainarray.isEmpty();
  ```


### has

has(key: number): boolean

判断此容器中是否含有该指定key

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | number | 是 | 查询的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 是否包含指定元素 |

- 示例:
  ```
  let plainarray = new PlainArray()
  plainarray.has(1);
  plainarray.add(1, "sddfhf");
  plainarray.has(1);
  ```


### get

get(key: number): T

获取指定key所对应的value

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | number | 是 | 查找的指定key |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回key映射的value值 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.get(1);
  ```


### getIndexOfKey

getIndexOfKey(key: number): number

查找指定元素第一次出现的下标值,如果没有找到该元素返回-1

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | number | 是 | 被查找的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回第一次找到指定元素的下标,没有找到返回-1 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.getIndexOfKey("sdfs");
  ```


### getIndexOfValue

getIndexOfValue(value: T): number

查找指定元素第一次出现的下标值,如果没有找到该元素返回-1

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | T | 是 | 被查找的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回第一次找到指定元素的下标,没有找到返回-1 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.getIndexOfValue("sddfhf");
  ```


### getKeyAt

getKeyAt(index: number): number

查找指定下标的元素键值对中key值，否则返回undefined

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 所查找的下标 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回该下标对应的元素键值对中key值 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.getKeyAt(1);
  ```


### clone

clone(): PlainArray<T>

克隆一个一模一样的实例,并返回克隆后的实例,修改克隆后的实例并不会影响原实例

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | PlainArray<T> | 返回新的对象实例 |

- 示例:
  ```
  let plainarray = new ArrayList();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  let newPlainArray = plainarray.clone();
  ```


### add

add(key: number, value: T): boolean;

向容器中添加一组数据

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | number | 是 | 添加成员数据的键名。 |
  | value | T | 是 | 添加成员数据的值。 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 确认是否成功添加 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  ```


### remove

remove(key: number): T;

删除指定的元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | number | 是 | 依据key指定删除的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回删除元素的值 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.remove(2);
  ```


### removeAt

removeAt(index: number): boolean;

删除指定下标的元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 指定想要删除元素下标 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 确认是否成功删除元素 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.removeAt(1);
  ```


### removeRangeFrom

removeRangeFrom(index: number, size: number): number

删除一定范围内的元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 删除元素的起始下标 |
  | size | number | 是 | 期望删除元素个数 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 实际删除元素个数 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.removeAt(1, 3);
  ```


### setValueAt

setValueAt(index: number, newValue: T): void

向容器中具体位置替换键值对中的值

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 指定替换数据下标 |
  | newValue | T | 是 | 替换键值对中的值 |


- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.setValueAt(1, 3546);
  ```


### toString

toString(): String

获取包含容器中所有键和值的字符串

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | String | 返回一个字符串。 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.toString();
  ```


### clear

clear(): void

清除容器中的所有元素,并把length置为0

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.clear();
  ```


### forEach

forEach(callbackfn: (value: T, key?: number, plainarray?: PlainArray<number, T>) => void, thisArg?: Object): void 

通过回调函数来遍历实例对象上的元素以及元素对应的下标

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callbackfn | function | 是 | 回调函数。 |
  | thisArg | Object | 否 | callbackfn被调用时用作this值 |

- callbackfn的参数说明
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | T | 是 | 当前遍历到的元素键值对的值。 |
  | key | number | 是 | 当前遍历到的元素键值对的键。 |
  | plainarray | PlainArray<number, T> | 否 | 当前调用forEach方法的实例对象。 |

- 示例:
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  plainarray.forEach((value, key)=>{
    console.log(value, key)
  });
  ```


### [Symbol.iterator]

[Symbol.iterator](): IterableIterator<[number, T]>

返回一个迭代器，迭代器的每一项都是一个 JavaScript对象,并返回该对象。

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | IterableIterator&lt;[[number, T],&nbsp;boolean]&gt; | 返回一个迭代器。 |

- 示例：
  ```
  let plainarray = new PlainArray();
  plainarray.add(1, "sddfhf");
  plainarray.add(2, "sffdfhf");
  for (let item of plainarray) { 
    console.log("key: " + item.key);
    console.log("value: " + item.value);
  } 
  ```