搜尋套件、儲存庫與 APP 分類

套件詳情v1.0.1

flutter_excel

excel 的一個分支。一個用於讀取、建立、編輯和更新電子試算表的 Flutter 與 Dart 庫,可在客戶端與伺服器端相容使用。

AndroidiOSWebmacOSWindowsLinux
近 30 天下載
801
喜歡數
31
Pub 分數
130

安裝套件

flutter pub add flutter_excel

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

flutter_excel 是一個從 excel 分叉出來的 Flutter 與 Dart 庫,讓開發者能在客戶端與伺服器環境中讀取、建立、編輯與更新 Excel 表格。它支援多種平台,包括 Android、iOS、Web、macOS、Windows 與 Linux,非常適合需要電子試算表功能的跨平台應用程式。該套件提供強大的工具來處理 Excel 檔案,無需依賴外部服務,確保資料隱私與離線使用。對於需要以 Excel 格式匯出、匯入或操作資料的應用程式特別實用。

適用情境

  • 將應用資料匯出到Excel
  • 匯入使用者上傳的Excel檔案
  • 產生報告
  • 管理庫存數據
  • 建立範本
  • 處理財務記錄

主要特色

  • 跨平台支援
  • 讀取、寫入和編輯 Excel 檔案
  • 伺服器與客戶端相容性
  • 無外部依賴
  • 支援多種檔案格式
  • 與 Flutter 的輕鬆整合

適合對象

  • 資料驅動的應用程式
  • 報告工具
  • 庫存管理系統
  • 財務軟體
  • 教育類應用
  • 桌面與行動應用程式

使用建議

  • 大檔案處理可能會影響效能
  • 有限的高級格式選項
  • 處理大資料集時需要謹慎的記憶體管理
  • 不適用於即時協作編輯
  • 依賴於底層 Excel 庫的穩定性
  • 可能需要對用戶輸入進行額外驗證

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

Excel

Platform Test Pub Package License: MIT Issue Forks Stars

Excel 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: any
2. Install it

You can install packages from the command line:

with pub:

$  pub get

with Flutter:

$  flutter packages get
3. Import it

Now in your Dart code, you can use:

    import 'package:excel/excel.dart';

Usage

Breaking Changes for those moving from 1.0.8 and below ----> 1.0.9 and above versions

The necessary changes to be made to updateCell function in order to prevent the code from breaking.

    
    excel.updateCell('SheetName', CellIndex.indexByString("A2"), "Here value", backgroundColorHex: "#1AFF1A", horizontalAlign: HorizontalAlign.Right);
    
    // Now in the above code wrap the optional arguments with CellStyle() and pass it to optional cellStyle parameter.
    // So the resulting code will look like
    
    excel.updateCell('SheetName', CellIndex.indexByString("A2"), "Here value", cellStyle: CellStyle( backgroundColorHex: "#1AFF1A", horizontalAlign: HorizontalAlign.Right ) );
    
Imports
    import 'dart:io';
    import 'package:path/path.dart';
    import 'package:excel/excel.dart';
    

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");
      }
    }
    
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");
      }
    }
  }
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");
      }
    }
    
Create New XLSX File
    var excel = Excel.createExcel(); // automatically creates 1 empty sheet: Sheet1
    
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);
      
      
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;
      
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, 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");
     
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 row
      List<String> dataList = ["Google", "loves", "Flutter", "and", "Flutter", "loves", "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(["Flutter", "till", "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 file
     var 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 = await getApplicationDocumentsDirectory();
     
    File(join("$directory/output_file_name.xlsx"))
      ..createSync(recursive: true)
      ..writeAsBytesSync(fileBytes);

Frequent Issues

Having Trouble using excel i.e: every version of some_other_library depends on version..... blah blah blah

Similar issues have been solved in the past : #26, #25, #11

Features coming in next version

On-going implementation for future:

  • Formulas
  • Conversion to PDF

Donate on Paypal

Thanks for d♥️nations, you are very kind hearted person 👌

所屬分類

依賴

依賴清單 3 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。