Sheet class

Properties

defaultColumnWidth → double?
no setter
defaultRowHeight → double?
no setter
getColumnAutoFits → Map<int, bool>
returns map of auto fit columns
no setter
getColumnWidths → Map<int, double>
returns map of custom width columns
no setter
getRowHeights → Map<int, double>
returns map of custom height rows
no setter
hashCode → int
The hash code for this object.
no setterinherited
headerFooter ↔ HeaderFooter?
getter/setter pair
isRTL ↔ bool
returns true is this sheet is right-to-left other-wise false
getter/setter pair
maxColumns → int
returns count of columns having data in sheet
no setter
maxRows → int
returns count of rows having data in sheet
no setter
rows → List<List<Data?>>
returns 2-D dynamic List of the sheet elements
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sheetName → String
return SheetName
no setter
spannedItems → List<String>
returns List of Spanned Cells as
no setter

Methods

appendRow(List<CellValue?> row) → void
Appends row iterables just post the last filled rowIndex.
cell(CellIndex cellIndex) → Data
returns the DataObject at position of cellIndex
clearRow(int rowIndex) → bool
returns true if the contents are successfully cleared else false.
findAndReplace(Pattern source, String target, {int first = -1, int startingRow = -1, int endingRow = -1, int startingColumn = -1, int endingColumn = -1}) → int
Returns the count of replaced source with target
getColumnAutoFit(int columnIndex) → bool
returns auto fit state of column index
getColumnWidth(int columnIndex) → double
returns width of column index
getRowHeight(int rowIndex) → double
returns height of row index
insertColumn(int columnIndex) → void
Inserts an empty column in sheet at position = columnIndex.
insertRow(int rowIndex) → void
Inserts an empty row in sheet at position = rowIndex.
insertRowIterables(List<CellValue?> row, int rowIndex, {int startingColumn = 0, bool overwriteMergedCells = true}) → void
Adds the row iterables in the given rowIndex = rowIndex in sheet
merge(CellIndex start, CellIndex end, {CellValue? customValue}) → void
Merges the cells starting from start to end.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeColumn(int columnIndex) → void
If sheet exists and columnIndex < maxColumns then it removes column at index = columnIndex
removeRow(int rowIndex) → void
If sheet exists and rowIndex < maxRows then it removes row at index = rowIndex
row(int rowIndex) → List<Data?>
returns row at index = rowIndex
selectRange(CellIndex start, {CellIndex? end}) → List<List<Data?>?>
returns 2-D dynamic List of the sheet cell data in that range.
selectRangeValues(CellIndex start, {CellIndex? end}) → List<List?>
returns 2-D dynamic List of the sheet elements in that range.
selectRangeValuesWithString(String range) → List<List?>
returns 2-D dynamic List of the sheet elements in that range.
selectRangeWithString(String range) → List<List<Data?>?>
returns 2-D dynamic List of the sheet cell data in that range.
setColumnAutoFit(int columnIndex) → void
Set Column AutoFit
setColumnWidth(int columnIndex, double columnWidth) → void
Set Column Width
setDefaultColumnWidth([double columnWidth = _excelDefaultColumnWidth]) → void
Set the default column width.
setDefaultRowHeight([double rowHeight = _excelDefaultRowHeight]) → void
Set the default row height.
setMergedCellStyle(CellIndex start, CellStyle mergedCellStyle) → void
Sets the cellStyle of the merged cells.
setRowHeight(int rowIndex, double rowHeight) → void
Set Row Height
toString() → String
A string representation of this object.
inherited
unMerge(String unmergeCells) → void
unMerge the merged cells.
updateCell(CellIndex cellIndex, CellValue? value, {CellStyle? cellStyle}) → void
Updates the contents of sheet of the cellIndex: CellIndex.indexByColumnRow(0, 0); where indexing starts from 0

Operators

operator ==(Object other) → bool
The equality operator.
inherited