List

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.

// List is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Import from: "core.ts"
 * Use like: am4core.List
 * --------------------------------------------------------
 */
import * as am4core from "@amcharts/amcharts4/core";

// List is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Include via: <script src="core.js"></script>
 * Access items like: am4core.List
 * --------------------------------------------------------
 */

Inheritance

List does not extend any other symbol.

List is extended by ListTemplate.

Properties

events
#

Type EventDispatcher < AMEvent < this, IListEvents < T > > >

Default new EventDispatcher()

Event dispatcher.

length
#

Type number

Number of items in list.

@readonly

values
#

Type Array < T >

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

constructor(

initial: Array < T >

)

#

Returns List

Constructor

clear()

#

Returns void

Removes all items from the list.

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) => 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.

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: T

)

#

Returns void

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

iterator()

#

Returns $iter.Iterator < T >

Returns a list iterator.

moveValue(

value: T,
toIndex?: number

)

#

Returns void

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 $type.Optional < T >

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 < T >

)

#

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 < T >

)

#

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 $type.Optional < T >

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

sort(

order: ( left: T, right: T) => Ordering

)

#

Returns void

Reorders list items according to specific ordering function.

swap(

a: number,
b: number

)

#

Returns void

Swaps indexes of two items in the list.

unshift(

value: T

)

#

Returns void

Adds an item as a first item in the list.

Events

#insertIndex

Param { type: "insertIndex",
  target: this }

Invoked when insertIndex method is called.

#inserted

Param { type: "inserted",
  target: this }

Invoked when item is added to the list.

@todo remove this later?

#removeIndex

Param { type: "removeIndex",
  target: this }

Invoked when item is removed.

#removed

Param { type: "removed",
  target: this }

Invoked when item is removed from the list.

@todo remove this later?

#setAll

Param { type: "setAll",
  target: this }

Invoked when setAll method is called.

#setIndex

Param { type: "setIndex",
  target: this }

Invoked when setIndex method is called.

Adapters

List does not have any adapters.