Skip to main content

Module cmd

Module cmd 

Source
Expand description

The command registry. Ids follow Excel’s ribbon (home.bold, insert.chart, data.sortAscending) plus primitive editing commands (cell.set, selection.set).

Modules§

analysis
Analysis ToolPak (Data › Analysis › Data Analysis): statistical tools that compute a report from input ranges and write it as a static table (values, not formulas) to an output range or a new worksheet.
controls
Form controls (Insert › Controls): buttons that run a macro or a command, and sliders and spin buttons that hold a whole number from 0 to 30000 and write it to a linked cell.
data
Data tab: sort, filter, remove duplicates, text to columns, data validation, outline.
draw
Draw tab: pen and eraser tools, ink strokes, Ink to Shape.
edit
Cell entry, selection, undo/redo, clipboard, clear, fill, find & replace.
equation
Equations (Insert › Symbols › Equation): floating shapes holding LaTeX source, laid out by gridcraft-math and drawn from the cached layout.
extra
More ribbon commands: Chart Design and Format, object arrangement, workbook views, table tools, Get Data, scripts (Automate), cell checkboxes, theme colours and fonts.
file
File menu: new, open, save, close, export, properties, options.
forecast
Data › Forecast › Forecast Sheet: a new sheet with the history, a FORECAST.ETS column, the FORECAST.ETS.CONFINT confidence bounds, optional FORECAST.ETS.STAT statistics and a chart.
format
Formatting: Home › Font, Alignment, Number, Styles, Cells › Format.
formulas
Formulas tab: AutoSum, Insert Function, names, auditing, calculation.
insert
Insert tab: tables, charts, sparklines, pictures, shapes, hyperlinks, comments and notes, conditional formatting (Home › Styles) and symbols.
inspect
Read-only commands for agents: inspect the workbook, read ranges, cell details.
macros
Macros: typed command lists that run as one undo step. See crate::engine::macros for the model, tokens, runner, debugger, recorder and policy. Automate scripts (automate.*) are a separate, older feature with their own storage; these commands neither read nor change it. A recording keeps the steps a script run ran while it recorded, as the run reported them.
pivot
PivotTable commands (Insert › PivotTable, PivotTable Analyze, PivotTable Design, Data › Refresh All). Every change re-renders the report as one undo step.
print
Printing: Page Setup, pagination and PDF output (File › Print, File › Export › PDF).
python
Python in cells: making and editing Python cells, and their return type. This build stores the code and the last result a file cached; it doesn’t run Python, so a cell with new or changed code shows #BLOCKED!.
review
Review tab: protection, spelling (basic), workbook statistics, comment navigation and the Comments pane, Show All Notes and Convert to Comments.
sheet
Worksheets and structure: insert/delete rows, columns and cells; sheet tabs.
slicer
Slicers: on-sheet widgets that filter one column of a table by clicking value tiles.
solver
Solver (Data › Analysis › Solver): finds values for variable cells that maximise, minimise or hit a value in an objective cell, subject to constraints.
spelling
Spelling: checks text cells against the system word list (/usr/share/dict/words on macOS and Linux; nothing is bundled) plus a user dictionary kept in the engine preferences.
stash
GridCraft data kept in hidden workbook-scope defined names, so that it travels inside the xlsx file.
view
View tab (sheet view state that’s saved with the file) and Page Layout settings.
whatif
What-If Analysis (Data › Forecast): Goal Seek, Scenario Manager, Data Tables; and the Data Tools that work on whole lists: Advanced Filter and Consolidate.

Structs§

CommandInfo
CommandSpec
Ctx
Applies an edit to a copy of the active workbook, then recalculates and commits it. changed collects cells whose content changed; set structural for row/column/sheet edits (full recalc).

Functions§

always
auto_row_height
Recomputes an automatic row height from its content: the largest font, and wrapped text. Rows with a user-set height keep it.
can_redo
can_undo
command_specs
find_command
has_clipboard
has_doc
is_secret_param
Params that hold a secret: password, or a name ending in Password.
journal_params
The params as the journal records them: secret params are left out, so a password never reaches the journal dialog, engine.journal or a recorded script (saved in the workbook). Replaying such an entry runs the command without that param.

Type Aliases§

Enabled
Run