js-apis-list.md 11.7 KB
Newer Older
L
linhaoran 已提交
1 2 3 4 5 6 7 8 9
# 线性容器List 

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


## 导入模块

```
10
import List from '@ohos.util.List'  
L
linhaoran 已提交
11 12
```

Z
zengyawen 已提交
13
## 系统能力
L
linhaoran 已提交
14

Z
zengyawen 已提交
15
SystemCapability.Utils.Lang
L
linhaoran 已提交
16 17 18 19 20 21 22 23 24


## List


### 属性

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
25
| length | number | 是 | 否 | List的元素个数。 |
L
linhaoran 已提交
26 27 28 29


### constructor

30
constructor()
L
linhaoran 已提交
31 32 33

List的构造函数。

Z
zengyawen 已提交
34 35

**示例:**
L
linhaoran 已提交
36

Z
zengyawen 已提交
37 38 39
```
let list = new List();
```
L
linhaoran 已提交
40 41 42 43


### add

Z
zengyawen 已提交
44
add(element: T): boolean
L
linhaoran 已提交
45 46 47

在List尾部插入元素。

Z
zengyawen 已提交
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| element | T | 是 | 添加进去的元素。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| boolean | 插入成功返回true,否则返回false。 |

**示例:**

```
63
let list = new List();
64 65
let result = list.add("a");
let result1 = list.add(1);
Z
zengyawen 已提交
66 67 68
let b = [1, 2, 3];
list.add(b);
let c = {name : "lala", age : "13"};
69
let result3 = list.add(false);
Z
zengyawen 已提交
70
```
L
linhaoran 已提交
71 72 73

### insert

Z
zengyawen 已提交
74
insert(element: T, index: number): void
L
linhaoran 已提交
75 76 77

在长度范围内任意位置插入指定元素。

Z
zengyawen 已提交
78 79 80 81 82 83
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| element | T | 是 | 插入元素。 |
| index | number | 是 | 插入的位置索引。 |
L
linhaoran 已提交
84

Z
zengyawen 已提交
85 86 87 88 89 90 91 92
**示例:**

```
let list = new List();
list.insert("A", 0);
list.insert(0, 1);
list.insert(true, 2);
```
L
linhaoran 已提交
93 94 95

### has

Z
zengyawen 已提交
96
has(element: T): boolean
L
linhaoran 已提交
97 98 99

判断此List中是否含有该指定元素。

Z
zengyawen 已提交
100 101 102 103 104
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| element | T | 是 | 指定元素。 |
L
linhaoran 已提交
105

Z
zengyawen 已提交
106
**返回值:**
L
linhaoran 已提交
107

Z
zengyawen 已提交
108 109 110 111 112 113 114 115
| 类型 | 说明 |
| -------- | -------- |
| boolean | 包含指定元素返回true,否则返回false。 |

**示例:**

```
let list = new List();
116
let result = list.has("Ahfbrgrbgnutfodgorrogorg");
Z
zengyawen 已提交
117
list.add("Ahfbrgrbgnutfodgorrogorg");
118
let result1 = list.has("Ahfbrgrbgnutfodgorrogorg");
Z
zengyawen 已提交
119
```
L
linhaoran 已提交
120 121 122

### get

Z
zengyawen 已提交
123
get(index: number): T
L
linhaoran 已提交
124 125 126

根据下标获取List中的元素。

Z
zengyawen 已提交
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
**参数:**

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| T | 根据下标查找到的元素。 |

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(1);
list.add(2);
list.add(4);
150
let result = list.get(2);
Z
zengyawen 已提交
151 152
```

L
linhaoran 已提交
153 154
### getLastIndexOf

Z
zengyawen 已提交
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
getLastIndexOf(element: T): number

查找指定元素最后一次出现的下标值,查找失败返回-1。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| element | T | 是 | 指定元素。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| number | 查找指定元素最后一次出现的下标值,查找失败返回-1。 |

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(1);
list.add(2);
list.add(4);
182
let result = list.getLastIndexOf(2);
Z
zengyawen 已提交
183
```
L
linhaoran 已提交
184 185 186

### getIndexOf

