Convert Sparkline to Image and HTML in Aspose.Cells for Java

Introduction

Sparklines are a compact way to visualize trends directly inside a worksheet. While Excel users see them in place, many real-world scenarios require a sparkline to leave the cell — for example, to be embedded into a different cell as a static picture, attached to an automated email, or rendered as part of an HTML report published to the web.

Aspose.Cells supports both of these operations. The Sparkline.toImage method renders an individual sparkline to a stream, and the resulting bytes can be assigned to Cell.EmbeddedImage (via setEmbeddedImage) so the picture is stored inside a single cell of the workbook. Separately, HtmlSaveOptions lets you convert the entire workbook — sparklines and all — into a self-contained HTML file. This article walks through both workflows end to end.

Workflow 1 — Render Sparklines to Images and Embed Them into Cells

In this workflow you will build a worksheet that contains a small range of source values, attach three different sparkline groups (Line, Column, and Stacked/Win-Loss) to that range, render each group as a PNG, and write those PNG bytes into adjacent cells as embedded images. The final result is a single .xlsx file that contains both the live sparklines and their rendered picture counterparts.

Step-by-Step Instructions

  1. Define a working directory and ensure it exists on disk.
  2. Create a new Workbook and obtain a reference to the first Worksheet.
  3. Populate cells A1 through E1 with five sample numeric values (for example, daily sales or temperature readings).
  4. Add three SparklineGroup objects to the worksheet by calling worksheet.getSparklineGroups().add(...):
    • A SparklineType.LINE group anchored at F1, with data range A1:E1.
    • A SparklineType.COLUMN group anchored at G1, with data range A1:E1.
    • A SparklineType.STACKED (win/loss) group anchored at H1, with data range A1:E1.
  5. Build an ImageOrPrintOptions instance and call setImageType(ImageType.PNG) so each sparkline is rendered as a transparent PNG.
  6. For each of the three groups, render its single sparkline using group.getSparklines().get(0).toImage(byteArrayOutputStream, imageOptions), convert the ByteArrayOutputStream to a byte[], and assign the array via worksheet.getCells().get("F2").setEmbeddedImage(...), worksheet.getCells().get("G2").setEmbeddedImage(...), and worksheet.getCells().get("H2").setEmbeddedImage(...) respectively.
  7. Call workbook.save("output_with_sparklines.xlsx") to save the workbook to disk.
import com.aspose.cells.*;
import java.io.*;

// Create a new workbook and access the first worksheet
Workbook workbook = new Workbook();
Worksheet worksheet = workbook.getWorksheets().get(0);

// Populate sample data in cells A1:E1
worksheet.getCells().get("A1").putValue(5);
worksheet.getCells().get("B1").putValue(-3);
worksheet.getCells().get("C1").putValue(8);
worksheet.getCells().get("D1").putValue(-2);
worksheet.getCells().get("E1").putValue(6);

// Add a Line sparkline group anchored at F1 (column 5, row 0)
CellArea lineArea = CellArea.createCellArea(5, 0, 5, 0);
int lineIdx = worksheet.getSparklineGroups().add(SparklineType.LINE, "A1:E1", false, lineArea);

// Add a Column sparkline group anchored at G1 (column 6, row 0)
CellArea columnArea = CellArea.createCellArea(6, 0, 6, 0);
int columnIdx = worksheet.getSparklineGroups().add(SparklineType.COLUMN, "A1:E1", false, columnArea);

// Add a Win/Loss (Stacked) sparkline group anchored at H1 (column 7, row 0)
CellArea stackedArea = CellArea.createCellArea(7, 0, 7, 0);
int stackedIdx = worksheet.getSparklineGroups().add(SparklineType.STACKED, "A1:E1", false, stackedArea);

// Configure image options for PNG output
ImageOrPrintOptions imageOptions = new ImageOrPrintOptions();
imageOptions.setImageType(ImageType.PNG);

// Convert the Line sparkline to image and embed it in cell F2
Sparkline lineSp = worksheet.getSparklineGroups().get(lineIdx).getSparklines().get(0);
ByteArrayOutputStream lineMs = new ByteArrayOutputStream();
lineSp.toImage(lineMs, imageOptions);
worksheet.getCells().get("F2").setEmbeddedImage(lineMs.toByteArray());

