excel_dart

Description:

excel dart

Excel Dart #























This library is a fork of excel latest version and i updated all the old dependencies that made some conflicts with newer packages, will not be any new features here, but i'll keep this library up to date #
Excel Dart is a flutter and dart library for reading, creating and updating excel-sheets for XLSX files. #
This library is MIT licensed So, it's free to use anytime, anywhere without any consent, because we believe in Open Source work.
Lets Get Started #
1. Depend on it #
Add this to your package's pubspec.yaml file:
dependencies:
excel_dart: any
copied to clipboard
2. Install it #
You can install packages from the command line:
with pub:
$ pub get
copied to clipboard
with Flutter:
$ flutter packages get
copied to clipboard
3. Import it #
Now in your Dart code, you can use:
import 'package:excel_dart/excel_dart.dart';
copied to clipboard
Usage #
Imports #
import 'dart:io';
import 'package:path/path.dart';
import 'package:excel_dart/excel_dart.dart';

copied to clipboard
Password protected ? protect #
Protect helps you to apply and remove password protection on your excel file.
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 Name
print(excel.tables[table].maxCols);
print(excel.tables[table].maxRows);
for (var row in excel.tables[table].rows) {
print("$row");
}
}

copied to clipboard
Is your excel file password protected ? ( We got u covered ) #
Protect helps you to apply and remove password protection on your excel file. protect
Read XLSX in Flutter Web #
Use FilePicker to pick files in Flutter Web. FilePicker

/// Use FilePicker to pick files in Flutter Web

FilePickerResult pickedFile = await FilePicker.platform.pickFiles(
type: FileType.custom,
allowedExtensions: ['xlsx'],
allowMultiple: false,
);

/// file might be picked

if (pickedFile != null) {
var bytes = pickedFile.files.single.bytes;
var excel = Excel.decodeBytes(bytes);
for (var table in excel.tables.keys) {
print(table); //sheet Name
print(excel.tables[table].maxCols);
print(excel.tables[table].maxRows);
for (var row in excel.tables[table].rows) {
print("$row");
}
}
}
copied to clipboard
Read XLSX from Flutter's Asset Folder #
import 'package:flutter/services.dart' show ByteData, rootBundle;

/* Your blah blah 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 Name
print(excel.tables[table].maxCols);
print(excel.tables[table].maxRows);
for (var row in excel.tables[table].rows) {
print("$row");
}
}

copied to clipboard
Create New XLSX File #
var excel = Excel.createExcel(); // automatically creates 1 empty sheet: Sheet1

copied to clipboard
Update Cell values #
/*
* 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.Double


var cell = sheetObject.cell(CellIndex.indexByString("A1"));
cell.value = 8; // dynamic values support provided;
cell.cellStyle = cellStyle;

// printing cell-type
print("CellType: "+ cell.cellType.toString());

///
/// 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);


copied to clipboard
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



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;

copied to clipboard
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');

copied to clipboard
Rename sheet #

/*
* excel.rename(String 'existingSheetName', String 'newSheetName');
* existingSheetName should exist in excel.tables.keys in order to successfully rename
*
*/

excel.rename('existingSheetName', 'newSheetName');

copied to clipboard
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');

copied to clipboard
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);

copied to clipboard
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'];

copied to clipboard
Merge Cells #
/*
* sheetObject.merge(CellIndex starting_cell, CellIndex ending_cell, dynamic '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: "Put this text after merge");

copied to clipboard
Get Merged Cells List #
// Check which cells are merged

sheetObject.spannedItems.forEach((cells) {
print("Merged:" + cells.toString());
});

copied to clipboard
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");

copied to clipboard
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');

copied to clipboard
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 row
List<String> dataList = ["Google", "loves", "Flutter", "and", "Flutter", "loves", "Excel"];

sheetObject.insertRowIterables(dataList, 8);

copied to clipboard
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(["Flutter", "till", "Eternity"]);

copied to clipboard
Get Default Opening Sheet #
/*
* method which returns the name of the default sheet
* excel.getDefaultSheet();
*/

var defaultSheet = excel.getDefaultSheet();
print("Default Sheet:" + defaultSheet.toString());

copied to clipboard
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.");
}

copied to clipboard
Saving #
On Flutter Web #
// when you are in flutter web then save() downloads the excel file.

// Call function save() to download the file
var fileBytes = excel.save(fileName: "My_Excel_File_Name.xlsx");

copied to clipboard
On Android / iOS #
For getting saving directory on Android or iOS, Use: path_provider
var fileBytes = excel.save();
var directory = await getApplicationDocumentsDirectory();

File(join("$directory/output_file_name.xlsx"))
..createSync(recursive: true)
..writeAsBytesSync(fileBytes);
copied to clipboard