Z
zengyawen 已提交
187 188 189 190 191 192 193 194 195 196 197 198 199 200
getIndexOf(element: T): number

查找指定元素第一次出现的下标值,查找失败返回-1。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| element | T | 是 | 指定元素。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
201
| number | 返回第一次找到指定元素的下标,没有找到返回-1。 |
Z
zengyawen 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(1);
list.add(2);
list.add(4);
list.getIndexOf(2);
215
let result = list.getIndexOf(2);
Z
zengyawen 已提交
216
```
L
linhaoran 已提交
217 218 219

### equal

Z
zengyawen 已提交
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
equal(obj: Object): boolean

比较指定对象与此List是否相等。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| obj | Object | 是 | 用来比较的对象。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| boolean | 如果对象与此列表相同回true,否则返回false。 |

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
let obj1 = new List();
obj1.add(2);
obj1.add(4);
obj1.add(5);
list.equal(obj1);
let obj2 = {name : "lala", age : "13"};
250
let result = list.equal(obj2);
Z
zengyawen 已提交
251 252
```

L
linhaoran 已提交
253 254
### removeByIndex

Z
zengyawen 已提交
255
removeByIndex(index: number): T
L
linhaoran 已提交
256 257 258

根据元素的下标值查找元素,返回元素后将其删除。

Z
zengyawen 已提交
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 指定元素的下标值。 |

**返回值:**

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

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(4);
280
let result = list.removeByIndex(2);
Z
zengyawen 已提交
281
```
L
linhaoran 已提交
282 283 284

### remove

Z
zengyawen 已提交
285
remove(element: T): boolean
L
linhaoran 已提交
286 287 288

删除查找到的第一个指定的元素。

Z
zengyawen 已提交
289 290 291 292
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
293
| element | T | 是 | 指定元素。 |
Z
zengyawen 已提交
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| boolean | 删除成功返回true,否则返回false。 |

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
309
let result = list.remove(2);
Z
zengyawen 已提交
310
```
L
linhaoran 已提交
311 312

### replaceAllElements
313

L
linhaoran 已提交
314
replaceAllElements(callbackfn: (value: T, index?: number, list?: List<T>) => T,
Z
zengyawen 已提交
315
thisArg?: Object): void
L
linhaoran 已提交
316 317 318

用户操作List中的元素,用操作后的元素替换原元素并返回操作后的元素。

Z
zengyawen 已提交
319 320 321 322 323 324 325 326 327 328 329 330 331
**参数:**

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

callbackfn的参数说明:

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
332
| list | List<T> | 否 | 当前调用replaceAllElements方法的实例对象。 |
Z
zengyawen 已提交
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.replaceAllElements((value, index) => {
  return value = 2 * value;
});
list.replaceAllElements((value, index) => {
  return value = value - 2;
});
```

L
linhaoran 已提交
350
### forEach
351

352
forEach(callbackfn: (value: T, index?: number, List?: List<T>) => void,
Z
zengyawen 已提交
353
thisArg?: Object): void
L
linhaoran 已提交
354 355 356

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

Z
zengyawen 已提交
357 358 359 360
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
361 362
| callbackfn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
Z
zengyawen 已提交
363 364 365 366 367 368 369

callbackfn的参数说明:

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
370
| List | List<T> | 否 | 当前调用forEach方法的实例对象。 |
Z
zengyawen 已提交
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.forEach((value, index) => {
  console.log(value, index);
});

```

L
linhaoran 已提交
386
### sort
387

Z
zengyawen 已提交
388 389
sort(comparator: (firstValue: T, secondValue: T) => number): void

L
linhaoran 已提交
390 391
对List中的元素进行一个排序操作。

Z
zengyawen 已提交
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| comparator | function | 是 | 回调函数。 |

comparator的参数说明:

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| firstValue | T | 是 | 前一项元素。 |
| secondValue | T | 是 | 后一项元素。 |

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.sort(a, (b => a - b));
list.sort(a, (b => b - a));
```

L
linhaoran 已提交
417
### getSubList
418

Z
zengyawen 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
getSubList(fromIndex: number, toIndex: number): List<T>

根据下标截取List中的一段元素,并返回这一段List实例,包括起始值但不包括终止值。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| fromIndex | number | 是 | 起始下标。 |
| toIndex | number | 是 | 终止下标。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
434
| List<T> | 返回List对象实例。 |
Z
zengyawen 已提交
435 436 437 438 439 440 441 442 443

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
444 445 446
let result = list.subList(2, 4);
let result1 = list.subList(4, 3);
let result2 = list.subList(2, 6);
Z
zengyawen 已提交
447
```
L
linhaoran 已提交
448 449

