ListData

Type class

A List that holds components data.

Click here for more info

Sources

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

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

/**
 * --------------------------------------------------------
 * Import from: "index.ts"
 * Use like: am5.ListData
 * --------------------------------------------------------
 */
import * as am5 from "@amcharts/amcharts5";

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

/**
 * --------------------------------------------------------
 * Include via: <script src="index.js"></script>
 * Access items like: am5.ListData
 * --------------------------------------------------------
 */

Inheritance

ListData extends List.

ListData is not extended by any other symbol.

Settings

ListData does not have any settings.

Private settings

ListData does not have any private settings.

Properties

events
#

Type EventDispatcher

Default new EventDispatcher<Events<this,
IListEvents<T>>>()

Inherited from List

length
#

Type number

Inherited from List

Number of items in list.

@readonly

processor
#

Type DataProcessor

An optional processor for data.

Click here for more info

values
#

Type Array

Inherited from List

An array of values in the list.

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

@readonly

There are 3 inherited items currently hidden from this list.

Methods

[Symbol.iterator]()

#

Returns Iterator

Inherited from List

Returns an ES6 iterator for the list.

clear()

#

Returns void

Inherited from List

Removes all items from the list.

constructor(

initial: Array

)

#

Returns ListData

Inherited from List

Constructor

contains(

value: T

)

#

Returns boolean

Inherited from List

Checks if list contains specific item reference.

copyFrom(

source: this

)

#

Returns void

Inherited from List

Copies and adds items from abother list.

each(

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

)

#

Returns void

Inherited from List

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

Inherited from List

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

Inherited from List

Returns an item at specified index.

hasIndex(

index: number

)

#

Returns boolean

Inherited from List

Checks if there's a value at specific index.

indexOf(

value: T

)

#

Returns number

Inherited from List

Searches the list for specific item and returns its index.

insertIndex(

index: number,
value: K

)

#

Returns K

Inherited from List

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

Inherited from List

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

Inherited from List

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

push(

value: K

)

#

Returns K

Inherited from List

Adds an item to the end of the list.

pushAll(

values: Array

)

#

Returns void

Inherited from List

Adds multiple items to the list.

removeIndex(

index: number

)

#

Returns T

Inherited from List

Removes a value at specific index.

removeValue(

value: T

)

#

Returns void

Inherited from List

Removes specific item from the list.

setAll(

newArray: Array

)

#

Returns void

Inherited from List

Sets multiple items to the list.

All current items are removed.

setIndex(

index: number,
value: T

)

#

Returns T

Inherited from List

Sets value at specific index.

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

shift()

#

Returns Optional

Inherited from List

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

swap(

a: number,
b: number

)

#

Returns void

Inherited from List

Swaps indexes of two items in the list.

unshift(

value: K

)

#

Returns K

Inherited from List

Adds an item as a first item in the list.

There are 22 inherited items currently hidden from this list.

Events

ListData does not have any events.