Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- a1() - Method in record class io.keikai.axyra.sheets.CellRef
-
The A1-style reference within its sheet (e.g.
- ABOVE_AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- aboveAverage(boolean, boolean) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
An above-average (or below-average when
below) rule. - aboveAverage(boolean, boolean, int) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
An above/below-average rule restricted to a standard-deviation band: select cells
stdDevstandard deviations above (or below, whenbelow) the mean (ECMA-376 §18.3.1.1stdDev, values 1-3). - ACCENT1 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- ACCENT2 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- ACCENT3 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- ACCENT4 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- ACCENT5 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- ACCENT6 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- activeCell() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet view's active cell as an A1 reference (
<sheetView><selection activeCell>, ECMA-376 §18.3.1.78), ornullwhen the sheet carries no selection at all. - activeSheet() - Method in class io.keikai.axyra.sheets.Workbook
-
The active (selected) sheet.
- addBoolean(boolean) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends a boolean at the next column.
- addCalculatedField(String, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Defines a calculated field — a virtual source column whose value is
formulaevaluated over the sums of the referenced source fields within each pivot bucket (Excel's calculated-field semantics; ECMA-376 Part 1 §18.10.1.13cacheField@formula). - addCalculatedItem(String, String, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Defines a calculated item on the row/column field
field— a virtual item whose per-cell value isformulaevaluated over the field's other items (ECMA-376 Part 1 §18.10.1.9; e.g. - addChart(Chart) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a chart to this sheet; returns the new chart's index.
- addChartSheet(String, Chart) - Method in class io.keikai.axyra.sheets.Workbook
-
Append a chart-sheet tab named
namehostingchart— a dedicated full-page chart tab (ECMA-376 §18.3.1.12chartsheet), as opposed to a chart floating on a worksheet viaSheet.addChart(io.keikai.axyra.sheets.content.Chart). - addCheckbox(String, int, int, int, int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a checkbox form control anchored to a two-cell rectangle, optionally bound to a linked cell (A1 ref) reflecting its state.
- addColumnField(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Adds
sourceFieldto the column axis (nested innermost). - addColumnPageBreak(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert a manual page break before
column(vertical break). - addConditionalFormat(ConditionalFormat) - Method in class io.keikai.axyra.sheets.Range
-
Attach a conditional-formatting rule to this rectangle.
- addConnector(String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a connector shape (
<xdr:cxnSp>) with the given preset geometry name (e.g. - addDataField(String, AggregateFunction) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Adds
sourceFieldto the values area with the default caption. - addDataField(String, AggregateFunction, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Adds
sourceFieldto the values area. - addDate(LocalDate, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends a date at the next column;
stylemust carry a date format. - addFilterField(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Adds
sourceFieldas a report filter (ECMA-376 page field). - addFontDir(String) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
-
Adds one directory to
ImageOptions.Builder.fontDirs(java.util.List). - addFontDir(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Adds one directory to
PdfOptions.Builder.fontDirs(List). - addFormControl(FormControl) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a form control (check box, option button, button, combo box, list box, scroll bar, spin button, edit box, label, group box); returns its index in
Sheet.formControls(). - addLinkedPicture(String, String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a linked picture over the rectangle
(r1,c1)..(r2,c2): the image is referenced by an externaltarget(URL or path) via<a:blip r:link>instead of embedding bytes (ECMA-376 Part 1 §20.1.8.13). - addName(String, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Add or replace a workbook-scoped defined name.
- addName(String, String, Sheet) - Method in class io.keikai.axyra.sheets.Workbook
-
Add or replace a name scoped to a sheet.
- addNumber(double) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends a number at the next column.
- addNumber(double, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends a number with a style at the next column.
- addOleObject(String, String, byte[]) - Method in class io.keikai.axyra.sheets.Workbook
-
Embed an OLE object (raw bytes + optional ProgID); returns its index.
- addPageField(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Alias of
PivotTableView.addFilterField(java.lang.String)using the OOXML "page field" name. - addPicture(byte[], String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert an image anchored to a two-cell rectangle (0-based cells).
- addPicture(byte[], String, int, int, int, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert an image with a full two-cell anchor including EMU offsets.
- addPivotChart(int, String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a PivotChart bound to the pivot table at
pivotIndexon this sheet, anchored over the given cell rectangle. - addPivotTable(String, String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Create a pivot table at
location(A1 anchor) over a source range; returns its index. - addProtectedRange(String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Adds an ungated allow-edit-range.
- addProtectedRange(String, String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Adds an allow-users-to-edit-range (
protectedRange— ECMA-376 Part 1 §18.3.1.72): the named rangesqrefstays editable while the sheet is protected. - address() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Returns the value of the
addressrecord component. - addRowField(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Adds
sourceFieldto the row axis (nested innermost). - addRowPageBreak(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert a manual page break before
row(horizontal break). - addScenario(String, String[], String[]) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a what-if scenario; returns its index.
- addShape(String, String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a drawing shape (e.g.
- addSlicer(String, String) - Method in class io.keikai.axyra.sheets.Workbook
- addSlicer(String, String, String, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Add a slicer that DISPLAYS: bound to the pivot field
sourceofpivotTable, anchored on sheetsheetIndexwith a two-cell drawing anchor spanningrow/coltoendRow/endCol(0-based, exclusive-corner semantics of ECMA-376 §20.5.2.32). - addSlicer(String, String, String, String, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Add a slicer that DISPLAYS, preserving an explicit backing cache name.
- addSparkline(String, String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a sparkline group (
"line","column", or"stacked") that drawsdataRef(e.g. - addStyle(StreamStyle) - Method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Registers a style and returns the index cells reference.
- addText(String) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends text at the next column.
- addText(String, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends text with a style at the next column.
- addTextBox(String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Add a text box (a
rectshape carryingtext); returns the new shape's index. - addThreadedComment(String, String) - Method in class io.keikai.axyra.sheets.Cell
-
Start a new comment thread on this cell; returns the generated comment id (a braced GUID).
- addThreadedReply(String, String, String) - Method in class io.keikai.axyra.sheets.Cell
-
Reply to the thread containing
parentId(a root or reply id; replies attach to the thread root, like Excel). - addTimeline(String, String, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Add a timeline (a date-based slicer) bound to a source pivot over a
dateField. - addTimeline(String, String, String, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Add a timeline that DISPLAYS: filters pivot table
sourceoverdateField, anchored on sheetsheetIndexspanningrow/coltoendRow/endCol. - addTrendline(int, Trendline) - Method in class io.keikai.axyra.sheets.ChartView
-
Add a trendline to a series.
- AggregateFunction - Enum Class in io.keikai.axyra.sheets
-
Aggregate function for a pivot table data (values) field.
- aggregation() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns the value of the
aggregationrecord component. - algorithm() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns the value of the
algorithmrecord component. - allBorders(BorderStyle, Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
The four outer border edges at once.
- allDependents(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
All transitive dependents of a cell (does not include the cell itself).
- allowBlank() - Method in class io.keikai.axyra.sheets.content.Validation
- allowBlank(boolean) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- allowCopy() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Whether content copy / extraction is permitted (default
true). - allowCopy(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Permit content copy / extraction (default
true; encryption only). - allowModify() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Whether document modification is permitted (default
true). - allowModify(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Permit document modification (default
true; encryption only). - allowPrint() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Whether printing is permitted (encryption only; default
true). - allowPrint(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Permit printing (default
true; encryption only). - alpha() - Method in class io.keikai.axyra.sheets.style.Color
- anchor() - Method in class io.keikai.axyra.sheets.ChartView
-
{fromRow, fromColumn, toRow, toColumn}two-cell anchor. - anchor(int, int, int, int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
The two-cell anchor rectangle (0-based cells).
- anchor(int, int, int, int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
-
Two-cell anchor rectangle (0-based, inclusive corners).
- anchorOffsets() - Method in class io.keikai.axyra.sheets.ChartView
-
{fromColOff, fromRowOff, toColOff, toRowOff}— the sub-cell EMU offsets of the two-cell anchor's corners (914400 EMU = 1 inch). - anchorOffsets(int, int, int, int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
The sub-cell EMU offsets of the two-cell anchor's from/to corners (914400 EMU = 1 inch).
- anchorOffsets(long, long, long, long) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
-
EMU offsets inside the anchor's corner cells (optional refinement).
- anchorOleObject(int, byte[], String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Display the workbook-level embedded OLE object at
objectIndex(seeWorkbook.addOleObject(java.lang.String, java.lang.String, byte[])) as an icon on this sheet, anchored over the cell rectangle(fromRow, fromCol)–(toRow, toCol)(0-based, exclusive bottom-right edge like a drawing anchor). - application() - Method in class io.keikai.axyra.sheets.Workbook
-
The authoring application (
ApplicationofdocProps/app.xml), ornull. - apply(double[]) - Method in interface io.keikai.axyra.sheets.formula.UserFunction
- apply(CellValue[]) - Method in interface io.keikai.axyra.sheets.formula.TypedUserFunction
- applyAdvancedFilter(Range, Range, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Run an advanced filter (Excel's Data > Advanced) over
listRangein place, hiding the data rows that do not matchcriteriaRange. - applyAdvancedFilterCopyTo(Range, Range, Range, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Advanced filter in "Copy to another location" mode: instead of hiding source rows, writes the list header plus each matching row (see
Sheet.applyAdvancedFilter(Range, Range, boolean)for the criteria semantics) starting at the top-left cell ofdestination. - applyAutoFilter() - Method in class io.keikai.axyra.sheets.Sheet
-
Execute the auto-filter: hides every data row failing any column's criteria and shows the rest.
- applyNamedStyle(String) - Method in class io.keikai.axyra.sheets.Range
-
Apply a previously registered named cell style to every cell in the rectangle.
- appVersion() - Method in class io.keikai.axyra.sheets.Workbook
-
The authoring application version (
AppVersion), ornull. - area() - Static method in class io.keikai.axyra.sheets.content.Chart
- argb() - Method in class io.keikai.axyra.sheets.style.Color
-
The packed 0xAARRGGBB value of an RGB color.
- argb(int, int, int, int) - Static method in class io.keikai.axyra.sheets.style.Color
-
Color from 8-bit a/r/g/b.
- array(CellValue[][]) - Static method in interface io.keikai.axyra.sheets.CellValue
-
A row-major matrix value (see
CellValue.Array) — the shape of a range argument to a typed user-defined function, or of an array result returned from one. - Array(CellValue[][]) - Constructor for record class io.keikai.axyra.sheets.CellValue.Array
-
Creates an instance of a
Arrayrecord class. - asc(int) - Static method in record class io.keikai.axyra.sheets.SortKey
-
Ascending sort on a column.
- ascending() - Method in record class io.keikai.axyra.sheets.PivotFieldSort
-
Returns the value of the
ascendingrecord component. - ascending() - Method in record class io.keikai.axyra.sheets.SortKey
-
Returns the value of the
ascendingrecord component. - asRange() - Method in class io.keikai.axyra.sheets.NamedRange
-
The cells this name points at.
- author() - Method in record class io.keikai.axyra.sheets.content.Comment
-
Returns the value of the
authorrecord component. - author() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns the value of the
authorrecord component. - author() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Document author (PDF metadata), or
null. - author() - Method in class io.keikai.axyra.sheets.Workbook
-
The author (OOXML
creator), ornull. - author(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
- auto() - Static method in class io.keikai.axyra.sheets.style.Color
-
The automatic (window-text) color.
- autoExpandTables(int, int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Apply Excel's type-adjacent table auto-expansion for a data entry at (
row,col): typing one row below a table's last data row (inside its column span, no totals row) grows it by one row; typing in the header row one column right of its last column grows it by one column namedtypedText— unless another table occupies the candidate column. - autoFill(Range) - Method in class io.keikai.axyra.sheets.Range
-
Auto-fill: detect a pattern in this range (linear numeric series, or a cyclic copy for text and mixed content) and extend it across
destination— Excel's fill-handle drag. - autoFilter() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
autoFilterrecord component. - autoFilter(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- autoFilterRange() - Method in class io.keikai.axyra.sheets.Sheet
-
The filtered block, or
nullwhen this sheet has no autofilter. - autoFitColumn(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Auto-fit a column's width to its widest cell value.
- autoFitRow(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Auto-fit a row's height from the default font size.
- AUTOMATIC - Enum constant in enum class io.keikai.axyra.sheets.calc.CalcMode
-
Recalculate automatically when dependencies change (Excel default).
- AUTOMATIC_EXCEPT_TABLES - Enum constant in enum class io.keikai.axyra.sheets.calc.CalcMode
-
Automatic except for data tables.
- autoMerge(boolean) - Method in class io.keikai.axyra.sheets.Range
-
Auto-merge runs of adjacent cells with identical, non-empty content — left-to-right within each row when
horizontalis true, otherwise top-to-bottom within each column. - autoTitle(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Mark the chart as carrying an Excel "auto" title: no explicit text is emitted, so the app derives the displayed title from the single series name.
- AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
- AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- axisColor() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The data-bar axis color token, or
null. - axisColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
axisColorrecord component. - axisColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
axisColorrecord component. - axisColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
The data-bar axis color.
- axisPosition() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The data-bar axis position (
automatic/middle/none), ornull. - axisPosition(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Data-bar axis position:
"automatic","middle", or"none". - AxyraException - Exception in io.keikai.axyra.sheets
-
Base type for engine and API failures surfaced from the native layer.
- AxyraException(String) - Constructor for exception io.keikai.axyra.sheets.AxyraException
- AxyraException(String, Throwable) - Constructor for exception io.keikai.axyra.sheets.AxyraException
- AxyraFormulaException - Exception in io.keikai.axyra.sheets
-
A formula parse or evaluation API failure — e.g.
- AxyraFormulaException(String) - Constructor for exception io.keikai.axyra.sheets.AxyraFormulaException
- AxyraFormulaException(String, Throwable) - Constructor for exception io.keikai.axyra.sheets.AxyraFormulaException
- AxyraIoException - Exception in io.keikai.axyra.sheets
-
A file I/O or format parse/write failure — e.g.
- AxyraIoException(String) - Constructor for exception io.keikai.axyra.sheets.AxyraIoException
- AxyraIoException(String, Throwable) - Constructor for exception io.keikai.axyra.sheets.AxyraIoException
B
- backgroundImage() - Method in class io.keikai.axyra.sheets.Sheet
-
The raw bytes of the sheet background image, or
nullwhen none. - backgroundImageFormat() - Method in class io.keikai.axyra.sheets.Sheet
-
The format token (png/jpeg/…) of the sheet background image, or
nullwhen none. - backward() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
backwardrecord component. - bar() - Static method in class io.keikai.axyra.sheets.content.Chart
- barBorderColor() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The data-bar border color token, or
nullwhen borderless. - barBorderColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Draw a data-bar border in
color. - barDirection() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The data-bar direction (
context/leftToRight/rightToLeft), ornull. - barDirection(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Data-bar direction:
"context","leftToRight", or"rightToLeft". - barShape() - Method in class io.keikai.axyra.sheets.ChartView
-
The solid a 3-D bar or column draws its bars as (
<c:shape>, ECMA-376 Part 1 §21.2.2.177):"box","cone","coneToMax","cylinder","pyramid"or"pyramidToMax". - barShape() - Method in class io.keikai.axyra.sheets.content.Chart
-
The solid a 3-D bar or column is drawn as;
"box"when the chart declares no shape, that being the attribute's default. - barShape(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
The solid a 3-D bar or column is drawn as —
<c:shape>, ECMA-376 Part 1 §21.2.2.177:"box"(the default),"cone","coneToMax","cylinder","pyramid"or"pyramidToMax". - barType() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns the value of the
barTyperecord component. - baseColumnWidth() - Method in class io.keikai.axyra.sheets.Sheet
-
The declared
baseColWidthbasis in characters, or0when the sheet does not declare one (the spec default of 8 applies). - baseField() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs
-
Returns the value of the
baseFieldrecord component. - baseItem() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs
-
Returns the value of the
baseItemrecord component. - BASELINE - Enum constant in enum class io.keikai.axyra.sheets.style.FontVertical
- BEGINS_WITH - Enum constant in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
Item label begins with the criterion.
- beginsWith(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A "cell text begins with
text" rule. - BELOW_AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- between(String, String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A
betweenrule. - BETWEEN - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
-
low <= aggregate <= high; the only two-threshold condition. - bindings() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns the value of the
bindingsrecord component. - BLACK - Static variable in class io.keikai.axyra.sheets.style.Color
- blank() - Static method in interface io.keikai.axyra.sheets.CellValue
-
The empty-cell singleton.
- Blank() - Constructor for record class io.keikai.axyra.sheets.CellValue.Blank
-
Creates an instance of a
Blankrecord class. - BLANK - Enum constant in enum class io.keikai.axyra.sheets.io.FormulaPolicy
-
Write the cell blank (drop formula and value).
- BLANK - Static variable in interface io.keikai.axyra.sheets.CellValue
-
Shared singleton for empty cells.
- blue() - Method in class io.keikai.axyra.sheets.style.Color
- BLUE - Static variable in class io.keikai.axyra.sheets.style.Color
- bold() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
boldrecord component. - bold() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
- bold() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
boldrecord component. - bold() - Method in class io.keikai.axyra.sheets.content.RichText.Run
- bold() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
boldrecord component. - bold() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns the value of the
boldrecord component. - bold() - Method in class io.keikai.axyra.sheets.io.StreamStyle
- bold() - Method in class io.keikai.axyra.sheets.style.CellStyle
- bold() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- bold(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- bookmarks() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Whether a PDF outline (one bookmark per exported sheet) is emitted.
- bookmarks(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Emit a PDF outline (bookmarks): one entry per exported sheet, targeting the sheet's first page — combined with
PdfOptions.Builder.pageRange(String), dropped sheets lose their bookmark and targets follow the renumbered pages. - bool(boolean) - Static method in interface io.keikai.axyra.sheets.CellValue
-
A boolean value (returns a cached singleton).
- Bool(boolean) - Constructor for record class io.keikai.axyra.sheets.CellValue.Bool
-
Creates an instance of a
Boolrecord class. - Bool(boolean) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Bool
-
Creates an instance of a
Boolrecord class. - BOOL - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
- booleanValue() - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
The boolean payload; meaningful only when
kind() == BOOL. - border(BorderStyle, Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Draw the same border style and color on all four edges of matching cells — the differential
<border>of the rule style. - border(Side) - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The given border edge: line style plus color.
- border(Side, BorderStyle, Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
One border edge.
- borderBottom() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The bottom border edge.
- borderDiagonal() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The diagonal border edge (direction:
CellStyle.diagonalDown()/CellStyle.diagonalUp()). - BorderEdge - Record Class in io.keikai.axyra.sheets.style
-
One border edge read back from a
CellStyle: the line style and its color. - BorderEdge(BorderStyle, Color) - Constructor for record class io.keikai.axyra.sheets.style.BorderEdge
-
Creates an instance of a
BorderEdgerecord class. - borderLeft() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The left border edge.
- borderRight() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The right border edge.
- borderSide(String, BorderStyle, Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Draw a border on one edge (
"left","right","top", or"bottom") of matching cells. - BorderStyle - Enum Class in io.keikai.axyra.sheets.style
-
A single border edge line style.
- borderTop() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The top border edge.
- bottom() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns the value of the
bottomrecord component. - bottom() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Returns the value of the
bottomrecord component. - BOTTOM - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition
- BOTTOM - Enum constant in enum class io.keikai.axyra.sheets.style.Side
- BOTTOM - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign
- boxWhisker() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A box & whisker chart: distribution quartiles with outlier whiskers.
- bubble() - Static method in class io.keikai.axyra.sheets.content.Chart
- bubbleSeries(String, String, String, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Add a bubble series: a values (Y) range, a categories (X) range and the sizes (Z) range that gives each bubble its area —
<c:bubbleSize>, ECMA-376 Part 1 §21.2.2.19. - bubbleSizes(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Attaches a bubble-size (Z) range to the series most recently added — the counterpart of
Chart.Builder.pointFill(int, io.keikai.axyra.sheets.style.Color)for a series that was added with one of the plainseries(...)overloads. - build() - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
The immutable chart.
- build() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
- build() - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- build() - Method in class io.keikai.axyra.sheets.content.RichText.Builder
- build() - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- build() - Method in class io.keikai.axyra.sheets.ImportOptions.Builder
-
Build the immutable
ImportOptions. - build() - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
- build() - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
- build() - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- build() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- build() - Method in class io.keikai.axyra.sheets.style.Theme.Builder
- builder() - Static method in class io.keikai.axyra.sheets.content.ConditionalFormat
- builder() - Static method in class io.keikai.axyra.sheets.content.RichText
- builder() - Static method in class io.keikai.axyra.sheets.content.Validation
- builder() - Static method in record class io.keikai.axyra.sheets.ImportOptions
-
A fresh builder pre-loaded with the defaults (
headers = true). - builder() - Static method in class io.keikai.axyra.sheets.io.ImageOptions
- builder() - Static method in class io.keikai.axyra.sheets.io.PdfOptions
- builder() - Static method in record class io.keikai.axyra.sheets.SheetProtection
-
A builder starting from
SheetProtection.defaults(). - builder() - Static method in class io.keikai.axyra.sheets.style.CellStyle
- builder() - Static method in class io.keikai.axyra.sheets.style.Theme
- Builder() - Constructor for class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
- Builder() - Constructor for class io.keikai.axyra.sheets.content.RichText.Builder
- Builder() - Constructor for class io.keikai.axyra.sheets.content.Validation.Builder
- Builder() - Constructor for class io.keikai.axyra.sheets.style.Theme.Builder
- button(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A push button; the caption comes from
.text(...)or the name. - BUTTON - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- byPercent() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Returns the value of the
byPercentrecord component. - byValue() - Method in record class io.keikai.axyra.sheets.PivotFieldSort
-
Whether items sort by a data field's aggregate (vs.
- byValueDataField() - Method in record class io.keikai.axyra.sheets.PivotFieldSort
-
Returns the value of the
byValueDataFieldrecord component.
C
- cachedValueCount() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns the value of the
cachedValueCountrecord component. - cacheName() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
cacheNamerecord component. - cacheName() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
cacheNamerecord component. - calcMode() - Method in class io.keikai.axyra.sheets.Workbook
-
The workbook calculation mode.
- CalcMode - Enum Class in io.keikai.axyra.sheets.calc
-
Workbook calculation mode.
- calculatedFields() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The calculated-field definitions, in definition order.
- calculatedItems() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The calculated-item definitions, in definition order.
- caption() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
captionrecord component. - caption() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
captionrecord component. - category() - Method in class io.keikai.axyra.sheets.Workbook
-
The document category (
cp:category), ornull. - categoryAxisTitle() - Method in class io.keikai.axyra.sheets.ChartView
- categoryAxisTitle() - Method in class io.keikai.axyra.sheets.content.Chart
-
The category (X) axis title, or
null. - categoryAxisTitle(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Category (X) axis title.
- categoryAxisVisible() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the category (X) axis is drawn.
- categoryAxisVisible(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Show or hide the category (X) axis (ECMA-376 §21.2.2.16 catAx).
- categoryName() - Static method in record class io.keikai.axyra.sheets.content.DataLabels
-
Labels showing the category name.
- cell(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
A single-cell view at
(row, col)(0-based). - Cell - Class in io.keikai.axyra.sheets
-
A single cell — a lightweight
(Sheet, row, col)view. - cellIs(String, String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A
cellIsrule, e.g. - cellRef() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns the value of the
cellRefrecord component. - CellRef - Record Class in io.keikai.axyra.sheets
-
A workbook-wide cell coordinate: a 0-based sheet index plus 0-based row and column.
- CellRef(int, int, int) - Constructor for record class io.keikai.axyra.sheets.CellRef
-
Creates an instance of a
CellRefrecord class. - CellStyle - Class in io.keikai.axyra.sheets.style
-
An immutable cell style — font, fill, borders, alignment, number format, and protection.
- CellStyle.Builder - Class in io.keikai.axyra.sheets.style
-
Fluent builder; only the attributes you set are sent (engine fills the rest).
- CellValue - Interface in io.keikai.axyra.sheets
-
A single cell's value — a short-lived, immutable marshalling object.
- CellValue.Array - Record Class in io.keikai.axyra.sheets
-
A rectangular, row-major matrix of scalar values (
rows[r][c]). - CellValue.Blank - Record Class in io.keikai.axyra.sheets
-
The empty cell value.
- CellValue.Bool - Record Class in io.keikai.axyra.sheets
-
A boolean cell value.
- CellValue.Error - Record Class in io.keikai.axyra.sheets
-
An error cell value, identified by its Excel
ERROR.TYPEcode (mirrors the engine'sFormulaError::code). - CellValue.Number - Record Class in io.keikai.axyra.sheets
-
A numeric cell value.
- CellValue.Text - Record Class in io.keikai.axyra.sheets
-
A text cell value.
- CENTER - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- CENTER - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign
- CENTER_CONTINUOUS - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- chart(int) - Method in class io.keikai.axyra.sheets.Sheet
-
A live view of the chart at
chartIndex(its position inSheet.charts()), with read-back getters and setters that apply immediately. - Chart - Class in io.keikai.axyra.sheets.content
-
A chart (immutable).
- CHART - Enum constant in enum class io.keikai.axyra.sheets.SheetType
-
A full-page chart tab.
- Chart.Builder - Class in io.keikai.axyra.sheets.content
-
Fluent builder.
- chartAreaBorder(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Chart-area frame (border) line color.
- chartAreaFill() - Method in class io.keikai.axyra.sheets.ChartView
-
The chart-area fill color, or
null(default). - chartAreaFill(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Chart-area fill color (ECMA-376 §21.2.2.198
<c:spPr>on the chart space). - chartAreaLineColor() - Method in class io.keikai.axyra.sheets.ChartView
-
The chart-area frame (border) line color, or
null(default). - chartAreaNoBorder() - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Suppress the chart-area frame (
<a:ln><a:noFill/></a:ln>). - chartAreaNoFill() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the chart-area background is explicitly TRANSPARENT (
<a:noFill/>, ECMA-376 §20.1.8.44) — the sheet shows through. - chartAreaNoFill() - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Make the chart-area background explicitly TRANSPARENT (
<a:noFill/>, ECMA-376 §20.1.8.44) so the sheet shows through — distinct from leaving the fill unset, which renders as the application-default opaque white. - chartAreaNoLine() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the chart-area frame is explicitly suppressed (no border box).
- charts() - Method in class io.keikai.axyra.sheets.Sheet
-
All charts on this sheet.
- chartSheetChart(int) - Method in class io.keikai.axyra.sheets.Workbook
-
A live view of the chart hosted by the chart sheet at
index— the same read-back/edit viewSheet.chart(int)returns. - chartSheetCount() - Method in class io.keikai.axyra.sheets.Workbook
-
Number of chart-sheet tabs in the workbook (authored + imported).
- chartSheetName(int) - Method in class io.keikai.axyra.sheets.Workbook
-
The tab name of the chart sheet at
index(its position among the chart sheets, in tab order); out-of-range throwsIndexOutOfBoundsException. - ChartView - Class in io.keikai.axyra.sheets
-
A live view of an existing chart, obtained via
Sheet.chart(int)for a chart on a worksheet's drawing layer, or viaWorkbook.chartSheetChart(int)for the full-page chart hosted by a chart-sheet tab: getters mirror theChartbuilder fields, setters apply immediately to the engine. - CHECK_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- checkBox(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A check box; set state with
.checked(true). - checked() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Check box / option button state.
- checked(boolean) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- clear() - Method in class io.keikai.axyra.sheets.Cell
-
Clear the cell (value and formula).
- clear() - Method in class io.keikai.axyra.sheets.Range
-
Clear every cell in the rectangle (value and formula).
- clearAutoFilter() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove any auto-filter.
- clearBackgroundImage() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the sheet background image; returns whether one existed.
- clearCharts() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove all charts from this sheet.
- clearColumnFilter(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the filter from a single column.
- clearConditionalFormats() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove all conditional-formatting rules from this sheet.
- clearFieldSort(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Restores manual/source item order for
field. - clearHyperlinks() - Method in class io.keikai.axyra.sheets.Range
-
Remove every hyperlink in the rectangle, keeping the cell values.
- clearLabelFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Clears the caption (label) filter of
field. - clearPageBreaks() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove all manual page breaks.
- clearPaperSize() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the explicit paper-size declaration, so the saved sheet omits the
paperSizeattribute and consumers use their printer default. - clearPictures() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove all pictures from this sheet.
- clearSeries() - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Drop every series this builder currently holds.
- clearShowDataAs(int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Restores the raw aggregate for the
position-th values field. - clearTopNFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Clears the Top-N filter of
field. - clearTrendlines(int) - Method in class io.keikai.axyra.sheets.ChartView
-
Remove every trendline from a series.
- clearValidations() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove all data-validation rules from this sheet.
- clearValueFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Clears the value filter of
field. - close() - Method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Finishes the workbook if it has not been finished already, so a normal try-with-resources exit produces a complete file.
- close() - Method in class io.keikai.axyra.sheets.Workbook
- code() - Method in enum class io.keikai.axyra.sheets.calc.CalcMode
- code() - Method in record class io.keikai.axyra.sheets.CellValue.Error
-
Returns the value of the
coderecord component. - code() - Method in enum class io.keikai.axyra.sheets.content.FormControlType
-
The wire token used across the native boundary.
- code() - Method in enum class io.keikai.axyra.sheets.DynamicFilterType
-
The ECMA-376 token passed across the FFI.
- code() - Method in enum class io.keikai.axyra.sheets.FilterOperator
-
The engine operator code passed across the FFI.
- code() - Method in enum class io.keikai.axyra.sheets.io.FormulaPolicy
- code() - Method in enum class io.keikai.axyra.sheets.TotalsRowFunction
-
The ECMA-376 token passed across the FFI.
- col() - Method in class io.keikai.axyra.sheets.Cell
-
0-based column.
- col() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
colrecord component. - col() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
colrecord component. - colCount() - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
Number of columns (0 for an empty matrix).
- colCount() - Method in class io.keikai.axyra.sheets.Range
-
Number of columns in the rectangle.
- color() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
colorrecord component. - color() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
colorrecord component. - color() - Method in record class io.keikai.axyra.sheets.style.BorderEdge
-
Returns the value of the
colorrecord component. - color() - Method in record class io.keikai.axyra.sheets.style.GradientStop
-
Returns the value of the
colorrecord component. - color(Color) - Method in class io.keikai.axyra.sheets.content.RichText.Run
- color(Theme.Slot) - Method in class io.keikai.axyra.sheets.style.Theme
-
The raw color token for
slot(hex or a system token), or null. - color(Theme.Slot, Color) - Method in class io.keikai.axyra.sheets.style.Theme.Builder
-
Set a slot to an RGB
Color(emitted as"RRGGBB"). - color(Theme.Slot, String) - Method in class io.keikai.axyra.sheets.style.Theme.Builder
-
Set a slot to a raw token (
"RRGGBB","AARRGGBB", or a system token). - Color - Class in io.keikai.axyra.sheets.style
-
A typed spreadsheet color: plain ARGB, a legacy indexed-palette reference, a theme-palette reference with an optional tint, or the automatic (window-text) color — mirroring OOXML's color forms (ECMA-376 §18.8.3
CT_Color). - colors() - Method in class io.keikai.axyra.sheets.style.Theme
-
The 12 raw color tokens (defensive copy; slots may be null).
- colorScale(Color...) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A 2- or 3-color scale rule (min → [mid] → max).
- colorScaleColors() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The color-scale gradient colors in cfvo order (engine color tokens:
#RRGGBBhex, rawAARRGGBBhex,theme:N[:tint],indexed:N); empty for other kinds. - colorStyle() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
colorStylerecord component. - column() - Method in record class io.keikai.axyra.sheets.CellRef
-
Returns the value of the
columnrecord component. - column() - Static method in class io.keikai.axyra.sheets.content.Chart
- column() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns the value of the
columnrecord component. - column() - Method in record class io.keikai.axyra.sheets.SortKey
-
Returns the value of the
columnrecord component. - columnCount() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
columnCountrecord component. - columnFields() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The column-axis fields, in nesting order.
- columnLabels() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Returns the value of the
columnLabelsrecord component. - columnLabels(String...) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder
-
Set the header display names (one per included column).
- columnPageBreaks() - Method in class io.keikai.axyra.sheets.Sheet
-
The manual vertical page-break columns.
- columns() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
columnsrecord component. - columns() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Returns the value of the
columnsrecord component. - columns(String...) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder
-
Restrict and order the imported columns to these property names.
- columnStyle(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The style applied to the entire column — the default for cells in the column that carry no cell-level style (
<col style>). - columnStyleId(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The column-level style id (an engine-internal dedup index, matching
Range.styleIds()), or0when the column carries no column-level style. - columnWidth(int) - Method in class io.keikai.axyra.sheets.Sheet
-
A column's width in character units.
- combine(Workbook...) - Method in class io.keikai.axyra.sheets.Workbook
-
Append a deep copy of EVERY sheet (visible and hidden) of each source workbook, in argument order, auto-suffixing colliding names — the cross-workbook merge counterpart of
Workbook.copySheetFrom(Workbook, int)(same migration semantics and exclusions, except as follows). - combo() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A combination chart: one plot holding column, line, area, horizontal bar and scatter series together (ECMA-376 Part 1 §21.2.2.145, one
<c:plotArea>with several plot groups). - COMBO_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- comboBox(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A drop-down combo box; feed it with
.listFillRange("F1:F5"). - command() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns the value of the
commandrecord component. - comment() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's comment, or
null. - Comment - Record Class in io.keikai.axyra.sheets.content
-
A cell comment (note): author plus plain text.
- Comment(String, String) - Constructor for record class io.keikai.axyra.sheets.content.Comment
-
Creates an instance of a
Commentrecord class. - CommentRun - Record Class in io.keikai.axyra.sheets.content
-
One formatted run of a rich-text cell comment (note) — ECMA-376 Part 1 §18.7.7
comment/text/r. - CommentRun(String, String, Double, boolean, boolean, boolean, boolean, String) - Constructor for record class io.keikai.axyra.sheets.content.CommentRun
-
Creates an instance of a
CommentRunrecord class. - commentRuns() - Method in class io.keikai.axyra.sheets.Cell
-
The comment's rich-text runs — empty for a plain-text note, null when the cell has no comment.
- comments() - Method in class io.keikai.axyra.sheets.Workbook
-
The comments/description (OOXML
description), ornull. - commit() - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Writes the row and invalidates this builder until the next
row(). - COMPACT - Enum constant in enum class io.keikai.axyra.sheets.PivotLayout
-
All row fields share one column; indentation shows nesting.
- company() - Method in class io.keikai.axyra.sheets.Workbook
-
The company (
CompanyofdocProps/app.xml), ornull. - ConditionalFormat - Class in io.keikai.axyra.sheets.content
-
A conditional-formatting rule (immutable).
- ConditionalFormat.Builder - Class in io.keikai.axyra.sheets.content
-
Fluent builder.
- ConditionalFormat.ValueObject - Record Class in io.keikai.axyra.sheets.content
-
A threshold value object of a color-scale / data-bar / icon-set rule (ECMA-376 §18.3.1.11 cfvo).
- conditionalFormats() - Method in class io.keikai.axyra.sheets.Sheet
-
All conditional-formatting rules on this sheet.
- connections() - Method in class io.keikai.axyra.sheets.Workbook
-
The data connections defined in this workbook (Power Query and other), read from
xl/connections.xml. - connectionString() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns the value of the
connectionStringrecord component. - consolidate(int, int, ConsolidateFunction, Range...) - Method in class io.keikai.axyra.sheets.Sheet
-
Consolidate several equally-shaped source ranges (possibly on other sheets) into this sheet at
(destRow, destColumn)usingfunction, aggregating by position. - ConsolidateFunction - Enum Class in io.keikai.axyra.sheets
-
Aggregation function for
Sheet.consolidate(int, int, io.keikai.axyra.sheets.ConsolidateFunction, io.keikai.axyra.sheets.Range...), by Excelxl*code. - contains(String) - Static method in class io.keikai.axyra.sheets.formula.Functions
-
Whether a function with the given name exists (case-insensitive).
- CONTAINS - Enum constant in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
Item label contains the criterion.
- containsBlanks() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Highlight blank cells (Excel's "contains blanks").
- containsErrors() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Highlight cells whose value is an error.
- containsText(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A "cell text contains
text" rule. - CONTENT_COMMENT - Static variable in class io.keikai.axyra.sheets.Range
-
Range.contentFlags()bit: the cell carries a comment. - CONTENT_HYPERLINK - Static variable in class io.keikai.axyra.sheets.Range
-
Range.contentFlags()bit: the cell carries a hyperlink. - CONTENT_RICH_TEXT - Static variable in class io.keikai.axyra.sheets.Range
-
Range.contentFlags()bit: the cell's text is rich (more than one run). - contentFlags() - Method in class io.keikai.axyra.sheets.Range
-
Row-major per-cell content flags — each entry is a bitwise OR of
Range.CONTENT_COMMENT,Range.CONTENT_HYPERLINKandRange.CONTENT_RICH_TEXT(0 = none). - contentStatus() - Method in class io.keikai.axyra.sheets.Workbook
-
The content status (
cp:contentStatus, e.g. - convertTableToRange(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Convert the named table back to an ordinary range (Excel's Table Design > Convert to Range): drops the table definition while keeping every cell value in place.
- copySheet(Sheet, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Append a deep copy of
sourceundernewNameand return it. - copySheetFrom(Workbook, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Append a deep copy of sheet
sheetIndexof ANOTHER workbook and return the new view. - copySheetFrom(Workbook, int, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Append a deep copy of sheet
sheetIndexof ANOTHER workbook undernewNameand return the new view. - copyTo(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Range
-
Copy this rectangle to
(dstRow, dstCol)ondstSheet(Excel's Copy → Paste). - copyTo(Sheet, int, int, String) - Method in class io.keikai.axyra.sheets.Range
-
Copy this rectangle with an Excel Paste-Special mode:
"all"/"values"/"formulas"/"formats"/"comments". - count() - Static method in class io.keikai.axyra.sheets.formula.Functions
-
The number of built-in functions.
- COUNT - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
- COUNT - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- COUNT - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- COUNT - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
-
COUNTA — counts non-empty cells (SUBTOTAL 103).
- COUNT_A - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- COUNT_NUMS - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
-
Count of numeric values only (
countNums). - COUNT_NUMS - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
-
COUNT — counts numeric cells (SUBTOTAL 102).
- COUNTA - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- create() - Static method in class io.keikai.axyra.sheets.io.CsvOptions
- create() - Static method in class io.keikai.axyra.sheets.io.HtmlOptions
- create() - Static method in class io.keikai.axyra.sheets.io.SaveOptions
- create() - Static method in class io.keikai.axyra.sheets.Workbook
-
Create a new empty workbook (sparse backend — the general-purpose default).
- create(Path) - Static method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Opens a streaming writer on
file, replacing it if it exists. - createColumnar() - Static method in class io.keikai.axyra.sheets.Workbook
-
Create a new empty workbook on the columnar storage backend — behaviorally identical to
Workbook.create()but far leaner in memory for large, dense, numeric workbooks (roughly 4.6× smaller at rest at 10M cells), and saving at or below the sparse path. - created() - Method in class io.keikai.axyra.sheets.Workbook
-
The creation timestamp (
dcterms:created, W3CDTF), ornull. - createSheet(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Append a new sheet and return a view of it.
- createTable(String, String...) - Method in class io.keikai.axyra.sheets.Range
-
Create a table (ListObject) over this rectangle.
- CsvOptions - Class in io.keikai.axyra.sheets.io
-
Options for
Workbook.saveCsv(path, options). - CsvOptions() - Constructor for class io.keikai.axyra.sheets.io.CsvOptions
- CsvOptions.Values - Enum Class in io.keikai.axyra.sheets.io
-
What a numeric cell is written as.
- custom(String) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A custom-formula constraint.
- CUSTOM - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- customName() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns the value of the
customNamerecord component. - customOrder() - Method in record class io.keikai.axyra.sheets.SortKey
-
Returns the value of the
customOrderrecord component. - customOrder(int, String...) - Static method in record class io.keikai.axyra.sheets.SortKey
-
Ascending sort on a column by the position of each value in
values(Excel's "Custom Lists" order, e.g. - customProperties() - Method in class io.keikai.axyra.sheets.Workbook
-
The custom document properties, in file order — an immutable read view (empty list when the workbook has none).
- CustomProperty - Record Class in io.keikai.axyra.sheets
-
A custom document property — one entry of the workbook's custom file properties part (
docProps/custom.xml, ECMA-376 Part 1 §22.3). - CustomProperty(String, CustomProperty.Value) - Constructor for record class io.keikai.axyra.sheets.CustomProperty
-
Creates an instance of a
CustomPropertyrecord class. - CustomProperty.Bool - Record Class in io.keikai.axyra.sheets
-
A boolean value (
vt:bool). - CustomProperty.Date - Record Class in io.keikai.axyra.sheets
-
A date value (
vt:filetime). - CustomProperty.Number - Record Class in io.keikai.axyra.sheets
-
A numeric value.
- CustomProperty.Raw - Record Class in io.keikai.axyra.sheets
-
Fidelity view of a variant type outside the modeled set (for example
vt:cycurrency):vtTypeis the original element name andvalueits text, both preserved verbatim in the file across open → save. - CustomProperty.Text - Record Class in io.keikai.axyra.sheets
-
A text value (
vt:lpwstr). - CustomProperty.Value - Interface in io.keikai.axyra.sheets
-
The typed value of a custom document property.
- customTableStyles() - Method in class io.keikai.axyra.sheets.Workbook
-
The workbook's CUSTOM table-style definitions (
<tableStyles>+ their differential-format payloads) plus the default table/pivot style names, as one opaque JSON value object — ornullwhen the workbook defines none.
D
- DARK_DOWN - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK_GRAY - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK_GRID - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK_HORIZONTAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK_TRELLIS - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK_UP - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK_VERTICAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- DARK1 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- DARK2 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- DASH_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- DASH_DOT_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- DASHED - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- data() - Method in record class io.keikai.axyra.sheets.content.OleObject
-
Returns the value of the
datarecord component. - dataBar(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A data-bar rule drawn in
color. - dataBarColor() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The data-bar fill color token, or
nullfor other kinds. - DataConnection - Record Class in io.keikai.axyra.sheets.content
-
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. - DataConnection(int, String, String, String, String) - Constructor for record class io.keikai.axyra.sheets.content.DataConnection
-
Creates an instance of a
DataConnectionrecord class. - dataField() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Returns the value of the
dataFieldrecord component. - dataField() - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Returns the value of the
dataFieldrecord component. - dataFields() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The values-area fields, in order.
- dataLabels(DataLabels) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Attach data labels to the most recently added series.
- DataLabels - Record Class in io.keikai.axyra.sheets.content
-
Series-level data labels (ECMA-376 §21.2.2.49
<c:dLbls>): which fields are drawn beside each data point, an optional labelposition, an optionalnumberFormatoverride (§21.2.2.79numFmt) 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. - DataLabels(boolean, boolean, boolean, boolean, boolean, String, String) - Constructor for record class io.keikai.axyra.sheets.content.DataLabels
-
Backward-compatible constructor without text styling (all txPr fields inherit).
- DataLabels(boolean, boolean, boolean, boolean, boolean, String, String, Integer, Color, Boolean, Double) - Constructor for record class io.keikai.axyra.sheets.content.DataLabels
-
Creates an instance of a
DataLabelsrecord class. - dataRange() - Method in record class io.keikai.axyra.sheets.content.Sparkline
-
Returns the value of the
dataRangerecord component. - dataType() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns the value of the
dataTyperecord component. - date(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A date constraint (e.g.
- Date(LocalDate) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Date
-
Creates an instance of a
Daterecord class. - DATE - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
- date1904() - Method in class io.keikai.axyra.sheets.Workbook
-
Whether the workbook uses the 1904 date system (ECMA-376 Part 1 §18.2.28
<workbookPr date1904>). - dateAxisRange() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
dateAxisRangerecord component. - dateAxisRange() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
dateAxisRangerecord component. - dateBy() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Returns the value of the
dateByrecord component. - dateField() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
dateFieldrecord component. - DateGroupItem - Record Class in io.keikai.axyra.sheets
-
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. - DateGroupItem(String, int, Integer, Integer, Integer, Integer, Integer) - Constructor for record class io.keikai.axyra.sheets.DateGroupItem
-
Creates an instance of a
DateGroupItemrecord class. - dateOccurring(TimePeriod) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A "date occurring" rule: highlight cells whose date falls in the given window (ECMA-376 §18.18.82 ST_TimePeriod).
- dateTimeValue() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's value interpreted as a date-time (day fraction rounded to seconds), or null when the cell is not numeric.
- dateValue() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's value interpreted as a date (the serial's day part under the workbook's date system), or null when the cell is not numeric.
- day() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
dayrecord component. - day(int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem
-
Select a single day.
- DAYS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- decimal(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A decimal constraint.
- defaultColumnWidth() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet's explicit default column width in character units, or
0when none is declared — column widths then derive fromSheet.baseColumnWidth(). - defaultRowHeight() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet's default row height in points — the height of every row without an explicit
Sheet.setRowHeight(int, double)override. - defaults() - Static method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
No colors, no point highlights, default axis — the plain default style.
- defaults() - Static method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Excel's default for new tables:
TableStyleMedium2, row stripes on. - defaults() - Static method in record class io.keikai.axyra.sheets.ImportOptions
-
Default options: header row enabled, all properties, no labels or styling.
- defaults() - Static method in class io.keikai.axyra.sheets.io.StreamStyle
-
The neutral style: General format, no emphasis.
- defaults() - Static method in record class io.keikai.axyra.sheets.SheetProtection
-
Excel's Protect Sheet dialog defaults (only cell selection allowed).
- defaultStyle() - Method in class io.keikai.axyra.sheets.Workbook
-
The workbook default ("Normal") style — what unstyled cells render with.
- deleteCells(Shift) - Method in class io.keikai.axyra.sheets.Range
-
Delete the rectangle's cells, shifting remaining cells
Shift.UPorShift.LEFT. - deleteColumns() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
deleteColumnsrecord component. - deleteColumns(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- deleteColumns(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Delete
countcolumns starting atstartCol. - deleteRows() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
deleteRowsrecord component. - deleteRows(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- deleteRows(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Delete
countrows starting atstartRow. - deleteSheet(int) - Method in class io.keikai.axyra.sheets.Workbook
-
Delete the sheet at
index. - delimiter() - Method in class io.keikai.axyra.sheets.io.CsvOptions
- delimiter(char) - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
The field separator (default
','); one ASCII character other than a quote or line break. - dependents(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
The direct dependents of a cell — the cells whose formulas read it.
- desc(int) - Static method in record class io.keikai.axyra.sheets.SortKey
-
Descending sort on a column.
- detail() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns the value of the
detailrecord component. - DIAGONAL - Enum constant in enum class io.keikai.axyra.sheets.style.Side
- diagonalDown() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Whether the diagonal border runs top-left → bottom-right.
- diagonalDown(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Diagonal direction: top-left to bottom-right.
- diagonalUp() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Whether the diagonal border runs bottom-left → top-right.
- diagonalUp(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Diagonal direction: bottom-left to top-right.
- DIALOG - Enum constant in enum class io.keikai.axyra.sheets.SheetType
-
A legacy Excel 5.0 dialog sheet.
- DIFFERENCE_FROM - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cell - base item's cell (needs base field + base item).
- differentFirst() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the first printed page uses its own header/footer (ECMA-376 §18.3.1.46
differentFirst). - differentOddEven() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether odd and even printed pages use distinct headers/footers (ECMA-376 §18.3.1.46
differentOddEven). - direction() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns the value of the
directionrecord component. - display() - Method in record class io.keikai.axyra.sheets.CellValue.Error
-
The Excel display string for this error, e.g.
- display() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Returns the value of the
displayrecord component. - displayName() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns the value of the
displayNamerecord component. - DISTRIBUTED - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- DISTRIBUTED - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign
- docSecurity() - Method in class io.keikai.axyra.sheets.Workbook
-
The
DocSecurityflags ofdocProps/app.xml, ornullwhen the workbook records none. - documentVersion() - Method in class io.keikai.axyra.sheets.Workbook
-
The author-recorded document version (
cp:versionofdocProps/core.xml), ornull. - DOTTED - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- DOUBLE - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- DOUBLE - Enum constant in enum class io.keikai.axyra.sheets.style.Underline
- DOUBLE_ACCOUNTING - Enum constant in enum class io.keikai.axyra.sheets.style.Underline
- doughnut() - Static method in class io.keikai.axyra.sheets.content.Chart
- DOWN - Enum constant in enum class io.keikai.axyra.sheets.Shift
- dropLines() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Visible drop-down rows of a combo box (Excel's default is 8).
- dropLines(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- duplicateValues() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Highlight duplicate values in the range.
- dyDescent() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet-level
x14ac:dyDescenttext-descent hint on<sheetFormatPr>, or0when absent. - DynamicFilterType - Enum Class in io.keikai.axyra.sheets
-
Dynamic auto-filter kind (ECMA-376 §18.18.26 ST_DynamicFilterType).
E
- EDIT_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- editBox(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
An edit box (legacy dialog-sheet control).
- edition() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns the value of the
editionrecord component. - email(String, String, String) - Static method in record class io.keikai.axyra.sheets.content.Hyperlink
-
An email hyperlink (
mailto:). - end() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Returns the value of the
endrecord component. - endCap() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns the value of the
endCaprecord component. - endCol() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
endColrecord component. - endCol() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
endColrecord component. - endRow() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
endRowrecord component. - endRow() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
endRowrecord component. - ENDS_WITH - Enum constant in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
Item label ends with the criterion.
- endsWith(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A "cell text ends with
text" rule. - engineName() - Method in enum class io.keikai.axyra.sheets.PivotLayout
-
The engine's stable lowercase name.
- EQUAL - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator
- EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellRef
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellValue.Blank
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellValue.Bool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellValue.Error
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellValue.Number
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CellValue.Text
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Comment
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.OleObject
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.ProtectedRange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Sparkline
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Table
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.TableColumn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.VbaModule
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.WriteProtection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CustomProperty.Bool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CustomProperty.Date
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CustomProperty
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CustomProperty.Number
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.CustomProperty.Text
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.FindFormat
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class io.keikai.axyra.sheets.io.StreamStyle
- equals(Object) - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class io.keikai.axyra.sheets.NamedRange
- equals(Object) - Method in record class io.keikai.axyra.sheets.PageMargins
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotCalculatedField
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotField
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotFieldSort
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotLabelFilter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotShowDataAs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.SortKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.keikai.axyra.sheets.style.BorderEdge
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class io.keikai.axyra.sheets.style.Color
- equals(Object) - Method in record class io.keikai.axyra.sheets.style.GradientStop
-
Indicates whether some other object is "equal to" this one.
- EQUALS - Enum constant in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
Item label equals the criterion.
- error(int) - Static method in interface io.keikai.axyra.sheets.CellValue
-
An error value from its Excel
ERROR.TYPEcode (1–14). - Error(int) - Constructor for record class io.keikai.axyra.sheets.CellValue.Error
-
Creates an instance of a
Errorrecord class. - errorBars(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The error bars of a series, or
null. - errorBars(ErrorBars) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Attach error bars to the most recently added series.
- ErrorBars - Record Class in io.keikai.axyra.sheets.content
-
Series error bars (ECMA-376 §21.2.2.55).
- ErrorBars(String, String, String, Double, boolean) - Constructor for record class io.keikai.axyra.sheets.content.ErrorBars
-
Creates an instance of a
ErrorBarsrecord class. - errorMessage() - Method in class io.keikai.axyra.sheets.content.Validation
- errorMessage(String, String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- errorString(int) - Static method in interface io.keikai.axyra.sheets.CellValue
-
Maps an Excel
ERROR.TYPEcode to its display string. - errorStyle() - Method in class io.keikai.axyra.sheets.content.Validation
-
How firmly a failure is reported:
stop/warning/information. - errorStyle(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- errorTitle() - Method in class io.keikai.axyra.sheets.content.Validation
- evaluate(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Evaluate an ad-hoc formula (leading
=optional) in the first sheet's context. - evaluate(String, Sheet) - Method in class io.keikai.axyra.sheets.Workbook
-
Evaluate an ad-hoc formula in the given sheet's context.
- EVALUATION - Enum constant in enum class io.keikai.axyra.sheets.LicenseStatus
-
A license is installed but not currently in force (invalid, not-yet-valid, or expired past grace).
- evenFooter() - Method in class io.keikai.axyra.sheets.Sheet
-
The even-page footer text, or
null(only used whenSheet.differentOddEven()). - evenHeader() - Method in class io.keikai.axyra.sheets.Sheet
-
The even-page header text, or
null(only used whenSheet.differentOddEven()). - expiresAt() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns the value of the
expiresAtrecord component. - expiresAtInstant() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
The expiry as an
Instant, ornullfor perpetual / unlicensed. - expression(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
An
expressionrule (a boolean formula). - extendedApparatus(String, String, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Carry the byte-exact apparatus of a modern extended (
cx:) chart — thechartExpart plus itschartColorStyle/chartStyleparts, each base64-encoded — so a re-authored waterfall/funnel/… re-emits the complete part set Excel requires to open the file. - extendedChartExData() - Method in class io.keikai.axyra.sheets.ChartView
-
Base64 of the source
xl/charts/chartEx*.xmlpart for an extended chart, ornullfor a classic chart. - extendedColorsData() - Method in class io.keikai.axyra.sheets.ChartView
-
Base64 of the extended chart's
chartColorStylepart, ornull. - extendedStyleData() - Method in class io.keikai.axyra.sheets.ChartView
-
Base64 of the extended chart's
chartStylepart, ornull. - ExternalLink - Record Class in io.keikai.axyra.sheets.content
-
An external workbook reference descriptor (immutable, read-only): a linked workbook that formulas such as
[Book2]Sheet1!A1or[1]Sheet1!A1resolve against. - ExternalLink(int, String, List<String>, int, List<Integer>) - Constructor for record class io.keikai.axyra.sheets.content.ExternalLink
-
Creates an instance of a
ExternalLinkrecord class. - externalLinkCount() - Method in class io.keikai.axyra.sheets.Workbook
-
Number of external workbook references (ECMA-376 §18.14).
- externalLinks() - Method in class io.keikai.axyra.sheets.Workbook
-
Every external workbook reference — the linked workbooks that formulas such as
[Book2]Sheet1!A1resolve against. - externalLinkSource(int) - Method in class io.keikai.axyra.sheets.Workbook
-
The current source path (primary relationship target) of the external workbook reference at
index, ornullwhen the index is out of range.
F
- FALLBACK_TO_EVALUATION - Enum constant in enum class io.keikai.axyra.sheets.LicenseMode
-
Run as an evaluation copy (watermarked output, the per-execution file and uptime limits) and say so once on standard error.
- FALSE - Static variable in interface io.keikai.axyra.sheets.CellValue
-
Shared singleton for
FALSE. - features() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns the value of the
featuresrecord component. - field() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Returns the value of the
fieldrecord component. - fieldGroup(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The grouping of
field, or null when ungrouped. - fieldSort(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The declared sort of
field, or null for manual/source order. - fill(Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Solid background fill.
- FILL - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- fillBackgroundColor() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The fill background (pattern) color, or
null. - fillColor() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns the value of the
fillColorrecord component. - fillColor() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The fill (foreground) color, or
null. - fillColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
- fillPattern() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The fill pattern type (solid / none / gray125 / …).
- fillPattern(PatternType, Color, Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
A patterned fill:
patterndrawn inforegroundoverbackground. - filterFields() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The report-filter (page) fields.
- FilterOperator - Enum Class in io.keikai.axyra.sheets
-
Comparison operator for a custom auto-filter condition.
- find(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Find all cells whose text matches, as
{row, col}pairs. - find(String, boolean, boolean, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Find with options.
- find(String, boolean, boolean, boolean, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet
-
Sheet.find(String, FindFormat)with the full option set. - find(String, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet
-
Find restricted to cells whose resolved style matches
format(Excel's search-by-format) — seeFindFormatfor the matching semantics. - FindFormat - Record Class in io.keikai.axyra.sheets
-
A style predicate for format-restricted find/replace (Excel's Find & Replace → Format...
- FindFormat(Color, Color, Boolean, Boolean, String) - Constructor for record class io.keikai.axyra.sheets.FindFormat
-
Creates an instance of a
FindFormatrecord class. - findName(String) - Method in class io.keikai.axyra.sheets.Workbook
-
The first defined name matching
name, ornull. - findRegex(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Find all cells whose text matches the regular expression
pattern(case-insensitive), as{row, col}pairs. - findRegex(String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Sheet.findRegex(String)with explicit case sensitivity. - finish() - Method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Completes the package and closes the file.
- firstColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
firstColorrecord component. - firstColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
firstColorrecord component. - firstColumn() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- firstColumn() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
firstColumnrecord component. - firstColumn() - Method in class io.keikai.axyra.sheets.content.Validation
- firstColumn() - Method in class io.keikai.axyra.sheets.Range
-
First (left) column, 0-based inclusive.
- firstFooter() - Method in class io.keikai.axyra.sheets.Sheet
-
The first-page footer text, or
null(only used whenSheet.differentFirst()). - firstHeader() - Method in class io.keikai.axyra.sheets.Sheet
-
The first-page header text, or
null(only used whenSheet.differentFirst()). - firstPageNumber() - Method in class io.keikai.axyra.sheets.Sheet
-
The number printed on the first page, or
0when unset. - firstRow() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The rectangle this rule applies to (0-based, from a read-back rule).
- firstRow() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
firstRowrecord component. - firstRow() - Method in class io.keikai.axyra.sheets.content.Validation
-
The rectangle this rule applies to (0-based, from a read-back rule).
- firstRow() - Method in class io.keikai.axyra.sheets.Range
-
First (top) row, 0-based inclusive.
- fitTo() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
The fit-to-page override, or
nullto keep each sheet's own scaling. - fitTo(PdfOptions.Fit) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Fit-to-page override for every selected sheet.
- fitToHeight() - Method in class io.keikai.axyra.sheets.Sheet
-
Pages tall the printout is fitted to (
0= automatic / unlimited); only meaningful whenSheet.isFitToPage(). - fitToPage(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Fit the printout to
widthpages wide byheighttall. - fitToWidth() - Method in class io.keikai.axyra.sheets.Sheet
-
Pages wide the printout is fitted to (
0= automatic / unlimited); only meaningful whenSheet.isFitToPage(). - fixed(double) - Static method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Fixed-magnitude Y error bars in both directions.
- FOLLOWED_HYPERLINK - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- fontCharset() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Font character set (0 = ANSI, 1 = DEFAULT, …).
- fontCharset(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Font character set (0 = ANSI, 1 = DEFAULT, …).
- fontColor() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns the value of the
fontColorrecord component. - fontColor() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The font color (RGB, theme, indexed, or automatic), or
null. - fontColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
- fontColor(Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- fontDirs() - Method in class io.keikai.axyra.sheets.io.ImageOptions
-
Extra directories scanned for fonts, on top of the host's own font paths.
- fontDirs() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Extra directories scanned for fonts, on top of the host's own font paths.
- fontDirs(List<String>) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
-
Extra directories scanned for fonts, on top of the host's own font paths.
- fontDirs(List<String>) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Extra directories scanned for fonts, on top of the host's own font paths.
- fontFamily() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Font-family class: 0 = n/a, 1 = Roman, 2 = Swiss, 3 = Modern, 4 = Script, 5 = Decorative.
- fontFamily(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Font-family class (0 = n/a, 1 = Roman, 2 = Swiss, 3 = Modern, 4 = Script, 5 = Decorative).
- fontName() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
fontNamerecord component. - fontName() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
fontNamerecord component. - fontName() - Method in class io.keikai.axyra.sheets.style.CellStyle
- fontName(String) - Method in class io.keikai.axyra.sheets.content.RichText.Run
- fontName(String) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- fontScheme() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Font theme scheme (
"major","minor", or empty). - fontScheme(String) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Font theme scheme (
"major","minor", or empty). - fontSize() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
fontSizerecord component. - fontSize() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
fontSizerecord component. - fontSize() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
fontSizerecord component. - fontSize() - Method in class io.keikai.axyra.sheets.style.CellStyle
- fontSize(double) - Method in class io.keikai.axyra.sheets.content.RichText.Run
- fontSize(double) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- fontVertical() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Font vertical alignment (baseline / superscript / subscript).
- fontVertical(FontVertical) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Font vertical alignment (baseline / superscript / subscript).
- FontVertical - Enum Class in io.keikai.axyra.sheets.style
-
Font vertical alignment — normal baseline, superscript, or subscript.
- footer() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns the value of the
footerrecord component. - footer() - Method in class io.keikai.axyra.sheets.Sheet
-
The page footer text, or
null. - format(double, String) - Static method in class io.keikai.axyra.sheets.format.Formats
-
Format a numeric value with an Excel format code, e.g.
- format(double, String, String) - Static method in class io.keikai.axyra.sheets.format.Formats
-
Format a numeric value with an Excel format code under a BCP-47 display locale: month / weekday names, AM/PM markers, and decimal / thousands separators localize, e.g.
- formatCells() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
formatCellsrecord component. - formatCells(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- formatColumns() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
formatColumnsrecord component. - formatColumns(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- formatRows() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
formatRowsrecord component. - formatRows(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- Formats - Class in io.keikai.axyra.sheets.format
-
Number / date formatting with Excel format codes — the engine's formatting pipeline exposed as stateless helpers (no workbook needed).
- FORMATTED - Enum constant in enum class io.keikai.axyra.sheets.io.CsvOptions.Values
-
The cell's display text under its number format (
13%,(1,234.50)). - formattedColumns() - Method in class io.keikai.axyra.sheets.Sheet
-
The 0-based indexes (ascending) of columns carrying explicit column-level metadata — width, hidden flag, column style or outline.
- formattedRows() - Method in class io.keikai.axyra.sheets.Sheet
-
0-based indexes of the rows carrying explicit row-level metadata — a custom height, a hidden flag, or a row style — the row analogue of
Sheet.formattedColumns(). - formattedText() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's display text: its value rendered through the cell style's number format under the workbook display locale (
Workbook.setLocale(java.lang.String); default en-US). - FormControl - Class in io.keikai.axyra.sheets.content
-
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.
- FormControl.Builder - Class in io.keikai.axyra.sheets.content
-
Fluent builder.
- formControlCount() - Method in class io.keikai.axyra.sheets.Sheet
- formControls() - Method in class io.keikai.axyra.sheets.Sheet
-
All form controls on this sheet, in z-order.
- FormControlType - Enum Class in io.keikai.axyra.sheets.content
-
The kind of a worksheet form control (the classic Form Controls group on Excel's Developer tab), matching the OOXML ctrlProp
objectTypefamilies (ECMA-376 Part 1 §18.3.1.13 plus the<formControlPr>part). - formula() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's formula source, or
nullif it is not a formula cell. - formula() - Method in class io.keikai.axyra.sheets.NamedRange
-
The formula the name resolves to — for a named range, a reference such as
"Sheet1!$A$1:$B$10"; for a named constant, its value. - formula() - Method in record class io.keikai.axyra.sheets.PivotCalculatedField
-
Returns the value of the
formularecord component. - formula() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Returns the value of the
formularecord component. - FORMULA - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
- formula1() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- formula1() - Method in class io.keikai.axyra.sheets.content.Validation
- formula1(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- formula2() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- formula2() - Method in class io.keikai.axyra.sheets.content.Validation
- formula2(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- formulaLocalized(String) - Method in class io.keikai.axyra.sheets.Cell
-
The cell's formula rendered in
locale's display form (translated function names +;separator), ornullfor a non-formula cell. - formulaPolicy() - Method in class io.keikai.axyra.sheets.io.SaveOptions
- formulaPolicy(FormulaPolicy) - Method in class io.keikai.axyra.sheets.io.SaveOptions
-
How formulas are written.
- FormulaPolicy - Enum Class in io.keikai.axyra.sheets.io
-
How formulas are written on export.
- formulaPolicyExplicit() - Method in class io.keikai.axyra.sheets.io.SaveOptions
-
Whether
SaveOptions.formulaPolicy(FormulaPolicy)was called, rather than left at the default. - formulas() - Method in class io.keikai.axyra.sheets.Range
-
Read every cell's formula source.
- formulaToA1(String, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Convert a formula's references from R1C1 back to A1 style.
- formulaToR1C1(String, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Convert a formula's cell references from A1 to R1C1 style, relative to the 1-based
(anchorRow, anchorColumn). - forward() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
forwardrecord component. - freezeColumn() - Method in class io.keikai.axyra.sheets.Sheet
-
The frozen column split (columns left are frozen); 0 if none.
- freezePanes(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Freeze rows above
freezeRowand columns left offreezeCol. - freezeRow() - Method in class io.keikai.axyra.sheets.Sheet
-
The frozen row split (rows above are frozen); 0 if none.
- from(String) - Static method in enum class io.keikai.axyra.sheets.content.LegendPosition
-
Parse an engine token; unknown / empty maps to
LegendPosition.RIGHT. - from(String) - Static method in enum class io.keikai.axyra.sheets.content.TimePeriod
-
The enum for an ST_TimePeriod token, or
nullif unknown. - from(String) - Static method in enum class io.keikai.axyra.sheets.style.BorderStyle
- from(String) - Static method in enum class io.keikai.axyra.sheets.style.FontVertical
-
Parse an engine token; unknown / empty maps to
FontVertical.BASELINE. - from(String) - Static method in enum class io.keikai.axyra.sheets.style.HAlign
- from(String) - Static method in enum class io.keikai.axyra.sheets.style.PatternType
-
Parse an engine token; unknown / empty maps to
PatternType.NONE. - from(String) - Static method in enum class io.keikai.axyra.sheets.style.Underline
- from(String) - Static method in enum class io.keikai.axyra.sheets.style.VAlign
- fromCode(int) - Static method in enum class io.keikai.axyra.sheets.calc.CalcMode
- fromCode(String) - Static method in enum class io.keikai.axyra.sheets.content.FormControlType
-
The type for a wire token;
FormControlType.UNKNOWNfor unrecognized tokens. - fromCol() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
fromColrecord component. - fromColumn() - Method in class io.keikai.axyra.sheets.content.FormControl
- fromJson(Object) - Static method in class io.keikai.axyra.sheets.style.Color
-
Decode the FFI JSON color form: a structured map (
{"rgb": ...}/{"indexed": N}/{"theme": I, "tint": T}/{"auto": true}) or a legacy string. - fromJson(String) - Static method in class io.keikai.axyra.sheets.content.Chart
- fromJson(String) - Static method in class io.keikai.axyra.sheets.content.ConditionalFormat
- fromJson(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
- fromJson(String) - Static method in class io.keikai.axyra.sheets.content.RichText
-
Rebuild from the engine's read-back JSON (see
Cell.richText()). - fromJson(String) - Static method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Parse the engine's sparkline-group JSON.
- fromJson(String) - Static method in record class io.keikai.axyra.sheets.content.Table
-
Parse the engine's table-info JSON.
- fromJson(String) - Static method in class io.keikai.axyra.sheets.content.Validation
- fromJson(String) - Static method in class io.keikai.axyra.sheets.style.CellStyle
-
Package-private: rebuild from the engine's resolved-style JSON.
- fromLabel(String) - Static method in enum class io.keikai.axyra.sheets.LicenseStatus
-
Map a status label from the native status JSON, defaulting to
LicenseStatus.UNLICENSED. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.DataConnection
-
Builds a
DataConnectionfrom a decoded JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Build an
ExternalLinkfrom one decoded FFI JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.Slicer
-
Build a
Slicerfrom one decoded FFI JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.SmartArt
-
Build a
SmartArtfrom one decoded FFI JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.Timeline
-
Build a
Timelinefrom one decoded FFI JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.VbaModule
-
Builds a
VbaModulefrom a decoded JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.XmlMap
-
Builds an
XmlMapfrom a decoded JSON object. - fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Builds a binding from a decoded JSON object.
- fromOoxml(String) - Static method in enum class io.keikai.axyra.sheets.AggregateFunction
-
Parses an ST_DataConsolidateFunction string (case-insensitive).
- fromRow() - Method in class io.keikai.axyra.sheets.content.FormControl
- fromRow() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
fromRowrecord component. - Functions - Class in io.keikai.axyra.sheets.formula
-
Query the engine's built-in function catalog (more than 500 Excel-compatible functions).
- funnel() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A funnel chart: values as progressively narrowing stages.
G
- gapWidth() - Method in class io.keikai.axyra.sheets.ChartView
-
Bar/column gap width percent (Excel default 150).
- gapWidth(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Bar/column gap width as a percentage of bar width (0–500, default 150).
- GENERAL - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- get(int, int) - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
The value at
(row, col), 0-based. - goalSeek(Cell, double, Cell) - Method in class io.keikai.axyra.sheets.Workbook
-
Goal seek: find the value for the
changingcell that makes thetargetcell equaltargetValue. - GRACE - Enum constant in enum class io.keikai.axyra.sheets.LicenseStatus
-
Expired but within the grace period; still licensed, with a countdown.
- gradient() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
falsewhen a data bar paints a solid fill instead of the default gradient;nullwhen the source did not specify. - gradient(boolean) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Solid (
false) vs gradient (true) data-bar fill. - gradientDegree() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The gradient rotation in whole degrees (ECMA-376 Part 1 §18.8.24
gradientFill/@degree), or-1when the fill is not a gradient. - gradientFill(int, Color...) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
A linear gradient fill at
degreedegrees across two or more color stops (spread evenly from 0 to 1). - GradientStop - Record Class in io.keikai.axyra.sheets.style
-
One color stop of a gradient fill (ECMA-376 Part 1 §18.8.38
gradientFill/stop), read back viaCellStyle.gradientStops(). - GradientStop(double, Color) - Constructor for record class io.keikai.axyra.sheets.style.GradientStop
-
Creates an instance of a
GradientStoprecord class. - gradientStops() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The gradient color stops in position order (§18.8.38); empty when the fill is not a gradient.
- gradientType() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
The gradient kind:
"linear"(rotated byCellStyle.gradientDegree()) or"path"(shape-bounded, fromCellStyle.Builder.pathGradientFill(io.keikai.axyra.sheets.style.Color...)), ornullwhen the fill is not a gradient. - grandTotalCaption() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The grand-total caption override, or null (locale default).
- grandTotalColumn() - Method in class io.keikai.axyra.sheets.PivotTableView
-
Whether the grand-total column (right) is shown.
- grandTotalRow() - Method in class io.keikai.axyra.sheets.PivotTableView
-
Whether the grand-total row (bottom) is shown.
- GRAY - Static variable in class io.keikai.axyra.sheets.style.Color
- GRAY_0625 - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- GRAY_125 - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- GREATER_THAN - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator
- GREATER_THAN - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
- GREATER_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator
- GREATER_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
- green() - Method in class io.keikai.axyra.sheets.style.Color
- GREEN - Static variable in class io.keikai.axyra.sheets.style.Color
- gridLines() - Method in class io.keikai.axyra.sheets.io.ImageOptions
-
Gridline override:
TRUE/FALSEforce gridlines on/off;nulluses the sheet's own print-gridlines flag. - gridLines(boolean) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
-
Force gridlines on or off (default: the sheet's print-gridlines flag).
- GROUP_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- groupBox(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A group box frame (visually groups option buttons).
- groupColumns(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Group columns
[startCol, endCol]at outline level 1. - groupFieldByDate(String, PivotDateGroupBy) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Groups the row/column field
fieldby a date component (ECMA-376 Part 1 §18.10.1.81rangePr@groupBy): onPivotTableView.refresh()the field's items become the component labels in calendar order (MONTHS-> "Jan".."Dec",QUARTERS-> "Qtr1".."Qtr4", …). - groupFieldByDate(String, PivotDateGroupBy...) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Multi-level date grouping — Excel's Years/Quarters/Months expansion:
components[0]becomes the outermost level. - groupFieldNumeric(String, double, double, double) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Groups the row/column field
fieldinto numeric bins ofintervalover[start, end]— Excel's label shapes ("0-9", last bin"90-100", outliers"<0"/">100"). - grouping() - Method in class io.keikai.axyra.sheets.ChartView
-
Bar/column/area/line grouping:
"clustered"/"stacked"/"percentStacked"/"standard"(Excel default"clustered"). - grouping() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
groupingrecord component. - grouping(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Bar/column/area/line grouping:
"clustered"/"stacked"/"percentStacked"/"standard"(default"clustered"). - groupRows(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Group rows
[startRow, endRow]at outline level 1. - groupShapes(String, int...) - Method in class io.keikai.axyra.sheets.Sheet
-
Group existing shapes into one
<xdr:grpSp>container (Excel's "Group"). - gte() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Returns the value of the
gterecord component.
H
- HAIR - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- HAlign - Enum Class in io.keikai.axyra.sheets.style
-
Horizontal text alignment.
- hasAutoFilter() - Method in class io.keikai.axyra.sheets.Sheet
- hasFeature(String) - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Whether this license enables
feature("*"is a wildcard). - hasGradientFill() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Whether this style carries a gradient fill.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellRef
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellValue.Blank
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellValue.Bool
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellValue.Error
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellValue.Number
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CellValue.Text
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Comment
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.OleObject
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.ProtectedRange
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Sparkline
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.TableColumn
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.VbaModule
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.WriteProtection
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CustomProperty.Bool
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CustomProperty.Date
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CustomProperty
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CustomProperty.Number
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.CustomProperty.Text
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Returns a hash code value for this object.
- hashCode() - Method in class io.keikai.axyra.sheets.io.StreamStyle
- hashCode() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns a hash code value for this object.
- hashCode() - Method in class io.keikai.axyra.sheets.NamedRange
- hashCode() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotCalculatedField
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotFieldSort
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotLabelFilter
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.SortKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.keikai.axyra.sheets.style.BorderEdge
-
Returns a hash code value for this object.
- hashCode() - Method in class io.keikai.axyra.sheets.style.Color
- hashCode() - Method in record class io.keikai.axyra.sheets.style.GradientStop
-
Returns a hash code value for this object.
- hasNamedStyle(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Whether a named style is registered.
- hasPageSetup() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the sheet carries a
<pageSetup>element (ECMA-376 §18.3.1.63). - hasPassword() - Method in record class io.keikai.axyra.sheets.content.ProtectedRange
-
Returns the value of the
hasPasswordrecord component. - hasPassword() - Method in record class io.keikai.axyra.sheets.content.WriteProtection
-
Returns the value of the
hasPasswordrecord component. - hasTextStyle() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Whether any label text styling (rotation / color / bold / size) is set.
- header() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns the value of the
headerrecord component. - header() - Method in class io.keikai.axyra.sheets.Sheet
-
The page header text (Excel codes like
&C,&Pallowed), ornull. - headerFooterPictureData(String) - Method in class io.keikai.axyra.sheets.Sheet
-
The image bytes of the header/footer picture in
section, ornull. - headerRowCount() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
headerRowCountrecord component. - headers() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Returns the value of the
headersrecord component. - headers(boolean) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder
-
Toggle the header row (default
true). - headerStyle() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Returns the value of the
headerStylerecord component. - headerStyle(CellStyle) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder
-
Set the style applied to the header row.
- HEIGHT - Enum constant in enum class io.keikai.axyra.sheets.io.PdfOptions.Fit
-
Fit all rows onto one page height; width unconstrained.
- hidden() - Method in class io.keikai.axyra.sheets.style.CellStyle
- hidden(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- HIDDEN - Enum constant in enum class io.keikai.axyra.sheets.Visibility
- highColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
highColorrecord component. - highColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
highColorrecord component. - histogram() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A histogram chart: values bucketed into frequency bins.
- holeSize() - Method in class io.keikai.axyra.sheets.ChartView
-
Doughnut hole size percent.
- holeSize(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Doughnut hole size as a percentage (10–90, default 50).
- horizontalAlign() - Method in class io.keikai.axyra.sheets.style.CellStyle
- horizontalAlign(HAlign) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- hour() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
hourrecord component. - hour(int, int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem
-
Select a single hour of a day (0-23).
- HOURS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- HtmlOptions - Class in io.keikai.axyra.sheets.io
-
Options for
Workbook.saveHtml(path, options). - HtmlOptions() - Constructor for class io.keikai.axyra.sheets.io.HtmlOptions
- hyperlink() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's hyperlink, or
null. - Hyperlink - Record Class in io.keikai.axyra.sheets.content
-
A cell hyperlink.
- Hyperlink(String, String, String) - Constructor for record class io.keikai.axyra.sheets.content.Hyperlink
-
Creates an instance of a
Hyperlinkrecord class. - HYPERLINK - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- hyperlinkBase() - Method in class io.keikai.axyra.sheets.Workbook
-
The base URI relative hyperlinks resolve against (
HyperlinkBaseofdocProps/app.xml), ornull. - hyperlinksChanged() - Method in class io.keikai.axyra.sheets.Workbook
-
The
HyperlinksChangedflag ofdocProps/app.xml, ornullwhen the workbook records none.
I
- iconSet(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
An icon-set rule, e.g.
- iconSetName() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The icon-set name (e.g.
- id() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns the value of the
idrecord component. - id() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns the value of the
idrecord component. - id() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns the value of the
idrecord component. - ImageOptions - Class in io.keikai.axyra.sheets.io
-
Options for sheet / range image export (
Renderer.toPng/Renderer.toSvg). - ImageOptions.Builder - Class in io.keikai.axyra.sheets.io
- importData(int, int, List<T>) - Method in class io.keikai.axyra.sheets.Sheet
-
Import a collection with default options (header row on, all properties).
- importData(int, int, List<T>, ImportOptions) - Method in class io.keikai.axyra.sheets.Sheet
-
Import a collection of Java objects into a range.
- ImportOptions - Record Class in io.keikai.axyra.sheets
-
Options for
Sheet.importData(int, int, java.util.List, ImportOptions)— data import that maps a collection of Java objects (records, JavaBeans, or plain-field classes) onto a range of cells. - ImportOptions(String[], boolean, String[], CellStyle) - Constructor for record class io.keikai.axyra.sheets.ImportOptions
-
Creates an instance of a
ImportOptionsrecord class. - ImportOptions.Builder - Class in io.keikai.axyra.sheets
-
Fluent builder for
ImportOptions. - increment() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Incremental change of a scroll bar / spin button.
- increment(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- indent() - Method in class io.keikai.axyra.sheets.style.CellStyle
- indent(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- index() - Method in class io.keikai.axyra.sheets.ChartView
-
This chart's index on its sheet.
- index() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns the value of the
indexrecord component. - index() - Method in class io.keikai.axyra.sheets.PivotTableView
-
This pivot table's index on its sheet.
- index() - Method in class io.keikai.axyra.sheets.Sheet
-
The 0-based index of this sheet in its workbook.
- INDEX - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
(cell x grand total) / (row total x column total).
- indexed(int) - Static method in class io.keikai.axyra.sheets.style.Color
-
A legacy indexed-palette color (ECMA-376 §18.8.27; index 0-255).
- indexedValue() - Method in class io.keikai.axyra.sheets.style.Color
-
The palette index of an indexed color.
- inputMessage() - Method in class io.keikai.axyra.sheets.content.Validation
- inputMessage(String, String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- inputTitle() - Method in class io.keikai.axyra.sheets.content.Validation
- insertCells(Shift) - Method in class io.keikai.axyra.sheets.Range
-
Insert blank cells over the rectangle, shifting existing cells
Shift.DOWNorShift.RIGHT. - insertColumns() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
insertColumnsrecord component. - insertColumns(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- insertColumns(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert
countblank columns beforestartCol. - insertHyperlinks() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
insertHyperlinksrecord component. - insertHyperlinks(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- insertRows() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
insertRowsrecord component. - insertRows(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- insertRows(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert
countblank rows beforestartRow. - insertSheet(int, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Insert a new empty sheet at
index(0..sheetCount inclusive), shifting later sheets right, and return a view of it. - internal(String, String) - Static method in record class io.keikai.axyra.sheets.content.Hyperlink
-
An internal (in-workbook) hyperlink to
cellRef, e.g. - INTERNATIONAL_MACRO_SHEET - Enum constant in enum class io.keikai.axyra.sheets.SheetType
-
An international Excel-4.0 macro sheet.
- interval() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Returns the value of the
intervalrecord component. - INVALID - Enum constant in enum class io.keikai.axyra.sheets.SignatureInfo.Status
-
The package content no longer matches the signature: a signed part was modified, removed or re-typed, or the signature value itself does not verify.
- io.keikai.axyra.sheets - package io.keikai.axyra.sheets
-
Public Java API for the Axyra Sheets engine.
- io.keikai.axyra.sheets.calc - package io.keikai.axyra.sheets.calc
- io.keikai.axyra.sheets.content - package io.keikai.axyra.sheets.content
- io.keikai.axyra.sheets.format - package io.keikai.axyra.sheets.format
- io.keikai.axyra.sheets.formula - package io.keikai.axyra.sheets.formula
- io.keikai.axyra.sheets.io - package io.keikai.axyra.sheets.io
- io.keikai.axyra.sheets.style - package io.keikai.axyra.sheets.style
- io.keikai.axyra.sheets.template - package io.keikai.axyra.sheets.template
- is3d() - Method in class io.keikai.axyra.sheets.ChartView
- is3d() - Method in class io.keikai.axyra.sheets.content.Chart
-
Whether the chart renders in 3-D.
- isAuto() - Method in class io.keikai.axyra.sheets.style.Color
-
Whether this is the automatic (window-text) color.
- isColumnHidden(int) - Method in class io.keikai.axyra.sheets.Sheet
- isColumnWidthCustom(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the column's width was explicitly authored (via
Sheet.setColumnWidth(int, double)or a<col width>in the source file), as opposed to inheriting the sheet default. - isDate() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Whether this is a date-component grouping (vs numeric bins).
- isDefaultRowHeightCustom() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the default row height is flagged as an explicit, honoured value (the
sheetFormatPr customHeightflag). - isEmail() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Whether this is an email (
mailto:) link. - isEmpty() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Whether no criterion is set.
- isExtendedChart() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether this is a modern extended chart — the ISO/IEC 29500 Transitional
cx:chart-extension schema (waterfall, funnel, histogram, treemap, sunburst, box & whisker, region map). - isFeatureEnabled(String) - Static method in class io.keikai.axyra.sheets.License
-
Whether the current license enables
feature. - isFinished() - Method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Whether the package has been completed.
- isFitToPage() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether fit-to-page scaling is active (set by
Sheet.fitToPage(int, int)); whenfalsethe sheet prints atSheet.pageScale(). - isIndexed() - Method in class io.keikai.axyra.sheets.style.Color
-
Whether this is a legacy indexed-palette color.
- isInternal() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Whether this is an internal (in-workbook) reference.
- isLandscape() - Method in class io.keikai.axyra.sheets.Sheet
- isLicensed() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Whether a valid license is in force (
LicenseStatus.LICENSEDorLicenseStatus.GRACE). - isOfPie() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether this chart is a pie-of-pie or bar-of-pie (
<c:ofPieChart>). - isPaperSizeDeclared() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether this sheet explicitly declares a paper size.
- isPresent() - Method in record class io.keikai.axyra.sheets.style.BorderEdge
-
Whether this edge draws anything.
- isProtected() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether this sheet is protected.
- isProtectedWithPassword() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the sheet's protection carries a password.
- isRgb() - Method in class io.keikai.axyra.sheets.style.Color
-
Whether this is a plain ARGB color.
- isRowHeightCustom(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the row's height was explicitly authored (via
Sheet.setRowHeight(int, double)or a<row ht>in the source file). - isRowHidden(int) - Method in class io.keikai.axyra.sheets.Sheet
- isStructureLocked() - Method in class io.keikai.axyra.sheets.Workbook
-
Whether the workbook structure is locked.
- isStructureProtected() - Method in class io.keikai.axyra.sheets.Workbook
-
Whether the workbook structure is protected (alias of
Workbook.isStructureLocked()). - isTheme() - Method in class io.keikai.axyra.sheets.style.Color
-
Whether this is a theme-palette color.
- isVisible() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Whether any field is shown (i.e.
- isWindowsLocked() - Method in class io.keikai.axyra.sheets.Workbook
-
Whether the workbook windows are locked (§18.2.29
lockWindows). - isWorkbookScoped() - Method in class io.keikai.axyra.sheets.NamedRange
-
Whether this name is workbook-scoped (visible on every sheet).
- isWriteProtected() - Method in class io.keikai.axyra.sheets.Workbook
-
Whether a modify password is stored.
- italic() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
italicrecord component. - italic() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Italicize matching cells.
- italic() - Method in class io.keikai.axyra.sheets.content.RichText.Run
- italic() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
italicrecord component. - italic() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns the value of the
italicrecord component. - italic() - Method in class io.keikai.axyra.sheets.io.StreamStyle
- italic() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- italic() - Method in class io.keikai.axyra.sheets.style.CellStyle
- italic(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- itemFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The currently visible items of
field's manual filter: the distinct source-column items minus the hidden ones.
J
- JUSTIFY - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- JUSTIFY - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign
K
- KEEP - Enum constant in enum class io.keikai.axyra.sheets.io.FormulaPolicy
-
Keep the formula and its cached value (default).
- keywords() - Method in class io.keikai.axyra.sheets.Workbook
-
The document keywords, or
null. - kind() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns the value of the
kindrecord component. - kind() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
kindrecord component. - kind() - Method in record class io.keikai.axyra.sheets.content.VbaModule
-
Returns the value of the
kindrecord component. - kind() - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
Returns the value of the
kindrecord component.
L
- label(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A static text label.
- LABEL - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- labelFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The caption (label) filter of
field, or null when unfiltered. - language() - Method in class io.keikai.axyra.sheets.Workbook
-
The document language (
dc:language, e.g. - LAST_7_DAYS - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- LAST_MONTH - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- LAST_MONTH - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- LAST_QUARTER - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- LAST_WEEK - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- LAST_WEEK - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- LAST_YEAR - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- lastColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
lastColorrecord component. - lastColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
lastColorrecord component. - lastColumn() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- lastColumn() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
lastColumnrecord component. - lastColumn() - Method in class io.keikai.axyra.sheets.content.Validation
- lastColumn() - Method in class io.keikai.axyra.sheets.Range
-
Last (right) column, 0-based inclusive.
- lastModifiedBy() - Method in class io.keikai.axyra.sheets.Workbook
-
The user who last saved the workbook (
cp:lastModifiedByofdocProps/core.xml), ornull. - lastPrinted() - Method in class io.keikai.axyra.sheets.Workbook
-
When the workbook was last printed (
cp:lastPrinted, a W3CDTF timestamp), ornull. - lastRow() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- lastRow() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
lastRowrecord component. - lastRow() - Method in class io.keikai.axyra.sheets.content.Validation
- lastRow() - Method in class io.keikai.axyra.sheets.Range
-
Last (bottom) row, 0-based inclusive.
- layout() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The report layout (compact / outline / tabular).
- layoutFamily() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
layoutFamilyrecord component. - layoutId() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
layoutIdrecord component. - left() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns the value of the
leftrecord component. - LEFT - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition
- LEFT - Enum constant in enum class io.keikai.axyra.sheets.Shift
- LEFT - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- LEFT - Enum constant in enum class io.keikai.axyra.sheets.style.Side
- legend(LegendPosition) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Legend placement;
LegendPosition.NONEhides the legend. - legendLayout() - Method in class io.keikai.axyra.sheets.ChartView
-
The manual legend layout as
[x, y, w, h]chart-relative fractions, ornullwhen the legend is placed automatically. - legendLayout(double, double, double, double) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Position the legend at an explicit rectangle in chart-relative fractions (
x/ytop-left,w/hsize, all in[0, 1]) — a manual legend layout. - legendPosition() - Method in class io.keikai.axyra.sheets.ChartView
- legendPosition() - Method in class io.keikai.axyra.sheets.content.Chart
-
Legend placement (defaults to
RIGHTwhen unset). - LegendPosition - Enum Class in io.keikai.axyra.sheets.content
-
Chart legend placement.
- legendVisible() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the legend is shown at all (independent of its position).
- legendVisible(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Show or hide the legend without changing its position — distinct from
Chart.Builder.legend(LegendPosition). - LESS_THAN - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator
- LESS_THAN - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
- LESS_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator
- LESS_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
- level() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
levelrecord component. - License - Class in io.keikai.axyra.sheets
-
Process-global licensing facade.
- LICENSED - Enum constant in enum class io.keikai.axyra.sheets.LicenseStatus
-
A valid, in-force license.
- licensee() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns the value of the
licenseerecord component. - LicenseInfo - Record Class in io.keikai.axyra.sheets
-
A snapshot of the engine's licensing status.
- LicenseInfo(LicenseStatus, String, String, List<String>, Long) - Constructor for record class io.keikai.axyra.sheets.LicenseInfo
-
A status without a
LicenseInfo.reason()(the shape before the reason was carried). - LicenseInfo(LicenseStatus, String, String, List<String>, Long, String) - Constructor for record class io.keikai.axyra.sheets.LicenseInfo
-
Creates an instance of a
LicenseInforecord class. - LicenseMode - Enum Class in io.keikai.axyra.sheets
-
What
Workbook.setLicense(String, LicenseMode)does with a token that is not in force. - licenseStatus() - Static method in class io.keikai.axyra.sheets.Workbook
-
The current process-global licensing status.
- LicenseStatus - Enum Class in io.keikai.axyra.sheets
-
The runtime licensing status of the engine (process-global).
- LIGHT_DOWN - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT_GRAY - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT_GRID - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT_HORIZONTAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT_TRELLIS - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT_UP - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT_VERTICAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- LIGHT1 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- LIGHT2 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot
- line() - Static method in class io.keikai.axyra.sheets.content.Chart
- linear() - Static method in record class io.keikai.axyra.sheets.content.Trendline
-
A plain linear trendline.
- linkedCell() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Linked cell in A1 form (e.g.
- linkedCell(String) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- linksUpToDate() - Method in class io.keikai.axyra.sheets.Workbook
-
The
LinksUpToDateflag ofdocProps/app.xml, ornullwhen the workbook records none. - list() - Static method in class io.keikai.axyra.sheets.formula.Functions
-
The canonical (uppercase) names of every built-in function, sorted alphabetically.
- list(String...) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A drop-down list of the given allowed values, with its in-cell arrow shown.
- LIST_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- listBox(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A list box; feed it with
.listFillRange("F1:F5"). - listFillRange() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Items source range in A1 form for combo / list boxes, or null.
- listFillRange(String) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- locale() - Method in class io.keikai.axyra.sheets.Workbook
-
The workbook display locale as a BCP-47 tag (default
"en-US"). - location() - Method in record class io.keikai.axyra.sheets.content.Sparkline
-
Returns the value of the
locationrecord component. - location() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The output anchor (e.g.
- locked() - Method in class io.keikai.axyra.sheets.style.CellStyle
- locked(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- lowColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
lowColorrecord component. - lowColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
lowColorrecord component.
M
- MACRO_SHEET - Enum constant in enum class io.keikai.axyra.sheets.SheetType
-
An Excel-4.0 macro sheet.
- majorFont() - Method in class io.keikai.axyra.sheets.style.Theme
-
The major (heading) font name.
- majorFont(String) - Method in class io.keikai.axyra.sheets.style.Theme.Builder
- manager() - Method in class io.keikai.axyra.sheets.Workbook
-
The manager (
ManagerofdocProps/app.xml), ornull. - MANUAL - Enum constant in enum class io.keikai.axyra.sheets.calc.CalcMode
-
Recalculate only on an explicit request.
- manualMax() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
manualMaxrecord component. - manualMax() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
manualMaxrecord component. - manualMin() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
manualMinrecord component. - manualMin() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
manualMinrecord component. - map() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A filled-region map chart: geographic regions colored by value.
- markersColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
markersColorrecord component. - markersColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
markersColorrecord component. - max() - Method in class io.keikai.axyra.sheets.content.FormControl
- MAX - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
- MAX - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- MAX - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- MAX - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- maxAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
maxAxisTyperecord component. - maxAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
maxAxisTyperecord component. - MEDIUM - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- MEDIUM_DASH_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- MEDIUM_DASH_DOT_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- MEDIUM_DASHED - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- MEDIUM_GRAY - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- merge() - Method in class io.keikai.axyra.sheets.Range
-
Merge the rectangle into a single cell.
- mergedRegions() - Method in class io.keikai.axyra.sheets.Sheet
-
The merged-cell regions on this sheet.
- min() - Method in class io.keikai.axyra.sheets.content.FormControl
- MIN - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
- MIN - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- MIN - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- MIN - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- minAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
minAxisTyperecord component. - minAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
minAxisTyperecord component. - minorFont() - Method in class io.keikai.axyra.sheets.style.Theme
-
The minor (body) font name.
- minorFont(String) - Method in class io.keikai.axyra.sheets.style.Theme.Builder
- minute() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
minuterecord component. - minute(int, int, int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem
-
Select a single minute.
- MINUTES - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- modified() - Method in class io.keikai.axyra.sheets.Workbook
-
The last-modified timestamp (
dcterms:modified, W3CDTF), ornull. - month() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
monthrecord component. - month(int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem
-
Select a whole month (
monthis 1-based). - MONTHS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- moveColumnField(int, int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Reorders column fields: moves position
fromtoto. - moveDataField(int, int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Reorders data fields: moves position
fromtoto. - moveRowField(int, int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Reorders row fields: moves position
fromtoto. - moveSheet(int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
Move the sheet at
fromto positionto, shifting the sheets in between. - movingAverage(int) - Static method in record class io.keikai.axyra.sheets.content.Trendline
-
A moving-average trendline over
periodpoints.
N
- name() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns the value of the
namerecord component. - name() - Method in class io.keikai.axyra.sheets.content.FormControl
-
The shape name, e.g.
- name() - Method in record class io.keikai.axyra.sheets.content.OleObject
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.ProtectedRange
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.TableColumn
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.VbaModule
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.CustomProperty
-
Returns the value of the
namerecord component. - name() - Method in class io.keikai.axyra.sheets.NamedRange
-
The defined name, as written in the workbook.
- name() - Method in record class io.keikai.axyra.sheets.PivotCalculatedField
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns the value of the
namerecord component. - name() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns the value of the
namerecord component. - name() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The pivot table name.
- name() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet's display name.
- NamedRange - Class in io.keikai.axyra.sheets
-
A defined name (named range).
- NamedRange(String, String, int) - Constructor for class io.keikai.axyra.sheets.NamedRange
-
A detached name — one that carries no workbook, so
NamedRange.asRange()has nothing to resolve against. - namedStyleCount() - Method in class io.keikai.axyra.sheets.Workbook
-
Number of registered named cell styles.
- names() - Method in class io.keikai.axyra.sheets.Workbook
-
All defined names, in definition order.
- negativeBorderColor() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The negative-value bar border color token, or
null. - negativeBorderColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
The border color of negative-value data bars.
- negativeColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
negativeColorrecord component. - negativeColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
negativeColorrecord component. - negativeFillColor() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The negative-value bar fill color token, or
null. - negativeFillColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
The fill color of negative-value data bars.
- NEXT_MONTH - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- NEXT_MONTH - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- NEXT_QUARTER - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- NEXT_WEEK - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- NEXT_WEEK - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- NEXT_YEAR - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- nodeTexts() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
nodeTextsrecord component. - NONE - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition
- NONE - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- NONE - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- NONE - Enum constant in enum class io.keikai.axyra.sheets.style.Underline
- NONE - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- NORMAL - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Raw aggregate (no transformation).
- NOT_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator
- NOT_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType
- notContainsBlanks() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Highlight non-blank cells.
- notContainsErrors() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Highlight cells whose value is not an error.
- notContainsText(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A "cell text does not contain
text" rule. - number() - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
Returns the value of the
numberrecord component. - number(double) - Static method in interface io.keikai.axyra.sheets.CellValue
-
A numeric value (Excel stores integers and decimals both as
f64). - Number(double) - Constructor for record class io.keikai.axyra.sheets.CellValue.Number
-
Creates an instance of a
Numberrecord class. - Number(double) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Number
-
Creates an instance of a
Numberrecord class. - NUMBER - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
- numberFormat() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
numberFormatrecord component. - numberFormat() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns the value of the
numberFormatrecord component. - numberFormat() - Method in class io.keikai.axyra.sheets.io.StreamStyle
-
The Excel number-format code, or
nullfor General. - numberFormat() - Method in class io.keikai.axyra.sheets.style.CellStyle
- numberFormat(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Apply a number format code (e.g.
- numberFormat(String) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- numbers() - Method in class io.keikai.axyra.sheets.Range
-
Read the rectangle as a row-major
double[].
O
- objects() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
objectsrecord component. - objects(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
-
Allow editing objects (shapes, charts).
- of() - Static method in record class io.keikai.axyra.sheets.FindFormat
-
The empty filter (no criteria — combine with
withXmethods). - of(int) - Static method in class io.keikai.axyra.sheets.style.Color
-
Color from a packed 0xAARRGGBB int.
- of(FormControlType, String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A control of any
FormControlType. - of(String) - Static method in class io.keikai.axyra.sheets.content.Chart
-
A chart of any supported type token: column, bar, line, pie, area, scatter, doughnut, radar, bubble, surface, stock, combo, waterfall, histogram, funnel, treemap, sunburst, boxWhisker, pareto, map.
- of(String) - Static method in record class io.keikai.axyra.sheets.content.CommentRun
-
A run of
textwith the default note formatting. - of(String) - Static method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
A valueless threshold (
"min"/"max"). - of(String) - Static method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
The default banding flags with a different built-in style name.
- of(String) - Static method in record class io.keikai.axyra.sheets.PivotStyle
-
Excel's Design-tab defaults: headers on, banding off, last column on.
- of(String[], String, String) - Static method in class io.keikai.axyra.sheets.style.Theme
-
Build a
Themefrom the engine's raw representation: the 12 color tokens (a shorter/longer array is padded/truncated to 12) and the fonts. - of(String, String) - Static method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
A threshold with a number or formula value.
- ofPieCustomSplit() - Method in class io.keikai.axyra.sheets.ChartView
-
The zero-based point indices a
custsplit puts in the second plot (<c:custSplit>); empty for every other rule. - ofPieSecondPlotIsBar() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether an of-pie chart draws its second plot as a stacked bar (
<c:ofPieType val="bar"/>) rather than as a second pie. - ofPieSecondPlotSize() - Method in class io.keikai.axyra.sheets.ChartView
-
The second plot's size as a percentage of the first (
<c:secondPieSize>), ornullwhen absent. - ofPieSplitPosition() - Method in class io.keikai.axyra.sheets.ChartView
-
The count or threshold the split rule compares against (
<c:splitPos>), ornullwhen absent. - ofPieSplitType() - Method in class io.keikai.axyra.sheets.ChartView
-
The of-pie split rule as the format's own token —
auto,cust,percent,posorval— ornullwhen the chart carries no<c:splitType>. - OleObject - Record Class in io.keikai.axyra.sheets.content
-
An embedded OLE object (e.g.
- OleObject(String, String, byte[]) - Constructor for record class io.keikai.axyra.sheets.content.OleObject
-
Creates an instance of a
OleObjectrecord class. - oleObjects() - Method in class io.keikai.axyra.sheets.Workbook
-
The embedded OLE objects in this workbook.
- ooxml() - Method in enum class io.keikai.axyra.sheets.AggregateFunction
-
The ST_DataConsolidateFunction string ("sum", "countNums", ...).
- open(InputStream, String) - Static method in class io.keikai.axyra.sheets.Workbook
-
Parse a workbook by reading all of
in(of the givenformat). - open(Path) - Static method in class io.keikai.axyra.sheets.Workbook
-
Open a workbook from a file.
- open(Path, String) - Static method in class io.keikai.axyra.sheets.Workbook
-
Open a workbook from a file, decrypting with
passwordwhen the file is an agile-encrypted workbook ([MS-OFFCRYPTO] §2.3.4 — whatWorkbook.saveEncrypted(java.nio.file.Path, java.lang.String)and Excel 2013+/365 write). - openBytes(byte[], String) - Static method in class io.keikai.axyra.sheets.Workbook
-
Parse a workbook from an in-memory byte array of the given
format. - openBytes(byte[], String, String) - Static method in class io.keikai.axyra.sheets.Workbook
-
Parse a workbook from an in-memory byte array, decrypting with
passwordwhen the bytes are an agile-encrypted workbook. - operator() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- operator() - Method in class io.keikai.axyra.sheets.content.Validation
- operator(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- OPTION_BUTTON - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- optionButton(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
An option (radio) button; set state with
.checked(true). - order() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
orderrecord component. - OUTLINE - Enum constant in enum class io.keikai.axyra.sheets.PivotLayout
-
Each row field gets its own column; parent values not repeated.
- overlap() - Method in class io.keikai.axyra.sheets.ChartView
-
Bar overlap percent (-100..100).
- overlap(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Bar overlap as a percentage (-100 to 100, default 0).
- ownerPassword() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Password granting full access, or
null(falls back to the user password). - ownerPassword(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Password granting full access (enables encryption).
P
- page() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Page change of a scroll bar.
- page() - Method in class io.keikai.axyra.sheets.io.ImageOptions
-
Which printed page renders (1-based over the sheet's print pagination, the PDF page numbering), or
nullfor page 1. - page(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- page(int) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
-
Render the given printed page (1-based over the sheet's print pagination — the same numbering the PDF export uses).
- PAGE - Enum constant in enum class io.keikai.axyra.sheets.io.PdfOptions.Fit
-
Fit the whole sheet onto a single page.
- pageCount(Workbook, int) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Number of printed pages
sheetIndexpaginates to — the valid range forImageOptions.Builder.page(int)and the PDF export's page numbering. - pageFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The selected item of the report-filter (page) field
field, or null for "(All)" — also null when the field is unknown or not a filter field. - pageMargins() - Method in class io.keikai.axyra.sheets.Sheet
-
The page margins in inches.
- PageMargins - Record Class in io.keikai.axyra.sheets
-
The six page margins of a sheet, in inches (Excel semantics; ECMA-376 Part 1 §18.3.1.62
pageMargins). - PageMargins(double, double, double, double, double, double) - Constructor for record class io.keikai.axyra.sheets.PageMargins
-
Creates an instance of a
PageMarginsrecord class. - pageOrderOverThenDown() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether pages print over-then-down.
- pageRange() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
The 1-based page selection (e.g.
- pageRange(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
1-based page selection over the final document, e.g.
- pageScale() - Method in class io.keikai.axyra.sheets.Sheet
-
The print scale percentage (100 = no scaling).
- paperSize() - Method in class io.keikai.axyra.sheets.Sheet
-
The paper size as its ECMA-376 numeric code (9 = A4 by default).
- pareto() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A pareto chart: sorted histogram with a cumulative-percentage line.
- parse(String) - Static method in class io.keikai.axyra.sheets.format.Formats
-
Classify user-typed cell text the way Excel does when a value is entered into a cell: numbers (including
"50%","$1,234.56","1/2","1.5E3"), dates and times (as Excel serials), booleans, formulas (leading=), and plain text. - parse(String) - Static method in class io.keikai.axyra.sheets.style.Color
-
Parse
"#RRGGBB"/"#AARRGGBB"(plus the legacy engine tokens"auto","indexed:N","theme:I:TINT_FP"); returnsnullfor anything else. - ParsedValue - Record Class in io.keikai.axyra.sheets.format
-
The result of classifying user-typed cell text the way Excel does — see
Formats.parse(String). - ParsedValue(ParsedValue.Kind, double, String) - Constructor for record class io.keikai.axyra.sheets.format.ParsedValue
-
Creates an instance of a
ParsedValuerecord class. - ParsedValue.Kind - Enum Class in io.keikai.axyra.sheets.format
-
The input classes Excel distinguishes when text is typed into a cell.
- pathGradientFill(Color...) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
A path (shape-bounded) gradient fill converging at the cell center, across two or more color stops (spread evenly from 0 to 1).
- PatternType - Enum Class in io.keikai.axyra.sheets.style
-
Cell fill pattern type (ECMA-376
ST_PatternType). - pdfA() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Whether the output is PDF/A-2b conformant (ISO 19005-2 level B).
- pdfA(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
- PdfOptions - Class in io.keikai.axyra.sheets.io
-
Options for PDF export (
Renderer.toPdf/Workbook.renderPdf). - PdfOptions.Builder - Class in io.keikai.axyra.sheets.io
- PdfOptions.Fit - Enum Class in io.keikai.axyra.sheets.io
-
Fit-to-page override (ECMA-376 fitToWidth / fitToHeight semantics).
- percent() - Static method in record class io.keikai.axyra.sheets.content.DataLabels
-
Labels showing the value as a percent of the total (pie / doughnut).
- PERCENT_DIFFERENCE_FROM - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cell / base item's cell — Excel's ratio semantics for an absolute base item (needs base field + base item).
- PERCENT_OF_COLUMN - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cell / column total.
- PERCENT_OF_PARENT - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cell / base-field-level ancestor subtotal (needs a base field).
- PERCENT_OF_ROW - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cell / row total.
- PERCENT_OF_TOTAL - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cell / grand total.
- percentage(double) - Static method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Percentage Y error bars in both directions.
- period() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
periodrecord component. - pictureAnchor(int) - Method in class io.keikai.axyra.sheets.Sheet
-
{fromRow, fromCol, toRow, toCol}anchor of the picture, or an empty array. - pictureAnchorFull(int) - Method in class io.keikai.axyra.sheets.Sheet
-
{fromRow, fromCol, fromRowOffset, fromColOffset, toRow, toCol, toRowOffset, toColOffset}anchor of the picture (EMU offsets included), or an empty array. - pictureCount() - Method in class io.keikai.axyra.sheets.Sheet
-
Number of pictures on this sheet.
- pictureData(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The raw image bytes of the picture at
pictureIndex, ornull. - pictureFormat(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The format token (png/jpeg/…) of the picture at
pictureIndex, ornull. - pictureLinkTarget(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The external link target of the picture at
pictureIndex, ornullwhen it is an ordinary embedded picture. - pie() - Static method in class io.keikai.axyra.sheets.content.Chart
- pivotCacheId() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
pivotCacheIdrecord component. - PivotCalculatedField - Record Class in io.keikai.axyra.sheets
-
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). - PivotCalculatedField(String, String) - Constructor for record class io.keikai.axyra.sheets.PivotCalculatedField
-
Creates an instance of a
PivotCalculatedFieldrecord class. - PivotCalculatedItem - Record Class in io.keikai.axyra.sheets
-
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). - PivotCalculatedItem(String, String, String) - Constructor for record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Creates an instance of a
PivotCalculatedItemrecord class. - pivotCount() - Method in class io.keikai.axyra.sheets.Sheet
- PivotDateGroupBy - Enum Class in io.keikai.axyra.sheets
-
Date-grouping granularity for a pivot field (ECMA-376 Part 1 §18.10.1.81
rangePr@groupBy). - PivotField - Record Class in io.keikai.axyra.sheets
-
One placed pivot field, as returned by the
PivotTableViewarea read-backs (rowFields(),columnFields(),dataFields(),filterFields()). - PivotField(String, int, AggregateFunction, String, String, boolean) - Constructor for record class io.keikai.axyra.sheets.PivotField
-
Creates an instance of a
PivotFieldrecord class. - PivotFieldGroup - Record Class in io.keikai.axyra.sheets
-
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. - PivotFieldGroup(PivotDateGroupBy, double, double, double) - Constructor for record class io.keikai.axyra.sheets.PivotFieldGroup
-
Creates an instance of a
PivotFieldGrouprecord class. - PivotFieldSort - Record Class in io.keikai.axyra.sheets
-
The declared sort of a pivot row/column field, read back via
PivotTableView.fieldSort(String). - PivotFieldSort(boolean, int) - Constructor for record class io.keikai.axyra.sheets.PivotFieldSort
-
Creates an instance of a
PivotFieldSortrecord class. - PivotLabelFilter - Record Class in io.keikai.axyra.sheets
-
A caption (label) filter on a pivot row/column field, read back via
PivotTableView.labelFilter(String). - PivotLabelFilter(PivotLabelFilterType, String) - Constructor for record class io.keikai.axyra.sheets.PivotLabelFilter
-
Creates an instance of a
PivotLabelFilterrecord class. - PivotLabelFilterType - Enum Class in io.keikai.axyra.sheets
-
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). - PivotLayout - Enum Class in io.keikai.axyra.sheets
-
Report layout of a pivot table (ECMA-376 Part 1 §18.10.1.73 — the
compact/outline/compactDataattribute trio). - pivotLocation(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The destination location (e.g.
- pivotName(int) - Method in class io.keikai.axyra.sheets.Sheet
- PivotShowDataAs - Record Class in io.keikai.axyra.sheets
-
The Show-Values-As state of a pivot values-area field, read back via
PivotTableView.showDataAs(int). - PivotShowDataAs(PivotShowDataAsType, String, String) - Constructor for record class io.keikai.axyra.sheets.PivotShowDataAs
-
Creates an instance of a
PivotShowDataAsrecord class. - PivotShowDataAsType - Enum Class in io.keikai.axyra.sheets
-
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). - pivotSource() - Method in class io.keikai.axyra.sheets.content.Chart
-
The PivotChart binding this chart is driven by, in Excel's
[WorkbookName]SheetName!PivotNameform (ECMA-376 §21.2.2.153), ornullfor a regular chart. - pivotSource(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The source data reference of the pivot table at
pivotIndex. - PivotStyle - Record Class in io.keikai.axyra.sheets
-
A named pivot-table style plus banding flags (
<pivotTableStyleInfo>— ECMA-376 Part 1 §18.10.1.88), read back viaPivotTableView.style(). - PivotStyle(String, boolean, boolean, boolean, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.PivotStyle
-
Creates an instance of a
PivotStylerecord class. - pivotTable(int) - Method in class io.keikai.axyra.sheets.Sheet
-
A live view of the pivot table at
pivotIndex: field areas (row / column / filter / values), aggregation functions, layout, grand totals, andPivotTableView.refresh(). - pivotTable(String) - Method in class io.keikai.axyra.sheets.Sheet
-
A live view of the pivot table named
name(exact match first, then case-insensitive). - pivotTables() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
pivotTablesrecord component. - pivotTables() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
pivotTablesrecord component. - pivotTables(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- PivotTableView - Class in io.keikai.axyra.sheets
-
A live view of an existing pivot table, obtained via
Sheet.pivotTable(int)orSheet.pivotTable(String): getters read the engine's deep pivot model, mutators apply immediately. - PivotTopNFilter - Record Class in io.keikai.axyra.sheets
-
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)valueitems / percent survive a refresh. - PivotTopNFilter(int, double, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.PivotTopNFilter
-
Creates an instance of a
PivotTopNFilterrecord class. - PivotValueFilter - Record Class in io.keikai.axyra.sheets
-
A value filter on a pivot row/column field, read back via
PivotTableView.valueFilter(String). - PivotValueFilter(int, PivotValueFilterType, double, double) - Constructor for record class io.keikai.axyra.sheets.PivotValueFilter
-
Creates an instance of a
PivotValueFilterrecord class. - PivotValueFilterType - Enum Class in io.keikai.axyra.sheets
-
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). - plotAreaBorder(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Plot-area frame (border) line color.
- plotAreaFill() - Method in class io.keikai.axyra.sheets.ChartView
-
The plot-area fill color, or
null(default). - plotAreaFill(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Plot-area fill color.
- plotAreaLayout() - Method in class io.keikai.axyra.sheets.ChartView
-
The manual plot-area layout (ECMA-376 §21.2.2.88
manualLayout) as[x, y, w, h]in chart-relative fractions, ornullwhen the plot area is laid out automatically. - plotAreaLayout(double, double, double, double) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Position the inner plot area at an explicit rectangle in chart-relative fractions (ECMA-376 §21.2.2.88
manualLayout):x/yare the top-left corner andw/hthe size, all in[0, 1]. - plotAreaLineColor() - Method in class io.keikai.axyra.sheets.ChartView
-
The plot-area frame (border) line color, or
null(default). - plotAreaNoBorder() - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Suppress the plot-area frame (
<a:ln><a:noFill/></a:ln>). - plotAreaNoFill() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the plot-area background is explicitly transparent (mirrors
ChartView.chartAreaNoFill()). - plotAreaNoFill() - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Make the plot-area background explicitly transparent (mirrors
Chart.Builder.chartAreaNoFill()). - plotAreaNoLine() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the plot-area frame is explicitly suppressed.
- pointExplosion(int, int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Explode the pie/doughnut slice at
pointIndexoutward bypercentof the radius (ECMA-376 §21.2.2.62dPt/explosion) on the most recently added series. - pointFill(int, Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Override the fill color of one data point (pie slice / bar) on the most recently added series (ECMA-376 §21.2.2.52 dPt).
- pointLabel(int, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Give one point of the most recently added series a label of its own (ECMA-376 §21.2.2.47
dLbl) — a caption in place of the value the rest of the series shows. - pointLabelHidden(int, boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Hide the label of one point while the rest of the series keeps its own (
<c:dLbl><c:delete val="1"/>). - polynomial(int) - Static method in record class io.keikai.axyra.sheets.content.Trendline
-
A polynomial trendline of the given order.
- position() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
positionrecord component. - position() - Method in record class io.keikai.axyra.sheets.style.GradientStop
-
Returns the value of the
positionrecord component. - precedents(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Workbook
-
The direct precedents of a cell — the cells its formula reads (may be cross-sheet).
- printArea() - Method in class io.keikai.axyra.sheets.Sheet
- printBlackAndWhite() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the sheet prints without colour.
- printComments() - Method in class io.keikai.axyra.sheets.Sheet
-
Where cell comments print, as the same code
Sheet.setPrintComments(int)takes. - printDraft() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the sheet prints in draft quality.
- printErrors() - Method in class io.keikai.axyra.sheets.Sheet
-
How error cells print, as the same code
Sheet.setPrintErrors(int)takes. - printGridlines() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether gridlines are printed (ECMA-376 §18.3.1.65 printOptions/gridLines).
- printHeadings() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether row and column headings are printed.
- printHorizontallyCentered() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether printed output is centered horizontally on the page (
<printOptions horizontalCentered>, ECMA-376 §18.3.1.70). - printResolution() - Method in class io.keikai.axyra.sheets.Sheet
-
The printer resolution in DPI.
- printTitleColumns() - Method in class io.keikai.axyra.sheets.Sheet
- printTitleRows() - Method in class io.keikai.axyra.sheets.Sheet
- printVerticallyCentered() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether printed output is centered vertically on the page (
<printOptions verticalCentered>, ECMA-376 §18.3.1.70). - priority() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
Evaluation priority (lower wins; 0 when unset).
- priority(int) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Evaluation priority (lower wins).
- process(Sheet, Map<String, Object>) - Static method in class io.keikai.axyra.sheets.template.TemplateMarkers
-
Process every
${...}marker in the sheet againstdata. - PRODUCT - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
- PRODUCT - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- PRODUCT - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- progId() - Method in record class io.keikai.axyra.sheets.content.OleObject
-
Returns the value of the
progIdrecord component. - protect() - Method in class io.keikai.axyra.sheets.Sheet
-
Enable sheet protection (Excel-default allowances).
- protect(boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Lock the workbook structure (no adding/removing/renaming sheets).
- protect(boolean, boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Lock the workbook structure and/or windows.
- protect(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Enable sheet protection with a password (ISO Write Protection hash, SHA-512 + 100,000 spins per [MS-OFFCRYPTO] §2.4.2.2) and Excel's default allowances.
- protect(String, SheetProtection) - Method in class io.keikai.axyra.sheets.Sheet
-
Enable sheet protection with explicit ECMA-376 §18.3.1.85 options and an optional password (
null= none). - ProtectedRange - Record Class in io.keikai.axyra.sheets.content
-
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). - ProtectedRange(String, String, boolean) - Constructor for record class io.keikai.axyra.sheets.content.ProtectedRange
-
Creates an instance of a
ProtectedRangerecord class. - protectedRanges() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet's allow-edit-ranges, in definition order.
- protection() - Method in class io.keikai.axyra.sheets.Sheet
-
The protection options (allow semantics), or
nullwhen this sheet is not protected. - protectStructure(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Lock the workbook structure (ECMA-376 §18.2.29
lockStructure) with a password (ISO Write Protection hash, [MS-OFFCRYPTO] §2.4.2.2). - protectStructure(String, boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Lock the workbook structure and optionally the windows (§18.2.29).
Q
- QUARTERS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- quickStyle() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
quickStylerecord component. - quotePrefix() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Whether the cell's text was entered with a leading apostrophe (ECMA-376 §18.8.45
xf@quotePrefix), which keeps a number-looking value as text.
R
- radar() - Static method in class io.keikai.axyra.sheets.content.Chart
- range(int, int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
-
Minimum / maximum of a scroll bar / spin button.
- range(int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
A range over the inclusive rectangle
(r1,c1)..(r2,c2), 0-based. - range(String) - Method in class io.keikai.axyra.sheets.Sheet
-
A range parsed from A1 notation, e.g.
- range(String) - Method in class io.keikai.axyra.sheets.Workbook
-
A range parsed from a sheet-qualified A1 reference — the spelling a defined name stores, e.g.
- Range - Class in io.keikai.axyra.sheets
-
A rectangular block of cells — the bulk API.
- RANK_ASCENDING - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Standard rank, smallest = 1; ties share a rank.
- RANK_DESCENDING - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Standard rank, largest = 1; ties share a rank.
- Raw(String, String) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Raw
-
Creates an instance of a
Rawrecord class. - RAW - Enum constant in enum class io.keikai.axyra.sheets.io.CsvOptions.Values
-
The stored value, for a data feed: numbers in their shortest exact form (
0.125,-1234.5), and cells formatted as a date or time as ISO 8601 (2026-09-30,18:00:00,2026-09-30T18:00:00). - readOnlyRecommended() - Method in record class io.keikai.axyra.sheets.content.WriteProtection
-
Returns the value of the
readOnlyRecommendedrecord component. - reason() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns the value of the
reasonrecord component. - recalculate() - Method in class io.keikai.axyra.sheets.Workbook
-
Full recalculation: recompute every formula cell.
- recalculateDirty() - Method in class io.keikai.axyra.sheets.Workbook
-
Recalculate only cells marked dirty since the last calculation.
- red() - Method in class io.keikai.axyra.sheets.style.Color
- RED - Static variable in class io.keikai.axyra.sheets.style.Color
- refresh() - Method in class io.keikai.axyra.sheets.PivotTableView
-
Re-reads the source range, runs the pivot cube engine (aggregation + layout), and materializes the computed output into the sheet at the pivot anchor — row labels, column headers, values, and grand totals become ordinary cells (like Excel's Refresh).
- refreshedBy() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The user name stamped on the pivot cache the last time it was refreshed (the
refreshedByattribute ofpivotCacheDefinition, ECMA-376 Part 1 §18.10.1.67), ornullwhen the source file carries none — as for a pivot table built through this API. - refreshErrorSheets() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns the value of the
refreshErrorSheetsrecord component. - registerFunction(String, UserFunction) - Method in class io.keikai.axyra.sheets.Workbook
-
Register a user-defined function callable from formulas by
name. - registerNamedStyle(String, CellStyle) - Method in class io.keikai.axyra.sheets.Workbook
-
Register a reusable named cell style (e.g.
- registerTypedFunction(String, TypedUserFunction) - Method in class io.keikai.axyra.sheets.Workbook
-
Register a typed user-defined function callable from formulas by
name. - reload() - Method in class io.keikai.axyra.sheets.ChartView
-
Re-read the chart state from the engine.
- reload() - Method in class io.keikai.axyra.sheets.PivotTableView
-
Re-read the pivot state from the engine.
- removeCalculatedField(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes the calculated field
nametogether with every values-area placement referencing it. - removeCalculatedItem(String, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes the calculated item
namefromfield. - removeChart(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the chart at
chartIndex(its position inSheet.charts()); returns whether it existed. - removeChartSheet(int) - Method in class io.keikai.axyra.sheets.Workbook
-
Remove the chart sheet at
index(its position among the chart sheets); returns whether it existed. - removeColumnField(int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes the
position-th column field. - removeComment() - Method in class io.keikai.axyra.sheets.Cell
-
Remove any comment.
- removeConditionalFormat(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the conditional-formatting rule at
formatIndex(its position inSheet.conditionalFormats()); returns whether it existed. - removeCustomProperty(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Remove the custom document property
name; returns whether it existed. - removeDataField(int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes the
position-th data (values) field. - removeDuplicates(int[], boolean) - Method in class io.keikai.axyra.sheets.Range
-
Remove duplicate rows in the rectangle, comparing the given key columns.
- removeExternalLink(int) - Method in class io.keikai.axyra.sheets.Workbook
-
Removes the external workbook reference at
index(0-based, inWorkbook.externalLinks()order): drops both the descriptor and the preservedexternalLinkpart so it is not re-emitted on save. - removeFilterField(int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes the
position-th report-filter field. - removeFormControl(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the form control at
controlIndex(its position inSheet.formControls()); returns whether it existed. - removeHeaderFooterPicture(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the header/footer picture in
section; returns whether one existed. - removeHyperlink() - Method in class io.keikai.axyra.sheets.Cell
-
Remove any hyperlink.
- removeName(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Remove all defined names with the given name; returns whether any matched.
- removeNamedStyle(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Delete a named cell style.
- removeOleObject(int) - Method in class io.keikai.axyra.sheets.Workbook
-
Remove the embedded OLE object at
index; returns whether it existed. - removePicture(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the picture at
pictureIndex(0-based, the same index used bySheet.pictureData(int)); returns whether it existed. - removeProtectedRange(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Removes the allow-edit-range
name; returns whether it existed. - removeRowField(int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes the
position-th row field (0-based nesting order). - removeShape(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the shape at
shapeIndex(0-based, the same index used bySheet.shapeType(int)); returns whether it existed. - removeTable(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the table with the given name; returns whether any matched.
- removeThreadedComment(String) - Method in class io.keikai.axyra.sheets.Cell
-
Remove the comment with
id— a root id removes its whole thread, a reply id removes just that reply. - removeValidation(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Remove the data-validation rule at
validationIndex(its position inSheet.validations()); returns whether it existed. - removeWriteProtection() - Method in class io.keikai.axyra.sheets.Workbook
-
Remove the write protection / read-only recommendation.
- renameSheet(int, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Rename the sheet at
indextonewName, rewriting formula references (OldName!A1becomesNewName!A1) and named ranges. - renderChartToPng(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Render the chart at
chartIndexto PNG image bytes at the given pixel size, ornullif the index is out of range. - renderChartToSvg(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Render the chart at
chartIndexto a standalone SVG document at the given pixel size, ornullif the index is out of range. - Renderer - Class in io.keikai.axyra.sheets.io
-
Render workbooks to fixed-layout formats — PDF documents and sheet / range images (PNG, SVG).
- renderPdf(PdfOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render the workbook to PDF bytes honoring
options(page range, sheet subset, fit override, encryption). - renderPdf(Path) - Method in class io.keikai.axyra.sheets.Workbook
-
Render the whole workbook to a PDF file.
- renderPdf(Path, PdfOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render the workbook to a PDF file honoring
options. - renderRangeImage(int, String, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render an A1 range of a sheet to the given raster format.
- renderRangePng(int, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render an A1 range (e.g.
- renderRangeSvg(int, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render an A1 range of a sheet to SVG bytes (see
Workbook.renderRangePng(int, java.lang.String, io.keikai.axyra.sheets.io.ImageOptions)). - renderSheetImage(int, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render one sheet to the given raster format:
"png","jpeg","gif","bmp"or"tiff". - renderSheetPng(int, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render one sheet (the first page of its print layout) to PNG bytes.
- renderSheetSvg(int, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Render one sheet (the first page of its print layout) to SVG bytes.
- replaceAll(String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Replace text in all matching cells; returns the number replaced.
- replaceAll(String, String, boolean, boolean, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Replace with options.
- replaceAll(String, String, boolean, boolean, boolean, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet
-
Sheet.replaceAll(String, String, FindFormat)with the full option set. - replaceAll(String, String, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet
-
Replace restricted to cells whose resolved style matches
format— seeFindFormatfor the matching semantics. - replaceAllRegex(String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Replace every match of the regular expression
pattern(case-insensitive) withreplacement, which may reference capture groups ("$1","${name}"). - replaceAllRegex(String, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Sheet.replaceAllRegex(String, String)with explicit case sensitivity. - replaceChart(int, Chart) - Method in class io.keikai.axyra.sheets.Sheet
-
Apply
chart's spec onto the chart already atchartIndex, in place, keeping its position inSheet.charts(). - replies() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns the value of the
repliesrecord component. - REQUIRED - Enum constant in enum class io.keikai.axyra.sheets.LicenseMode
-
Throw
AxyraExceptioninstead: for production code, where a bad key should stop the job before it writes a single marked file. - resizeTable(String, Range) - Method in class io.keikai.axyra.sheets.Sheet
-
Resize the named table to
newRange(Excel's Table Design > Resize Table). - resolved() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns the value of the
resolvedrecord component. - reverse() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
Whether an icon set draws its icons in reversed order.
- reverse(boolean) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Draw the icon set in reversed order.
- revision() - Method in class io.keikai.axyra.sheets.Workbook
-
The revision number (
cp:revision), ornull. - rgb(int, int, int) - Static method in class io.keikai.axyra.sheets.style.Color
-
Opaque color from 8-bit r/g/b.
- rgb(Theme.Slot) - Method in class io.keikai.axyra.sheets.style.Theme
-
The slot color as a
Color, or null when it is a system token / unset. - richRunCount() - Method in class io.keikai.axyra.sheets.Cell
-
Number of rich-text runs on this cell (0 if it is not rich text).
- richText() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's rich (multi-run) text with per-run formatting, or
nullif the cell is not rich text. - RichText - Class in io.keikai.axyra.sheets.content
-
Rich (multi-run) cell text — a sequence of runs, each with its own optional font overrides (bold, italic, underline, strike, name, size, color).
- RichText.Builder - Class in io.keikai.axyra.sheets.content
-
Fluent builder for a rich-text value.
- RichText.Run - Class in io.keikai.axyra.sheets.content
-
Per-run font overrides.
- RichText.RunInfo - Record Class in io.keikai.axyra.sheets.content
-
A read-back view of one run: its text plus the font overrides it carries.
- right() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns the value of the
rightrecord component. - RIGHT - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition
- RIGHT - Enum constant in enum class io.keikai.axyra.sheets.Shift
- RIGHT - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign
- RIGHT - Enum constant in enum class io.keikai.axyra.sheets.style.Side
- rightToLeft() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether this sheet is displayed right-to-left.
- rootElement() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns the value of the
rootElementrecord component. - rotation() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
rotationrecord component. - row() - Method in class io.keikai.axyra.sheets.Cell
-
0-based row.
- row() - Method in record class io.keikai.axyra.sheets.CellRef
-
Returns the value of the
rowrecord component. - row() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
rowrecord component. - row() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
rowrecord component. - row(int) - Method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Begins row
index(0-based). - rowCount() - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
Number of rows.
- rowCount() - Method in class io.keikai.axyra.sheets.Range
-
Number of rows in the rectangle.
- rowFields() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The row-axis fields, in nesting order.
- rowHeight(int) - Method in class io.keikai.axyra.sheets.Sheet
-
A row's height in points.
- rowOutlineLevel(int) - Method in class io.keikai.axyra.sheets.Sheet
-
A row's outline level (0 = not grouped).
- rowPageBreaks() - Method in class io.keikai.axyra.sheets.Sheet
-
The manual horizontal page-break rows.
- rows() - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
Returns the value of the
rowsrecord component. - rowStyle(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The style applied to the entire row — the default for cells in the row that carry no cell-level style.
- rowStyleId(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The interned style id applied to the entire row (
<row s="N" customFormat="1">), or0when the row carries no row-level style. - run() - Static method in class io.keikai.axyra.sheets.content.RichText
-
A per-run style spec (see
RichText.Run). - run(int) - Method in class io.keikai.axyra.sheets.content.RichText
-
The run at
indexas a typed view. - run(String) - Method in class io.keikai.axyra.sheets.content.RichText.Builder
-
A plain (unstyled) run.
- run(String, RichText.Run) - Method in class io.keikai.axyra.sheets.content.RichText.Builder
-
A run with the given style (
null= plain). - Run() - Constructor for class io.keikai.axyra.sheets.content.RichText.Run
- runCount() - Method in class io.keikai.axyra.sheets.content.RichText
-
Number of runs.
- RunInfo(String, String, Double, boolean, boolean, boolean, boolean, Color) - Constructor for record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Creates an instance of a
RunInforecord class. - RUNNING_TOTAL - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Cumulative sum along the base field in display order.
- runs() - Method in class io.keikai.axyra.sheets.content.RichText
-
Every run as a typed view, in order.
S
- save(OutputStream, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Serialize to
formatand write the bytes toout. - save(Path) - Method in class io.keikai.axyra.sheets.Workbook
-
Write the workbook to a file; the format comes from the extension.
- save(Path, SaveOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Write with export options (XLSX honors them; other formats ignore them).
- saveBytes(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Serialize the workbook to the given
format(an extension token, with or without the leading dot) and return the bytes — for writing to any sink without touching the filesystem. - saveCsv(Path, CsvOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Write one sheet as delimited text, choosing which sheet, the separator, and whether numbers are written as display text (what
save("x.csv")and Excel write) or as stored values for a data feed. - saveEncrypted(Path, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Write the workbook with
passwordas its password to open. - saveHtml(Path, HtmlOptions) - Method in class io.keikai.axyra.sheets.Workbook
-
Write the workbook as HTML in the shape
optionsasks for — the package (a document plus its sidecar directory) or one self-contained document. - SaveOptions - Class in io.keikai.axyra.sheets.io
-
Export options for
Workbook.save(path, options). - SaveOptions() - Constructor for class io.keikai.axyra.sheets.io.SaveOptions
- scale() - Method in class io.keikai.axyra.sheets.io.ImageOptions
-
Zoom over the 96-DPI base (1.0 = 96 DPI).
- scale(double) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
-
Zoom over the 96-DPI base (1.0 = 96 DPI, 2.0 = 192 DPI).
- scaleCrop() - Method in class io.keikai.axyra.sheets.Workbook
-
The
ScaleCropflag ofdocProps/app.xml, ornullwhen the workbook records none. - scatter() - Static method in class io.keikai.axyra.sheets.content.Chart
- scenarioCount() - Method in class io.keikai.axyra.sheets.Sheet
- scenarioName(int) - Method in class io.keikai.axyra.sheets.Sheet
- scenarios() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
scenariosrecord component. - scenarios(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
-
Allow editing what-if scenarios.
- schema() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns the value of the
schemarecord component. - schemaId() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns the value of the
schemaIdrecord component. - SCROLL_BAR - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- scrollBar(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A scroll bar; configure
.range(min, max)/.value(v). - scrollColumn() - Method in class io.keikai.axyra.sheets.Sheet
-
The first visible column of an unfrozen view; see
Sheet.scrollRow(). - scrollRow() - Method in class io.keikai.axyra.sheets.Sheet
-
The first visible row of an unfrozen view — the row component of
<sheetView topLeftCell>(ECMA-376 Part 1 §18.3.1.87), i.e. - second() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
secondrecord component. - second(int, int, int, int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem
-
Select a single second.
- secondaryAxis(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Plot the most recently added series against a secondary value axis (
on) — drawn on the right of the plot with its own scale, the way a ratio or a percentage is shown next to amounts — or against the primary one. - SECONDS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- selectedIndex() - Method in class io.keikai.axyra.sheets.content.FormControl
-
1-based selected item index of a combo / list box; 0 = no selection.
- selectedIndex(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
-
1-based selected item index of a combo / list box.
- selectionSqref() - Method in class io.keikai.axyra.sheets.Sheet
-
The selected ranges of the sheet view (
<selection sqref>) as a space-separated list, ornullwhen nothing was selected. - selectLockedCells() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
selectLockedCellsrecord component. - selectLockedCells(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- selectUnlockedCells() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
selectUnlockedCellsrecord component. - selectUnlockedCells(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- series(String, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Add a data series referencing a values range.
- series(String, String, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Add a data series with a categories (labels) range.
- series(String, String, String, Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Add a data series with an explicit fill color.
- seriesBubbleSizes(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The series' bubble-size (Z) range reference (
<c:bubbleSize>), ornullon anything but a bubble chart that declares one. - seriesBubbleSizes(int) - Method in class io.keikai.axyra.sheets.content.Chart
-
The bubble-size (Z) reference of series
seriesIndex, ornullwhen it has none. - seriesCategories(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The series categories range reference, or
null. - seriesColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
seriesColorrecord component. - seriesColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
seriesColorrecord component. - seriesCount() - Method in class io.keikai.axyra.sheets.ChartView
- seriesCount() - Method in class io.keikai.axyra.sheets.content.Chart
- seriesDataLabels(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The series-level data labels (
<c:dLbls>), ornullwhen the series carries none. - seriesFill(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The explicit per-series fill color, or
nullwhen the series uses the theme default. - seriesHiddenPointLabels(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The point indices whose label the chart hides while the rest of the series keeps its own (
<c:dLbl><c:delete val="1"/>). - seriesInSecondPlot(int) - Method in class io.keikai.axyra.sheets.ChartView
-
Which of a series' points a pie-of-pie / bar-of-pie draws in its second plot, one flag per cached value.
- seriesName() - Static method in record class io.keikai.axyra.sheets.content.DataLabels
-
Labels showing the series name.
- seriesName(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The series name reference/text, or
null. - seriesPointExplosions(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The explicit per-slice explosion overrides of a series (pie/doughnut), keyed by 0-based point index (ECMA-376 §21.2.2.62
dPt/explosion, percent of radius). - seriesPointFills(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The explicit per-data-point (per-slice / per-bar) fill overrides of a series, keyed by 0-based point index (ECMA-376 §21.2.2.52 dPt).
- seriesPointLabels(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The captions of the series' per-point labels (
<c:dLbl>), keyed by the point index each names. - seriesSecondaryAxis(int) - Method in class io.keikai.axyra.sheets.ChartView
-
Whether this series is plotted against the secondary value axis of a combination chart;
falseon an ordinary chart. - seriesSecondaryAxis(int) - Method in class io.keikai.axyra.sheets.content.Chart
-
Whether series
seriesIndexis plotted against the secondary value axis of a combo chart;falsefor an index past the end. - seriesType(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The plot group this series is drawn in on a combination chart — one
<c:plotArea>holding several<c:*Chart>groups, the bar-plus-line shape Excel calls a combo (ECMA-376 Part 1 §21.2.2.145):"column","line","area","bar","scatter", or the type of the group an imported combo put it in ("radar","bubble","stock"). - seriesType(int) - Method in class io.keikai.axyra.sheets.content.Chart
-
The plot type of series
seriesIndexin a combo chart —"column","line"or"area"— ornullwhen the series carries none (a combo series without one is drawn as a column). - seriesType(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
The plot type of the most recently added series in a combo chart — the plot group it is drawn in (ECMA-376 Part 1 §21.2.2.145: a
<c:barChart>,<c:lineChart>,<c:areaChart>or<c:scatterChart>under the one<c:plotArea>). - seriesValueCache(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The series' cached point values (
<c:numCache>), in point order. - seriesValues(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The series values range reference (e.g.
- setActiveCell(String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Moves the cursor and the selection.
- setActiveSheet(int) - Method in class io.keikai.axyra.sheets.Workbook
-
Activate the sheet at
index; out-of-range throwsAxyraException. - setAnchor(int, int, int, int) - Method in class io.keikai.axyra.sheets.ChartView
-
Move / resize the chart's two-cell anchor.
- setApplication(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the
Applicationname written todocProps/app.xml. - setAppVersion(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
AppVersion(Excel's form isMM.mmmm, e.g. - setArrayFormula(String) - Method in class io.keikai.axyra.sheets.Range
-
Set a CSE (Ctrl+Shift+Enter) array formula over the whole rectangle, anchored at the top-left cell.
- setAuthor(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the author (OOXML
creator). - setAutoFilter(Range) - Method in class io.keikai.axyra.sheets.Sheet
-
Define an auto-filter over
range(its top row is the filter header). - setAutoTitle(boolean) - Method in class io.keikai.axyra.sheets.ChartView
-
Mark (or clear) the title as an Excel "auto" title.
- setBackgroundImage(byte[], String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the full-sheet background image.
- setBaseColumnWidth(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the
baseColWidthbasis in characters. - setBlank(int, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a styled blank at
column— worth writing only for the style. - setBoolean(int, boolean) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a boolean at
column. - setBoolean(int, boolean, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a boolean with a style at
column. - setCalcMode(CalcMode) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the workbook calculation mode.
- setCategory(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
cp:category. - setCategoryAxisTitle(String) - Method in class io.keikai.axyra.sheets.ChartView
-
Set (or clear with
null) the category-axis title. - setCategoryAxisVisible(boolean) - Method in class io.keikai.axyra.sheets.ChartView
-
Show or hide the category (X) axis.
- setColumnColorFilter(int, boolean, Color) - Method in class io.keikai.axyra.sheets.Sheet
-
Filter a column by cell fill color (or font color when
cellColoris false); only rows whose cell matchescolorsurvive. - setColumnCustomFilter(int, FilterOperator, String) - Method in class io.keikai.axyra.sheets.Sheet
-
A single-condition custom filter on a column.
- setColumnCustomFilter(int, FilterOperator, String, FilterOperator, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
A two-condition custom filter;
andJoin= true joins with AND, false OR. - setColumnDateFilter(int, boolean, DateGroupItem...) - Method in class io.keikai.axyra.sheets.Sheet
-
A date grouping filter that optionally keeps blank cells too.
- setColumnDateFilter(int, DateGroupItem...) - Method in class io.keikai.axyra.sheets.Sheet
-
A date grouping filter (ECMA-376 §18.3.2.4) on a column: a date cell survives
Sheet.applyAutoFilter()if it falls inside any ofitems. - setColumnDynamicFilter(int, DynamicFilterType) - Method in class io.keikai.axyra.sheets.Sheet
-
A dynamic filter (ECMA-376 §18.3.2.5) on a column: today / thisWeek / lastMonth / yearToDate / aboveAverage / ….
- setColumnFieldCaption(int, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Renames the
position-th column field; seePivotTableView.setRowFieldCaption(int, java.lang.String). - setColumnFieldSubtotals(int, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Toggles subtotals for the
position-th column field. - setColumnFilter(int, String...) - Method in class io.keikai.axyra.sheets.Sheet
-
Restrict a column (0-based, relative to the auto-filter range start) to the given values.
- setColumnGroupCollapsed(int, int, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Collapse or expand a grouped column range — the column analogue.
- setColumnHidden(int, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show or hide a column.
- setColumnsOutlineLevel(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the outline level
0..7on columns[startCol, endCol]. - setColumnStyle(int, CellStyle) - Method in class io.keikai.axyra.sheets.Sheet
-
Apply a style to the entire column: cells in the column without a cell-level style render with it, exactly like Excel's "format whole column".
- setColumnTop10Filter(int, boolean, double, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
A Top-10 filter (ECMA-376 §18.3.2.10) on a column: keep the top
valueitems — orvaluepercent of the items whenpercentis true;bottomflips to the smallest values. - setColumnWidth(int, double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set a column's width in Excel character units.
- setComment(Comment) - Method in class io.keikai.axyra.sheets.Cell
- setComment(String, String) - Method in class io.keikai.axyra.sheets.Cell
-
Attach or replace the cell's comment.
- setCommentLayout(double, double, boolean) - Method in class io.keikai.axyra.sheets.Cell
-
Set the note-shape layout of this cell's existing comment: box size in points and whether the note stays visible without hovering (Excel's "Show Comment").
- setComments(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the comments/description (OOXML
description). - setCompany(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
Company. - setConnectionCommand(String, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the command text (e.g.
- setConnectionString(String, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the connection string of the named connection; returns whether a connection matched.
- setContentStatus(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
cp:contentStatus. - setCreated(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
dcterms:created(a W3CDTF timestamp). - setCustomProperty(String, boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Set (or replace) the boolean-typed custom document property
name. - setCustomProperty(String, double) - Method in class io.keikai.axyra.sheets.Workbook
-
Set (or replace) the number-typed custom document property
name. - setCustomProperty(String, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set (or replace) the text-typed custom document property
name. - setCustomProperty(String, LocalDate) - Method in class io.keikai.axyra.sheets.Workbook
-
Set (or replace) the date-typed custom document property
name. - setCustomTableStyles(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Install custom table-style definitions produced by
Workbook.customTableStyles(). - setDate(int, LocalDate, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a date at
column. - setDate(LocalDate) - Method in class io.keikai.axyra.sheets.Cell
-
Sets a date: the value becomes the Excel serial for
date(honoring the workbook's 1900/1904 date system), and ayyyy-mm-ddnumber format is applied when the cell still hasGeneral(an existing format is kept). - setDate1904(boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Switch the workbook date system.
- setDateTime(int, LocalDateTime, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a date-time at
column; the time becomes the fractional part. - setDateTime(LocalDateTime) - Method in class io.keikai.axyra.sheets.Cell
-
Sets a date-time: the serial carries the day fraction (second precision) and a
yyyy-mm-dd hh:mm:ssformat is applied when the cell still hasGeneral. - setDefaultColumnWidth(double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the explicit default column width in character units.
- setDefaultFont(CellStyle) - Method in class io.keikai.axyra.sheets.Workbook
-
Replace the workbook default ("Normal") font with the font attributes of
style(name, size, color, bold, …); its non-font attributes are ignored. - setDefaultRowHeight(double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the default row height in points.
- setDefaultRowHeightCustom(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the
customHeightflag on the default row height. - setDifferentFirst(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the
differentFirstflag. - setDifferentOddEven(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the
differentOddEvenflag. - setDocSecurity(Integer) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
DocSecurity(nullclears it). - setDocumentVersion(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
cp:version;nullclears it. - setDyDescent(double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear, with
0) the sheet-levelx14ac:dyDescenthint. - setErrorBars(int, ErrorBars) - Method in class io.keikai.axyra.sheets.ChartView
-
Set (or remove with
null) the error bars of a series. - setEvenFooter(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the even-page footer text;
nullclears it. - setEvenHeader(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the even-page header text;
nullclears it. - setExternalLinkSource(int, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Repoints the external workbook reference at
indexto a new source path (the relationship target written intoexternalLinkrels on save). - setFilterFieldCaption(int, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Renames the
position-th report-filter field; seePivotTableView.setRowFieldCaption(int, java.lang.String). - setFirstFooter(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the first-page footer text;
nullclears it. - setFirstHeader(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the first-page header text;
nullclears it. - setFirstPageNumber(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The number printed on the first page;
0restores the workbook's own numbering (ECMA-376 §18.3.1.63firstPageNumbertogether withuseFirstPageNumber). - setFooter(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the page footer text;
nullclears it. - setFormula(int, String) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a formula at
column, without the leading=. - setFormula(int, String, double, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a formula plus the cached result Excel shows before recalculating.
- setFormula(int, String, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a formula with a style at
column. - setFormula(String) - Method in class io.keikai.axyra.sheets.Cell
-
Set the cell's formula (empty string clears it).
- setFormula(String) - Method in class io.keikai.axyra.sheets.Range
-
Fill the rectangle with one formula, as Excel's Ctrl+Enter does: the formula is written for the top-left cell, and every other cell gets it with its relative references shifted by its offset from there (
A1*B1onC1:C3becomesA2*B2in C2 andA3*B3in C3);$-anchored references stay put. - setFormulaLocalized(String, String) - Method in class io.keikai.axyra.sheets.Cell
-
Set the cell's formula written in a locale's display form — translated function names (e.g.
- setFormulas(String[][]) - Method in class io.keikai.axyra.sheets.Range
-
Write per-cell formulas (
rowCount() x colCount()). - setGapWidth(int) - Method in class io.keikai.axyra.sheets.ChartView
- setGrandTotalCaption(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sets the grand-total caption (ECMA-376 Part 1 §18.10.1.46); pass
nullto restore the locale default ("Grand Total"). - setGrandTotals(boolean, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Toggles the grand-total row (bottom) and grand-total column (right).
- setHeader(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the page header text;
nullclears it. - setHeaderFooterPicture(String, byte[], String, double, double) - Method in class io.keikai.axyra.sheets.Sheet
-
Place a picture in a header/footer section (ECMA-376 §18.3.1.32
legacyDrawingHF). - setHoleSize(int) - Method in class io.keikai.axyra.sheets.ChartView
- setHyperlink(Hyperlink) - Method in class io.keikai.axyra.sheets.Cell
-
Attach or replace the cell's hyperlink.
- setHyperlink(String) - Method in class io.keikai.axyra.sheets.Cell
-
Attach or replace a URL hyperlink.
- setHyperlinkBase(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
HyperlinkBase. - setHyperlinksChanged(Boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
HyperlinksChanged(nullclears it). - setItemFilter(String, String...) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Restricts
field's manual item filter tovisibleItems— Excel's filter dropdown with only those entries checked (ECMA-376 Part 1 §18.10.1.45item@h). - setIterativeCalc(boolean, int, double) - Method in class io.keikai.axyra.sheets.Workbook
-
Enable/disable iterative (circular-reference) calculation.
- setKeywords(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the document keywords.
- setLabelFilter(String, PivotLabelFilterType, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sets the caption (label) filter of the row/column field
field— Excel's "Label Filters" menu (ECMA-376 Part 1 §18.10.1.32). - setLandscape(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Set landscape (true) or portrait (false) orientation.
- setLanguage(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
dc:language(an RFC 5646 language tag, e.g. - setLastModifiedBy(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
cp:lastModifiedBy. - setLastPrinted(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
cp:lastPrinted(a W3CDTF timestamp, e.g. - setLayout(PivotLayout) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sets the report layout (ECMA-376 Part 1 §18.10.1.73; BOR-PV-001).
- setLegend(LegendPosition) - Method in class io.keikai.axyra.sheets.ChartView
- setLegendVisible(boolean) - Method in class io.keikai.axyra.sheets.ChartView
-
Show or hide the legend without changing its position.
- setLicense(byte[]) - Static method in class io.keikai.axyra.sheets.Workbook
-
Install a license token (raw bytes of the
payload.signatureenvelope) and return the resultingLicenseInfo. - setLicense(byte[], LicenseMode) - Static method in class io.keikai.axyra.sheets.Workbook
-
Install a license token, choosing what happens when it is not in force.
- setLicense(InputStream) - Static method in class io.keikai.axyra.sheets.Workbook
-
Install a license token by reading all of
in. - setLicense(String) - Static method in class io.keikai.axyra.sheets.Workbook
-
Install a license token from its text form (UTF-8).
- setLicense(String, LicenseMode) - Static method in class io.keikai.axyra.sheets.Workbook
-
Install a license token from its text form (UTF-8), choosing what happens when it is not in force.
- setLinksUpToDate(Boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
LinksUpToDate(nullclears it). - setLocale(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the workbook display locale (
"de-DE","ja-JP", ...). - setManager(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
Manager. - setModified(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
dcterms:modified(a W3CDTF timestamp). - setNumber(int, double) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a number at
column. - setNumber(int, double, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets a number with a style at
column. - setNumber(int, int, double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set a single numeric cell (0-based).
- setNumbers(double[]) - Method in class io.keikai.axyra.sheets.Range
-
Write the rectangle from a row-major
double[]of lengthrowCount() * colCount(). - setOleObjectData(int, byte[]) - Method in class io.keikai.axyra.sheets.Workbook
-
Replace the embedded OLE object's bytes in place; returns whether the index existed.
- setOverlap(int) - Method in class io.keikai.axyra.sheets.ChartView
- setPageFilter(String, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Selects a single item on the report-filter (page) field
field— Excel's single-select page filter dropdown (ECMA-376 Part 1 §18.10.1.62pageField@item). - setPageMargins(double, double, double, double, double, double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the six page margins in inches (Excel semantics, ECMA-376 §18.3.1.62 pageMargins).
- setPageMargins(PageMargins) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the page margins from a
PageMarginsvalue — the symmetric counterpart ofSheet.pageMargins(), so a read–modify–write round-trip needs no unpacking into six positional arguments. - setPageOrderOverThenDown(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Whether pages print over-then-down instead of down-then-over (ECMA-376 §18.3.1.63
pageOrder). - setPageScale(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the print scale percentage (disables fit-to-page).
- setPaperSize(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the paper size from its ECMA-376 numeric code (§18.18.50 ST_PaperSize): 1 = Letter, 5 = Legal, 8 = A3, 9 = A4, 11 = A5, ….
- setPictureLinkTarget(int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Repoints a linked picture at a new source.
- setPrintArea(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the print area (A1 range), or
nullto clear it. - setPrintBlackAndWhite(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Print without colour (ECMA-376 §18.3.1.63
blackAndWhite). - setPrintComments(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Where cell comments print: 0 not at all, 1 as displayed on the sheet, 2 collected at the end (ECMA-376 §18.3.1.63
cellComments). - setPrintDraft(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Print in draft quality, omitting graphics (ECMA-376 §18.3.1.63
draft). - setPrintErrors(int) - Method in class io.keikai.axyra.sheets.Sheet
-
How error cells print: 0 as displayed, 1 blank, 2 as a dash, 3 as
#N/A(ECMA-376 §18.3.1.70printOptions/errors). - setPrintGridlines(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Whether gridlines are printed.
- setPrintHeadings(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Whether row and column headings are printed (ECMA-376 §18.3.1.70 printOptions/headings).
- setPrintHorizontallyCentered(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Center printed output horizontally on the page.
- setPrintResolution(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The printer resolution in DPI, applied to both axes.
- setPrintTitleColumns(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Columns repeated at the left of every printed page (e.g.
- setPrintTitleRows(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Rows repeated at the top of every printed page (e.g.
- setPrintVerticallyCentered(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Center printed output vertically on the page.
- setRevision(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
cp:revision. - setRichComment(String, CommentRun...) - Method in class io.keikai.axyra.sheets.Cell
-
Attach or replace a RICH-TEXT comment (note): each
CommentRuncarries per-run font overrides (ECMA-376 Part 1 §18.7.7). - setRichText(RichText) - Method in class io.keikai.axyra.sheets.Cell
-
Set this cell to rich (multi-run) formatted text.
- setRightToLeft(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Set this sheet's right-to-left display flag.
- setRowFieldCaption(int, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Renames the
position-th row field for display (ECMA-376 Part 1 §18.10.1.69pivotField@name— Excel writes this attribute when a placed field is renamed in the pivot UI); passnullto restore the source column name. - setRowFieldSubtotals(int, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Toggles subtotals for the
position-th row field. - setRowGroupCollapsed(int, int, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Collapse or expand a grouped row range (Excel's outline +/- button): hides/shows the detail rows and stamps the
collapsedflag on the group's summary row (below the group when the sheet summarizes below). - setRowHeight(int, double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set a row's height in points.
- setRowHidden(int, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show or hide a row.
- setRowsOutlineLevel(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the outline level
0..7on rows[startRow, endRow](0 ungroups). - setRowStyle(int, CellStyle) - Method in class io.keikai.axyra.sheets.Sheet
-
Apply a style to the entire row: cells in the row without a cell-level style render with it, exactly like Excel's "format whole row".
- setScaleCrop(Boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
ScaleCrop(nullclears it). - setScrollPosition(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Scrolls an unfrozen view so that
(row, column)sits at the top left. - setSeries(int, String, String, String) - Method in class io.keikai.axyra.sheets.ChartView
-
Replace the name / values / categories references of one series.
- setSeriesDataLabels(int, DataLabels) - Method in class io.keikai.axyra.sheets.ChartView
-
Set (or remove with
null) the data labels of a series. - setSeriesFill(int, Color) - Method in class io.keikai.axyra.sheets.ChartView
-
Set (or clear with
null) the explicit fill color of one series. - setSeriesSecondaryAxis(int, boolean) - Method in class io.keikai.axyra.sheets.ChartView
-
Plot one series of a combo chart against the secondary value axis (
on) or the primary one — the counterpart ofChart.Builder.secondaryAxis(boolean). - setSeriesType(int, String) - Method in class io.keikai.axyra.sheets.ChartView
-
Move one series of a combo chart into the plot group of another type — the counterpart of
Chart.Builder.seriesType(String). - setShapeAltText(int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear with
null) the shape's alternative text. - setShapeFillColor(int, Color) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear with
null) the shape's solid fill color. - setShapeFlip(int, boolean, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the shape's horizontal / vertical flip flags.
- setShapeHyperlink(int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear with
null) the shape's hyperlink URL. - setShapeLineColor(int, Color) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear with
null) the shape's line (outline) color. - setShapeName(int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Renames a shape.
- setShapeRotation(int, double) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the shape's rotation in degrees (clockwise).
- setShapeStyleXml(int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear with
null) the shape's<xdr:style>theme style-matrix reference from raw inner XML (thelnRef/fillRef/effectRef/fontRefchildren, without the enclosing<xdr:style>tags). - setShapeText(int, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Set (or clear with
null) the shape's text body. - setSharedDoc(Boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Set
SharedDoc(nullclears it). - setShowDataAs(int, PivotShowDataAsType) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sets the Show-Values-As mode of the
position-th values-area field for the base-less modes (percent of total/row/column, running total, ranks, index). - setShowDataAs(int, PivotShowDataAsType, String, String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sets the Show-Values-As mode with base references:
baseFieldnames a row/column-placed field,baseItemone of its item labels. - setShowDataLabels(boolean) - Method in class io.keikai.axyra.sheets.ChartView
- setShowFormulas(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Turn the show-formulas display mode on or off.
- setShowGridlines(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show or hide the sheet view's gridlines.
- setShowRowColHeaders(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show or hide the sheet view's row/column headers.
- setShowZeros(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show zeros as
0, or blank the cells that hold them. - setSlicerSelection(String, String...) - Method in class io.keikai.axyra.sheets.Workbook
-
Replace a slicer's item selection (clicking slicer buttons): only rows whose value is among
selectedValuespass the linked pivot's nextrefresh(). - setSlicerStyle(String, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set a slicer's style by name — a built-in
SlicerStyleLight1..6/SlicerStyleDark1..6/SlicerStyleOther1..2, or a custom slicer style. - setSourceSheetId(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Renumbers the sheet's
<sheet sheetId>. - setSparklineStyle(int, SparklineStyle) - Method in class io.keikai.axyra.sheets.Sheet
-
Replaces the style (colors + point-highlight flags) of the
group-th sparkline group — the styling counterpart ofSheet.addSparkline(java.lang.String, java.lang.String, java.lang.String); read the current state back viaSheet.sparklines()andSparklineGroup.style(). - setStyle(PivotStyle) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Applies a named pivot style + banding flags (ECMA-376 Part 1 §18.10.1.88
pivotTableStyleInfo); Excel renders the bands on open. - setStyle(CellStyle) - Method in class io.keikai.axyra.sheets.Cell
-
Apply a style to this cell (the engine dedups identical styles).
- setStyle(CellStyle) - Method in class io.keikai.axyra.sheets.Range
-
Apply a style to every cell in the rectangle.
- setStyle(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Applies
namewith Excel's Design-tab default flags. - setSubject(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the document subject.
- setSummaryBelow(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Sets whether row-group summaries sit below their detail rows.
- setSummaryRight(boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Sets whether column-group summaries sit right of their detail columns.
- setTabColor(Color) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the sheet tab color;
nullclears it. - setTableColumnTotals(String, String, TotalsRowFunction) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the totals-row aggregation of one column of the named table (ECMA-376 §18.18.92 ST_TotalsRowFunction).
- setTableColumnTotals(String, String, TotalsRowFunction, String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Full form:
functionmay benull(label only);labelbecomestotalsRowLabel;formulais required forTotalsRowFunction.CUSTOMand ignored otherwise. - setTableHeaderRow(String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show or hide the named table's header row (ECMA-376 §18.5.1.2
headerRowCount: 1 = header present, 0 = headerless). - setTableStyle(String, TableStyleInfo) - Method in class io.keikai.axyra.sheets.Sheet
-
Replace the style binding (ECMA-376 §18.5.1.20 tableStyleInfo) of the named table; returns whether the table matched.
- setTableTotalsRow(String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Show or hide the named table's totals row (ECMA-376 §18.5.1.2
totalsRowCount). - setText(int, String) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets text at
column. - setText(int, String, int) - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Sets text with a style at
column. - setTheme(Theme) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the workbook theme (color scheme + major/minor fonts).
- setThreadedCommentResolved(String, boolean) - Method in class io.keikai.axyra.sheets.Cell
-
Resolve / reopen the thread containing
id; returns whether it matched a comment on this sheet. - setThreeD(boolean) - Method in class io.keikai.axyra.sheets.ChartView
- setTimelineRange(String, LocalDate, LocalDate) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the selected date range of the named timeline — the range its bound pivot is filtered to on the next
pivotrefresh(). - setTitle(String) - Method in class io.keikai.axyra.sheets.ChartView
-
Set (or clear with
null) the chart title. - setTitle(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Set the document title (
nullclears it). - setTopNFilter(String, int, int, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Keeps only the top (or bottom)
countitems of the row/column fieldfield, ranked by their aggregate of thedataField-th values-area entry — Excel's "Top 10" value filter. - setTopPercentFilter(String, int, double, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Percent mode: keeps the top (or bottom) items whose aggregates accumulate to
percentof the field's total. - setValidation(Validation) - Method in class io.keikai.axyra.sheets.Range
-
Attach a data-validation rule to this rectangle.
- setValue(CellValue) - Method in class io.keikai.axyra.sheets.Cell
-
Set the cell's value, clearing any formula.
- setValueAxisGridlines(boolean) - Method in class io.keikai.axyra.sheets.ChartView
-
Show or hide the value (Y) axis' major gridlines.
- setValueAxisScale(double, double) - Method in class io.keikai.axyra.sheets.ChartView
- setValueAxisTitle(String) - Method in class io.keikai.axyra.sheets.ChartView
-
Set (or clear with
null) the value-axis title. - setValueAxisVisible(boolean) - Method in class io.keikai.axyra.sheets.ChartView
-
Show or hide the value (Y) axis.
- setValueFilter(String, int, PivotValueFilterType, double) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sets a single-threshold value filter on the row/column field
field: each item's aggregate of thedataField-th values-area entry is compared withtype; failing items (and items with no numeric aggregate) are hidden on the nextPivotTableView.refresh(). - setValueFilterBetween(String, int, double, double) - Method in class io.keikai.axyra.sheets.PivotTableView
-
PivotValueFilterType.BETWEENform:low <= aggregate <= high. - setValues(CellValue[][]) - Method in class io.keikai.axyra.sheets.Range
-
Write every cell from a
CellValue[][](row-major,rowCount() x colCount()). - setViewType(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Sets the view the tab opens in.
- setVisibility(Visibility) - Method in class io.keikai.axyra.sheets.Sheet
-
Set this sheet's visibility.
- setWriteProtection(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Write-protect the workbook with a modify password (
<fileSharing>— ECMA-376 Part 1 §18.2.12): Excel prompts for the password on open and offers read-only otherwise. - setWriteProtection(String, String, boolean) - Method in class io.keikai.axyra.sheets.Workbook
-
Write-protect the workbook:
passwordgates editing (null = none),userNamerecords who reserved the file, andreadOnlyRecommendedshows the open-read-only prompt. - setZoom(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Set the sheet view zoom percentage.
- shapeAltText(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The shape's alternative text (
cNvPr/@descr), ornull. - shapeAnchor(int) - Method in class io.keikai.axyra.sheets.Sheet
-
{fromRow, fromCol, toRow, toCol}, or an empty array when out of range. - shapeCount() - Method in class io.keikai.axyra.sheets.Sheet
-
Number of shapes on this sheet.
- shapeFillColor(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The shape's solid fill color, or
null(no / non-RGB fill). - shapeFlip(int) - Method in class io.keikai.axyra.sheets.Sheet
-
{flipHorizontal, flipVertical}, or an empty array when out of range. - shapeHyperlink(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The hyperlink URL attached to the shape via DrawingML
hlinkClick, ornullwhen the shape has no hyperlink. - shapeLineColor(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The shape's line (outline) color, or
null. - shapeName(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The shape's drawing name (
<xdr:cNvPr name>, ECMA-376 Part 1 §20.5.2.16) — what Excel shows in the Name Box and what a macro uses to address the shape. - shapeRotation(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The shape's rotation in degrees (clockwise).
- shapeStyleXml(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The raw inner XML of the shape's
<xdr:style>theme style-matrix reference (thelnRef/fillRef/effectRef/fontRefchildren), ornullwhen the shape has no such block. - shapeText(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The shape's text body, or
null. - shapeType(int) - Method in class io.keikai.axyra.sheets.Sheet
-
The geometry token of the shape at
shapeIndex(e.g. - sharedDoc() - Method in class io.keikai.axyra.sheets.Workbook
-
The
SharedDocflag ofdocProps/app.xml, ornullwhen the workbook records none. - sheet(int) - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
The sheet to write, by 0-based index (default: the active sheet).
- sheet(int) - Method in class io.keikai.axyra.sheets.Workbook
-
The sheet at
index(0-based). - sheet(String) - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
The sheet to write, by name (default: the active sheet).
- sheet(String) - Method in class io.keikai.axyra.sheets.Workbook
-
The sheet with the given name.
- Sheet - Class in io.keikai.axyra.sheets
-
A worksheet — a lightweight
(Workbook, sheetIndex)view. - sheetCount() - Method in class io.keikai.axyra.sheets.Workbook
-
Number of sheets.
- sheetIndex() - Method in record class io.keikai.axyra.sheets.CellRef
-
Returns the value of the
sheetIndexrecord component. - sheetIndex() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
sheetIndexrecord component. - sheetIndex() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
sheetIndexrecord component. - sheetIndex() - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
The sheet index, or -1 for "the active sheet" / a sheet named by
CsvOptions.sheetName(). - sheetIndex() - Method in class io.keikai.axyra.sheets.Range
-
The 0-based index of the sheet this range belongs to.
- sheetName() - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
The sheet name, or
nullwhen not chosen by name. - sheetNames() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns the value of the
sheetNamesrecord component. - sheetNames() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Selected sheet names (unmodifiable), or
null. - sheetNames(String...) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Sheet names to export (case-sensitive; unknown names fail).
- sheetPageCount(int) - Method in class io.keikai.axyra.sheets.Workbook
-
Number of printed pages the sheet paginates to — the valid range for
ImageOptions.Builder.page(int)and the PDF export's page numbering. - SheetProtection - Record Class in io.keikai.axyra.sheets
-
Sheet protection options — the checkboxes of Excel's "Protect Sheet" dialog.
- SheetProtection(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.SheetProtection
-
Creates an instance of a
SheetProtectionrecord class. - SheetProtection.Builder - Class in io.keikai.axyra.sheets
-
Fluent builder; every setter takes
true= allowed. - sheets() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Selected sheet indices (copy), or
nullwhen not restricted. - sheets() - Method in class io.keikai.axyra.sheets.Workbook
-
A snapshot list of all sheet views, in order.
- sheets(int...) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Sheet indices to export (0-based; hidden sheets included when listed).
- sheetScope() - Method in class io.keikai.axyra.sheets.NamedRange
-
The 0-based index of the sheet this name is scoped to, or
-1. - sheetType() - Method in class io.keikai.axyra.sheets.Sheet
-
What kind of tab this is — worksheet, chartsheet, dialog sheet or (international) Excel-4.0 macro sheet.
- SheetType - Enum Class in io.keikai.axyra.sheets
-
What kind of tab a
Sheetis. - Shift - Enum Class in io.keikai.axyra.sheets
-
Direction that surrounding cells move when inserting or deleting a cell range.
- showCaption() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
showCaptionrecord component. - showCategoryName() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
showCategoryNamerecord component. - showColHeaders() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns the value of the
showColHeadersrecord component. - showColStripes() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns the value of the
showColStripesrecord component. - showColumnStripes() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns the value of the
showColumnStripesrecord component. - showDataAs(int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The Show-Values-As state of the
position-th values-area field, or null when the position is out of range. - showDataLabels() - Method in class io.keikai.axyra.sheets.ChartView
- showDataLabels() - Method in class io.keikai.axyra.sheets.content.Chart
-
Whether data labels are shown.
- showDataLabels(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Show/hide data labels on the series.
- showDropdown() - Method in class io.keikai.axyra.sheets.content.Validation
-
Whether a list rule offers its items through an in-cell drop-down arrow.
- showDropdown(boolean) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
-
Whether a list rule shows its in-cell drop-down arrow; shown when not set.
- showEquation() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
showEquationrecord component. - showErrorMessage() - Method in class io.keikai.axyra.sheets.content.Validation
- showErrorMessage(boolean) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
-
Whether a failure raises a message at all.
- showFirst() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
showFirstrecord component. - showFirst() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
showFirstrecord component. - showFirstColumn() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns the value of the
showFirstColumnrecord component. - showFormulas() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the grid shows formula text instead of evaluated results (
<sheetView showFormulas>). - showGridlines() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the sheet VIEW draws gridlines (
<sheetView showGridLines>, ECMA-376 §18.3.1.87). - showHigh() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
showHighrecord component. - showHigh() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
showHighrecord component. - showInputMessage() - Method in class io.keikai.axyra.sheets.content.Validation
- showInputMessage(boolean) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
-
Whether the input hint is shown when the cell is selected.
- showLast() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
showLastrecord component. - showLast() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
showLastrecord component. - showLastColumn() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns the value of the
showLastColumnrecord component. - showLastColumn() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns the value of the
showLastColumnrecord component. - showLegendKey() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
showLegendKeyrecord component. - showLow() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
showLowrecord component. - showLow() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
showLowrecord component. - showMarkers() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
showMarkersrecord component. - showMarkers() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
showMarkersrecord component. - showNegative() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
showNegativerecord component. - showNegative() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns the value of the
showNegativerecord component. - showPercent() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
showPercentrecord component. - showRowColHeaders() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether the sheet VIEW draws the row/column headers (
showRowColHeaders). - showRowHeaders() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns the value of the
showRowHeadersrecord component. - showRowStripes() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns the value of the
showRowStripesrecord component. - showRowStripes() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns the value of the
showRowStripesrecord component. - showRSquared() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns the value of the
showRSquaredrecord component. - showScenario(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Apply a scenario (writes its changing-cell values); returns whether it existed.
- showSeriesName() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
showSeriesNamerecord component. - showSubtotals() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns the value of the
showSubtotalsrecord component. - showValue() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
Whether the cell value is shown beside a data bar / icon set (ECMA-376 default
true; meaningful for those kinds only). - showValue() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
showValuerecord component. - showValue(boolean) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Show / hide the cell value beside a data bar or icon set.
- showZeros() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether a zero-valued cell shows
0or shows blank (<sheetView showZeros>, ECMA-376 §18.3.1.87). - shrinkToFit() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Whether text shrinks to fit the cell rather than wrapping or overflowing (ECMA-376 §18.8.1
alignment@shrinkToFit). - shrinkToFit(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Shrink the text to fit rather than letting it overflow.
- Side - Enum Class in io.keikai.axyra.sheets.style
-
A cell border edge.
- sign(byte[], byte[]) - Method in class io.keikai.axyra.sheets.Workbook
-
Serialize the workbook to an XLSX package and digitally sign it (an OPC package signature per ECMA-376 Part 2 §13: RSA-SHA256, or ECDSA-P256-SHA256 when
privateKeyis an EC P-256 key), returning the signed file bytes. - sign(Path, byte[], byte[]) - Method in class io.keikai.axyra.sheets.Workbook
-
Sign like
Workbook.sign(byte[], byte[])and write the result tofile. - SignatureInfo - Record Class in io.keikai.axyra.sheets
-
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.
- SignatureInfo(String, String, String, SignatureInfo.Status, String) - Constructor for record class io.keikai.axyra.sheets.SignatureInfo
-
Creates an instance of a
SignatureInforecord class. - SignatureInfo.Status - Enum Class in io.keikai.axyra.sheets
-
Verification outcome of a package signature.
- signatures() - Method in class io.keikai.axyra.sheets.Workbook
-
The digital-signature validation reports for this workbook's source file, captured when it was opened — an immutable read view, empty for unsigned or programmatically created workbooks.
- signedAt() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns the value of the
signedAtrecord component. - signerName() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns the value of the
signerNamerecord component. - SINGLE - Enum constant in enum class io.keikai.axyra.sheets.style.Underline
- SINGLE_ACCOUNTING - Enum constant in enum class io.keikai.axyra.sheets.style.Underline
- singleFile() - Method in class io.keikai.axyra.sheets.io.HtmlOptions
- singleFile(boolean) - Method in class io.keikai.axyra.sheets.io.HtmlOptions
-
Write one self-contained document instead of the package: every sheet in one file, every image inlined.
- skip() - Method in class io.keikai.axyra.sheets.io.StreamRow
-
Appends a blank at the next column, advancing past it.
- skipComments() - Method in class io.keikai.axyra.sheets.io.SaveOptions
- skipComments(boolean) - Method in class io.keikai.axyra.sheets.io.SaveOptions
- skipHyperlinks() - Method in class io.keikai.axyra.sheets.io.SaveOptions
- skipHyperlinks(boolean) - Method in class io.keikai.axyra.sheets.io.SaveOptions
- SLANT_DASH_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- Slicer - Record Class in io.keikai.axyra.sheets.content
-
A workbook slicer descriptor (immutable, read-only): an interactive filter control bound to a pivot table or an Excel Table.
- Slicer(String, String, String, String, boolean, List<String>, int, boolean, String, int, int, int, int, int) - Constructor for record class io.keikai.axyra.sheets.content.Slicer
-
Creates an instance of a
Slicerrecord class. - slicerCount() - Method in class io.keikai.axyra.sheets.Workbook
-
Number of slicers in the workbook.
- slicers() - Method in class io.keikai.axyra.sheets.Workbook
-
Every slicer in the workbook, each joined with its cache so the filtered field and the linked pivot tables travel with it.
- slicerSelection(String) - Method in class io.keikai.axyra.sheets.Workbook
-
The selected item values of a slicer, or
nullif it does not exist. - SLOT_COUNT - Static variable in class io.keikai.axyra.sheets.style.Theme
-
Number of color slots in a theme.
- SmartArt - Record Class in io.keikai.axyra.sheets.content
-
A SmartArt diagram descriptor (immutable, read-only).
- SmartArt(String, String, String, String, int, int, int, int, List<String>) - Constructor for record class io.keikai.axyra.sheets.content.SmartArt
-
Creates an instance of a
SmartArtrecord class. - smartArtCount() - Method in class io.keikai.axyra.sheets.Sheet
-
Number of SmartArt diagrams anchored on this sheet.
- smartArts() - Method in class io.keikai.axyra.sheets.Sheet
-
The SmartArt diagrams anchored on this sheet (read-only descriptors: layout family, anchor, visible node texts).
- SOLID - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType
- sort() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns the value of the
sortrecord component. - sort(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder
- sort(int, boolean) - Method in class io.keikai.axyra.sheets.Range
-
Sort ascending/descending on a single column.
- sort(SortKey...) - Method in class io.keikai.axyra.sheets.Range
-
Sort the rectangle by one or more keys (first key is primary).
- sortByColor(Range, int, boolean, boolean, Color...) - Method in class io.keikai.axyra.sheets.Sheet
-
Sort the rows of
rangeby cell fill color (or font color whencellColoris false) atsortColumnIndex(0-based, relative to the range start). - sortField(String, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sorts the row/column field
fieldby item label (ECMA-376 Part 1 §18.10.1.69sortType; BOR-PVE-014 NC1). - sortFieldByValue(String, boolean, int) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Sorts the row/column field
fieldby the aggregate of thedataField-th values-area entry (§18.10.1.72autoSortScope; BOR-PVE-014 R1). - sortingTextAsNumber() - Method in record class io.keikai.axyra.sheets.SortKey
-
A copy of this key that reads numeric-looking text as a number — Excel's "Sort anything that looks like a number, as a number".
- SortKey - Record Class in io.keikai.axyra.sheets
-
One sort key: a 0-based range-relative index and its direction, optionally carrying a custom ordering list (Excel's "Custom Lists").
- SortKey(int, boolean) - Constructor for record class io.keikai.axyra.sheets.SortKey
-
A plain key without a custom ordering list.
- SortKey(int, boolean, String[]) - Constructor for record class io.keikai.axyra.sheets.SortKey
-
A key with a custom ordering list but the default text ordering.
- SortKey(int, boolean, String[], boolean) - Constructor for record class io.keikai.axyra.sheets.SortKey
-
Creates an instance of a
SortKeyrecord class. - sortLeftToRight(SortKey...) - Method in class io.keikai.axyra.sheets.Range
-
Sort left to right (Excel's Sort Options → "Sort left to right"): reorder whole columns within the rectangle by the values of one or more key rows.
- source() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns the value of the
sourcerecord component. - source() - Method in record class io.keikai.axyra.sheets.content.VbaModule
-
Returns the value of the
sourcerecord component. - sourceField() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
sourceFieldrecord component. - sourceFields() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The source column names available for field placement.
- sourceIndex() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns the value of the
sourceIndexrecord component. - sourceRef() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The source data reference (e.g.
- sourceSheetId() - Method in class io.keikai.axyra.sheets.Sheet
-
The workbook-level id this sheet arrived with (
<sheet sheetId>inxl/workbook.xml), or0for a sheet created in this session — the writer allocates an id for those on save. - Sparkline - Record Class in io.keikai.axyra.sheets.content
-
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). - Sparkline(String, String) - Constructor for record class io.keikai.axyra.sheets.content.Sparkline
-
Creates an instance of a
Sparklinerecord class. - SparklineGroup - Record Class in io.keikai.axyra.sheets.content
-
A sparkline group: a set of same-styled mini inline charts (ECMA-376 Part 4 §18.3.1.32,
x14:sparklineGroup). - SparklineGroup(String, boolean, boolean, boolean, boolean, boolean, boolean, String, String, String, String, String, String, String, String, String, String, Double, Double, String, List<Sparkline>) - Constructor for record class io.keikai.axyra.sheets.content.SparklineGroup
-
Creates an instance of a
SparklineGrouprecord class. - sparklineGroupCount() - Method in class io.keikai.axyra.sheets.Sheet
-
Number of sparkline groups on this sheet.
- sparklines() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
sparklinesrecord component. - sparklines() - Method in class io.keikai.axyra.sheets.Sheet
-
All sparkline groups on this sheet (ECMA-376 Part 4 §18.3.1.32,
x14:sparklineGroups): the group type, basic marker/highlight style, series color and each sparkline's data range and draw location. - SparklineStyle - Record Class in io.keikai.axyra.sheets.content
-
The style of a sparkline group — series/point colors, point-highlight flags, and vertical-axis scaling (MS-XLSX
x14:sparklineGroup). - SparklineStyle(String, String, String, String, String, String, String, String, boolean, boolean, boolean, boolean, boolean, boolean, String, String, Double, Double, String) - Constructor for record class io.keikai.axyra.sheets.content.SparklineStyle
-
Creates an instance of a
SparklineStylerecord class. - spillRange() - Method in class io.keikai.axyra.sheets.Range
-
The A1 reference of the dynamic-array spill (or legacy CSE array) region containing this range's top-left cell — e.g.
- SPIN_BUTTON - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
- spinButton(String) - Static method in class io.keikai.axyra.sheets.content.FormControl
-
A spin button; configure
.range(min, max)/.value(v). - splitColumn() - Method in class io.keikai.axyra.sheets.Sheet
-
The split column (
0when unsplit), mirroringSheet.freezeColumn(). - splitPanes(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
Split the view into scrollable panes at
(splitRow, splitColumn)(0 = no split on that axis). - splitRow() - Method in class io.keikai.axyra.sheets.Sheet
-
The split row (rows split below it;
0when unsplit), mirroringSheet.freezeRow(). - splitToFiles(Path, String) - Method in class io.keikai.axyra.sheets.Workbook
-
Split this workbook into one single-sheet file per sheet, written to
dir(created if missing), and return the written paths in sheet order. - sqref() - Method in record class io.keikai.axyra.sheets.content.ProtectedRange
-
Returns the value of the
sqrefrecord component. - start() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Returns the value of the
startrecord component. - startSheet(String) - Method in class io.keikai.axyra.sheets.io.StreamWorkbook
-
Closes any open sheet and starts a new one.
- state() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns the value of the
staterecord component. - status() - Static method in class io.keikai.axyra.sheets.License
-
The current licensing status.
- status() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns the value of the
statusrecord component. - STD_DEV - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
-
Sample standard deviation (
stdDev). - STD_DEV - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- STD_DEVP - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
-
Population standard deviation (
stdDevp). - STDEV - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- STDEV - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- STDEV_P - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- STDEVP - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- stock() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A stock chart (high-low-close).
- stopIfTrue() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Stop evaluating lower-priority rules once this one matches.
- stopIfTrue() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
Whether lower-priority rules stop evaluating once this one matches.
- StreamRow - Class in io.keikai.axyra.sheets.io
-
A row under construction for
StreamWorkbook. - StreamStyle - Class in io.keikai.axyra.sheets.io
-
A cell style for
StreamWorkbook— the small subset that covers report authoring: a number format plus bold / italic. - StreamWorkbook - Class in io.keikai.axyra.sheets.io
-
Writes an XLSX file row by row, in memory that does not grow with the row count.
- strike() - Method in class io.keikai.axyra.sheets.content.RichText.Run
- strike() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
strikerecord component. - strikethrough() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
strikethroughrecord component. - strikethrough() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Strike through matching cells.
- strikethrough() - Method in class io.keikai.axyra.sheets.style.CellStyle
- strikethrough(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- style() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's resolved style.
- style() - Method in class io.keikai.axyra.sheets.ChartView
-
The chart's built-in style number (
<c:style val>), or-1when it carries none. - style() - Method in class io.keikai.axyra.sheets.content.Chart
-
The chart's built-in style number (
<c:style val>), or-1when the chart carries none — which is what a chart built here does. - style() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
stylerecord component. - style() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
The group's style as a reusable patch (see
Sheet.setSparklineStyle). - style() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
stylerecord component. - style() - Method in class io.keikai.axyra.sheets.PivotTableView
-
The named pivot style, or null when none is applied.
- style() - Method in class io.keikai.axyra.sheets.Range
-
The style of the top-left cell of the rectangle.
- style() - Method in record class io.keikai.axyra.sheets.style.BorderEdge
-
Returns the value of the
stylerecord component. - style(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
The chart's built-in style number (
<c:style val>). - styleIds() - Method in class io.keikai.axyra.sheets.Range
-
Row-major per-cell style ids (an engine-internal dedup index).
- styleName() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns the value of the
styleNamerecord component. - subject() - Method in class io.keikai.axyra.sheets.Workbook
-
The document subject, or
null. - subscript() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Shorthand for
fontVertical(SUBSCRIPT). - SUBSCRIPT - Enum constant in enum class io.keikai.axyra.sheets.style.FontVertical
- subtotal(int, int, int, boolean, SubtotalFunction, int...) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert subtotals into
[firstRow, lastRow]as above. - subtotal(int, int, int, SubtotalFunction, int...) - Method in class io.keikai.axyra.sheets.Sheet
-
Insert subtotals into the sorted data block
[firstRow, lastRow]: after each run of equal values ingroupColumn, a summary row offunctionoversubtotalColumnsis inserted (plus a grand total). - SubtotalFunction - Enum Class in io.keikai.axyra.sheets
-
Aggregate function for
Sheet.subtotal(int, int, int, io.keikai.axyra.sheets.SubtotalFunction, int...), by Excel SUBTOTAL code. - SUM - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
- SUM - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- SUM - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- SUM - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- summaryBelow() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether a row group's summary row sits below its detail rows (
<outlinePr summaryBelow>, ECMA-376 §18.3.1.61). - summaryRight() - Method in class io.keikai.axyra.sheets.Sheet
-
Whether a column group's summary column sits right of its detail columns (
<outlinePr summaryRight>). - sunburst() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A sunburst chart: hierarchical proportions as concentric rings.
- superscript() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
-
Shorthand for
fontVertical(SUPERSCRIPT). - SUPERSCRIPT - Enum constant in enum class io.keikai.axyra.sheets.style.FontVertical
- surface() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A surface chart.
T
- tabColor() - Method in class io.keikai.axyra.sheets.Sheet
-
The tab color as a typed
Color, ornullwhen the tab has no color. - Table - Record Class in io.keikai.axyra.sheets.content
-
A table (ListObject): a named rectangular region with header columns (ECMA-376 §18.5.1.2).
- Table(String, int, int, int, int, List<String>, int, boolean, TableStyleInfo, List<TableColumn>) - Constructor for record class io.keikai.axyra.sheets.content.Table
-
Creates an instance of a
Tablerecord class. - TableColumn - Record Class in io.keikai.axyra.sheets.content
-
One table column (ECMA-376 §18.5.1.3 tableColumn): the header name plus its totals-row configuration.
- TableColumn(String, String, String) - Constructor for record class io.keikai.axyra.sheets.content.TableColumn
-
Creates an instance of a
TableColumnrecord class. - tableColumns() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
tableColumnsrecord component. - tableName() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns the value of the
tableNamerecord component. - tables() - Method in class io.keikai.axyra.sheets.Sheet
-
All tables (ListObjects) on this sheet, with style and totals state.
- tableSlicer() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns the value of the
tableSlicerrecord component. - TableStyleInfo - Record Class in io.keikai.axyra.sheets.content
-
A table's style binding (ECMA-376 §18.5.1.20 tableStyleInfo): the built-in style name (e.g.
- TableStyleInfo(String, boolean, boolean, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Creates an instance of a
TableStyleInforecord class. - TABULAR - Enum constant in enum class io.keikai.axyra.sheets.PivotLayout
-
Like outline but parent values repeat on every row.
- targetWidthPx() - Method in class io.keikai.axyra.sheets.io.ImageOptions
-
Exact output width in pixels (aspect kept), or
nullto useImageOptions.scale(). - targetWidthPx(int) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder
-
Exact output width in pixels; the height keeps the page aspect ratio.
- TemplateMarkers - Class in io.keikai.axyra.sheets.template
-
Data binding via template markers — a lightweight reporting layer built entirely on the public read/write API.
- text() - Method in record class io.keikai.axyra.sheets.content.Comment
-
Returns the value of the
textrecord component. - text() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
textrecord component. - text() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The text operand of a
notContainsTextrule, ornull. - text() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Caption text painted by captioned controls, or null (name is used).
- text() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
textrecord component. - text() - Method in class io.keikai.axyra.sheets.content.RichText
-
The flat cell text — the concatenation of every run's text.
- text() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns the value of the
textrecord component. - text() - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
Returns the value of the
textrecord component. - text(String) - Static method in interface io.keikai.axyra.sheets.CellValue
-
A text value.
- text(String) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- Text(String) - Constructor for record class io.keikai.axyra.sheets.CellValue.Text
-
Creates an instance of a
Textrecord class. - Text(String) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Text
-
Creates an instance of a
Textrecord class. - TEXT - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
- textAsNumber() - Method in record class io.keikai.axyra.sheets.SortKey
-
Returns the value of the
textAsNumberrecord component. - textColor() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns the value of the
textColorrecord component. - textLength(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A text-length constraint (e.g.
- textRotation() - Method in class io.keikai.axyra.sheets.style.CellStyle
- textRotation(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- textToColumns(String, int, int, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Text to Columns with an explicit destination: fields of source row
iland at(destRow + i, destColumn...). - textToColumns(String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Text to Columns (Excel's delimited mode) splitting in place: each text cell of the one-column
srcRange(e.g. - textToColumns(String, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet
-
Text to Columns splitting in place, optionally treating a run of consecutive delimiters as one split point (Excel's "treat consecutive delimiters as one", useful for space-aligned text).
- theme() - Method in class io.keikai.axyra.sheets.Workbook
-
The workbook theme (color scheme + major/minor fonts), or
nullwhen the workbook has no theme. - theme(int) - Static method in class io.keikai.axyra.sheets.style.Color
-
A theme-palette color with no tint (theme slot 0-11).
- theme(int, double) - Static method in class io.keikai.axyra.sheets.style.Color
-
A theme-palette color:
themeIndexis the theme slot (0-11: dark1, light1, dark2, light2, accent1-6, hyperlink, followedHyperlink) andtintlightens (positive) or darkens (negative) it, in[-1, 1](ECMA-376 §18.8.19). - Theme - Class in io.keikai.axyra.sheets.style
-
The workbook theme — the 12-slot color scheme plus the major (heading) and minor (body) font names.
- Theme.Builder - Class in io.keikai.axyra.sheets.style
-
Fluent builder for a
Theme. - Theme.Slot - Enum Class in io.keikai.axyra.sheets.style
-
The 12 canonical theme color slots, in ECMA-376
<a:clrScheme>order. - themeIndex() - Method in class io.keikai.axyra.sheets.style.Color
-
The theme slot (0-11) of a theme color.
- THICK - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- THIN - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle
- THIS_MONTH - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- THIS_MONTH - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- THIS_QUARTER - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- THIS_WEEK - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- THIS_WEEK - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- THIS_YEAR - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- ThreadedComment - Record Class in io.keikai.axyra.sheets.content
-
A threaded comment (Excel 365 conversation) on a cell.
- ThreadedComment(String, String, String, String, boolean, List<ThreadedComment>) - Constructor for record class io.keikai.axyra.sheets.content.ThreadedComment
-
Creates an instance of a
ThreadedCommentrecord class. - threadedComments() - Method in class io.keikai.axyra.sheets.Cell
-
This cell's comment threads: each root
ThreadedCommentcarries its replies. - threeD() - Method in class io.keikai.axyra.sheets.content.FormControl
-
The 3-D shading flag of the Format Control dialog.
- threeD(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Render the chart in 3-D.
- threeD(boolean) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- time(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A time constraint.
- Timeline - Record Class in io.keikai.axyra.sheets.content
-
A workbook timeline descriptor (immutable, read-only): a specialised slicer for date-based filtering of a pivot table.
- Timeline(String, String, String, String, String, String, Integer, int, int, int, int, int) - Constructor for record class io.keikai.axyra.sheets.content.Timeline
-
Creates an instance of a
Timelinerecord class. - timelineCount() - Method in class io.keikai.axyra.sheets.Workbook
-
Number of timelines in the workbook.
- timelineRange(String) - Method in class io.keikai.axyra.sheets.Workbook
-
The selected date range of the named timeline as
[start, end](either may benullwhen unbounded), ornullwhen the timeline is unknown or has no active selection. - timelines() - Method in class io.keikai.axyra.sheets.Workbook
-
Every timeline in the workbook, each joined with its cache so the filtered date field and granularity level travel with it.
- timePeriod() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The date window of a
timePeriodrule, ornull. - TimePeriod - Enum Class in io.keikai.axyra.sheets.content
-
The date window of a "date occurring" conditional-formatting rule — ECMA-376 §18.18.82
ST_TimePeriod. - timestamp() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns the value of the
timestamprecord component. - tint() - Method in class io.keikai.axyra.sheets.style.Color
-
The tint in
[-1, 1]of a theme color. - title() - Method in class io.keikai.axyra.sheets.ChartView
-
The chart title, or
null. - title() - Method in class io.keikai.axyra.sheets.content.Chart
- title() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Document title (PDF metadata), or
null. - title() - Method in class io.keikai.axyra.sheets.Workbook
-
The document title, or
null. - title(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
- title(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
- titleAuto() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the chart title is an Excel "auto" title — a
<c:title>present with no explicit text, so the app derives it from the single series name. - titleAuto() - Method in class io.keikai.axyra.sheets.content.Chart
-
Whether this chart carries an Excel "auto" title (derived from the series name).
- titleFormula() - Method in class io.keikai.axyra.sheets.ChartView
-
The cell reference the title follows (
<c:strRef><c:f>), ornullfor a literal or absent title. - titleFormula() - Method in class io.keikai.axyra.sheets.content.Chart
-
The cell reference the title follows (
<c:strRef><c:f>), ornullfor a literal or absent title. - titleFormula(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Make the chart title follow a cell rather than a literal string —
<c:title><c:tx><c:strRef><c:f>. - titleLayout() - Method in class io.keikai.axyra.sheets.ChartView
-
The manual title layout as
[x, y, w, h]chart-relative fractions, ornullwhen the title is placed automatically. - titleLayout(double, double, double, double) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Position the chart title at an explicit rectangle in chart-relative fractions — a manual title layout.
- toBmp(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet to BMP bytes.
- toBuilder() - Method in class io.keikai.axyra.sheets.content.Chart
-
A builder pre-loaded with this chart spec, for read–modify–write round-trips.
- toBuilder() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
A builder pre-loaded with this rule, for read–modify–write round-trips.
- toBuilder() - Method in class io.keikai.axyra.sheets.content.FormControl
-
A builder pre-loaded with this control, for read–modify–write round-trips.
- toBuilder() - Method in class io.keikai.axyra.sheets.content.RichText
-
A builder pre-loaded with this text's runs, for read–modify–write round-trips.
- toBuilder() - Method in class io.keikai.axyra.sheets.content.Validation
-
A builder pre-loaded with this rule, for read–modify–write round-trips.
- toBuilder() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
A builder pre-loaded with this value, for read–modify–write round-trips.
- toBuilder() - Method in class io.keikai.axyra.sheets.io.ImageOptions
-
A builder pre-loaded with this value, for read–modify–write.
- toBuilder() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
A builder pre-loaded with this value, for read–modify–write.
- toBuilder() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
A builder pre-loaded with this value, for read–modify–write round-trips.
- toBuilder() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
A builder pre-loaded with this style's attributes — the edit-existing workflow:
cell.style().toBuilder().bold().build(). - toBuilder() - Method in class io.keikai.axyra.sheets.style.Theme
- toCol() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
toColrecord component. - toColumn() - Method in class io.keikai.axyra.sheets.content.FormControl
- TODAY - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- TODAY - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- toGif(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet to GIF bytes.
- toHex() - Method in class io.keikai.axyra.sheets.style.Color
-
"#AARRGGBB"of an RGB color. - toImage(Workbook, int, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet to the given raster format —
"png","jpeg","gif","bmp"or"tiff". - toImage(Workbook, int, String, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render an A1 range of a sheet to the given raster format.
- toJpeg(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet to JPEG bytes (composited over white).
- toJson() - Method in class io.keikai.axyra.sheets.content.Chart
- toJson() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- toJson() - Method in class io.keikai.axyra.sheets.content.FormControl
- toJson() - Method in class io.keikai.axyra.sheets.content.RichText
-
The runs as a JSON array crossed to the engine.
- toJson() - Method in class io.keikai.axyra.sheets.content.Validation
- toJson() - Method in class io.keikai.axyra.sheets.style.CellStyle
-
Package-private: the flat JSON crossed to the engine.
- toJsonValue() - Method in class io.keikai.axyra.sheets.style.Color
-
The structured JSON value crossed to the engine.
- token() - Method in enum class io.keikai.axyra.sheets.content.LegendPosition
- token() - Method in enum class io.keikai.axyra.sheets.content.TimePeriod
-
The ST_TimePeriod token crossed to the engine.
- token() - Method in enum class io.keikai.axyra.sheets.style.BorderStyle
- token() - Method in enum class io.keikai.axyra.sheets.style.FontVertical
- token() - Method in enum class io.keikai.axyra.sheets.style.HAlign
- token() - Method in enum class io.keikai.axyra.sheets.style.PatternType
- token() - Method in enum class io.keikai.axyra.sheets.style.Underline
- token() - Method in enum class io.keikai.axyra.sheets.style.VAlign
- TOMORROW - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- TOMORROW - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- tooltip() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Returns the value of the
tooltiprecord component. - top() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns the value of the
toprecord component. - TOP - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition
- TOP - Enum constant in enum class io.keikai.axyra.sheets.style.Side
- TOP - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign
- TOP_RIGHT - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition
- top10(int, boolean, boolean) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
A top-N (or bottom-N when
bottom) rule;percentranks by %. - toPdf(Workbook, PdfOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render the workbook to PDF bytes honoring
options(null= defaults). - toPdf(Workbook, Path) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render the whole workbook to a PDF file.
- toPdf(Workbook, Path, PdfOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render the workbook to a PDF file honoring
options. - topNFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The Top-N filter of
field, or null when unfiltered. - toPng(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet to PNG bytes — page 1 of its print layout, or the page selected in
options. - toPng(Workbook, int, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render an A1 range (e.g.
- toRow() - Method in class io.keikai.axyra.sheets.content.FormControl
- toRow() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns the value of the
toRowrecord component. - toString() - Method in record class io.keikai.axyra.sheets.CellRef
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CellValue.Array
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CellValue.Blank
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CellValue.Bool
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CellValue.Error
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CellValue.Number
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CellValue.Text
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Comment
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.DataConnection
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.ExternalLink
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Hyperlink
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.OleObject
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.ProtectedRange
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Slicer
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.SmartArt
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Sparkline
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.TableColumn
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Timeline
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.Trendline
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.VbaModule
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.WriteProtection
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.XmlMap
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CustomProperty.Bool
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CustomProperty.Date
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CustomProperty.Number
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CustomProperty.Text
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.CustomProperty
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.FindFormat
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.format.ParsedValue
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.ImportOptions
-
Returns a string representation of this record class.
- toString() - Method in class io.keikai.axyra.sheets.io.StreamStyle
- toString() - Method in record class io.keikai.axyra.sheets.LicenseInfo
-
Returns a string representation of this record class.
- toString() - Method in class io.keikai.axyra.sheets.NamedRange
- toString() - Method in record class io.keikai.axyra.sheets.PageMargins
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotCalculatedField
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotField
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotFieldSort
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotLabelFilter
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.SheetProtection
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.SignatureInfo
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.SortKey
-
Returns a string representation of this record class.
- toString() - Method in record class io.keikai.axyra.sheets.style.BorderEdge
-
Returns a string representation of this record class.
- toString() - Method in class io.keikai.axyra.sheets.style.Color
- toString() - Method in record class io.keikai.axyra.sheets.style.GradientStop
-
Returns a string representation of this record class.
- toSvg(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet (first page of its print layout) to SVG bytes (UTF-8).
- toSvg(Workbook, int, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render an A1 range of a sheet to SVG bytes (UTF-8).
- totalsRowFunction() - Method in record class io.keikai.axyra.sheets.content.TableColumn
-
Returns the value of the
totalsRowFunctionrecord component. - TotalsRowFunction - Enum Class in io.keikai.axyra.sheets
-
Table totals-row aggregation (ECMA-376 §18.18.92 ST_TotalsRowFunction).
- totalsRowLabel() - Method in record class io.keikai.axyra.sheets.content.TableColumn
-
Returns the value of the
totalsRowLabelrecord component. - totalsRowShown() - Method in record class io.keikai.axyra.sheets.content.Table
-
Returns the value of the
totalsRowShownrecord component. - toTiff(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer
-
Render one sheet to TIFF bytes.
- treemap() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A treemap chart: hierarchical proportions as nested rectangles.
- trendline(Trendline) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Add a trendline to the most recently added series.
- Trendline - Record Class in io.keikai.axyra.sheets.content
-
A series trendline (ECMA-376 §21.2.2.210).
- Trendline(String, double, double, int, int, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.content.Trendline
-
Creates an instance of a
Trendlinerecord class. - trendlines(int) - Method in class io.keikai.axyra.sheets.ChartView
-
The trendlines of a series (empty when none).
- TRUE - Static variable in interface io.keikai.axyra.sheets.CellValue
-
Shared singleton for
TRUE. - type() - Method in class io.keikai.axyra.sheets.ChartView
-
The chart type token (column/bar/line/pie/…).
- type() - Method in class io.keikai.axyra.sheets.content.Chart
- type() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
- type() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Returns the value of the
typerecord component. - type() - Method in class io.keikai.axyra.sheets.content.FormControl
- type() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup
-
Returns the value of the
typerecord component. - type() - Method in class io.keikai.axyra.sheets.content.Validation
- type() - Method in record class io.keikai.axyra.sheets.PivotLabelFilter
-
Returns the value of the
typerecord component. - type() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs
-
Returns the value of the
typerecord component. - type() - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Returns the value of the
typerecord component. - type(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Change the chart family this spec describes, keeping everything else it already carries — the counterpart of
Chart.type()on the read–modify–write path, where the family comes from the file and the caller wants a different one. - type(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder
- TypedUserFunction - Interface in io.keikai.axyra.sheets.formula
-
A typed user-defined formula function.
U
- underline() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
Returns the value of the
underlinerecord component. - underline() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Single-underline matching cells.
- underline() - Method in class io.keikai.axyra.sheets.content.RichText.Run
- underline() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo
-
Returns the value of the
underlinerecord component. - underline() - Method in class io.keikai.axyra.sheets.style.CellStyle
- underline(Underline) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- Underline - Enum Class in io.keikai.axyra.sheets.style
-
Font underline style.
- unfreeze() - Method in class io.keikai.axyra.sheets.Sheet
-
Remove any frozen panes.
- ungroupField(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
Removes
field's grouping (items revert to the raw values). - ungroupShapes(int) - Method in class io.keikai.axyra.sheets.Sheet
-
Dissolve a group created by
Sheet.groupShapes(java.lang.String, int...): members return to standalone emission and the group entry is removed. - uniqueId() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet's revision GUID as stored in the source file (Excel's
xr:uidon the sheet part root), braces included — for example"{B9A12774-C2A8-4D3E-B631-D37318C68856}". - uniqueValues() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Highlight values that occur exactly once in the range.
- UNKNOWN - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType
-
A control the engine could not classify (imported edge cases).
- UNLICENSED - Enum constant in enum class io.keikai.axyra.sheets.LicenseStatus
-
No license has been installed.
- unmerge() - Method in class io.keikai.axyra.sheets.Range
-
Unmerge any merged regions overlapping the rectangle.
- unprotect() - Method in class io.keikai.axyra.sheets.Sheet
-
Disable sheet protection (ignores any password).
- unprotect() - Method in class io.keikai.axyra.sheets.Workbook
-
Remove workbook structure/window locks.
- unprotect(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Disable sheet protection after verifying
passwordagainst the stored hash (ISO hash, or the legacy 16-bitpasswordattribute of transitional files). - unprotectStructure(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Clear the workbook protection after verifying
passwordagainst the stored hash. - UNSUPPORTED - Enum constant in enum class io.keikai.axyra.sheets.SignatureInfo.Status
-
The signature uses an algorithm or construct outside the implemented subset, so no verdict can honestly be given — this is deliberately distinct from
SignatureInfo.Status.INVALID. - UP - Enum constant in enum class io.keikai.axyra.sheets.Shift
- updateFormControl(int, FormControl) - Method in class io.keikai.axyra.sheets.Sheet
-
Replace the form control at
controlIndex(its position inSheet.formControls()) — read one, tweak it viaFormControl.toBuilder(), write it back. - updateNamedStyle(String, CellStyle) - Method in class io.keikai.axyra.sheets.Workbook
-
Redefine a named cell style and PROPAGATE the change: every cell (and row/column default) currently styled with it is restyled — Excel's "Modify…" on a cell style.
- url(String) - Static method in record class io.keikai.axyra.sheets.content.Hyperlink
-
A URL hyperlink with no display text or tooltip.
- url(String, String) - Static method in record class io.keikai.axyra.sheets.content.Hyperlink
-
A URL hyperlink with display text.
- usedRange() - Method in class io.keikai.axyra.sheets.Sheet
-
The used-cell bounding range, or
nullif the sheet is empty. - UserFunction - Interface in io.keikai.axyra.sheets.formula
-
A user-defined formula function.
- userName() - Method in record class io.keikai.axyra.sheets.content.WriteProtection
-
Returns the value of the
userNamerecord component. - userPassword() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Password required to open the document, or
null(no encryption unless owner set). - userPassword(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Password required to open the document (enables encryption).
- utf8Bom() - Method in class io.keikai.axyra.sheets.io.CsvOptions
- utf8Bom(boolean) - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
Whether to start the file with a UTF-8 byte-order mark, as Excel's "CSV UTF-8" does (default false).
V
- VALID - Enum constant in enum class io.keikai.axyra.sheets.SignatureInfo.Status
-
Every signed digest and the signature value verified.
- Validation - Class in io.keikai.axyra.sheets.content
-
A data-validation rule (immutable).
- Validation.Builder - Class in io.keikai.axyra.sheets.content
-
Fluent builder.
- validations() - Method in class io.keikai.axyra.sheets.Sheet
-
All data-validation rules on this sheet.
- VAlign - Enum Class in io.keikai.axyra.sheets.style
-
Vertical text alignment.
- value() - Method in class io.keikai.axyra.sheets.Cell
-
The cell's value (formula cells return their evaluated value).
- value() - Method in record class io.keikai.axyra.sheets.CellValue.Bool
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CellValue.Number
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CellValue.Text
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Returns the value of the
valuerecord component. - value() - Static method in record class io.keikai.axyra.sheets.content.DataLabels
-
Labels showing the data value.
- value() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns the value of the
valuerecord component. - value() - Method in class io.keikai.axyra.sheets.content.FormControl
-
Current value of a scroll bar / spin button.
- value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Bool
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Date
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Number
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Text
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.CustomProperty
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.PivotLabelFilter
-
Returns the value of the
valuerecord component. - value() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter
-
Returns the value of the
valuerecord component. - value(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder
- value(int, int) - Method in class io.keikai.axyra.sheets.Sheet
-
The value of a single cell (0-based).
- value1() - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Returns the value of the
value1record component. - value2() - Method in record class io.keikai.axyra.sheets.PivotValueFilter
-
Returns the value of the
value2record component. - valueAxisGridlines() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the value (Y) axis draws major gridlines (
<c:majorGridlines>). - valueAxisGridlines() - Method in class io.keikai.axyra.sheets.content.Chart
-
Whether the value (Y) axis draws major gridlines (
<c:majorGridlines>, ECMA-376 Part 1 §21.2.2). - valueAxisGridlines(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Show or hide the value (Y) axis' major gridlines — the lines across the plot at each major tick (
<c:majorGridlines>, ECMA-376 Part 1 §21.2.2). - valueAxisMax() - Method in class io.keikai.axyra.sheets.ChartView
-
The explicit value-axis maximum, or
null(auto). - valueAxisMin() - Method in class io.keikai.axyra.sheets.ChartView
-
The explicit value-axis minimum, or
null(auto). - valueAxisScale(double, double) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Fix the value (Y) axis scale to
[min, max]. - valueAxisTitle() - Method in class io.keikai.axyra.sheets.ChartView
- valueAxisTitle() - Method in class io.keikai.axyra.sheets.content.Chart
-
The value (Y) axis title, or
null. - valueAxisTitle(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Value (Y) axis title.
- valueAxisVisible() - Method in class io.keikai.axyra.sheets.ChartView
-
Whether the value (Y) axis is drawn.
- valueAxisVisible(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Show or hide the value (Y) axis (ECMA-376 §21.2.2.226 valAx).
- valueFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView
-
The value filter of
field, or null when unfiltered. - valueObject(ConditionalFormat.ValueObject) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Append a threshold value object (ECMA-376 §18.3.1.11 cfvo) for a color-scale / data-bar / icon-set rule.
- valueObject(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Append a valueless threshold (
"min"/"max"). - valueObject(String, String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder
-
Append a threshold with a number or formula value.
- ValueObject(String, String, boolean) - Constructor for record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject
-
Creates an instance of a
ValueObjectrecord class. - valueObjects() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat
-
The threshold value objects of a color-scale / data-bar / icon-set rule, in document order; empty for the non-visual kinds.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.AggregateFunction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.calc.CalcMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.ConsolidateFunction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.content.FormControlType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.content.LegendPosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.content.TimePeriod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.DynamicFilterType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.FilterOperator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.io.CsvOptions.Values
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.io.FormulaPolicy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.io.PdfOptions.Fit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.LicenseMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.LicenseStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.PivotDateGroupBy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.PivotLayout
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.PivotValueFilterType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.SheetType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.Shift
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.SignatureInfo.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.BorderStyle
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.FontVertical
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.HAlign
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.PatternType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.Side
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.Theme.Slot
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.Underline
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.style.VAlign
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.SubtotalFunction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.TotalsRowFunction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.keikai.axyra.sheets.Visibility
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.keikai.axyra.sheets.AggregateFunction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.calc.CalcMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.ConsolidateFunction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.content.FormControlType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.content.LegendPosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.content.TimePeriod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.DynamicFilterType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.FilterOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class io.keikai.axyra.sheets.io.CsvOptions
- values() - Static method in enum class io.keikai.axyra.sheets.io.CsvOptions.Values
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.io.FormulaPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.io.PdfOptions.Fit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.LicenseMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.LicenseStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.PivotDateGroupBy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.PivotLayout
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.PivotValueFilterType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class io.keikai.axyra.sheets.Range
-
Read every cell as a
CellValue. - values() - Static method in enum class io.keikai.axyra.sheets.SheetType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.Shift
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.SignatureInfo.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.BorderStyle
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.FontVertical
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.HAlign
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.PatternType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.Side
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.Theme.Slot
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.Underline
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.style.VAlign
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.SubtotalFunction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.TotalsRowFunction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.keikai.axyra.sheets.Visibility
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values(CsvOptions.Values) - Method in class io.keikai.axyra.sheets.io.CsvOptions
-
Display text (default) or stored values.
- VALUES_ONLY - Enum constant in enum class io.keikai.axyra.sheets.io.FormulaPolicy
-
Write the cached value only (drop the formula).
- valueType() - Method in record class io.keikai.axyra.sheets.content.ErrorBars
-
Returns the value of the
valueTyperecord component. - VAR - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
-
Sample variance (
var). - VAR - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- VAR - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- VAR - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction
- VAR_P - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction
- VARP - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction
-
Population variance (
varp). - VARP - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction
- VbaModule - Record Class in io.keikai.axyra.sheets.content
-
A VBA code module extracted from a macro-enabled workbook's
vbaProject.bin(read-only): its editor name, kind, and decompressed source text. - VbaModule(String, String, String) - Constructor for record class io.keikai.axyra.sheets.content.VbaModule
-
Creates an instance of a
VbaModulerecord class. - vbaModules() - Method in class io.keikai.axyra.sheets.Workbook
-
The VBA code modules in this macro-enabled workbook (read-only): each module's editor name, kind (
"standard"/"class"/"document"), and MS-OVBA-decompressed source text. - verifyProtectedRangePassword(String, String) - Method in class io.keikai.axyra.sheets.Sheet
-
Verifies the password of the allow-edit-range
name. - verifyProtectionPassword(String) - Method in class io.keikai.axyra.sheets.Sheet
-
Whether
passwordmatches the sheet's stored hash, leaving the protection in place either way. - verifyWritePassword(String) - Method in class io.keikai.axyra.sheets.Workbook
-
Verifies
passwordagainst the stored modify-password hash;falsewhen the workbook is not write-protected. - verticalAlign() - Method in class io.keikai.axyra.sheets.style.CellStyle
- verticalAlign(VAlign) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- VERY_HIDDEN - Enum constant in enum class io.keikai.axyra.sheets.Visibility
- view3D() - Method in class io.keikai.axyra.sheets.ChartView
-
The chart's 3-D view angles (ECMA-376 §21.2.2.228
view3D) as[rotX, rotY, depthPercent], ornullwhen the chart is not 3-D. - view3D(int, int, int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder
-
Render the chart in 3-D with the given view angles (ECMA-376 §21.2.2.228
view3D):rotXis the elevation androtYthe rotation, both in degrees;depthPercentis the depth as a percentage of the plot height (100 = default). - viewType() - Method in class io.keikai.axyra.sheets.Sheet
-
Which view the tab opens in (
<sheetView view>, ECMA-376 §18.3.1.87):"normal","pageBreakPreview"or"pageLayout". - visibility() - Method in class io.keikai.axyra.sheets.Sheet
-
This sheet's visibility (visible / hidden / very-hidden).
- Visibility - Enum Class in io.keikai.axyra.sheets
-
A sheet's three-state visibility.
- VISIBLE - Enum constant in enum class io.keikai.axyra.sheets.Visibility
- vtType() - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw
-
Returns the value of the
vtTyperecord component.
W
- waterfall() - Static method in class io.keikai.axyra.sheets.content.Chart
-
A waterfall (bridge) chart: running total with positive/negative steps.
- watermark() - Method in class io.keikai.axyra.sheets.io.PdfOptions
-
Diagonal watermark text painted under every page's content, or
null. - watermark(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder
-
Paint
textas a diagonal light-gray watermark under every page's content (e.g. - WHITE - Static variable in class io.keikai.axyra.sheets.style.Color
- wholeNumber(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation
-
A whole-number constraint (e.g.
- WIDTH - Enum constant in enum class io.keikai.axyra.sheets.io.PdfOptions.Fit
-
Fit all columns onto one page width; height unconstrained.
- wire() - Method in enum class io.keikai.axyra.sheets.PivotDateGroupBy
-
The OOXML
groupBytoken, also used across the FFI. - wire() - Method in enum class io.keikai.axyra.sheets.PivotLabelFilterType
-
The engine token passed across the FFI.
- wire() - Method in enum class io.keikai.axyra.sheets.PivotShowDataAsType
-
The OOXML
showDataAstoken, also used across the FFI. - wire() - Method in enum class io.keikai.axyra.sheets.PivotValueFilterType
-
The engine token passed across the FFI.
- withAxisColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
- withBold() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
A copy with bold on.
- withBold() - Method in class io.keikai.axyra.sheets.io.StreamStyle
-
This style, bold — the usual header row.
- withBold(boolean) - Method in record class io.keikai.axyra.sheets.FindFormat
-
A copy matching cells whose font bold flag equals
b. - withBold(boolean) - Method in class io.keikai.axyra.sheets.io.StreamStyle
-
This style with bold set explicitly.
- withBold(Boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy with the given label bold flag (
nullinherits). - withColor(String) - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
A copy with the given ARGB font color (
"FFFF0000"). - withColStripes() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
A copy with banded columns on.
- withCustomAxis(double, double) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Fixes the vertical axis to the range
[min, max]across every sparkline in the group (both axis types become"custom") — the shared scale used to compare magnitudes point-for-point. - withCustomOrder(String...) - Method in record class io.keikai.axyra.sheets.SortKey
-
A copy of this key carrying the given custom ordering list.
- withDateAxis(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Spaces the category axis by the dates in
rangeRef(e.g. - withFillColor(Color) - Method in record class io.keikai.axyra.sheets.FindFormat
-
A copy matching cells whose fill foreground (pattern) color equals
c. - withFirstColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Sets the first-point color and turns
showFirston. - withFont(String, Double) - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
A copy with the given font name and size (either may be null).
- withFontColor(Color) - Method in record class io.keikai.axyra.sheets.FindFormat
-
A copy matching cells whose font color equals
c. - withFontSize(Double) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy with the given label font size in points (
nullinherits). - withGroupAxis() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Scales the vertical axis to the whole group's data range (both axis types become
"group") — a shared auto scale, without fixed bounds. - withHighColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Sets the high-point color and turns
showHighon. - withItalic() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
A copy with italic on.
- withItalic() - Method in class io.keikai.axyra.sheets.io.StreamStyle
-
This style, italic.
- withItalic(boolean) - Method in record class io.keikai.axyra.sheets.FindFormat
-
A copy matching cells whose font italic flag equals
i. - withItalic(boolean) - Method in class io.keikai.axyra.sheets.io.StreamStyle
-
This style with italic set explicitly.
- withLastColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Sets the last-point color and turns
showLaston. - withLowColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Sets the low-point color and turns
showLowon. - withMarkersColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Sets the marker color and turns
showMarkerson. - withNegativeColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
-
Sets the negative-point color and turns
showNegativeon. - withNumberFormat(String) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy with the given number-format override (
nullinherits the axis). - withNumberFormat(String) - Method in record class io.keikai.axyra.sheets.FindFormat
-
A copy matching cells whose resolved number format code equals
code(e.g. - withNumberFormat(String) - Method in class io.keikai.axyra.sheets.io.StreamStyle
-
This style with an Excel number-format code, e.g.
- withPosition(String) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy with the given position token (
nullclears it). - withRotation(Integer) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy with the given label rotation in whole degrees (
nullinherits). - withRowStripes() - Method in record class io.keikai.axyra.sheets.PivotStyle
-
A copy with banded rows on.
- withSeriesColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
- withShowCategoryName(boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy showing (or hiding) the category name.
- withShowLegendKey(boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy showing (or hiding) the legend-key swatch beside the label.
- withShowMarkers(boolean) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle
- withShowPercent(boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy showing (or hiding) the percent-of-total value.
- withShowSeriesName(boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy showing (or hiding) the series name.
- withShowValue(boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy showing (or hiding) the data value.
- withStrikethrough() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
A copy with strikethrough on.
- withTextColor(Color) - Method in record class io.keikai.axyra.sheets.content.DataLabels
-
Copy with the given label text color (
nullinherits). - withUnderline() - Method in record class io.keikai.axyra.sheets.content.CommentRun
-
A copy with underline on.
- Workbook - Class in io.keikai.axyra.sheets
-
A spreadsheet workbook — the top-level container of sheets and the sole owner of the native engine handle.
- WORKSHEET - Enum constant in enum class io.keikai.axyra.sheets.SheetType
-
An ordinary worksheet.
- wrapText() - Method in class io.keikai.axyra.sheets.style.CellStyle
- wrapText(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder
- writeProtection() - Method in class io.keikai.axyra.sheets.Workbook
-
The write-protection state, or null when the workbook carries no
<fileSharing>element. - WriteProtection - Record Class in io.keikai.axyra.sheets.content
-
The workbook's write-protection state (
<fileSharing>— ECMA-376 Part 1 §18.2.12), read back viaWorkbook.writeProtection(). - WriteProtection(boolean, String, boolean) - Constructor for record class io.keikai.axyra.sheets.content.WriteProtection
-
Creates an instance of a
WriteProtectionrecord class.
X
- XmlMap - Record Class in io.keikai.axyra.sheets.content
-
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). - XmlMap(int, String, String, String, String, List<XmlMapBinding>) - Constructor for record class io.keikai.axyra.sheets.content.XmlMap
-
Creates an instance of a
XmlMaprecord class. - XmlMapBinding - Record Class in io.keikai.axyra.sheets.content
-
One cell binding of an XML map (read-only): a worksheet-table column bound to an XPath.
- XmlMapBinding(String, String, String, String, String) - Constructor for record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Creates an instance of a
XmlMapBindingrecord class. - xmlMaps() - Method in class io.keikai.axyra.sheets.Workbook
-
The XML map definitions in this workbook (read-only): each map's id, name, root element, schema id and XSD schema text, read from
xl/xmlMaps.xml. - xpath() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding
-
Returns the value of the
xpathrecord component.
Y
- year() - Method in record class io.keikai.axyra.sheets.DateGroupItem
-
Returns the value of the
yearrecord component. - year(int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem
-
Select the whole calendar year.
- YEAR_TO_DATE - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
- YEARS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy
- YELLOW - Static variable in class io.keikai.axyra.sheets.style.Color
- YESTERDAY - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod
- YESTERDAY - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType
Z
- zoom() - Method in class io.keikai.axyra.sheets.Sheet
-
The sheet view zoom percentage (100 by default).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form