### clear
450

Z
zengyawen 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
clear(): void

清除List中的所有元素,并把length置为0。

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.clear();
```

L
linhaoran 已提交
466
### set
467

468
set(index: number, element: T): T
469

L
linhaoran 已提交
470 471
将此 List 中指定位置的元素替换为指定元素。

Z
zengyawen 已提交
472 473 474 475 476 477 478
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| index | number | 是 | 查找的下标值。 |
| element | T | 是 | 用来替换的元素。 |

479 480 481 482 483 484
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| T | 返回替换后的元素 |

Z
zengyawen 已提交
485 486 487 488 489 490 491 492 493 494 495 496
**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.set(2, "b");

```

L
linhaoran 已提交
497
### convertToArray
498

Z
zengyawen 已提交
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
convertToArray(): Array<T>

把当前List实例转换成数组,并返回转换后的数组。

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Array<T> | 返回转换后的数组。 |

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
517
let result = list.convertToArray();
Z
zengyawen 已提交
518 519
```

L
linhaoran 已提交
520
### isEmpty
521

Z
zengyawen 已提交
522
isEmpty(): boolean
L
linhaoran 已提交
523 524 525

判断该List是否为空。

Z
zengyawen 已提交
526 527 528 529 530 531 532 533 534 535 536 537 538 539
**返回值:**

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

**示例:**

```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
540
let result = list.isEmpty();
Z
zengyawen 已提交
541 542
```

L
linhaoran 已提交
543 544
### getFirst

Z
zengyawen 已提交
545
getFirst(): T
W
wusongqing 已提交
546

L
linhaoran 已提交
547 548
获取List实例中的第一个元素。

Z
zengyawen 已提交
549 550 551 552 553 554 555 556 557
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| T | 返回实例的第一个元素。 |

**示例:**

```
558
let list = new List();
Z
zengyawen 已提交
559 560 561 562
list.add(2);
list.add(4);
list.add(5);
list.add(4);
563
let result = list.getFirst();
Z
zengyawen 已提交
564 565
```

L
linhaoran 已提交
566 567
### getLast

Z
zengyawen 已提交
568
getLast(): T
W
wusongqing 已提交
569

L
linhaoran 已提交
570 571
获取List实例中的最后一个元素。

Z
zengyawen 已提交
572
**返回值:**
L
linhaoran 已提交
573

Z
zengyawen 已提交
574 575 576
| 类型 | 说明 |
| -------- | -------- |
| T | 返回实例的最后一个元素。 |
L
linhaoran 已提交
577

Z
zengyawen 已提交
578 579 580
**示例:**

```
581
let list = new List();
Z
zengyawen 已提交
582 583 584 585
list.add(2);
list.add(4);
list.add(5);
list.add(4);
586
let result = list.getLast();
Z
zengyawen 已提交
587
```
L
linhaoran 已提交
588 589 590

### [Symbol.iterator]

591
[Symbol.iterator]\(): IterableIterator<T>
L
linhaoran 已提交
592 593


Z
zengyawen 已提交
594
返回一个迭代器,迭代器的每一项都是一个 JavaScript 对象,并返回该对象。
L
linhaoran 已提交
595

Z
zengyawen 已提交
596
**返回值:**
L
linhaoran 已提交
597

Z
zengyawen 已提交
598 599 600
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator<T> | 返回一个迭代器。 |
L
linhaoran 已提交
601

Z
zengyawen 已提交
602
**示例:**
L
linhaoran 已提交
603

Z
zengyawen 已提交
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
```
let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);

// 使用方法一:
for (let item of list) { 
  console.log(item); 
}

// 使用方法二:
let iter = list[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
  console.log(temp);
  temp = iter.next().value;
}
```