Skip to main content

Module features

Module features 

Source
Expand description

Sheet features beyond cells: tables, conditional formatting, data validation, comments, hyperlinks, charts, images, autofilter, print settings.

Structs§

Anchor
Position of a floating object: top-left cell plus offset, size in points.
AutoFilter
Chart
ChartDataTable
A chart’s data table (c:dTable), independent of the chart legend.
Comment
A note (classic comment) or a threaded comment.
CondFormat
EditRange
Review › Allow Edit Ranges: cells that stay editable on a protected sheet, with or without a password (XLSX <protectedRange>).
EquationCache
The laid-out form of an equation’s LaTeX source. It is derived data: rebuilt by EquationCache::refresh whenever the source changes, never saved, and ignored when shapes are compared. Painters read it and never lay equations out themselves, so nothing in a paint path can reach the layout engine.
FormControl
A form control (button, slider, spin button) floating over the sheet.
Hyperlink
Image
LineInfo
Outline grouping info for a row or column.
NoteBox
A note box’s place and size, from the note’s VML shape: Excel’s <x:Anchor> with its corners stored relative to the note’s cell, so the box moves with the note when rows or columns are inserted or deleted, and the shape’s width and height.
NoteCorner
One corner of a NoteBox.
ObjRef
One floating object on a sheet: its kind and its workbook-unique id.
PivotCalcField
A calculated field: a formula over other fields (=Sales*0.1, ='Unit Price'*Units). As in Excel, it is evaluated on the sums of the fields it names for each report cell, not per record.
PivotField
A field placed in the Rows or Columns area.
PivotFilter
A report filter (or, for a field also in Rows/Columns, its hidden-items filter).
PivotTable
A PivotTable: its definition plus where its output was last written. The output itself is static cell values and styles on the sheet, rewritten on every refresh.
PivotValue
A field in the Values area.
PrintSettings
Series
Shape
ShapeFormat
How a shape’s outline and text look. The text properties apply to the whole text (the first paragraph’s and first run’s properties when a file has several).
SheetProtection
Slicer
A slicer: an on-sheet filter widget bound to one column of a table. Clicking its value tiles sets that column’s FilterCriterion::Values in the sheet’s AutoFilter and re-applies it, so a slicer is just a visual front-end over the existing filter machinery.
Sparkline
Table
TableColumn
Trendline
A chart trendline (Add Chart Element ▸ Trendline, Format Trendline pane).
Validation
XmlColumnPr
A table column’s binding to an XML map (<xmlColumnPr>).

Enums§

AnchorMode
How a floating object is pinned to the grid when its cells move or resize. Mirrors Excel’s Format ▸ Size and Properties ▸ Properties, stored in the file as the anchor’s editAs: twoCell (absent editAs), oneCell and absolute.
CfOperator
CfRule
CfValueKind
ChartKind
ControlAction
What a button runs when it is pressed.
ControlKind
What a form control on the sheet is.
ErrorStyle
FilterCriterion
HfPage
Which header/footer pair a printed page uses.
LegendPos
LineDash
DrawingML preset line dash (a:prstDash).
MacroInput
The range a button’s macro runs on.
ObjKind
The kinds of floating object a sheet holds. Commands name an object by kind and workbook-unique id ({kind: "chart", id}); ObjKind::name is that parameter’s spelling. Equations are stored as shapes (ShapeKind::Equation) but select, open and delete as their own kind.
Orientation
PageOrder
The sequence of a sheet’s pages (XLSX pageSetup pageOrder, ECMA-376 ST_PageOrder).
PivotDateGroup
Grouping of a date field (values are date serials).
PivotFunc
Summarize-values-by function.
PivotLayout
How a PivotTable lays out its row fields.
PivotShowAs
Show-values-as transform.
PivotSort
QuartileMethod
Quartile calculation for a box & whisker series.
ShapeKind
ShapeTextAlign
Horizontal alignment of a shape’s text (a:pPr algn).
ShapeTextAnchor
Vertical anchor of a shape’s text in its box (a:bodyPr anchor).
SparklineKind
TotalsFn
TrendlineKind
Regression a trendline fits (c:trendlineType).
ValidationKind

Constants§

CONTROL_MAX
The largest value a slider or spin button takes (Excel’s scroll bar limit). Values are whole numbers from 0 to this.

Functions§

default_icon_thresholds
Excel’s default icon-set thresholds: one per icon, the first being the lower bound, then even percent steps (0, 33, 67 for three icons).
icon_count
Number of icons in an icon set (3Arrows → 3, 5Quarters → 5), always 3 to 5.
password_hash
The non-cryptographic password hash older GridCraft versions stored for sheet protection (only verified now, see SheetProtection::legacy_password_hash).