Skip to main content
The batteries-included editor. Guide: Editor.

mountXlsxEditor()

Import from @reductoai/xlsx-editor.

XlsxEditorOptions

Import from @reductoai/xlsx-editor.

XlsxEditorHandle

Import from @reductoai/xlsx-editor.

XlsxEditorModel

Import from @reductoai/xlsx-editor.

XlsxEditorModel properties

activeCellBox()

Where the cell window opens: beside the active cell.

addWatch()

Adds every cell of reference to the Watch Window; false, with the error set, when it names no cells.

ask()

attach()

The grid’s element; a workbook opened before it exists waits for it.

borderPen()

Draw Border, Draw Border Grid or Erase Border; the same mode again turns the pen off.

cancelFunction()

cancelPasteName()

circleInvalid()

Circle Invalid Data on the active sheet; the count of cells ringed.

clearCircles()

copyAsPicture()

The selection’s picture onto the system clipboard, where a paste takes it in as a picture.

designChart()

A Chart Design pick on the selected chart.

destroy()

editChartTextAt()

Edits the picked title’s text in place, the caret where the click landed.

endChartText()

external()

Runs an edit made around the grid (a script, an agent) on view.edits.excel as one undo step; the grid then shows what it did, sheets added, moved or deleted included.

find()

Find Next or Find Previous from the active cell; the grid goes to the match.

findAll()

formatChart()

Formats the picked element; a slider drag sends one group.

formatPainter()

Format Painter: holds the selection’s formats until the next cells picked with the mouse take them. A double-click keeps it on until Escape or the button again, as in Excel.

goTo()

Selects a cell Find All listed.

group()

Group or Ungroup: whole lines go at once; on cells Excel first asks Rows or Columns.

groupDetail()

Show Detail or Hide Detail on the selection; whole lines act on their own axis only.

hasBackground()

Page Layout > Background: true when the active sheet has a picture, so the button reads Delete Background.

input()

What the cell editor opens with: the formula, else the value.

insertChart()

Insert > Chart: Excel centres the new chart in the cells in view and selects it.

insertFunction()

OK in Function Arguments: the call goes in where Shift+F3 was pressed and the formula is entered.

insertPicture()

A picture file at the active cell, or at at (points from A1’s corner); inCell makes it the cell’s value.

markSaved()

The host kept the workbook another way, such as its own download of Workbook.save().
Excel’s right-click menu at target, over the grid’s current selection.

merge()

Lands another writer’s change: the grid repaints and keeps the selection on its cells.

open()

openAdvancedFilter()

Data > Advanced: Advanced Filter on the list around the selection.

openCellWindow()

Opens the note or link window on the active cell; a chart or shape selection has none.

openCfRule()

New Formatting Rule (edit null) or Edit Rule; from Manage Rules (scope) it goes back there.

openCfRules()

Conditional Formatting > Manage Rules, showing the rules of the selection or the sheet.

openConsolidate()

Data > Consolidate, written from the active cell.

openCopyPicture()

Home > Copy > Copy as Picture.

openCreateNames()

Formulas > Create from Selection.

openDataTable()

Data > What-If Analysis > Data Table, over the selection.

openDefineName()

Define Name (edit null) or Name Manager’s Edit; a new name refers to the selection.

openFillAcross()

Home > Fill > Across Worksheets, while sheets are grouped.

openGoalSeek()

Data > What-If Analysis > Goal Seek, with the active cell as the Set cell.

openMergeStyles()

Home > Cell Styles > Merge Styles: copies the styles of another workbook in.

openMoveChart()

Chart Design > Move Chart on the selected chart.

openNames()

Formulas > Name Manager.

openNewCellStyle()

Home > Cell Styles > New Cell Style: a style by example of the active cell.

openPageSetup()

Page Layout > Page Setup, on tab (Custom Margins opens Margins).

openPasteName()

F3 on the grid, or Use in Formula > Paste Names: nothing when no name is usable, as in Excel.

openProtect()

Review > Protect Sheet or Protect Workbook: the dialog when it is off, the password prompt when a password guards it, and straight off when none does, as Excel does.

openRemoveDuplicates()

Data > Remove Duplicates on the list around the selection; Excel’s refusals show as the error.

openReportConnections()

Slicer > Report Connections for name, or for the one selected slicer; a table slicer has none.

openRule()

Opens a quick rule dialog of Conditional Formatting over the selection.

openScenarios()

Data > What-If Analysis > Scenario Manager for the active sheet.

openSelectData()

Chart Design > Select Data on the selected chart.

openSeries()

Home > Fill > Series: opens Excel’s Series window on the selection.

openSlicerSettings()

Slicer Settings for name, or for the one selected slicer.

openSparkEdit()

Sparkline > Edit Data > Edit Group Location & Data: Create Sparklines on the active group.

openSparklines()

Insert > Sparklines: opens Create Sparklines for Line, Column or Win/Loss.

openSparkSettings()

Sparkline > Edit Data > Hidden & Empty Cells, or Axis > Custom Value for the minimum or maximum.

openSubtotal()

Data > Subtotal on the list around the selection; outside a list it says so instead.

openTextColumns()

Data > Text to Columns, over a one-column selection.

openValidation()

Data > Data Validation over the selection, after Excel’s prompt when its cells differ.

pickBackground()

Page Layout > Background: the file picker, then the picture tiled behind the active sheet.

pickChartPart()

Picks the element the Format pane edits, from its list or a click on the chart.

pickChartPartAt()

The element under a pointer on the selected chart, as Excel’s second click picks it.

pickPicture()

Insert > Picture: the file picker, then the picture over the cells at the active cell, or in it.

replace()

Replace or Replace All; the count of cells changed.

run()

save()

setPeers()

Other writers’ selections on the grid.

setPen()

Line Color and Line Style set the pen and turn Draw Border on, as Excel does.

setReadOnly()

Mounts the grid again over the same session, so shared edits and the user’s place stay.

shown()

The cell’s text as the grid shows it.

stepNote()

Review > Next or Previous: selects the next note or comment and opens it.

stopPainter()

stopPen()

sync()

Reads the grid selection and the history again, after an edit made around the model.

toggleSplit()

View > Split: on at the active cell, or off; frozen panes become a split at the same place, as in Excel.

useInFormula()

Use in Formula and Paste Name’s OK: the name goes in at the caret, or starts =name.

XlsxEditorHooks

The confirm hooks answer Excel’s OK/Cancel questions; without one the editor’s own prompt asks. Import from @reductoai/xlsx-editor.

watch()

Calls onChange after any field read reads changes; returns the stop. Import from @reductoai/xlsx-editor.