SortedList

Type class

A list where all items are ordered according to specific ordering function, which is passed in via constructor parameter, when creating an instance of SortedList.

Sources

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

TypeScript

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

JavaScript

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

Inheritance

SortedList extends OrderedList.

SortedList is extended by SortedListTemplate.

Properties

5 inherited items

#events

Type EventDispatcher <AMEvent <OrderedList <T>, ISortedListEvents <T>>>Default new EventDispatcher()Inherited from OrderedList

Event dispatcher.

#first

Type T | undefinedInherited from OrderedList

First item in the list.

#last

Type T | undefinedInherited from OrderedList

Last item in the list.

#length

Type numberInherited from OrderedList

Number of items in the list.

#values

Type Array <T>Inherited from OrderedList

All items of the list.

Do not modify the list directly. Rather use insert() and remove() methods.

Methods

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

Returns SortedList

Constructor.

#indexOf(value: T)

Returns number

Returns index of the item in list if found.

-1 if item is not in the list.

10 inherited items

#[Symbol.iterator]()

Returns Iterator <T>Inherited from OrderedList

Returns an ES6 iterator for the list.

#clear()

Returns voidInherited from OrderedList

Removes all items from the list.

#contains(value: T)

Returns booleanInherited from OrderedList

Checks if list contains the value.

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

Returns voidInherited from OrderedList

Calls f for each element in the list.

#getIndex(index: number)

Returns T | undefinedInherited from OrderedList

Returns an item at specific index.

#insert(value: T)

Returns voidInherited from OrderedList

Inserts a value into list.

#iterator()

Returns Iterator <T>Inherited from OrderedList

Returns a list iterator.

#remove(value: T)

Returns voidInherited from OrderedList

Removes an item with the value from the list.

#setAll(newArray: Array <T>)

Returns voidInherited from OrderedList

Sets multiple items to the list.

All current items are removed.

#slice(start: number,
end: number)

Returns OrderedList <T>Inherited from OrderedList

Returns part of the list between start and end indexes, as a new OrderedList.

Events

#inserted

Param { type: "inserted", target: OrderedList, index: number, newValue: A }

Invoked when new value is inserted into the list.

#removed

Param { type: "removed", target: OrderedList, index: number, oldValue: A }

Invoked when a value is removed from the list.