Uses of Package
io.keikai.axyra.sheets.content

Package
Description
Public Java API for the Axyra Sheets engine.
The objects a workbook or sheet holds besides cell values: charts, tables, data validations, conditional formats, comments, hyperlinks, sparklines, form controls, slicers, timelines, external links, embedded objects and more.
  • Class
    Description
    A chart (immutable).
    A cell comment (note): author plus plain text.
    One formatted run of a rich-text cell comment (note) — ECMA-376 Part 1 §18.7.7 comment/text/r.
    A conditional-formatting rule (immutable).
    A data connection (Power Query or other) read from a workbook's xl/connections.xml: its id, display name, source kind, command text and connection string.
    Series-level data labels (ECMA-376 §21.2.2.49 <c:dLbls>): which fields are drawn beside each data point, an optional label position, an optional numberFormat override (§21.2.2.79 numFmt) that formats the value independently of the value axis, plus optional label text styling (§21.2.2.216 <c:txPr>): rotation, color, bold and font size.
    Series error bars (ECMA-376 §21.2.2.55).
    An external workbook reference descriptor (immutable, read-only): a linked workbook that formulas such as [Book2]Sheet1!A1 or [1]Sheet1!A1 resolve against.
    A worksheet form control (immutable): check box, option button, button, combo box, list box, scroll bar, spin button, edit box, label or group box — the classic Form Controls group on Excel's Developer tab.
    A cell hyperlink.
    Chart legend placement.
    An embedded OLE object (e.g.
    An allow-users-to-edit-range: a named cell range that stays editable while the sheet is protected, optionally gated by its own password (ECMA-376 Part 1 §18.3.1.72 protectedRange).
    Rich (multi-run) cell text — a sequence of runs, each with its own optional font overrides (bold, italic, underline, strike, name, size, color).
    A workbook slicer descriptor (immutable, read-only): an interactive filter control bound to a pivot table or an Excel Table.
    A SmartArt diagram descriptor (immutable, read-only).
    A sparkline group: a set of same-styled mini inline charts (ECMA-376 Part 4 §18.3.1.32, x14:sparklineGroup).
    The style of a sparkline group — series/point colors, point-highlight flags, and vertical-axis scaling (MS-XLSX x14:sparklineGroup).
    A table (ListObject): a named rectangular region with header columns (ECMA-376 §18.5.1.2).
    A table's style binding (ECMA-376 §18.5.1.20 tableStyleInfo): the built-in style name (e.g.
    A threaded comment (Excel 365 conversation) on a cell.
    A workbook timeline descriptor (immutable, read-only): a specialised slicer for date-based filtering of a pivot table.
    A series trendline (ECMA-376 §21.2.2.210).
    A data-validation rule (immutable).
    A VBA code module extracted from a macro-enabled workbook's vbaProject.bin (read-only): its editor name, kind, and decompressed source text.
    The workbook's write-protection state (<fileSharing> — ECMA-376 Part 1 §18.2.12), read back via Workbook.writeProtection().
    An XML map definition (read-only) from a workbook's xl/xmlMaps.xml: the map's id, name, the XML root element it is anchored on, the referenced schema id, the XSD schema text, and the cell bindings (which table columns bind to which XPath).
  • Class
    Description
    A chart (immutable).
    A fluent builder for a Chart.
    One formatted run of a rich-text cell comment (note) — ECMA-376 Part 1 §18.7.7 comment/text/r.
    A conditional-formatting rule (immutable).
    A fluent builder for a ConditionalFormat.
    A threshold value object of a color-scale / data-bar / icon-set rule (ECMA-376 §18.3.1.11 cfvo).
    A data connection (Power Query or other) read from a workbook's xl/connections.xml: its id, display name, source kind, command text and connection string.
    Series-level data labels (ECMA-376 §21.2.2.49 <c:dLbls>): which fields are drawn beside each data point, an optional label position, an optional numberFormat override (§21.2.2.79 numFmt) that formats the value independently of the value axis, plus optional label text styling (§21.2.2.216 <c:txPr>): rotation, color, bold and font size.
    Series error bars (ECMA-376 §21.2.2.55).
    An external workbook reference descriptor (immutable, read-only): a linked workbook that formulas such as [Book2]Sheet1!A1 or [1]Sheet1!A1 resolve against.
    A worksheet form control (immutable): check box, option button, button, combo box, list box, scroll bar, spin button, edit box, label or group box — the classic Form Controls group on Excel's Developer tab.
    A fluent builder for a FormControl.
    The kind of a worksheet form control (the classic Form Controls group on Excel's Developer tab), matching the OOXML ctrlProp objectType families (ECMA-376 Part 1 §18.3.1.13 plus the <formControlPr> part).
    A cell hyperlink.
    Chart legend placement.
    Rich (multi-run) cell text — a sequence of runs, each with its own optional font overrides (bold, italic, underline, strike, name, size, color).
    Fluent builder for a rich-text value.
    Per-run font overrides, created with RichText.run().
    A read-back view of one run: its text plus the font overrides it carries.
    A workbook slicer descriptor (immutable, read-only): an interactive filter control bound to a pivot table or an Excel Table.
    A SmartArt diagram descriptor (immutable, read-only).
    One sparkline within a SparklineGroup: a data-source range and the cell the mini-chart is drawn in (ECMA-376 Part 4 §18.3.1.32, x14:sparkline).
    A sparkline group: a set of same-styled mini inline charts (ECMA-376 Part 4 §18.3.1.32, x14:sparklineGroup).
    The style of a sparkline group — series/point colors, point-highlight flags, and vertical-axis scaling (MS-XLSX x14:sparklineGroup).
    A table (ListObject): a named rectangular region with header columns (ECMA-376 §18.5.1.2).
    One table column (ECMA-376 §18.5.1.3 tableColumn): the header name plus its totals-row configuration.
    A table's style binding (ECMA-376 §18.5.1.20 tableStyleInfo): the built-in style name (e.g.
    A threaded comment (Excel 365 conversation) on a cell.
    A workbook timeline descriptor (immutable, read-only): a specialised slicer for date-based filtering of a pivot table.
    The date window of a "date occurring" conditional-formatting rule — ECMA-376 §18.18.82 ST_TimePeriod.
    A series trendline (ECMA-376 §21.2.2.210).
    A data-validation rule (immutable).
    A fluent builder for a Validation.
    A VBA code module extracted from a macro-enabled workbook's vbaProject.bin (read-only): its editor name, kind, and decompressed source text.
    An XML map definition (read-only) from a workbook's xl/xmlMaps.xml: the map's id, name, the XML root element it is anchored on, the referenced schema id, the XSD schema text, and the cell bindings (which table columns bind to which XPath).
    One cell binding of an XML map (read-only): a worksheet-table column bound to an XPath.