List – amCharts 5 Documentation

Type class

A List class is used to hold a number of indexed items of the same type.

Sources

List can be used (imported) via one of the following packages.

// Import List
import * as am5 from "@amcharts/amcharts5";

// Create List
am5.List.new(root, {
  // ... config if applicable
});

<!-- Load List -->
<script src="index.js"></script>

<script>
// Create List
am5.List.new(root, {
  // ... config if applicable
});
</script>

Inheritance

List does not extend any other symbol.

List is extended by ListAutoDispose, Children, ListData.

Settings

List does not have any settings.

Private settings

List does not have any private settings.

Properties

events #	Type `EventDispatcher` Default `new EventDispatcher()`
length #	Type `number` Number of items in list. @readonly
values #	Type `Array` An array of values in the list. Do not use this property to add values. Rather use dedicated methods, like `push()`, `removeIndex()`, etc. @readonly

events
#

Type EventDispatcher

Default new EventDispatcher()

length
#

Type number

Number of items in list.

@readonly

values
#

Type Array

An array of values in the list.

Do not use this property to add values. Rather use dedicated methods, like push(), removeIndex(), etc.

@readonly

Methods

[Symbol.iterator]() #	Returns `Iterator` Returns an ES6 iterator for the list.
clear() #	Returns `void` Removes all items from the list.
constructor( initial: `Array` ) #	Returns `List` Constructor
contains( value: `T` ) #	Returns `boolean` Checks if list contains specific item reference.
copyFrom( source: `this` ) #	Returns `void` Copies and adds items from abother list.
each( f: ( value: `T`, index: `number`) => `void` ) #	Returns `void` Calls `f` for each element in the list. `f` should have at least one parameter defined which will get a current item, with optional second argument - index.
eachReverse( f: ( value: `T`, index: `number`) => `void` ) #	Returns `void` Calls `f` for each element in the list, from right to left. `f` should have at least one parameter defined which will get a current item, with optional second argument - index.
getIndex( index: `number` ) #	Returns `T` \| `undefined` Returns an item at specified index.
hasIndex( index: `number` ) #	Returns `boolean` Checks if there's a value at specific index.
indexOf( value: `T` ) #	Returns `number` Searches the list for specific item and returns its index.
insertIndex( index: `number`, value: `K` ) #	Returns `K` Adds an item to the list at a specific index, which pushes all the other items further down the list.
moveValue( value: `K`, toIndex?: `undefined` \| `number` ) #	Returns `K` Moves an item to a specific index within the list. If the index is not specified it will move the item to the end of the list.
pop() #	Returns `Optional` Returns the last item from the list, and removes it.
push( value: `K` ) #	Returns `K` Adds an item to the end of the list.
pushAll( values: `Array` ) #	Returns `void` Adds multiple items to the list.
removeIndex( index: `number` ) #	Returns `T` Removes a value at specific index.
removeValue( value: `T` ) #	Returns `void` Removes specific item from the list.
setAll( newArray: `Array` ) #	Returns `void` Sets multiple items to the list. All current items are removed.
setIndex( index: `number`, value: `T` ) #	Returns `T` Sets value at specific index. If there's already a value at the index, it is overwritten.
shift() #	Returns `Optional` Returns the first item from the list, and removes it.
swap( a: `number`, b: `number` ) #	Returns `void` Swaps indexes of two items in the list.
unshift( value: `K` ) #	Returns `K` Adds an item as a first item in the list.

[Symbol.iterator]()

Returns Iterator

Returns an ES6 iterator for the list.

clear()

Returns void

Removes all items from the list.

constructor(

initial: Array

)

Returns List

Constructor

contains(

value: T

)

Returns boolean

Checks if list contains specific item reference.

copyFrom(

source: this

)

Returns void

Copies and adds items from abother list.

each(

f: ( value: T, index: number) => void

)

Returns void

Calls f for each element in the list.

f should have at least one parameter defined which will get a current item, with optional second argument - index.

eachReverse(

f: ( value: T, index: number) => void

)

Returns void

Calls f for each element in the list, from right to left.

f should have at least one parameter defined which will get a current item, with optional second argument - index.

getIndex(

index: number

)

Returns T | undefined

Returns an item at specified index.

hasIndex(

index: number

)

Returns boolean

Checks if there's a value at specific index.

indexOf(

value: T

)

Returns number

Searches the list for specific item and returns its index.

insertIndex(

index: number,
value: K

)

Returns K

Adds an item to the list at a specific index, which pushes all the other items further down the list.

moveValue(

value: K,
toIndex?: undefined | number

)

Returns K

Moves an item to a specific index within the list.

If the index is not specified it will move the item to the end of the list.

pop()

Returns Optional

Returns the last item from the list, and removes it.

push(

value: K

)

Returns K

Adds an item to the end of the list.

pushAll(

values: Array

)

Returns void

Adds multiple items to the list.

removeIndex(

index: number

)

Returns T

Removes a value at specific index.

removeValue(

value: T

)

Returns void

Removes specific item from the list.

setAll(

newArray: Array

)

Returns void

Sets multiple items to the list.

All current items are removed.

setIndex(

index: number,
value: T

)

Returns T

Sets value at specific index.

If there's already a value at the index, it is overwritten.

shift()

Returns Optional

Returns the first item from the list, and removes it.

swap(

a: number,
b: number

)

Returns void

Swaps indexes of two items in the list.

unshift(

value: K

)

Returns K

Adds an item as a first item in the list.

Events

Add event handlers to List object using its events.on() method.

Read about adding event handlers.

#clear	Param { oldValues: `Array`, type: `"clear"`, target: `this` }
#insertIndex	Param { index: `number`, newValue: `A`, type: `"insertIndex"`, target: `this` }
#moveIndex	Param { newIndex: `number`, oldIndex: `number`, value: `A`, type: `"moveIndex"`, target: `this` }
#push	Param { newValue: `A`, type: `"push"`, target: `this` }
#removeIndex	Param { index: `number`, oldValue: `A`, type: `"removeIndex"`, target: `this` }
#setIndex	Param { index: `number`, newValue: `A`, oldValue: `A`, type: `"setIndex"`, target: `this` }