Orientação gerada a partir de informações públicas. Apenas para referência.
O pacote excel é uma biblioteca do Flutter e Dart que permite a leitura, criação, edição e atualização de planilhas do Excel de forma transparente. Ele suporta operações do lado do cliente e do lado do servidor em múltiplas plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux. Projetado para compatibilidade e facilidade de uso, permite que desenvolvedores trabalhem diretamente com arquivos Excel em seus aplicativos Dart, sem depender de ferramentas externas. A biblioteca se integra suavemente aos projetos Flutter por meio do pub.dev e fornece uma API direta para manipular planilhas programaticamente.
Casos de uso
Lendo arquivos Excel em aplicativos Flutter
Criando novos arquivos do Excel a partir de dados
Editando planilhas do Excel existentes
Gerando relatórios no formato Excel
Processamento de Excel do lado do servidor
Principais recursos
Suporte multiplataforma
Compatibilidade entre cliente e servidor
API simples para manipulação de Excel
Suporta arquivos .xlsx
Exportação/importação de dados embutida
Indicado para
Aplicações Flutter orientadas por dados
Recursos de relatórios e análise
Exportando dados do aplicativo para o Excel
Serviços de backend que precisam de tratamento de Excel
Aplicativos móveis e web que exigem integração de planilhas
Considerações
O tratamento de arquivos grandes pode afetar o desempenho
Opções avançadas de formatação limitadas
Nenhuma avaliação de fórmula do Excel embutida
Requer gerenciamento cuidadoso da memória para grandes conjuntos de dados
Depende de dependências externas para funcionalidade completa
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
Excel
Excel is a flutter and dart library for reading, creating and updating excel-sheets for XLSX files.
Road-map:
➕ Formulas and Calculations
💾 Support Multiple Data type efficiently
📈 Charts
🌄 Add Pictures
📰 Create Tables and style
🔐 Encrypt and Decrypt excel on the go.
Many more features
Breaking changes from 4.x.x to 5.x.x
Updated minimum Dart SDK to 3.6.0
Breaking changes from 3.x.x to 4.x.x
Renamed Formula to FormulaCellValue
Cells value now represented by the sealed class CellValue instead of dynamic. Subtypes are TextCellValueFormulaCellValue, IntCellValue, DoubleCellValue, DateCellValue, TextCellValue, BoolCellValue, TimeCellValue, DateTimeCellValue and they allow for exhaustive switch (see Dart Docs (sealed class modifier)).
Breaking changes from 2.x.x to 3.x.x
Renamed getColAutoFits() to getColumnAutoFits(), and changed return type to Map<int, bool> in Sheet
Renamed getColWidths() to getColumnWidths(), and changed return type to Map<int, double> in Sheet
Renamed getColAutoFit() to getColumnAutoFit() in Sheet
Renamed getColWidth() to getColumnWidth() in Sheet
Renamed setColAutoFit() to setColumnAutoFit() in Sheet
Renamed setColWidth() to setColumnWidth() in Sheet
If you find this tool useful, please drop a ⭐️
Usage
Read XLSX File
var file = 'Path_to_pre_existing_Excel_File/excel_file.xlsx';
var bytes = File(file).readAsBytesSync();
var excel = Excel.decodeBytes(bytes);
for (var table in excel.tables.keys) {
print(table); //sheet Nameprint(excel.tables[table].maxColumns);
print(excel.tables[table].maxRows);
for (var row in excel.tables[table].rows) {
for (var cell in row) {
print('cell ${cell.rowIndex}/${cell.columnIndex}');
final value = cell.value;
final numFormat = cell.cellStyle?.numberFormat ?? NumFormat.standard_0;
switch(value){
casenull:
print(' empty cell');
print(' format: ${numFormat}');
caseTextCellValue():
print(' text: ${value.value}');
caseFormulaCellValue():
print(' formula: ${value.formula}');
print(' format: ${numFormat}');
caseIntCellValue():
print(' int: ${value.value}');
print(' format: ${numFormat}');
caseBoolCellValue():
print(' bool: ${value.value ? 'YES!!' : 'NO..' }');
print(' format: ${numFormat}');
caseDoubleCellValue():
print(' double: ${value.value}');
print(' format: ${numFormat}');
caseDateCellValue():
print(' date: ${value.year}${value.month}${value.day} (${value.asDateTimeLocal()})');
caseTimeCellValue():
print(' time: ${value.hour}${value.minute} ... (${value.asDuration()})');
caseDateTimeCellValue():
print(' date with time: ${value.year}${value.month}${value.day}${value.hour} ... (${value.asDateTimeLocal()})');
}
print('$row');
}
}
}
Read XLSX in Flutter Web
Use FilePicker to pick files in Flutter Web. FilePicker
/// Use FilePicker to pick files in Flutter WebFilePickerResult pickedFile = awaitFilePicker.platform.pickFiles(
type: FileType.custom,
allowedExtensions: ['xlsx'],
allowMultiple: false,
);
/// file might be pickedif (pickedFile != null) {
var bytes = pickedFile.files.single.bytes;
var excel = Excel.decodeBytes(bytes);
for (var table in excel.tables.keys) {
print(table); //sheet Nameprint(excel.tables[table].maxColumns);
print(excel.tables[table].maxRows);
for (var row in excel.tables[table].rows) {
print('$row');
}
}
}
Read XLSX from Flutter's Asset Folder
import'package:flutter/services.dart'showByteData, rootBundle;
/* Your ......other important..... code here */ByteData data = await rootBundle.load('assets/existing_excel_file.xlsx');
var bytes = data.buffer.asUint8List(data.offsetInBytes, data.lengthInBytes);
var excel = Excel.decodeBytes(bytes);
for (var table in excel.tables.keys) {
print(table); //sheet Nameprint(excel.tables[table].maxColumns);
print(excel.tables[table].maxRows);
for (var row in excel.tables[table].rows) {
print('$row');
}
}
/*
* sheetObject.updateCell(cell, value, { CellStyle (Optional)});
* sheetObject created by calling - // Sheet sheetObject = excel['SheetName'];
* cell can be identified with Cell Address or by 2D array having row and column Index;
* Cell Style options are optional
*/Sheet sheetObject = excel['SheetName'];
CellStyle cellStyle = CellStyle(backgroundColorHex: '#1AFF1A', fontFamily :getFontFamily(FontFamily.Calibri));
cellStyle.underline = Underline.Single; // or Underline.Doublevar cell = sheetObject.cell(CellIndex.indexByString('A1'));
cell.value = null; // removing any value
cell.value = TextCellValue('Some Text');
cell.value = IntCellValue(8);
cell.value = BoolCellValue(true);
cell.value = DoubleCellValue(13.37);
cell.value = DateCellValue(year: 2023, month: 4, day: 20);
cell.value = TimeCellValue(hour: 20, minute: 15, second: 5, millisecond: ...);
cell.value = DateTimeCellValue(year: 2023, month: 4, day: 20, hour: 15, ...);
cell.cellStyle = cellStyle;
// setting the number style
cell.cellStyle = (cell.cellStyle ?? CellStyle()).copyWith(
/// for IntCellValue, DoubleCellValue and BoolCellValue use;
numberFormat: CustomNumericNumFormat('#,##0.00 \\m\\²'),
/// for DateCellValue and DateTimeCellValue use:
numberFormat: CustomDateTimeNumFormat('m/d/yy h:mm'),
/// for TimeCellValue use:
numberFormat: CustomDateTimeNumFormat('mm:ss'),
/// a builtin format for dates
numberFormat: NumFormat.standard_14,
/// a builtin format that uses a red text color for negative numbers
numberFormat: NumFormat.standard_38,
// The numberFormat changes automatially if you set a CellValue that // does not work with the numberFormat set previously. So in case you// want to set a new value, e.g. from a date to a decimal number, // make sure you set the new value first and then your custom// numberFormat).
);
// printing cell-typeprint('CellType: ' + switch(cell.value) {
null => 'empty cell',
TextCellValue() => 'text',
FormulaCellValue() => 'formula',
IntCellValue() => 'int',
BoolCellValue() => 'bool',
DoubleCellValue() => 'double',
DateCellValue() => 'date',
TimeCellValue => 'time',
DateTimeCellValue => 'date with time',
});
////// Inserting and removing column and rows// insert column at index = 8
sheetObject.insertColumn(8);
// remove column at index = 18
sheetObject.removeColumn(18);
// insert row at index = 82
sheetObject.insertRow(82);
// remove row at index = 80
sheetObject.removeRow(80);
Cell-Style Options
key
description
fontFamily
eg. getFontFamily(FontFamily.Arial) or getFontFamily(FontFamily.Comic_Sans_MS) There is total 182 Font Families available for now
fontSize
specify the font-size as integer eg. fontSize = 15
bold
makes text bold - when set to true, by-default it is set to false
italic
makes text italic - when set to true, by-default it is set to false
underline
Gives underline to text enum Underline { None, Single, Double } eg. Underline.Single, by-default it is set to Underline.None
fontColorHex
Font Color eg. '#0000FF'
rotation (degree)
rotation of text eg. 50, rotation varies from -90 to 90, with including 90 and -90
backgroundColorHex
Background color of cell eg. '#faf487'
wrap
Text wrapping enum TextWrapping { WrapText, Clip } eg. TextWrapping.Clip
verticalAlign
align text vertically enum VerticalAlign { Top, Center, Bottom } eg. VerticalAlign.Top
horizontalAlign
align text horizontally enum HorizontalAlign { Left, Center, Right } eg. HorizontalAlign.Right
leftBorder
the left border of the cell (see below)
rightBorder
the right border of the cell
topBorder
the top border of the cell
bottomBorder
the bottom border of the cell
diagonalBorder
the diagonal "border" of the cell
diagonalBorderUp
boolean value indicating if the diagonal "border" should be displayed on the up diagonal
diagonalBorderDown
boolean value indicating if the diagonal "border" should be displayed on the down diagonal
numberFormat
a subtype of NumFormat to style the CellValue displayed, use default formats such as NumFormat.standard_34 or create your own using CustomNumericNumFormat('#,##0.00 \\m\\²')CustomDateTimeNumFormat('m/d/yy h:mm')CustomTimeNumFormat('mm:ss')
Borders
Borders are defined for each side (left, right, top, and bottom) of the cell. Both diagonals (up and down) share the
same settings. A boolean value true must be set to either diagonalBorderUp or diagonalBorderDown (or both) to
display the desired diagonal.
Each border must be a Border object. This object accepts two parameters : borderStyle to select one of the different
supported styles and borderColorHex to change the border color.
The borderStyle must be a value from the enumerationBorderStyle:
BorderStyle.None
BorderStyle.DashDot
BorderStyle.DashDotDot
BorderStyle.Dashed
BorderStyle.Dotted
BorderStyle.Double
BorderStyle.Hair
BorderStyle.Medium
BorderStyle.MediumDashDot
BorderStyle.MediumDashDotDot
BorderStyle.MediumDashed
BorderStyle.SlantDashDot
BorderStyle.Thick
BorderStyle.Thin
/*
*
* Defines thin borders on the left and right of the cell, red thin border on the top
* and blue medium border on the bottom.
*
*/CellStyle cellStyle = CellStyle(
leftBorder: Border(borderStyle: BorderStyle.Thin),
rightBorder: Border(borderStyle: BorderStyle.Thin),
topBorder: Border(borderStyle: BorderStyle.Thin, borderColorHex: 'FFFF0000'),
bottomBorder: Border(borderStyle: BorderStyle.Medium, borderColorHex: 'FF0000FF'),
);
Make sheet RTL
/*
* set rtl to true for making sheet to right-to-left
* default value of rtl = false ( which means the fresh or default sheet is ltr )
*
*/var sheetObject = excel['SheetName'];
sheetObject.rtl = true;
Copy sheet contents to another sheet
/*
* excel.copy(String 'existingSheetName', String 'anotherSheetName');
* existingSheetName should exist in excel.tables.keys in order to successfully copy
* if anotherSheetName does not exist then it will be automatically created.
*
*/
excel.copy('existingSheetName', 'anotherSheetName');
Rename sheet
/*
* excel.rename(String 'existingSheetName', String 'newSheetName');
* existingSheetName should exist in excel.tables.keys in order to successfully rename
*
*/
excel.rename('existingSheetName', 'newSheetName');
Delete sheet
/*
* excel.delete(String 'existingSheetName');
* (existingSheetName should exist in excel.tables.keys) and (excel.tables.keys.length >= 2), in order to successfully delete.
*
*/
excel.delete('existingSheetName');
Link sheet
/*
* excel.link(String 'sheetName', Sheet sheetObject);
*
* Any operations performed on (object of 'sheetName') or sheetObject then the operation is performed on both.
* if 'sheetName' does not exist then it will be automatically created and linked with the sheetObject's operation.
*
*/
excel.link('sheetName', sheetObject);
Un-Link sheet
/*
* excel.unLink(String 'sheetName');
* In order to successfully unLink the 'sheetName' then it must exist in excel.tables.keys
*
*/
excel.unLink('sheetName');
// After calling the above function be sure to re-make a new reference of this.Sheet unlinked_sheetObject = excel['sheetName'];
Merge Cells
/*
* sheetObject.merge(CellIndex starting_cell, CellIndex ending_cell, TextCellValue('customValue'));
* sheetObject created by calling - // Sheet sheetObject = excel['SheetName'];
* starting_cell and ending_cell can be identified with Cell Address or by 2D array having row and column Index;
* customValue is optional
*/
sheetObject.merge(CellIndex.indexByString('A1'), CellIndex.indexByString('E4'), customValue: TextCellValue('Put this text after merge'));
Get Merged Cells List
// Check which cells are merged
sheetObject.spannedItems.forEach((cells) {
print('Merged:' + cells.toString());
});
Un-Merge Cells
/*
* sheetObject.unMerge(cell);
* sheetObject created by calling - // Sheet sheetObject = excel['SheetName'];
* cell should be identified with string only with an example as 'A1:E4'.
* to check if 'A1:E4' is un-merged or not
* call the method excel.getMergedCells(sheet); and verify that it is not present in it.
*/
sheetObject.unMerge('A1:E4');
Find and Replace
/*
* int replacedCount = sheetObject.findAndReplace(source, target);
* sheetObject created by calling - // Sheet sheetObject = excel['SheetName'];
* source is the string or ( User's Custom Pattern Matching RegExp )
* target is the string which is put in cells in place of source
*
* it returns the number of replacements made
*/int replacedCount = sheetObject.findAndReplace('Flutter', 'Google');
Insert Row Iterables
/*
* sheetObject.insertRowIterables(list-iterables, rowIndex, iterable-options?);
* sheetObject created by calling - // Sheet sheetObject = excel['SheetName'];
* list-iterables === list of iterables which has to be put in specific row
* rowIndex === the row in which the iterables has to be put
* Iterable options are optional
*//// It will put the list-iterables in the 8th index rowList<CellValue> dataList = [TextCellValue('Google'), TextCellValue('loves'), TextCellValue('Flutter'), TextCellValue('and'), TextCellValue('Flutter'), TextCellValue('loves'), TextCellValue('Excel')];
sheetObject.insertRowIterables(dataList, 8);
Iterable Options
key
description
startingColumn
starting column index from which list-iterables should be started
overwriteMergedCells
overwriteMergedCells is by-defalut set to true, when set to false it will stop over-write and will write only in unique cells
Append Row
/*
* sheetObject.appendRow(list-iterables);
* sheetObject created by calling - // Sheet sheetObject = excel['SheetName'];
* list-iterables === list of iterables
*/
sheetObject.appendRow([TextCellValue('Flutter'), TextCellValue('till'), TextCellValue('Eternity')]);
Get Default Opening Sheet
/*
* method which returns the name of the default sheet
* excel.getDefaultSheet();
*/var defaultSheet = excel.getDefaultSheet();
print('Default Sheet:' + defaultSheet.toString());
Set Default Opening Sheet
/*
* method which sets the name of the default sheet
* returns bool if successful then true else false
* excel.setDefaultSheet(sheet);
* sheet = 'SheetName'
*/var isSet = excel.setDefaultSheet(sheet);
if (isSet) {
print('$sheet is set to default sheet.');
} else {
print('Unable to set $sheet to default sheet.');
}
Saving
On Flutter Web
// when you are in flutter web then save() downloads the excel file.// Call function save() to download the filevar fileBytes = excel.save(fileName: 'My_Excel_File_Name.xlsx');
On Android / iOS
For getting saving directory on Android or iOS, Use: path_provider
var fileBytes = excel.save();
var directory = awaitgetApplicationDocumentsDirectory();
File(join('$directory/output_file_name.xlsx'))
..createSync(recursive: true)
..writeAsBytesSync(fileBytes);