SVGStringList
The SVGStringList interface defines a list of strings.
Indexable
[index: number]: string
Methods
[iterator]()
iterator: ArrayIterator<string>;
Returns
ArrayIterator<string>
appendItem()
appendItem(newItem): string;
The appendItem() method of the SVGStringList interface inserts a new item at the end of the list. If the given item is already in a list, it is removed from its previous list before it is inserted into this list. The inserted item is the item itself and not a copy.
Parameters
| Parameter | Type |
|---|---|
newItem | string |
Returns
string
clear()
clear(): void;
The clear() method of the SVGStringList interface clears all existing items from the list, with the result being an empty list.
Returns
void
getItem()
getItem(index): string;
The getItem() method of the SVGStringList interface returns the specified item from the list. The returned item is the item itself and not a copy. Any changes made to the item are immediately reflected in the list. The first item is indexed 0.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
string
initialize()
initialize(newItem): string;
The initialize() method of the SVGStringList interface clears all existing items from the list and re-initializes the list to hold the single item specified by the parameter. If the inserted item is already in a list, it is removed from its previous list before it is inserted into this list. The inserted item is the item itself and not a copy. The return value is the item inserted into the list.
Parameters
| Parameter | Type |
|---|---|
newItem | string |
Returns
string
insertItemBefore()
insertItemBefore(newItem, index): string;
The insertItemBefore() method of the SVGStringList interface inserts a new item into the list at the specified position. The first item is indexed 0. The inserted item is the item itself and not a copy.
Parameters
| Parameter | Type |
|---|---|
newItem | string |
index | number |
Returns
string
removeItem()
removeItem(index): string;
The removeItem() method of the SVGStringList interface removes an existing item at the given index from the list.
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
string
replaceItem()
replaceItem(newItem, index): string;
The replaceItem() method of the SVGStringList interface replaces an existing item in the list with a new item. The inserted item is the item itself and not a copy.
Parameters
| Parameter | Type |
|---|---|
newItem | string |
index | number |
Returns
string
Properties
length
readonly length: number;
The length property of the SVGStringList interface returns the number of items in the list. It is an alias of numberOfItems to make SVG lists more array-like.
numberOfItems
readonly numberOfItems: number;
The numberOfItems property of the SVGStringList interface returns the number of items in the list. length is an alias of it.