Data Components Export to CSV

You can export Webix data components to the CSV format.

The components don't require any special configuration to be exported.

The described functionality is available both in Standard and Pro versions, but pay attention that the IE browser is supported starting from version 10.

To export data from a data component into a CSV document you need to call the toCSV method. The method takes 2 parameters:

  • id - (string, object) id or object of the exported view
  • options - (object) optional, a set of configuration options that define what data will be displayed in the CSV file

For example, to export a list to a CSV document, you need to call of the toCSV() method that takes the view object or its id as a parameter:

webix.ui({
    view:"list",
    id: "mylist",
    // list configuration
    ...
});
 
webix.toCSV($$("mylist"));

Related sample:  Export to CSV

Customizing Export to CSV

The toCSV method returns all data specified in the dataset of a component, or in the columns parameter of the DataTable view. The data is exported into a CSV document with "Data" name by default.

However, you may need to get some particular data, or customize the file name.

Export API allows

  • providing a custom filename:
webix.toCSV($$("table"), {
     filename: "table"    
});
  • stripping HTML tags from the cells:
webix.toCSV($$("mylist"), {
     filterHTML:true
});
  • setting columns you'd like to see in the export file. There are two ways to set the custom columns for export:

You can provide an associative array (hash) with column ids as keys. Their values can be either boolean for default parameters (taken from component configuration) or object for custom parameters:

webix.toCSV($$("table"), {
    columns:{
        "rank":true,
        "title":{ header:"Title", width:250}
    }
});

With such a notation the order of the columns in the resulting file is defined automatically with a for.. in loop. Sometimes it may be unreliable, e.g.:

webix.toCSV($$("table"), {
    columns:{
        "rank":true,
        "title":{ header:"Title", width:250},
        "2016":{ header:"Votes in 2016"},
        "2015":{ header:"Votes in 2015"}
    }
});

The order in the export file will be: "2015", "2016", "rank", "title" since numbers are processed first and come in the ascending order.

To ensure the strict order of columns in the resulting file, you can specify the columns as a plain array:

webix.toCSV($$("table"), {
    columns:[
        { id:"rank" },
        { id:"title", header:"Title", width:250},
        { id:"2016", header:"Votes in 2016"},
        { id:"2015", header:"Votes in 2015"}
    ]
});

Note that if you want to get the default column's parameters in this case, you should specify only the column's id (see the "rank" column).

  • defining custom header or template parameter for data in the specified column:
webix.toCSV($$("mylist"), {
    columns:{
        "title":{header: "Title", template: webix.template("#id#.#name#")},
        "year":{header: "Year"}
    }
});

The column will be rendered with the stated additional properties, which may differ from the component's parameters.

  • not rendering "hyphens" before child nodes in tree-like structures by using the plainOutput option with the true value
webix.toCSV($$("mytreetable"), {
    columns:{
        plainOutput:true
    }
});
  • rendering a template set in the widget's dataset via setting the rawValues option to false
webix.ui({
  rows:[
    { 
      view:"datatable", 
      data:grid_data, 
      columns:[{id:"title", fillspace:true, template:"Film #title#"}]
    }
  ]
});
 
webix.toCSV($$("$datatable1"),{
    columns:{
        rawValues:false
    }
});
  • including extra fields into export by forming them right within the export function:
webix.toCSV($$("mylist"), { 
    columns:{ 
        Custom1:{
            template:function(obj){
                return "Year " + obj.year;
            },
            header:"Year"
        },
        //other columns
        title:true
    }
});

"Custom1" (any name can be used) receives data from the year field even if it is not seen in this component but is presented in its dataset. The field is rendered with template and header that will be the header of the corresponding column in the resulting table.

  • setting the desired columns' delimiter using webix.csv.delimiter.cols
webix.csv.delimiter.cols = ",";

Related sample:  Export to CSV

Back to top