// Convert the Column sparkline to image and embed it in cell G2
Sparkline columnSp = worksheet.getSparklineGroups().get(columnIdx).getSparklines().get(0);
ByteArrayOutputStream columnMs = new ByteArrayOutputStream();
columnSp.toImage(columnMs, imageOptions);
worksheet.getCells().get("G2").setEmbeddedImage(columnMs.toByteArray());

// Convert the Win/Loss sparkline to image and embed it in cell H2
Sparkline stackedSp = worksheet.getSparklineGroups().get(stackedIdx).getSparklines().get(0);
ByteArrayOutputStream stackedMs = new ByteArrayOutputStream();
stackedSp.toImage(stackedMs, imageOptions);
worksheet.getCells().get("H2").setEmbeddedImage(stackedMs.toByteArray());

// Save the workbook to disk
workbook.save("output_with_sparklines.xlsx");

The code above produces a workbook where each visual representation of a sparkline is duplicated in two forms: the live, native sparkline anchored at row 1, and a static PNG picture embedded directly into a neighboring cell on row 2. Because the pictures live inside the file itself, the workbook remains a single self-contained artifact that can be emailed or archived without breaking the embedded image references. Render each sparkline group as a PNG, convert the ByteArrayOutputStream to a byte[], and assign the array to the EmbeddedImage property of the target cell through setEmbeddedImage(byte[]) — the assignment is what makes the picture part of the cell’s stored contents.

Workflow 2 — Export the Sparkline Worksheet to HTML

Once the workbook contains live sparklines (and optionally embedded picture counterparts), the entire worksheet can be published to the web by saving it as HTML. The HtmlSaveOptions class exposes the knobs you need to control this export; in this workflow you will reuse the output_with_sparklines.xlsx file produced by Workflow 1 and convert it to a clean, single-page HTML document.

Step-by-Step Instructions

  1. Ensure the output_with_sparklines.xlsx file produced by Workflow 1 is available on disk in your working directory.
  2. Load that file into a new Workbook instance.
  3. Instantiate HtmlSaveOptions and call setExportActiveWorksheetOnly(true) so the resulting HTML file contains only the active worksheet rather than the entire workbook.
  4. Call workbook.save("sparklines.html", htmlOptions) to write the HTML output to disk.
import com.aspose.cells.*;

Workbook workbook = new Workbook("output_with_sparklines.xlsx");
HtmlSaveOptions htmlOptions = new HtmlSaveOptions();
htmlOptions.setExportActiveWorksheetOnly(true);
workbook.save("sparklines.html", htmlOptions);

The code above takes the sparkline-rich workbook from Workflow 1 and turns it into a portable HTML file. Sparklines are preserved as inline SVG or PNG renderings inside the generated HTML, depending on the export mode, so end users can view the trends in any modern browser without needing Excel installed. By setting ExportActiveWorksheetOnly to true through setExportActiveWorksheetOnly(true), you avoid accidentally publishing hidden sheets or auxiliary data — only the worksheet currently visible to the user is exported.

API Summary

The workflows above rely on a small set of Aspose.Cells APIs working together.

  • SparklineGroup and the collection accessor worksheet.getSparklineGroups() are used to declare the type (Line, Column, Stacked), the data range, and the anchor cell for each sparkline group. In this article each group is anchored to a single cell, so the group is reached through worksheet.getSparklineGroups().get(i).
  • Sparkline and the indexer group.getSparklines().get(0) return the individual sparkline inside a group. Because every group in the example contains exactly one sparkline, no for loop is required.
  • Sparkline.toImage(Stream, ImageOrPrintOptions) is the rendering method that writes a picture of the sparkline into a supplied Stream. The method returns void; you read the bytes from the stream after the call.
  • Cell.EmbeddedImage is a byte[] property (assigned via cell.setEmbeddedImage(byte[])) that stores a picture inside a single cell. It is available in Aspose.Cells 26.5 and later and is the recommended way to round-trip a sparkline rendered by toImage back into the same workbook.
  • HtmlSaveOptions.setExportActiveWorksheetOnly(boolean) restricts HTML export to the active worksheet. It is one of the most commonly used properties on HtmlSaveOptions when generating single-page reports.
  • ImageOrPrintOptions.setImageType(ImageType) lives in the com.aspose.cells.drawing package and selects the picture format (for example, ImageType.PNG) used when rendering with toImage and when printing worksheets to images.
Using Sparklines and Setting 3D Format