All Classes and Interfaces
Class
Description
Aggregate function for a pivot table data (values) field.
Base type for engine and API failures surfaced from the native layer.
A formula the API cannot accept: for example a syntactically invalid
formula passed to
Range.setFormula(java.lang.String) or Cell.setFormula(java.lang.String).A file I/O or file-format failure: for example a missing file, an
unsupported format, or a malformed workbook that cannot be read or written.
One border edge read back from a
CellStyle with
CellStyle.border(Side): the line style and its color.The line style of one cell border edge (ECMA-376
ST_BorderStyle).The workbook calculation mode, read with
Workbook.calcMode() and set
with Workbook.setCalcMode(CalcMode).One cell of a sheet: a lightweight
(sheet, row, column) view, 0-based,
that holds no native resource.A workbook-wide cell coordinate: a 0-based sheet index plus 0-based row and
column.
An immutable cell style: font, fill, borders, alignment, number format and
protection.
Fluent builder for a
CellStyle.One cell's value: a number, text, boolean, error or blank, or a matrix
passed to and from a user-defined function.
A rectangular, row-major matrix of scalar values (
rows[r][c]).The empty cell value; use the shared
CellValue.BLANK.A boolean cell value.
An error cell value, identified by its Excel
ERROR.TYPE code
(see CellValue.error(int) for the codes).A numeric cell value.
A text cell value.
A chart (immutable).
A fluent builder for a
Chart.A view of one existing chart, obtained with
Sheet.chart(int) for a
chart on a worksheet, or with Workbook.chartSheetChart(int) for the
chart of a chart-sheet tab.An immutable spreadsheet color in one of four kinds: plain ARGB, a legacy
indexed-palette reference, a theme-palette reference with an optional tint,
or the automatic (window-text) color.
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 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).
Aggregation function for
Sheet.consolidate(int, int, io.keikai.axyra.sheets.ConsolidateFunction, io.keikai.axyra.sheets.Range...).Options for
Workbook.saveCsv(path, options).What a numeric cell is written as; see
CsvOptions.values(Values).A custom document property — one entry of the workbook's custom file
properties part (
docProps/custom.xml, ECMA-376 Part 1 §22.3).A boolean value (
vt:bool).A date value (
vt:filetime).A numeric value.
Fidelity view of a variant type outside the modeled set (for example
vt:cy currency): vtType is the original element name
and value its text, both preserved verbatim in the file across
open and save.A text value (
vt:lpwstr).The typed value of a custom document property.
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.One date grouping item of a date auto-filter (ECMA-376 §18.3.2.4
dateGroupItem, §18.18.24 ST_DateTimeGrouping): selects
every date/time cell inside the period named by grouping.Dynamic auto-filter kind (ECMA-376 §18.18.26 ST_DynamicFilterType).
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.Comparison operator for a custom auto-filter condition.
A style predicate for format-restricted find/replace (Excel's Find &
Replace → Format...
The vertical position of the font: normal baseline, superscript or subscript
(ECMA-376
ST_VerticalAlignRun).Number and date formatting with Excel format codes, and classification of
typed input.
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).How formula cells are written by
Workbook.save(path, SaveOptions).Queries the engine's catalog of built-in Excel-compatible functions.
One color stop of a gradient fill (ECMA-376 Part 1 §18.8.38
gradientFill/stop), read back with CellStyle.gradientStops().Horizontal alignment of the cell content (ECMA-376
ST_HorizontalAlignment).Options for
Workbook.saveHtml(path, options): choose between the
HTML package and one self-contained document.A cell hyperlink.
Immutable options for sheet and range image export:
Renderer.toPng(io.keikai.axyra.sheets.Workbook, int, io.keikai.axyra.sheets.io.ImageOptions),
Renderer.toSvg(io.keikai.axyra.sheets.Workbook, int, io.keikai.axyra.sheets.io.ImageOptions), Renderer.toImage(io.keikai.axyra.sheets.Workbook, int, java.lang.String, io.keikai.axyra.sheets.io.ImageOptions) and the JPEG, GIF, BMP and
TIFF shortcuts, and the matching Workbook.render* methods.Fluent builder for
ImageOptions; see ImageOptions.builder().Options for
Sheet.importData(int, int, java.util.List, ImportOptions),
which writes a list of Java objects onto a sheet, one object per row and one
property per column.Fluent builder for
ImportOptions.Chart legend placement.
Process-global licensing facade.
A snapshot of the engine's licensing status.
What
Workbook.setLicense(String, LicenseMode) does with a token that
is not in force.The runtime licensing status of the engine (process-global).
A defined name (named range).
An embedded OLE object (e.g.
The six page margins of a sheet, in inches (Excel semantics; ECMA-376 Part 1
§18.3.1.62
pageMargins).The result of classifying user-typed cell text the way Excel does, returned
by
Formats.parse(String).The input classes Excel distinguishes when text is typed into a cell.
The pattern of a cell fill (ECMA-376
ST_PatternType).Immutable options for PDF export:
Renderer.toPdf(io.keikai.axyra.sheets.Workbook, java.nio.file.Path) and
Workbook.renderPdf.Fluent builder for
PdfOptions; see PdfOptions.builder().Fit-to-page override for
PdfOptions.Builder.fitTo(Fit), with the meaning of
Excel's page setup "Fit to" (ECMA-376 fitToWidth /
fitToHeight).A pivot calculated-field definition: a virtual source column computed from
a formula over the other source columns (ECMA-376 Part 1 §18.10.1.13
cacheField@formula).A pivot calculated-item definition: a virtual item of a row/column field
computed from the field's other items (ECMA-376 Part 1 §18.10.1.9
calculatedItem).Date component a pivot row/column field is grouped by (ECMA-376 Part 1
§18.10.1.81
rangePr@groupBy).One placed pivot field, as returned by the
PivotTableView area
read-backs (rowFields(), columnFields(),
dataFields(), filterFields()).The grouping of a pivot row/column field, read back via
PivotTableView.fieldGroup(String): either a date-component
grouping (PivotFieldGroup.dateBy() non-null) or numeric range bins.The declared sort of a pivot row/column field, read back via
PivotTableView.fieldSort(String).A caption (label) filter on a pivot row/column field, read back via
PivotTableView.labelFilter(String).Caption (label) filter condition for a pivot row/column field — Excel's
"Label Filters" menu (ECMA-376 Part 1 §18.18.72
ST_PivotFilterType,
caption subset).Report layout of a pivot table (ECMA-376 Part 1 §18.10.1.73 — the
compact / outline / compactData attribute trio).The Show-Values-As state of a pivot values-area field, read back via
PivotTableView.showDataAs(int).Show-Values-As display mode for a pivot values-area field — Excel's
"Show Values As" menu (ECMA-376 Part 1 §18.10.1.18
dataField@showDataAs).A named pivot-table style plus banding flags (
<pivotTableStyleInfo> — ECMA-376 Part 1 §18.10.1.88), read back via
PivotTableView.style().A view of one pivot table: its definition (fields, filters, sorts, layout,
style) and the
PivotTableView.refresh() that writes its output into the sheet.The Top-N ("Top 10") filter of a pivot row/column field, read back via
PivotTableView.topNFilter(String): items rank by their aggregate
of a values-area entry and only the top (or bottom) value items /
percent survive a refresh.A value filter on a pivot row/column field, read back via
PivotTableView.valueFilter(String).Value filter condition for a pivot row/column field — Excel's "Value
Filters" menu (ECMA-376 Part 1 §18.18.72
ST_PivotFilterType,
value subset).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).A rectangle of cells on one sheet: the bulk API.
Renders workbooks to fixed-layout output: PDF documents, and sheet or range
images in PNG, JPEG, GIF, BMP, TIFF or SVG.
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.
Export options for
Workbook.save(path, options).A worksheet: a lightweight view bound to one tab of a
Workbook.Sheet protection options — the checkboxes of Excel's "Protect Sheet"
dialog.
Builder for
SheetProtection; every setter takes true = allowed.What kind of tab a
Sheet is.Direction that surrounding cells move when inserting or deleting a cell range.
One border edge of a cell.
Validation report for one package digital signature — an OPC (ECMA-376
Part 2 §13) XML signature found in the workbook file when it was opened.
Verification outcome of a package signature.
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 sort key: a 0-based range-relative index and its direction, optionally
carrying a custom ordering list (Excel's "Custom Lists").
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 row under construction for
StreamWorkbook.An immutable cell style for
StreamWorkbook: the small subset that
covers report authoring, a number format plus bold and italic.Writes an XLSX file row by row, in memory that does not grow with the row
count.
Aggregate function for
Sheet.subtotal(int, int, int, io.keikai.axyra.sheets.SubtotalFunction, int...), by Excel SUBTOTAL
code.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.
Data binding via template markers — a lightweight reporting layer
built entirely on the public read/write API.
An immutable workbook theme: the 12-slot color scheme plus the major
(heading) and minor (body) font names.
The 12 theme color slots, in ECMA-376
<a:clrScheme> order.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.Table totals-row aggregation (ECMA-376 §18.18.92 ST_TotalsRowFunction).
A series trendline (ECMA-376 §21.2.2.210).
A user-defined formula function that receives typed values, including
ranges.
The underline style of a font (ECMA-376
ST_UnderlineValues).A numeric user-defined formula function.
A data-validation rule (immutable).
A fluent builder for a
Validation.Vertical alignment of the cell content (ECMA-376
ST_VerticalAlignment).A VBA code module extracted from a macro-enabled workbook's
vbaProject.bin (read-only): its editor name, kind, and decompressed
source text.A sheet's three-state visibility.
A spreadsheet workbook: the top-level container of sheets and the owner of
the native engine workbook.
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).One cell binding of an XML map (read-only): a worksheet-table column bound
to an XPath.