How to add images to Excel worksheet programmatically in Flutter ?

Syncfusion Flutter XlsIO library is used to create and modify Excel documents. Using this library, you can add images like JPEG and PNG formats to an Excel worksheet using Flutter.

Steps to add images to the Excel document programmatically.

Step 1: Create a new Flutter application project.

1. Open Visual Studio Code (after installing the Dart and Flutter extensions as stated on this setup editor page).
2. Click View -> Command Palette…

3. Type Flutter and choose Flutter: New Project.

4. Enter the project name and press the Enter button.
5. Now choose the location of the project.

Step 2: Add the following code in your pubspec.yaml file to install the syncfusion flutter xlsio package in your application. It will be automatically downloaded from the pub once you trigger the flutter pub get commend or Get packages option from the Visual Studio Code.

dependencies:
   syncfusion_flutter_xlsio: ^18.4.31-beta

Import the following package in your main.dart file.

import 'package:syncfusion_flutter_xlsio/xlsio.dart' ;

Step 3: Add the following code in the lib/main.dart file to create a simple button.

 @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            FlatButton(
              child: const Text(
                'Generate Excel',
                style: TextStyle(color: Colors.white),
              ),
              color: Colors.blue,
              onPressed: _addImageToExcel,
            )
          ],
        ),
      ),
    );
  }

Step 4: Use the following code to load an image in the Flutter project.

1. Add the following code in your pubspec.yaml file.

   flutter:
     # To add assets to your application, add an assets section, like this:
     assets:
       - images/
   

2. Import the following package in your main.dart file.

   import 'dart:convert';
   import 'package:flutter/services.dart';
   

3. Add the following code in lib/main.dart file to read an image.

   Future<List<int>> _readImageData(String name) async {
       final ByteData data = await rootBundle.load('images/$name');
       return data.buffer.asUint8List(data.offsetInBytes, data.lengthInBytes);
     }
    
   

Step 5: Add the following code to the _addImageToExcel()  function to add Images to a Excel document programmatically.

Future<void> _addImageToExcel() async {
    // Create a Excel document.
    // Creating a workbook.
    final Workbook workbook = Workbook();
 
    // Accessing via index
    final Worksheet sheet = workbook.worksheets[0];
 
    final String image = base64.encode(await _readImageData('image.jpg'));
 
    // Add image to Excel worksheet.
    sheet.pictures.addBase64(1, 1, image);
 
    // Save and launch the excel.
    final List<int> bytes = workbook.saveAsStream();
 
    // Dispose the document.
    workbook.dispose();
  }

Step 6: Use the following code to save and launch the generated Excel file.

1. Add the following dependencies in your pubspec.yaml file.

   path_provider: ^1.6.7
   open_file: ^3.0.1   #Open source library to launch the Excel file in mobile devices
   

2. Import the following packages in your main.dart file.

   import 'dart:io'; 
   import 'package:path_provider/path_provider.dart';
   import 'package:open_file/open_file.dart';
   

3. Include the following code snippet in the _addImageToExcel() method to open the Excel document in the mobile‘s default application (any Excel application).

    // Get the storage folder location using path_provider package.
    final Directory directory = await getExternalStorageDirectory();
    // Get directory path
    final String path = directory.path;
    // Create an empty file to write Excel data
    final File file = File('$path/ExcelImage.xlsx');
    // Write Excel data
    await file.writeAsBytes(bytes, flush: true);
    // Launch the file (used open_file package)
    await OpenFile.open('$path/ExcelImage.xlsx');
   

Step 7: Run the sample using the flutter run command. This will add Image to the Excel document.

After the application launches, you will get the Excel document below.

Output Excel document created using XlsIO

You can download the complete work sample from add-image-to-excel.zip.

Take a moment to peruse the documentation where you can find basic Excel document processing options along with the features like import and export data, chart, formulas, conditional formatting, data validation, tables, pivot tables and protect the Excel documents, and most importantly, the PDF, CSV and Image conversions with code examples.

Conclusion

I hope you enjoyed learning about how to add images to Excel worksheet programmatically in Flutter.

You can refer to our XIsIO’s feature tour page to learn about its other groundbreaking features. Explore our UG documentation and online demos to understand how to manipulate data in Excel documents.

If you are an existing user, you can access our latest components from the License and Downloads page. For new users, you can try our 30-day free trial to check out XlsIO and other Syncfusion® components.

If you have any queries or require clarification, please let us know in the comments below or contact us through our support forums, Support Tickets, or feedback portal. We are always happy to assist you!