excel_plus library

A high-performance library for reading, creating, and editing Excel .xlsx files in Dart and Flutter.

Classes

BoolCellValue Cell Values
A cell value containing a boolean.
Border Styling
Represents a border on one side of a cell.
CellErrorValue Cell Values
A cell value containing an Excel error literal, such as #DIV/0! or #N/A.
CellIndex Core
Identifies a cell position by its column and row index.
CellStyle Styling
Styling class for cells.
CellValue Cell Values
Base type for all cell values in an Excel worksheet.
Chart Charts
A chart anchored to a worksheet cell, authored over data ranges.
ChartSeries Charts
One data series in a Chart: a values range plus an optional name and, for scatter charts, an x-values range.
Comment Worksheet
A classic cell comment (note), the little pop-up box anchored to a cell.
ConditionalFormat Worksheet
A conditional formatting rule applied to a cell range.
CsvConfig
Immutable configuration for CSV encoding/decoding.
CustomDateTimeNumFormat Number Formats
A custom date/time format with a user-defined format code.
CustomNumericNumFormat Number Formats
A custom numeric number format with a user-defined format code.
CustomNumFormat Number Formats
Interface for custom (user-defined) number formats.
CustomTimeNumFormat Number Formats
A custom time format with a user-defined format code.
Data Core
Represents a single cell's data within a Sheet.
DataValidation Worksheet
An input rule applied to a cell range: a dropdown list, a numeric/length bound, a date/time constraint, or a custom formula.
DateCellValue Cell Values
A cell value containing a date (year, month, day).
DateTimeCellValue Cell Values
Excel does not know if this is UTC or not. Use methods asDateTimeLocal or asDateTimeUtc to get the DateTime object you prefer.
DateTimeNumFormat Number Formats
Base class for date/time number formats.
DefinedName Core
A workbook defined name (a named range, constant, or formula).
DoubleCellValue Cell Values
A cell value containing a double.
Excel Core
The main class for reading, creating, and editing Excel .xlsx files.
ExcelColor Styling
Represents a color value for use in cell styling.
ExcelImage Worksheet
A picture embedded in a worksheet.
ExcelTable Tables
An Excel table (a "ListObject") over a rectangular range, a named region with a header row, banded styling, and a filter.
FilterColumn Worksheet
A criterion applied to one column of a sheet's autofilter, the filter that actually hides non-matching rows, beyond just showing the dropdown arrow.
FormulaApi Core
The formula subsystem of a workbook: register custom functions that Sheet.evaluate can call.
FormulaCellValue Cell Values
A cell value containing a formula expression.
GradientFill Styling
A gradient cell fill, a smooth blend between two or more colour stops.
GradientStop Styling
One colour stop of a GradientFill: color placed at position along the gradient (0.0 = start, 1.0 = end). A gradient needs at least two stops.
HeaderFooter Layout
Header and footer settings for a worksheet.
A hyperlink attached to a cell (or cell range).
InputFileStream
Stream in data from a file.
InputStream
IntCellValue Cell Values
A cell value containing an integer.
NumericNumFormat Number Formats
Base class for numeric number formats.
NumFormat Number Formats
Base class for number formats that control how cell values are displayed.
PageMargins Worksheet
Printed page margins, in inches (the unit used by <pageMargins>).
PageSetup Worksheet
How a worksheet is laid out for printing: orientation, scaling, centering, what to print, and page margins.
PaperSize
Printer paper sizes, as the codes used by <pageSetup paperSize> (ECMA-376 ยง18.3.1.63). Only the common sizes are named; any other code can still be set via PageSetup.paperSize as a raw int.
PivotDataField Pivot Tables
A value field in a PivotTable: which source column to aggregate and how.
PivotTable Pivot Tables
A pivot table summarising a worksheet range.
Sheet Core
Represents a single worksheet within an Excel workbook.
Sparkline Worksheet
A single sparkline: a tiny chart of dataRange drawn inside the cell at location.
SparklineGroup Worksheet
A group of Sparklines that share one type and colour scheme, the unit Excel stores sparklines in.
StandardDateTimeNumFormat Number Formats
A standard date/time format with a fixed format ID.
StandardNumericNumFormat Number Formats
A standard numeric number format with a fixed format ID.
StandardNumFormat Number Formats
Interface for standard (built-in) number formats.
StandardTimeNumFormat Number Formats
A standard time format with a fixed format ID.
TableStyle Tables
A few common built-in table style names, for convenience. Any valid Excel style name string (e.g. 'TableStyleLight9', 'TableStyleDark3') also works as ExcelTable.style.
TextCellValue Cell Values
A cell value containing text, optionally with rich-text formatting.
TextSpan Cell Values
A span of optionally styled text, similar to Flutter's TextSpan.
TimeCellValue Cell Values
A cell value containing a time of day.
TimeNumFormat Number Formats
Base class for time-only number formats.

