SVGStringList
SVG string list interface
The SVGStringList
defines a list of strings.
An SVGStringList
object can be designated as read only, which means that attempts to modify the object will result in an exception being thrown.
Interface overview
Also implement | None |
---|---|
Methods |
|
Properties |
|
Normative document | SVG 1.1 (2nd Edition) |
Instance properties
Name | Type | Description |
---|---|---|
numberOfItems |
unsigned long |
The number of items in the list. |
length |
unsigned long |
A mirror of the value in numberOfItems , for consistency
with other interfaces.
Non-standard
|
Instance methods
Name & Arguments | Return | Description |
---|---|---|
clear() |
void |
Clears all existing current items from the list, with the result being an empty list. Exceptions:
|
initialize(string newItem) |
string |
Clears all existing current 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. Exceptions:
|
getItem(number index) |
string |
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 number 0. Exceptions:
|
insertItemBefore(string newItem, number index) |
string |
Inserts a new item into the list at the specified position. The first
item is number 0. If Exceptions:
|
replaceItem(string newItem, number index) |
string |
Replaces an existing item in the list with a new item. If
Exceptions:
|
removeItem(in unsigned long index) |
string |
Removes an existing item from the list. Exceptions:
|
appendItem(string newItem) |
string |
Inserts a new item at the end of the list. If Exceptions:
|
Browser compatibility
BCD tables only load in the browser