Web Components Tree Grid Exporting

    The Ignite UI for Web Components Tree Grid provides data export functionality through the Grid Toolbar Exporter component. You can export the displayed data to Excel, CSV, or PDF formats. Excel exports use the MS Excel table format, which supports features like filtering and sorting. To enable exporting, place the IgcGridToolbarExporter inside the grid's toolbar. By default, all export formats are enabled.

    Web Components Exporting Example

    Export Multi Column Headers Grid

    You can export IgcTreeGridComponent with defined multi-column headers. All headers are reflected in the exported Excel file as they are displayed in the IgcTreeGridComponent. If you want to exclude the defined multi-column headers from the exported data, set the ExporterOption IgnoreMultiColumnHeaders to true.

    Note

    The exported IgcTreeGridComponent will not be formatted as a table, since Excel tables do not support multiple column headers.

    Note

    IgcGridToolbarExporter is also configured to demonstrate how you can control which export formats are available to end users. Use the toolbar exporter options to toggle Excel, CSV, or PDF buttons:

    • export-excel, export-csv, export-pdf

    Export Grid with Frozen Column Headers

    By default, the Excel Exporter service exports the grid with scrollable (unfrozen) column headers. In many scenarios you may want to freeze all headers at the top of the exported Excel file so they always stay in view as the user scrolls through the records. To achieve this, set the ExporterOption FreezeHeaders to true.

    Note

    PDF exports automatically include the column header row at the top of the document, so readers retain the same context when they open or print the file.

    constructor() {
  var gridToolbarExporter1 = document.getElementById('gridToolbarExporter1') as IgcGridToolbarExporterComponent;
  gridToolbarExporter1.addEventListener("exportStarted", this.webGridExportEventFreezeHeaders);
}

public webGridExportEventFreezeHeaders(args: any): void {
  args.detail.options.freezeHeaders = true;
}

    Known Limitations

    Limitación Descripción
    Niveles de jerarquía El servicio exportador de Excel puede crear hasta 8 niveles de jerarquía.
    Tamaño máximo de hoja de trabajo El tamaño máximo de hoja de cálculo admitido por Excel es 1.048.576 filas por 16.384 columnas.
    Estilo celular The Excel exporter service does not support exporting a custom style applied to a cell component. In such scenarios we recommend using the Excel Library.
    Wide PDF layouts Very wide grids can force PDF columns to shrink to fit the page. Apply column widths or hide low-priority fields before exporting to keep the document legible.

    API References

    Additional Resources

    Nuestra comunidad es activa y siempre da la bienvenida a nuevas ideas.