Builds table elements with methods to add rows quickly.
Tutorial/Demo
Implements
Syntax
new HtmlTable([table, options]);
Arguments
- table - (mixed; optional) - a Table DOM element or it's id; if you do not specify one, one will be created.
- options - (object; optional) a key/value set of options.
Options
- properties - (object) a set of properties for the Table element; defaults to {cellpadding:0, cellspacing:0, border:0}
- rows - (array) an array of row objects (see HtmlTable.push)
- headers - (array) a row that is injected in the thead; required for sorting.
Example
var myTable = new HtmlTable({
properties: {
border: 1,
cellspacing: 3
},
headers: ['fruits', 'colors'],
rows: [
['apple', 'red'],
['lemon', 'yellow']
]
});
myTable.inject($('someContainer'));
//ALSO
var myTable = new HtmlTable($('existingTable'));
myTable.push(['data','goes','here']);
Inserts a new table row.
Syntax
myHtmlTable.push(row, rowProperties);
Arguments
- row - (array or element) the data for the row or TR element.
- rowProperties - (object) the properties for the row (class, id, styles, etc)
Row data
Row data can be in either of two formats. Note that they can be mixed and matched.
- simple - (array) an array of strings that will be inserted into each table data
OR
- detailed - (array) an array of objects with definitions for content and properties for each table data
Note that it can also be an actual TR element.
Examples
//example of 'simple' rows
myTable.push(['value 1', 'value 2', 'value 3'], {'class': 'tableRowClass'}); //new row
//detailed rows
myTable.push([
{ //can specify data AND properties
content: 'value 4',
properties: {
colspan: 2,
'class': 'doubleWide',
style: '1px solid blue'
}
},
'value 5' //can just be data; mixing and the two in the same row is fine
]);
//RESULT:
<table cellpadding="0" cellspacing="0" border="0">
<tr class="tableRowClass">
<td>value 1</td>
<td>value 2</td>
<td>value 3</td>
</tr>
<tr>
<td colspan="2" class="doubleWide" style="1px solid blue">value 4</td>
<td>value 5</td>
</tr>
</table>
Returns
- (object) an object containing the tr and td tags.
Example of Object Returned
{tr: theTableRow, tds: [td, td, td]}
Empties the tbody of the table.
Syntax
myTable.empty();
Returns
- (object) This instance of HtmlTable.
Sets the contents of the header or footer.
Syntax
myTable.set(what, rowArray);
Arguments
- what - (string) either 'headers' or 'footers'
- rowArray - (array) an array of header information; same as the row data sent to HtmlTable.push
Returns
- (object) The row data (same as returned by the push method).
When $ is called on this class the table is returned.
Example
$(myHtmlTable) == myHtmlTable.table
This class implements the following element methods:
- adopt
- inject
- wraps
- grap
- replaces
- empty
- dispose
These will execute these methods on the table element.
Example
myHtmlTable.table.inject(document.body);
//same as:
myHtmlTable.inject(document.body);
//same as:
$(myHtmlTable).inject(document.body);
Extends the native Element object with a reference to its HtmlTable instance.
Syntax
myElement.retrieve('HtmlTable'); //the instance of HtmlTable for the element