Export to Excel

To export data from datatable/treetable into an Excel document, you need to call the toExcel method.
The method takes 2 parameters:

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

For example, to export a datatable to an Excel document, you need to start with the view initialization:

{
    view:"datatable",
    id: "myDatatable",
    // datatable configuration
    ...
}

And then the call of the toExcel() method should follow.

webix.toExcel($$("myDataTable"));

Related sample:  Export to Excel

Customizing Export

The toExcel() method returns all data specified in the columns parameter of a datatable view. The data is exported into an Excel document with "Data" name and "Data" sheet name.

However, you may need to get some particular data, or customize file and sheet names.

Export API allows

  • providing a custom filename and sheet name:
webix.toExcel($$("table"), {
     filename: "table", // for filename
     name: "Films" // for sheet name
});

Related sample:  Export to Excel

  • stripping HTML tags from the cells:
webix.toExcel($$("table"), {
     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.toExcel($$("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.toExcel($$("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.toExcel($$("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 parameters, such as header, width or template for data in the specified column:
webix.toExcel($$("myDataTable"), {
    columns:{
        "title":{header: "Title", width: 200, template: webix.template("#id#.#name#")},
        "year":{header: "Year", width: 100}
    }
});

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

  • including extra fields into export by forming them right within the export function:
webix.toExcel(datatable, { 
    columns:{ 
        Custom1:{
            template:function(obj){
                return "Year " + obj.year;
            },
            width:50,
            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 datatable but is presented in its dataset. The field is rendered with width, template and header that will be the header of the corresponding column in the export table.

  • rendering a template set in the widget's dataset via setting the rawValues option to false
webix.ui({
  rows:[
    { 
      view:"datatable", 
      id:"table",
      data:grid_data, 
      columns:[{id:"title", fillspace:true, template:"Film #title#"}]
    }
  ]
});
 
webix.toExcel($$("table"), {
    columns:{
        rawValues:false
    }
});
  • including column and row spans (if any) into export:
webix.toExcel($$("table"), {
   spans:true
});
Back to top
If you have not checked yet, be sure to visit site of our main product Webix best ui framework and page of ui datagrid product.