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.
<div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 20%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 120" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget" target="_top"><rect x="1" y="1" width="110" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="56" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">EventTarget</text></a><polyline points="111,25 121,20 121,30 111,25" stroke="#D4DDE4" fill="none"/><line x1="121" y1="25" x2="151" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/Node" target="_top"><rect x="151" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="188.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Node</text></a><polyline points="226,25 236,20 236,30 226,25" stroke="#D4DDE4" fill="none"/><line x1="236" y1="25" x2="266" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/Element" target="_top"><rect x="266" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="303.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Element</text></a><polyline points="341,25 351,20 351,30 341,25" stroke="#D4DDE4" fill="none"/><line x1="351" y1="25" x2="381" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement" target="_top"><rect x="381" y="1" width="110" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="436" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">HTMLElement</text></a><polyline points="491,25 501,20 501,30 491,25" stroke="#D4DDE4" fill="none"/><line x1="501" y1="25" x2="509" y2="25" stroke="#D4DDE4"/><line x1="509" y1="25" x2="509" y2="90" stroke="#D4DDE4"/><line x1="509" y1="90" x2="492" y2="90" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableElement" target="_top"><rect x="331" y="65" width="160" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text x="411" y="94" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">HTMLTableElement</text></a></svg></div>
a:hover text { fill: #0095DD; pointer-events: all;}
Properties
Inherits properties from its parent, HTMLElement
.
HTMLTableElement.caption
- Is a
HTMLTableCaptionElement
representing the first<caption>
that is a child of the element, ornull
if none is found. When set, if the object doesn't represent a<caption>
, aDOMException
with theHierarchyRequestError
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. HTMLTableElement.tHead
- Is a
HTMLTableSectionElement
representing the first<thead>
that is a child of the element, ornull
if none is found. When set, if the object doesn't represent a<thead>
, aDOMException
with theHierarchyRequestError
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. HTMLTableElement.tFoot
- Is a
HTMLTableSectionElement
representing the first<tfoot>
that is a child of the element, ornull
if none is found. When set, if the object doesn't represent a<tfoot>
, aDOMException
with theHierarchyRequestError
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. HTMLTableElement.rows
Read only- 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. TheHTMLCollection
is live and is automatically updated when theHTMLTableElement
changes. HTMLTableElement.tBodies
Read only- Returns a live
HTMLCollection
containing all the<tbody>
of the element. TheHTMLCollection
is live and is automatically updated when theHTMLTableElement
changes. HTMLTableElement.sortable
- Is a
Boolean
value indicating if the user agent is allowed to provide sorting mechanism for the table, if it supports such a feature. This property reflects thesortable
attribute. HTMLTableElement.align
- Is a
DOMString
containing an enumerated value reflecting thealign
attribute. It indicates the alignment of the element's contents with respect to the surrounding context. The possible values are"left"
,"right"
, and"center"
. HTMLTableElement.bgColor
- Is a
DOMString
containing the background color of the cells. It reflects the obsoletebgcolor
attribute. HTMLTableElement.border
- Is a
DOMString
containing the width in pixels of the border of the table. It reflects the obsoleteborder
attribute. HTMLTableElement.cellPadding
- Is a
DOMString
containing the width in pixels of the horizontal and vertical sapce between cell content and cell borders. It reflects the obsoletecellpadding
attribute. HTMLTableElement.cellSpacing
- Is a
DOMString
containing the width in pixels of the horizontal and vertical separation between cells. It reflects the obsoletecellspacing
attribute. HTMLTableElement.frame
- Is a
DOMString
containing the type of the external borders of the table. It reflects the obsoleteframe
attribute and can take one of the following values:"void"
,"above"
,"below"
,"hsides"
,"vsides"
,"lhs"
,"rhs"
,"box"
, or"border"
. HTMLTableElement.rules
- Is a
DOMString
containing the type of the internal borders of the table. It reflects the obsoleterules
attribute and can take one of the following values:"none"
,"groups"
,"rows"
,"cols"
, or"all"
. HTMLTableElement.summary
- Is a
DOMString
containing a description of the purpose or the structure of the table. It reflects the obsoletesummary
attribute. HTMLTableElement.width
- Is a
DOMString
containing the length in pixels or in percentage of the desired width fo the entire table. It reflects the obsoletewidth
attribute.
Methods
Inherits methods from its parent, HTMLElement
.
HTMLTableElement.createTHead()
- 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. HTMLTableElement.deleteTHead()
- Removes the first
<thead>
that is a child of the element. HTMLTableElement.createTFoot()
- 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. HTMLTableElement.deleteTFoot()
- Removes the first
<tfoot>
that is a child of the element. HTMLTableElement.createCaption()
- 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. HTMLTableElement.deleteCaption()
- Removes the first
<caption>
that is a child of the element. HTMLTableElement.insertRow()
- Returns an
HTMLTableRowElement
representing a new row of the table. It inserts it in the rows collection immediately before the<tr>
element at the givenindex
position. If necessary a<tbody>
is created. If theindex
is-1
, the new row is appended to the collection. If theindex
is smaller than-1
or greater than the number of rows in the collection, aDOMException
with the valueIndexSizeError
is raised. HTMLTableElement.deleteRow()
- Removes the row corresponding to the
index
given in parameter. If theindex
value is-1
the last row is removed; if it smaller than-1
or greater than the amount of rows in the collection, aDOMException
with the valueIndexSizeError
is raised. HTMLTableElement.stopSorting()
- Removes the
sortable
attribute to all<th>
elements of the table.
Specifications
Specification | Status | Comment |
---|---|---|
WHATWG HTML Living Standard The definition of 'HTMLTableElement' in that specification. |
Living Standard | Added the sortable property and the stopSorting() method. |
HTML5 The definition of 'HTMLTableElement' in that specification. |
Recommendation | Added the createTBody() method.Obsoleted xaz |
Document Object Model (DOM) Level 2 HTML Specification The definition of 'HTMLTableElement' in that specification. |
Recommendation | Defined when caption , tHead , tFoot , insertRow() , and deleteRow() raise exceptions. |
Document Object Model (DOM) Level 1 Specification The definition of 'HTMLTableElement' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | 1.0 (1.7 or earlier) | (Yes) | (Yes) | (Yes) |
sortable property and stopSorting() method |
No support | No support | No support | No support | No support | No support |
createTBody() |
(Yes) | (Yes) | 25.0 (25.0) | (Yes) | (Yes) | (Yes) |
Feature | Android | Edge | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | 1.0 (1.0) | (Yes) | (Yes) | (Yes) |
sortable property and stopSorting() method |
No support | No support | No support | No support | No support | No support |
createTBody() |
(Yes) | (Yes) | 25.0 (25.0) | (Yes) | (Yes) | (Yes) |
See also
- The HTML element implementing this interface:
<table>
.