W3cubDocs

TableElement

extends Element › DOMElement › Node › EventTarget

Available on js

The HTMLTableElement interface provides special properties and methods (beyond the regular HTMLElement object interface it also has available to it by inheritance) for manipulating the layout and presentation of tables in an HTML document.

Documentation HTMLTableElement by Mozilla Contributors, licensed under CC-BY-SA 2.5.

Variables

`align:String`

Is a DOMString containing an enumerated value reflecting the align attribute. It indicates the alignment of the element's contents with respect to the surrounding context. The possible values are "left", "right", and "center".

`bgColor:String`

Is a DOMString containing the background color of the cells. It reflects the obsolete bgColor attribute.

`border:String`

Is a DOMString containing the width in pixels of the border of the table. It reflects the obsolete border attribute.

`caption:TableCaptionElement`

Is a HTMLTableCaptionElement representing the first caption that is a child of the element, or null if none is found. When set, if the object doesn't represent a caption, a DOMException with the HierarchyRequestError name is thrown. If a correct object is given, it is inserted in the tree as the first child of this element and the first caption that is a child of this element is removed from the tree, if any.

`cellPadding:String`

Is a DOMString containing the width in pixels of the horizontal and vertical sapce between cell content and cell borders. It reflects the obsolete cellpadding attribute.

`cellSpacing:String`

Is a DOMString containing the width in pixels of the horizontal and vertical separation between cells. It reflects the obsolete cellspacing attribute.

`frame:String`

Is a DOMString containing the type of the external borders of the table. It reflects the obsolete frame attribute and can take one of the following values: "void", "above", "below", "hsides", "vsides", "lhs", "rhs", "box", or "border".

`read onlyrows:HTMLCollection`

Returns a live HTMLCollection containing all the rows of the element, that is all tr that are a child of the element, or a child or one of its thead, tbody and tfoot children. The rows members of a thead appear first, in tree order, and those members of a tbody last, also in tree order. The HTMLCollection is live and is automatically updated when the HTMLTableElement changes.

`rules:String`

Is a DOMString containing the type of the internal borders of the table. It reflects the obsolete rules attribute and can take one of the following values: "none", "groups", "rows", "cols", or "all".

`summary:String`

Is a DOMString containing a description of the purpose or the structure of the table. It reflects the obsolete summary attribute.

`read onlytBodies:HTMLCollection`

Returns a live HTMLCollection containing all the tbody of the element. The HTMLCollection is live and is automatically updated when the HTMLTableElement changes.

`tFoot:TableSectionElement`

Is a HTMLTableSectionElement representing the first tfoot that is a child of the element, or null if none is found. When set, if the object doesn't represent a tfoot, a DOMException with the HierarchyRequestError name is thrown. If a correct object is given, it is inserted in the tree immediately before the first element that is neither a caption, a colgroup, nor a thead, or as the last child if there is no such element, and the first tfoot that is a child of this element is removed from the tree, if any.

`tHead:TableSectionElement`

Is a HTMLTableSectionElement representing the first thead that is a child of the element, or null if none is found. When set, if the object doesn't represent a thead, a DOMException with the HierarchyRequestError name is thrown. If a correct object is given, it is inserted in the tree immediately before the first element that is neither a caption, nor a colgroup, or as the last child if there is no such element, and the first thead that is a child of this element is removed from the tree, if any.

`width:String`

Is a DOMString containing the length in pixels or in percentage of the desired width fo the entire table. It reflects the obsolete width attribute.

Methods

`createCaption():Element`

Returns an HTMLElement representing the first caption that is a child of the element. If none is found, a new one is created and inserted in the tree as the first child of the table element.

`createTBody():Element`

`createTFoot():Element`

Returns an HTMLElement representing the first tfoot that is a child of the element. If none is found, a new one is created and inserted in the tree immediately before the first element that is neither a caption, a colgroup, nor a thead, or as the last child if there is no such element.

`createTHead():Element`

Returns an HTMLElement representing the first thead that is a child of the element. If none is found, a new one is created and inserted in the tree immediately before the first element that is neither a caption, nor a colgroup, or as the last child if there is no such element.

`deleteCaption():Void`

Removes the first caption that is a child of the element.

`deleteRow(index:Int):Void`

Removes the row corresponding to the index given in parameter. If the index value is -1 the last row is removed; if it smaller than -1 or greater than the amount of rows in the collection, a DOMException with the value IndexSizeError is raised.

Throws:

`null`	DOMError

`deleteTFoot():Void`

Removes the first tfoot that is a child of the element.

`deleteTHead():Void`

Removes the first thead that is a child of the element.

`insertRow(index:Int = -1):Element`

Returns an HTMLTableRowElement representing a new row of the table. It inserts it in the rows collection immediately before the tr element at the given index position. If necessary a tbody is created. If the index is -1, the new row is appended to the collection. If the index is smaller than -1 or greater than the number of rows in the collection, a DOMException with the value IndexSizeError is raised.

Throws:

`null`	DOMError