js.html.TableElement - Haxe 4.2.2 API

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.

`@:value({ index : -1 })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

Inherited Variables

Defined by DOMElement

Defined by Node

`read onlybaseURI:String`

Returns a DOMString representing the base URL. The concept of base URL changes from one language to another; in HTML, it corresponds to the protocol, the domain name and the directory structure, that is all until the last '/'.

`read onlychildNodes:NodeList`

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

`read onlyfirstChild:Node`

Returns a Node representing the first direct child node of the node, or null if the node has no child.

`read onlyisConnected:Bool`

Returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.

`read onlylastChild:Node`

Returns a Node representing the last direct child node of the node, or null if the node has no child.

`read onlynextSibling:Node`

Returns a Node representing the next node in the tree, or null if there isn't such node.

`read onlynodeName:String`

Returns a DOMString containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.

`read onlynodeType:Int`

Returns an unsigned short representing the type of the node. Possible values are:

Name Value

`ELEMENT_NODE`	`1`
`ATTRIBUTE_NODE` (deprecated)	`2`
`TEXT_NODE`	`3`
`CDATA_SECTION_NODE` (deprecated)	`4`
`ENTITY_REFERENCE_NODE` (deprecated)	`5`
`ENTITY_NODE` (deprecated)	`6`
`PROCESSING_INSTRUCTION_NODE`	`7`
`COMMENT_NODE`	`8`
`DOCUMENT_NODE`	`9`
`DOCUMENT_TYPE_NODE`	`10`
`DOCUMENT_FRAGMENT_NODE`	`11`
`NOTATION_NODE` (deprecated)	`12`

`nodeValue:String`

Returns / Sets the value of the current node

`read onlyownerDocument:HTMLDocument`

Returns the Document that this node belongs to. If the node is itself a document, returns null.

`read onlyparentElement:Element`

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.

`read onlyparentNode:Node`

Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.

`read onlypreviousSibling:Node`

Returns a Node representing the previous node in the tree, or null if there isn't such node.

`textContent:String`

Returns / Sets the textual content of an element and all its descendants.

Inherited Methods

Defined by Element

Defined by DOMElement

Defined by Node

`appendChild(node:Node):Node`

Adds the specified childNode argument as the last child to the current node.

If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.

	@throws DOMError

`@:value({ deep : false })cloneNode(deep:Bool = false):Node`

Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.

Throws:

`null`	DOMError

`compareDocumentPosition(other:Node):Int`

Compares the position of the current node against another node in any other document.

`contains(other:Node):Bool`

Returns a Boolean value indicating whether a node is a descendant of a given node or not.

`getRootNode(?options:Null<GetRootNodeOptions>):Node`

Returns the context object's root which optionally includes the shadow root if it is available.

`hasChildNodes():Bool`

Returns a Boolean indicating if the element has any child nodes, or not.

`insertBefore(node:Node, child:Node):Node`

Inserts a Node before the reference node as a child of a specified parent node.

Throws:

`null`	DOMError

`isDefaultNamespace(namespace:String):Bool`

Accepts a namespace URI as an argument and returns a Boolean with a value of true if the namespace is the default namespace on the given node or false if not.

`isEqualNode(node:Node):Bool`

Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

`isSameNode(node:Node):Bool`

Returns a Boolean value indicating whether or not the two nodes are the same (that is, they reference the same object).

`lookupNamespaceURI(prefix:String):String`

Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.

`lookupPrefix(namespace:String):String`

Returns a DOMString containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.

`normalize():Void`

Clean up all the text nodes under this element (merge adjacent, remove empty).

`removeChild(child:Node):Node`

Removes a child node from the current element, which must be a child of the current node.

Throws:

`null`	DOMError

`replaceChild(node:Node, child:Node):Node`

Replaces one child Node of the current one with the second one given in parameter.

Throws:

`null`	DOMError

class TableElement

package js.html

extends Element › DOMElement › Node › EventTarget

Variables

align:String

bgColor:String

border:String

caption:TableCaptionElement

cellPadding:String

cellSpacing:String

frame:String

read onlyrows:HTMLCollection

rules:String

summary:String

read onlytBodies:HTMLCollection

tFoot:TableSectionElement

tHead:TableSectionElement

width:String

Methods

createCaption():Element

createTBody():Element

createTFoot():Element

createTHead():Element

deleteCaption():Void

deleteRow(index:Int):Void

deleteTFoot():Void

deleteTHead():Void

@:value({ index : -1 })insertRow(index:Int = -1):Element

Inherited Variables

Defined by DOMElement

accessKey:String

read onlyaccessKeyLabel:String

read onlyassignedSlot:SlotElement

read onlyattributes:NamedNodeMap

read onlychildElementCount:Int

read onlychildren:HTMLCollection

read onlyclassList:DOMTokenList

className:String

read onlyclientHeight:Int

read onlyclientLeft:Int

read onlyclientTop:Int

read onlyclientWidth:Int

contentEditable:String

read onlycontextMenu:MenuElement

read onlydataset:DOMStringMap

dir:String

draggable:Bool

read onlyfirstElementChild:Element

hidden:Bool

id:String

innerHTML:String

innerText:String

read onlyisContentEditable:Bool

itemId:String

read onlyitemProp:DOMTokenList

read onlyitemRef:DOMTokenList

itemScope:Bool

read onlyitemType:DOMTokenList

itemValue:Dynamic

lang:String

read onlylastElementChild:Element

read onlylocalName:String

read onlynamespaceURI:String

read onlynextElementSibling:Element

read onlyoffsetHeight:Int

read onlyoffsetLeft:Int

read onlyoffsetParent:Element

read onlyoffsetTop:Int

read onlyoffsetWidth:Int

onabort:Function

onanimationcancel:Function

onanimationend:Function

onanimationiteration:Function

onanimationstart:Function

onauxclick:Function

onblur:Function

oncanplay:Function

oncanplaythrough:Function

onchange:Function

onclick:Function

`align:String`

`bgColor:String`

`border:String`

`caption:TableCaptionElement`

`cellPadding:String`

`cellSpacing:String`

`frame:String`

`read onlyrows:HTMLCollection`

`rules:String`

`summary:String`

`read onlytBodies:HTMLCollection`

`tFoot:TableSectionElement`

`tHead:TableSectionElement`

`width:String`

`createCaption():Element`

`createTBody():Element`

`createTFoot():Element`

`createTHead():Element`

`deleteCaption():Void`

`deleteRow(index:Int):Void`

`deleteTFoot():Void`

`deleteTHead():Void`

`@:value({ index : -1 })insertRow(index:Int = -1):Element`

`accessKey:String`

`read onlyaccessKeyLabel:String`

`read onlyassignedSlot:SlotElement`

`read onlyattributes:NamedNodeMap`

`read onlychildElementCount:Int`

`read onlychildren:HTMLCollection`

`read onlyclassList:DOMTokenList`

`className:String`

`read onlyclientHeight:Int`

`read onlyclientLeft:Int`

`read onlyclientTop:Int`

`read onlyclientWidth:Int`

`contentEditable:String`

`read onlycontextMenu:MenuElement`

`read onlydataset:DOMStringMap`

`dir:String`

`draggable:Bool`

`read onlyfirstElementChild:Element`

`hidden:Bool`

`id:String`

`innerHTML:String`

`innerText:String`

`read onlyisContentEditable:Bool`

`itemId:String`

`read onlyitemProp:DOMTokenList`

`read onlyitemRef:DOMTokenList`

`itemScope:Bool`

`read onlyitemType:DOMTokenList`

`itemValue:Dynamic`

`lang:String`

`read onlylastElementChild:Element`

`read onlylocalName:String`

`read onlynamespaceURI:String`

`read onlynextElementSibling:Element`

`read onlyoffsetHeight:Int`

`read onlyoffsetLeft:Int`

`read onlyoffsetParent:Element`

`read onlyoffsetTop:Int`

`read onlyoffsetWidth:Int`

`onabort:Function`

`onanimationcancel:Function`

`onanimationend:Function`

`onanimationiteration:Function`

`onanimationstart:Function`

`onauxclick:Function`

`onblur:Function`

`oncanplay:Function`

`oncanplaythrough:Function`

`onchange:Function`

`onclick:Function`

`onclose:Function`

`oncontextmenu:Function`

`oncopy:Function`

`oncut:Function`

`ondblclick:Function`

`ondrag:Function`

`ondragend:Function`