HTMLOptionsCollection

HTMLOptionsCollection is an interface representing a collection of HTML option elements (in document order) and offers methods and properties for traversing the list as well as optionally altering its items. This type is returned solely by the "options" property of select.

interface HTMLOptionsCollection extends HTMLCollectionOf<HTMLOptionElement> {

length: number;

selectedIndex: number;

add(element: HTMLOptionElement | HTMLOptGroupElement, before?: HTMLElement | number | null): void;

remove(index: number): void;

}

var HTMLOptionsCollection: {

prototype: HTMLOptionsCollection;

new (): HTMLOptionsCollection;

};

§Extends

HTMLCollectionOf<HTMLOptionElement>

[src]

§Properties

length: number

[src]

Returns the number of elements in the collection.

When set to a smaller number, truncates the number of option elements in the corresponding container.

When set to a greater number, adds new blank option elements to that container.

selectedIndex: number

[src]

Returns the index of the first selected item, if any, or −1 if there is no selected item.

Can be set, to change the selection.

§Methods

add(element: HTMLOptionElement | HTMLOptGroupElement, before?: HTMLElement | number | null): void

[src]

Inserts element before the node given by before.

The before argument can be a number, in which case element is inserted before the item with that number, or an element from the collection, in which case element is inserted before that element.

If before is omitted, null, or a number out of range, then element will be added at the end of the list.

This method will throw a "HierarchyRequestError" DOMException if element is an ancestor of the element into which it is to be inserted.

remove(index: number): void

[src]

Removes the item with index index from the collection.