ListTemplate

Type class

A version of a List that has a "template".

A template is an instance of an object, that can be used to create new elements in the list without actually needing to create instances for those.

When new element is created in the list, e.g. by calling its create() method, an exact copy of the element is created (including properties and other attributes), inserted into the list and returned.

Sources

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

TypeScript

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

JavaScript

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

Inheritance

ListTemplate extends List.

ListTemplate is not extended by any other symbol.

Properties

#template

Type T

A "template" object to copy all properties from when creating new list items.

3 inherited items

#events

Type EventDispatcher <AMEvent <this, IListEvents <T>>>Default new EventDispatcher()Inherited from List

Event dispatcher.

#length

Type numberInherited from List

Number of items in list.

#values

Type Array <T>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.

Methods

#clone()

Returns ListTemplate <T>

Creates an exact clone of the list, including its items and template.

#constructor(t: T)

Returns ListTemplate

Constructor

#copyFrom(source: this)

Returns void

Copies all elements from other list.

#create(make: { })

Returns T

Instantiates a new object of the specified type, adds it to the end of the list, and returns it.

21 inherited items

#[Symbol.iterator]()

Returns Iterator <T>Inherited from List

Returns an ES6 iterator for the list.

#clear()

Returns voidInherited from List

Removes all items from the list.

#contains(value: T)

Returns booleanInherited from List

Checks if list contains specific item reference.

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

Returns voidInherited 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.

#getIndex(index: number)

Returns T | undefinedInherited from List

Returns an item at specified index.

#hasIndex(index: number)

Returns booleanInherited from List

Checks if there's a value at specific index.

#indexOf(value: T)

Returns numberInherited from List

Searches the list for specific item and returns its index.

#insertIndex(index: number,
value: T)

Returns voidInherited from List

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

#iterator()

Returns Iterator <T>Inherited from List

Returns a list iterator.

#moveValue(value: T,
toIndex?: number)

Returns voidInherited 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 $type.Optional <T>Inherited from List

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

#push(value: K)

Returns KInherited from List

Adds an item to the end of the list.

#pushAll(values: Array <T>)

Returns voidInherited from List

Adds multiple items to the list.

#removeIndex(index: number)

Returns TInherited from List

Removes a value at specific index.

#removeValue(value: T)

Returns voidInherited from List

Removes specific item from the list.

#setAll(newArray: Array <T>)

Returns voidInherited from List

Sets multiple items to the list.

All current items are removed.

#setIndex(index: number,
value: T)

Returns TInherited from List

Sets value at specific index.

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

#shift()

Returns $type.Optional <T>Inherited from List

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

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

Returns voidInherited from List

Reorders list items according to specific ordering function.

#swap(a: number,
b: number)

Returns voidInherited from List

Swaps indexes of two items in the list.

#unshift(value: T)

Returns voidInherited from List

Adds an item as a first item in the list.

Events

6 inherited items

#inserted

Param { type: "inserted", target: ListTemplate, newValue: A }Inherited from List

Invoked when item is added to the list.

#insertIndex

Param { type: "insertIndex", target: ListTemplate, index: number, newValue: A }Inherited from List

Invoked when insertIndex method is called.

#removed

Param { type: "removed", target: ListTemplate, oldValue: A }Inherited from List

Invoked when item is removed from the list.

#removeIndex

Param { type: "removeIndex", target: ListTemplate, index: number, oldValue: A }Inherited from List

Invoked when item is removed.

#setAll

Param { type: "setAll", target: ListTemplate, newArray: Array <A>, oldArray: Array <A> }Inherited from List

Invoked when setAll method is called.

#setIndex

Param { type: "setIndex", target: ListTemplate, index: number, newValue: A, oldValue: A }Inherited from List

Invoked when setIndex method is called.