Example: DataTable + DataSource.Get + JSON Data

Populating Your DataTable with Remote Data Using DataSource.Get

Your table can be easily popluated with remote JSON data from a JSONP webservice by creating a DataSource instance and using the DataTableDataSource plugin to load the data into a DataTable.

Start with the use() statement:

YUI().use("datasource-get", "datasource-jsonschema", "datatable-datasource-deprecated", function(Y) {
});

Next create a DataSource.Get instance pointing to YQL. The YQL Console makes it easy to determine the REST URL we want to send. You also need to define the correct schema for the DataSourceJSONSchema plugin. This is a good time to call sendRequest to make sure the data returns as expected.

var dataSource = new Y.DataSource.Get({
    source: "http://query.yahooapis.com/v1/public/yql?"+
        "q=select%20*%20from%20local.search%20where%20zip%3D%2794089%27%20"+
        "and%20query%3D%27pizza%27&format=json&"+
        "env=store%3A%2F%2Fdatatables.org%2Falltableswithkeys"
});

dataSource.plug(Y.Plugin.DataSourceJSONSchema, {
    schema: {
        resultListLocator: "query.results.Result",
        resultFields: ["Title", "Phone", "Rating.AverageRating"]
    }
});

dataSource.sendRequest({
    callback: {
        success: function(e) {
            Y.log(e);
        }
    }
});

Now that the DataSource is created properly, define the columns that you want your table to show. These columns map directly to the parameter names returned in the data.

var cols = [
    "Title",
    "Phone",
    { key: "Rating.AverageRating", label: "Rating" }
];

Now you are ready to create a DataTable using the columns you have defined. When you plug the instance with the DataTableDataSource plugin, point to your DataSource instance. After you render the table, load the data via the plugin.

var table = new Y.DataTable.Base({
    columnset: cols,
    summary:"Pizza places near 98089",
    caption:"Table with JSON data from YQL"
});

table.plug(Y.Plugin.DataTableDataSource, {
    datasource: dataSource
}).render("#pizza");

table.datasource.load();

One final change you can make is to split the URL between the DataSource source value and the request value sent to the DataTableDataSource plugin. Splitting the URL this way facilitates making future requests to the same DataSource. You can see this in the Full Code Listing below.

Full Code Listing

<div id="pizza" class="yui3-skin-sam dt-example"></div>

<script>
YUI().use("datasource-get", "datasource-jsonschema", "datatable-base-deprecated", "datatable-datasource-deprecated", function (Y) {

var url = "http://query.yahooapis.com/v1/public/yql?format=json" +
              "&env=store%3A%2F%2Fdatatables.org%2Falltableswithkeys",
    query = "&q=" + encodeURIComponent(
        'select * from local.search ' +
        'where zip = "94089" and query = "pizza"'),
    dataSource,
    table;

dataSource = new Y.DataSource.Get({ source: url });

dataSource.plug(Y.Plugin.DataSourceJSONSchema, {
    schema: {
        resultListLocator: "query.results.Result",
        resultFields: [
            "Title",
            "Phone",
            {
                key: "Rating.AverageRating",
                // YQL is returning "NaN" for unrated restaurants
                parser: function (val) {
                    return isNaN(val) ? '(none)' : val;
                }
            }
        ]
    }
});

table = new Y.DataTable.Base({
    columnset: [
        "Title",
        "Phone",
        { key:"Rating.AverageRating", label:"Rating" }
    ],
    summary: "Pizza places near 98089",
    caption: "Table with JSON data from YQL"
});

table.plug(Y.Plugin.DataTableDataSource, { datasource: dataSource });

table.render("#pizza");

table.datasource.load({ request: query });
});
</script>