Enums

BorderStyle Styling
Available border line styles in Excel.
ChartGrouping Charts
How multiple series are combined (ignored by pie/doughnut/scatter).
ChartType Charts
The kind of chart to render.
ColorType Styling
Color type category.
ConditionalFormatType Worksheet
The kind of a ConditionalFormat rule. Covers the common OOXML cfRule types; anything else reads as other (its raw type is on ConditionalFormat.typeName).
DataValidationErrorStyle
How Excel reacts when an entry fails validation.
DataValidationOperator
Comparison used by the bounded validation types (DataValidationType.whole, DataValidationType.decimal, DataValidationType.date, DataValidationType.time, DataValidationType.textLength).
DataValidationType
The kind of input rule a DataValidation enforces on a cell range.
FillPatternType Styling
Cell fill pattern. solid fills the cell with a single colour (the cell style's backgroundColor); the other patterns draw a hatch/shade using the backgroundColor as the pattern colour over an optional fillBackgroundColor.
FilterColumnType
The kind of criterion a FilterColumn applies.
FilterOperator
A comparison used by FilterColumn.custom.
FontFamily Styling
Available font families.
FontScheme Styling
Font scheme setting.
GradientType Styling
The geometry of a GradientFill.
HorizontalAlign Styling
Horizontal alignment of cell content.
IconSetType Worksheet
The icon set drawn by ConditionalFormat.iconSet. The name encodes the icon count (three / four / five icons).
LegendPosition Charts
Where the legend sits, or none to hide it.
PageOrientation
Page orientation for printing a worksheet.
PivotFunction Pivot Tables
The aggregation applied to a pivot-table data field.
QuoteMode
When to quote fields during CSV encoding.
SheetProtectionOption Worksheet
An action a user may be permitted to perform on a protected sheet.
SheetVisibility Worksheet
Visibility of a worksheet's tab within the workbook.
SparklineType Worksheet
The kind of miniature chart drawn by a SparklineGroup.
TextWrapping Styling
Text wrapping mode for cells.
ThemeColor Styling
The twelve document-theme color slots, in the order Excel indexes them in styles.xml (theme="N"). Use with ExcelColor.theme to author a color that follows the workbook's theme.
Underline Styling
Text underline style.
VerticalAlign Styling
Vertical alignment of cell content.

Extensions

ExcelCsv on Excel CSV
CSV import and single-sheet export for an Excel workbook.
SheetCsv on Sheet CSV
CSV export for a Sheet.

Typedefs

ExcelFunction = CellValue Function(List<CellValue?> args)
Signature for a custom formula function registered via Excel.formula to FormulaApi.registerFunction.

Exceptions / Errors

CsvException
Base exception for all CSV operations.
CsvParseException
Thrown when CSV input cannot be parsed.
ExcelArchiveException Errors
Thrown when the bytes are not a readable .xlsx container.
ExcelEncodeException Errors
Thrown when a workbook cannot be encoded back to .xlsx during Excel.save / Excel.encode.
ExcelException Errors
Base class for every exception thrown by excel_plus.
ExcelFormatException Errors
Thrown when the archive is a valid ZIP but its XML content is malformed or internally inconsistent.
FormulaParseException Errors
Raised internally when a formula string cannot be parsed by the evaluation engine.