API

Please note that the API is not finalised and may change so check back once in while.

table

type Object

Reference to the HTMLTableElement.

---

initialized

type Boolean

Returns true if the library is fully loaded and all HTML is rendered.

---

rows

type Array

Collection of all HTMLTableRowElements in the table.

---

pages

type Array

Collection of pages each of which contain collections of HTMLTableRowElements.

---

refresh()

Refreshes the table. This will recount the rows, reset any search and remove any set message, but will not reset any sorting.

---

page(num [int])

Load a chosen page.

---

addRows(data [object])

Add new rows to the table. Must be an object with the rows propery set and the number of values for each row must match the column count of the table.

var dataTable = new DataTable("#myTable");

// New data to add
var newData = {
	rows: [
		[
            "Cedric Kelly",
            "Senior Javascript Developer",
            "Edinburgh",
            "6224",
            "2012/03/29",
            "$433,060"
        ],
        [
            "Airi Satou",
            "Accountant",
            "Tokyo",
            "5407",
            "2008/11/28",
            "$162,700"
        ]
      ]
};

// add the rows
dataTable.addRows(newData);

---

sortColumn(column [int], direction [string])

Sort the data by column and direction.

// sort the 4th column in descending order
dataTable.sortColumn(4, 'desc');

---

setMessage(message [string])

Display a message in the table.

dataTable.setMessage("Hello, world!");

---

init()

Re-initialise the instance after calling the destroy() method.

---

destroy()

Destroy the instance.

---

export(options [object])

Export the table data to various formats.

The options argument must be an object of which the only required property is the type property which accepts either csv, txt, json or sql as it's value. The rest are optional:

{
    download: true, // trigger download of file or return the string
    skipColumn: [], // array of column indexes to skip

    // csv
    lineDelimiter:  "\n", // line delimiter for csv type
    columnDelimiter:  ",", // column delimiter for csv type

    // sql
    tableName: "myTable", // SQL table name for sql type

    // json
    replacer: null, // JSON.stringify's replacer parameter for json type
    space: 4 // JSON.stringify's space parameter for json type
};

Examples

// Export the current page as a .csv file
dataTable.export({
    type: "csv",
    filename: "my-csv-file"
    selection: dataTable.currentPage
});

// Export pages 1-5 as an .sql file
dataTable.export({
    type: "sql",
    tableName: "sql_users",
    selection: [1,2,3,4,5]
});

// Export to .json file
dataTable.export({
    type: "json",
});

// Export to json string, omitting the 1st, 3rd and 5th columns
dataTable.export({
    type: "json",
    skipColumn: [0,2,4],
    download: false // return formatted string instead of file
});

---

import(options [object])

Import data into the table from json or csv strings.

The options argument must be an object of which the only required properties are data and type. The data property should be the csv or json string and the type property should indicate the type of data being imported - csv or json.

{
    type: "csv" // or "json"
    data: // the csv or json string

    // csv
    lineDelimiter:  "\n", // line delimiter for csv type
    columnDelimiter:  ",", // column delimiter for csv type
};

    // Import a csv string
    datatable.import({
        type: "csv",
        data: "Heading 1|Heading 2|Heading 3,Value 1|Value 2|Value 3,Value 4|Value 5|Value 6".
        lineDelimiter:  ",",
        columnDelimiter:  "|"
    });

Note that whilst checks are performed for valid json strings, none are present for csv checking so it's up to you to make sure the formatting is correct.

---

print()

Display printable version.

---