New to Kendo UI for jQuery? Start a free 30-day trial

Excel

configuration

Configures the Excel export settings of the TreeList.

excel

Object

<div id="treelist"></div>
<script>
  $("#treelist").kendoTreeList({
    columns: [
      { field: "Name" },
      { field: "Position" }
    ],
    dataSource: [
      { id: 1, Name: "Daryl Sweeney", Position: "CEO", parentId: null },
      { id: 2, Name: "Guy Wooten", Position: "Chief Technical Officer", parentId: 1 }
    ],
    excel: {
      fileName: "TreeListData.xlsx",
      allPages: true
    }
  });
</script>

excel.allPages

Boolean

If set to true the TreeList will export all pages of data. By default the TreeList exports only the current page.

Default: false

<div id="treelist"></div>
<script>
  $("#treelist").kendoTreeList({
    toolbar: ["excel"],
    columns: [
      { field: "FirstName", title: "First Name" },
      { field: "LastName", title: "Last Name", width: 160 },
      { field: "Position" }
    ],
    excel: {
      allPages: true
    },
    pageable: {
      pageSize: 10
    },
    dataSource: {
      transport: {
        read: {
          url: "https://demos.telerik.com/service/v2/core/EmployeeDirectory/All"
        }
      },
      schema: {
        model: {
          id: "EmployeeID",
          fields: {
            parentId: { field: "ReportsTo",  nullable: true },
            EmployeeID: { field: "EmployeeId", type: "number" },
            Extension: { field: "Extension", type: "number" }
          },
          expanded: true
        }
      }
    }
  });
</script>

excel.fileName

String

Specifies the file name of the exported Excel file.

Default: "Export.xslx"

<div id="treelist"></div>
<script>
  $("#treelist").kendoTreeList({
    toolbar: ["excel"],
    columns: [
      { field: "FirstName", title: "First Name" },
      { field: "LastName", title: "Last Name", width: 160 },
      { field: "Position" }
    ],
    excel: {
      fileName: "Employees.xlsx"
    },
    dataSource: {
      transport: {
        read: {
          url: "https://demos.telerik.com/service/v2/core/EmployeeDirectory/All"
        }
      },
      schema: {
        model: {
          id: "EmployeeID",
          fields: {
            parentId: { field: "ReportsTo",  nullable: true },
            EmployeeID: { field: "EmployeeId", type: "number" },
            Extension: { field: "Extension", type: "number" }
          }
        }
      }
    }
  });
</script>

excel.filterable

Boolean

Enables or disables column filtering in the Excel file. Not to be mistaken with the filtering feature of the TreeList.

Default: false

<div id="treelist"></div>
<script>
  $("#treelist").kendoTreeList({
    toolbar: ["excel"],
    columns: [
      { field: "FirstName", title: "First Name" },
      { field: "LastName", title: "Last Name", width: 160 },
      { field: "Position" }
    ],
    excel: {
      filterable: true
    },
    dataSource: {
      transport: {
        read: {
          url: "https://demos.telerik.com/service/v2/core/EmployeeDirectory/All"
        }
      },
      schema: {
        model: {
          id: "EmployeeID",
          fields: {
            parentId: { field: "ReportsTo",  nullable: true },
            EmployeeID: { field: "EmployeeId", type: "number" },
            Extension: { field: "Extension", type: "number" }
          }
        }
      }
    }
  });
</script>

excel.forceProxy

Boolean

If set to true, the content will be forwarded to proxyURL even if the browser supports local file saving.

Default: false

<div id="treelist"></div>
<script>
  $("#treelist").kendoTreeList({
    columns: [
      { field: "Name" },
      { field: "Position" }
    ],
    dataSource: [
      { id: 1, Name: "Daryl Sweeney", Position: "CEO", parentId: null },
      { id: 2, Name: "Guy Wooten", Position: "Chief Technical Officer", parentId: 1 }
    ],
    excel: {
      fileName: "TreeListData.xlsx",
      forceProxy: true,
      proxyURL: "/save"
    }
  });
</script>

The URL of the server-side proxy which will stream the file to the end user. A proxy will be used when the browser is not capable of saving files locally. Such browsers are IE version 9 and earlier and Safari. The developer is responsible for implementing the server-side proxy. The proxy will return the decoded file with the Content-Disposition header set to attachment; filename="<fileName.xslx>".

The proxy will receive a POST request with the following parameters in the request body:

contentType - The MIME type of the file.
base64 - The base-64 encoded file content.
fileName - The file name as requested by the caller.

Default: null

<div id="treelist"></div>
<script>
  $("#treelist").kendoTreeList({
    toolbar: ["excel"],
    columns: [
      { field: "FirstName", title: "First Name" },
      { field: "LastName", title: "Last Name", width: 160 },
      { field: "Position" }
    ],
    excel: {
      proxyURL: "/save"
    },
    dataSource: {
      transport: {
        read: {
          url: "https://demos.telerik.com/service/v2/core/EmployeeDirectory/All"
        }
      },
      schema: {
        model: {
          id: "EmployeeID",
          fields: {
            parentId: { field: "ReportsTo",  nullable: true },
            EmployeeID: { field: "EmployeeId", type: "number" },
            Extension: { field: "Extension", type: "number" }
          }
        }
      }
    }
  });
</script>

Excel

excel

excel.allPages

excel.fileName

excel.filterable

excel.forceProxy

excel.proxyURL