Blazor Grid Export to Excel Service

    The Ignite UI for Blazor Export to Excel Service in Blazor Grid can export data to excel. The data export functionality is encapsulated in the ExcelExporterService class and the data is exported in MS Excel table format. This format allows features like filtering, sorting, etc. To do this you need to invoke the Export method of ExcelExporterService and pass the IgbGrid component as first argument to export grid easily.

    Blazor Excel Exporter Example

    Export Grouped Data

    To export grouped data you just need to group the IgbGrid by one or more columns. The browser will download a file named "ExportedDataFile.xlsx" which contains the data from the IgbGrid component in MS Excel format grouped by the selected column. You can find example in the beggining of the topic.

    Export Multi Column Headers Grid

    It is now possible to export IgbGrid with defined multi-column headers. All headers will be reflected in the exported excel file as they are displayed in the IgbGrid. If you want to exclude the defined multi-column headers from the exported data you can set the ExporterOption IgnoreMultiColumnHeaders to true.

    [!Note] The exported IgbGrid will not be formatted as a table, since Excel tables do not support multiple column headers.

    Export Grid with Frozen Column Headers

    Por padrão, o serviço Exportador do Excel exporta a grade com cabeçalhos de coluna roláveis (descongelados). Há cenários em que você pode querer congelar todos os cabeçalhos na parte superior do arquivo Excel exportado para que eles sempre permaneçam à vista enquanto o usuário percorre os registros. Para conseguir isso, você pode definir o ExporterOption FreezeHeaders para true.

     <IgbGrid>
    <IgbGridToolbar>
      <IgbGridToolbarActions>
        <IgbGridToolbarExporter
          ExportExcel="true" ExportStartedScript="WebGridExportEventFreezeHeaders">
        </IgbGridToolbarExporter>
      </IgbGridToolbarActions>
    </IgbGridToolbar>
 </IgbGrid>

igRegisterScript("WebGridExportEventFreezeHeaders", (ev) => {
    ev.detail.options.freezeHeaders = false;
}, false);

    Known Limitations

    Limitação Descrição
    Tamanho máximo da planilha O tamanho máximo da planilha com suporte no Excel é de 1.048.576 linhas por 16.384 colunas.
    Estilo de célula O serviço exportador do Excel não oferece suporte à exportação de um estilo personalizado aplicado a um componente de célula. Nesses cenários, recomendamos o uso da Biblioteca do Excel.

    API References

    • ExcelExporterService
    • ExcelExporterOptions
    • IgbGrid

    Additional Resources

    Nossa comunidade é ativa e sempre acolhedora para novas ideias.