Skip to main content

ExcelRange

Excel.Range: a fixed rectangle of one sheet. Reads are current; writes apply at once. Import from @reductoai/xlsx/officejs.

ExcelRange properties

ExcelRange.advancedFilter()

Extension (VBA’s Range.AdvancedFilter): filters this list in place by a criteria range, or copies the records under the header row of copyToRange. Returns the number of records shown or copied.

ExcelRange.autoFill()

Fills destinationRange, which holds this range and grows it along one side, as dragging the fill handle does.

ExcelRange.calculate()

ExcelRange.clear()

ExcelRange.clearOrResetContents()

Clears the values and formulas; this facade has no cell controls to reset.

ExcelRange.consolidate()

Extension (VBA’s Range.Consolidate): one block summarizing the sources by place or by their labels, from this range’s top-left cell; gives the block.

ExcelRange.copyFrom()

Pastes sourceRange here as Excel’s copy and paste (special) does; tiles when this range holds it a whole number of times.

ExcelRange.delete()

Deletes the cells and closes the gap from below (Up) or the right (Left); whole rows or columns go entirely.

ExcelRange.find()

The first cell whose formula or constant matches; from one cell, the next match on the sheet.

ExcelRange.findOrNullObject()

ExcelRange.getAbsoluteResizedRange()

ExcelRange.getBoundingRect()

ExcelRange.getCell()

ExcelRange.getCellProperties()

Each cell’s members that options asks for; true on a branch loads all of it.

ExcelRange.getColumn()

ExcelRange.getColumnProperties()

One entry per column of the range, read down the range’s rows.

ExcelRange.getColumnsAfter()

ExcelRange.getColumnsBefore()

ExcelRange.getDependents()

ExcelRange.getDirectDependents()

ExcelRange.getDirectPrecedents()

The cells of a kind, as Excel’s Go To Special finds them; throws when there are none.

ExcelRange.getDisplayedCellProperties()

As getCellProperties, with fonts, fills and borders as conditional formats show them.

ExcelRange.getEntireColumn()

ExcelRange.getEntireRow()

ExcelRange.getExtendedRange()

The range Ctrl+Shift+Arrow selects from this one.

ExcelRange.getImage()

A Base64 PNG of the cells as Office.js paints them: no headers, and gridlines only when the sheet shows them; at most 1,000 rows by 100 columns from the top-left cell. A promise, not a ClientResult. Extension: { labels: true } adds column letters and row numbers, so a model can name the cell under a mark. In a browser, import @reductoai/xlsx/view once; @reductoai/xlsx/node brings its own painter.

ExcelRange.getIntersection()

ExcelRange.getIntersectionOrNullObject()

ExcelRange.getLastCell()

ExcelRange.getLastColumn()

ExcelRange.getLastRow()

ExcelRange.getMergedAreasOrNullObject()

The merged areas that overlap this range.

ExcelRange.getOffsetRange()

ExcelRange.getPivotTables()

Pivot tables that overlap the range, or lie inside it with fullyContained.

ExcelRange.getPrecedents()

ExcelRange.getRangeEdge()

The cell Ctrl+Arrow lands on from the active cell (the top-left by default).

ExcelRange.getResizedRange()

ExcelRange.getRow()

ExcelRange.getRowProperties()

One entry per row of the range, read across the range’s columns.

ExcelRange.getRowsAbove()

ExcelRange.getRowsBelow()

ExcelRange.getSpecialCells()

ExcelRange.getSpecialCellsOrNullObject()

ExcelRange.getSpillingToRange()

ExcelRange.getSpillingToRangeOrNullObject()

ExcelRange.getSpillParent()

ExcelRange.getSpillParentOrNullObject()

ExcelRange.getSurroundingRegion()

Excel’s current region around the top-left cell: bounded by blank rows and columns.

ExcelRange.getTables()

The tables that overlap this range, or only those inside it.

ExcelRange.getUsedRange()

ExcelRange.getUsedRangeOrNullObject()

ExcelRange.getVisibleView()

The cells that hidden rows and columns leave showing.

ExcelRange.group()

Adds one outline level to the rows or columns of the range; seven is the most.

ExcelRange.hideGroupDetails()

Collapses the group a summary row or column heads, else the innermost group holding the range.

ExcelRange.insert()

Inserts cells the size of this range and returns them. Whole rows or columns insert rows or columns; otherwise shift pushes the cells below (Down) or to the right (Right). References, merges, formats and anchors follow the moved cells as in Excel.

ExcelRange.merge()

Merges the range, or each of its rows with across; only the top-left value is kept.

ExcelRange.moveTo()

Cuts the range and pastes it with its top-left cell at destinationRange’s, as Excel’s cut and paste does.

ExcelRange.removeDuplicates()

Keeps the first row of each key; keys compare shown text, ignoring case.

ExcelRange.replaceAll()

Replaces in formulas and constants as Excel’s Replace All does; each changed cell is entered again.

ExcelRange.select()

Office.js select moves the UI selection; a file has none to move.

ExcelRange.set()

Sets several properties at once; a navigation member takes a nested batch.

ExcelRange.setCellProperties()

Writes each cell’s members; the grid must be the range’s size.

ExcelRange.setColumnProperties()

ExcelRange.setDirty()

Marks the cells to calculate again at the next recalculation.

ExcelRange.setRowProperties()

ExcelRange.showGroupDetails()

Expands that group; groups inside it that are collapsed stay so.

ExcelRange.ungroup()

Removes one outline level; throws when no row or column of the range has one.

ExcelRange.unmerge()

Blank cells a merge left with no format of their own go, as in Excel.

RangeValueType

Import from @reductoai/xlsx/officejs.

RangeAreas

Excel.RangeAreas: rectangles of one sheet, kept in the order given. Import from @reductoai/xlsx/officejs.

RangeAreas properties

RangeAreas.calculate()

RangeAreas.clear()

RangeAreas.clearOrResetContents()

RangeAreas.copyFrom()

Pastes the source at the top-left of each area.

RangeAreas.getEntireColumn()

RangeAreas.getEntireRow()

RangeAreas.getIntersection()

RangeAreas.getIntersectionOrNullObject()

RangeAreas.getOffsetRangeAreas()

RangeAreas.getSpecialCells()

RangeAreas.getSpecialCellsOrNullObject()

RangeAreas.getTables()

The tables that meet an area, or only those inside one.

RangeAreas.getUsedRangeAreas()

Each area clipped to the sheet’s used range; areas outside it drop out.

RangeAreas.getUsedRangeAreasOrNullObject()

RangeAreas.select()

RangeAreas.set()

Sets several properties at once; a navigation member takes a nested batch.

RangeAreas.setDirty()

RangeSort

Excel.RangeSort. Import from @reductoai/xlsx/officejs.

RangeSort.apply()

Sorts the range’s shown rows (columns with orientation “Columns”) by fields, the first outermost. A header row (column) stays on top; formulas move as a copy would.

parseAddress()

“A1”, “A1:B2”, “A:C”, “2:5” or any of those after Sheet!; undefined when it is not an A1 address. Import from @reductoai/xlsx/officejs.

formatAddress()

Import from @reductoai/xlsx/officejs.