Index (Axyra Sheets — Java SDK 1.0.0-Beta API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

a1() - Method in record class io.keikai.axyra.sheets.CellRef: Returns the A1 reference within its sheet, e.g.
ABOVE_AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Numbers above the average of the column's data rows.
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 stdDev standard deviations above (or below, when below) the mean (ECMA-376 §18.3.1.1 stdDev, values 1-3).
ACCENT1 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Accent 1, the first chart and table series color.
ACCENT2 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Accent 2.
ACCENT3 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Accent 3.
ACCENT4 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Accent 4.
ACCENT5 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Accent 5.
ACCENT6 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Accent 6.
activeCell() - Method in class io.keikai.axyra.sheets.Sheet: Returns the view's active cell as an A1 reference, such as "B3" (<sheetView><selection activeCell>, ECMA-376 §18.3.1.78), or null when the sheet has no selection.
activeSheet() - Method in class io.keikai.axyra.sheets.Workbook: The active sheet: the tab Excel shows when the file opens.
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 formula evaluated over the sums of the referenced source fields within each pivot bucket (Excel's calculated-field semantics; ECMA-376 Part 1 §18.10.1.13 cacheField@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 is formula evaluated 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: Adds a chart to this sheet.
addChartSheet(String, Chart) - Method in class io.keikai.axyra.sheets.Workbook: Append a chart-sheet tab named name hosting chart — a dedicated full-page chart tab (ECMA-376 §18.3.1.12 chartsheet), as opposed to a chart floating on a worksheet via Sheet.addChart(io.keikai.axyra.sheets.content.Chart).
addCheckbox(String, int, int, int, int, String) - Method in class io.keikai.axyra.sheets.Sheet: Adds a check box form control over a cell rectangle, optionally bound to a linked cell that holds its state.
addColumnField(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Adds sourceField to the column axis as the innermost level.
addColumnPageBreak(int) - Method in class io.keikai.axyra.sheets.Sheet: Inserts a manual vertical page break left of the 0-based column.
addConditionalFormat(ConditionalFormat) - Method in class io.keikai.axyra.sheets.Range: Adds a conditional-formatting rule over 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 sourceField to the values area with the "Sum of Sales"-style default caption.
addDataField(String, AggregateFunction, String) - Method in class io.keikai.axyra.sheets.PivotTableView: Adds sourceField to the values area with a caption.
addDate(LocalDate, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Appends a date at the next column; style must carry a date format.
addFilterField(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Adds sourceField as a report filter: Excel's Filters area, an 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: Adds a form control: check box, option button, button, combo box, list box, scroll bar, spin button, edit box, label or group box.
addLinkedPicture(String, String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Adds a linked picture over the cell rectangle from (r1, c1) to (r2, c2): the image is referenced by an external target, a URL or a path, through <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: Adds a workbook-scoped defined name, or replaces one.
addName(String, String, Sheet) - Method in class io.keikai.axyra.sheets.Workbook: Adds a defined name scoped to scope, or replaces one; the rules of Workbook.addName(String, String) apply.
addNumber(double) - Method in class io.keikai.axyra.sheets.io.StreamRow: Appends a number at the next column; same as setNumber(next, value).
addNumber(double, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Appends a number with a style index at the next column.
addOleObject(String, String, byte[]) - Method in class io.keikai.axyra.sheets.Workbook: Embeds an OLE object (raw bytes, optional ProgID) at workbook level.
addPageField(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Same as PivotTableView.addFilterField(java.lang.String), under the OOXML "page field" name.
addPicture(byte[], String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Inserts an embedded image over the cell rectangle from (fromRow, fromColumn) to (toRow, toColumn).
addPicture(byte[], String, int, int, int, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Inserts an embedded image with a full two-cell anchor, offsets included.
addPivotChart(int, String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Add a PivotChart bound to the pivot table at pivotIndex on this sheet, anchored over the given cell rectangle.
addPivotTable(String, String, String) - Method in class io.keikai.axyra.sheets.Sheet: Creates an empty pivot table whose top-left cell is location (A1, such as "H1") over the source range sourceRef, such as "Data!A1:D100".
addProtectedRange(String, String) - Method in class io.keikai.axyra.sheets.Sheet: Adds an allow-edit range without a password; see Sheet.addProtectedRange(String, String, String).
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 range sqref stays editable while the sheet is protected.
address() - Method in record class io.keikai.axyra.sheets.content.Hyperlink: Returns the value of the address record component.
addRowField(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Adds sourceField to the row axis as the innermost level.
addRowPageBreak(int) - Method in class io.keikai.axyra.sheets.Sheet: Inserts a manual horizontal page break above the 0-based row.
addScenario(String, String[], String[]) - Method in class io.keikai.axyra.sheets.Sheet: Adds a what-if scenario to this sheet.
addShape(String, String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Adds a drawing shape, such as "rect", "ellipse" or "roundRect", with optional text, over the cell rectangle from (fromRow, fromCol) to (toRow, toCol), 0-based.
addSlicer(String, String) - Method in class io.keikai.axyra.sheets.Workbook: Adds a slicer descriptor named name bound to source, a table or pivot field name.
addSlicer(String, String, String, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Workbook: Adds a slicer that displays in Excel: bound to the pivot field source of pivotTable, anchored on sheet sheetIndex with a two-cell drawing anchor spanning row/col to endRow/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: Adds a slicer that displays in Excel, keeping 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 draws dataRef (e.g.
addStyle(StreamStyle) - Method in class io.keikai.axyra.sheets.io.StreamWorkbook: Registers a style and returns the index that cells pass as their style argument.
addText(String) - Method in class io.keikai.axyra.sheets.io.StreamRow: Appends text at the next column; null writes a blank.
addText(String, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Appends text with a style index at the next column; null writes a styled blank.
addTextBox(String, int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Add a text box holding text, anchored over the cell rectangle from (fromRow, fromCol) to (toRow, toCol), 0-based; returns the new shape's 0-based index.
addThreadedComment(String, String) - Method in class io.keikai.axyra.sheets.Cell: Starts a new Excel 365 comment thread on this cell.
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: Adds a timeline (a date slicer) that filters pivot table source over dateField, placed beside the pivot: on the pivot's sheet, at its first row, one column clear of the sheet's used range and of any slicer or timeline already there, 6 columns wide and 7 rows tall.
addTimeline(String, String, String, int, int, int, int, int) - Method in class io.keikai.axyra.sheets.Workbook: Adds a timeline that displays in Excel: it filters pivot table source over dateField, anchored on sheet sheetIndex spanning row/col to endRow/endCol.
addTrendline(int, Trendline) - Method in class io.keikai.axyra.sheets.ChartView: Adds a trendline to a series, after any it already has.
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 aggregation record component.
algorithm() - Method in record class io.keikai.axyra.sheets.SignatureInfo: Returns the value of the algorithm record component.
allBorders(BorderStyle, Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the left, right, top and bottom edges of each cell to the same line.
allDependents(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Workbook: Every cell that depends on a cell directly or through other cells; the cell itself is not included.
allowBlank() - Method in class io.keikai.axyra.sheets.content.Validation: Whether a blank cell passes the rule.
allowBlank(boolean) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets whether a blank cell passes the rule; true by default.
allowCopy() - Method in class io.keikai.axyra.sheets.io.PdfOptions: Whether content copy and extraction is permitted (encryption only; default true).
allowCopy(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Permits or forbids copying and extracting content.
allowModify() - Method in class io.keikai.axyra.sheets.io.PdfOptions: Whether document modification is permitted (encryption only; default true).
allowModify(boolean) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Permits or forbids changing the document.
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: Permits or forbids printing.
alpha() - Method in class io.keikai.axyra.sheets.style.Color: The alpha channel of an RGB color.
anchor() - Method in class io.keikai.axyra.sheets.ChartView: The two-cell anchor as {fromRow, fromColumn, toRow, toColumn}, all 0-based.
anchor(int, int, int, int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the two-cell anchor (0-based).
anchor(int, int, int, int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the two-cell anchor (0-based).
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: Sets the offsets of the anchor's corners inside their cells, in EMU (914400 EMU = 1 inch).
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 (see Workbook.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 (Application of docProps/app.xml), or null when none is set.
apply(double[]) - Method in interface io.keikai.axyra.sheets.formula.UserFunction: Computes the function result.
apply(CellValue[]) - Method in interface io.keikai.axyra.sheets.formula.TypedUserFunction: Computes the function result.
applyAdvancedFilter(Range, Range, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Run an advanced filter (Excel's Data > Advanced) over listRange in place, hiding the data rows that do not match criteriaRange.
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 of destination.
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: Applies a registered named cell style to every cell in the rectangle, replacing each cell's style.
appVersion() - Method in class io.keikai.axyra.sheets.Workbook: The authoring application version (AppVersion), or null.
area() - Static method in class io.keikai.axyra.sheets.content.Chart: An area 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: An RGB color with an alpha channel.
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 Array record class.
arrayFormulaRefs() - Method in class io.keikai.axyra.sheets.Range: Reads, for each cell, the extent of the legacy array formula (Ctrl+Shift+Enter) whose top-left cell it is: "B2:B5", or "C3" for a one-cell array.
asc(int) - Static method in record class io.keikai.axyra.sheets.SortKey: Returns an ascending key on column.
ascending() - Method in record class io.keikai.axyra.sheets.PivotFieldSort: Returns the value of the ascending record component.
ascending() - Method in record class io.keikai.axyra.sheets.SortKey: Returns the value of the ascending record component.
asRange() - Method in class io.keikai.axyra.sheets.NamedRange: Returns the cells this name points at, resolved from the formula held by this object.
author() - Method in record class io.keikai.axyra.sheets.content.Comment: Returns the value of the author record component.
author() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment: Returns the value of the author record 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 dc:creator), or null when none is set.
author(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Sets the document author in the PDF metadata.
auto() - Static method in class io.keikai.axyra.sheets.style.Color: The automatic color: Excel's "Automatic", which draws as the window-text color (black by default).
autoExpandTables(int, int, String) - Method in class io.keikai.axyra.sheets.Sheet: Applies Excel's table auto-expansion for an entry typed at (row, col).
autoFill(Range) - Method in class io.keikai.axyra.sheets.Range: Detects a pattern in this range and extends it over destination, as Excel's fill handle does: a linear numeric series, or a cyclic copy for text and mixed content.
autoFilter() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the autoFilter record component.
autoFilter(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows using AutoFilter (default false).
autoFilterRange() - Method in class io.keikai.axyra.sheets.Sheet: Returns the filtered block, header row included, or null when this sheet has no auto-filter.
autoFitColumn(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets a column's width to fit the widest text its cells display in the sheet's used rows.
autoFitRow(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets a row's height to fit its tallest content, as Excel's AutoFit Row Height does.
AUTOMATIC - Enum constant in enum class io.keikai.axyra.sheets.calc.CalcMode: Recalculates dependent formulas after every change; Excel's default.
AUTOMATIC_EXCEPT_TABLES - Enum constant in enum class io.keikai.axyra.sheets.calc.CalcMode: Excel's "Automatic except for data tables" (calcMode="autoNoTable").
autoMerge(boolean) - Method in class io.keikai.axyra.sheets.Range: Merges runs of adjacent cells with identical, non-empty displayed text: left to right within each row when horizontal is 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: Arithmetic mean of the numeric values (Excel's "Average").
AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: AVERAGE: mean of the numbers at each position.
AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 1, AVERAGE: mean of the numbers.
AVERAGE - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(101, column): mean of the visible values.
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 axisColor record component.
axisColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the axisColor record component.
axisColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: Sets the data-bar axis color.
axisPosition() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The data-bar axis position (automatic / middle / none), or null.
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: Creates an exception with a message.
AxyraException(String, Throwable) - Constructor for exception io.keikai.axyra.sheets.AxyraException: Creates an exception with a message and the cause it wraps.
AxyraFormulaException - Exception in io.keikai.axyra.sheets: A formula the API cannot accept: for example a syntactically invalid formula passed to Range.setFormula(java.lang.String) or Cell.setFormula(java.lang.String).
AxyraFormulaException(String) - Constructor for exception io.keikai.axyra.sheets.AxyraFormulaException: Creates a formula exception with a message.
AxyraFormulaException(String, Throwable) - Constructor for exception io.keikai.axyra.sheets.AxyraFormulaException: Creates a formula exception with a message and the cause it wraps.
AxyraIoException - Exception in io.keikai.axyra.sheets: A file I/O or file-format failure: for example a missing file, an unsupported format, or a malformed workbook that cannot be read or written.
AxyraIoException(String) - Constructor for exception io.keikai.axyra.sheets.AxyraIoException: Creates an I/O or file-format exception with a message.
AxyraIoException(String, Throwable) - Constructor for exception io.keikai.axyra.sheets.AxyraIoException: Creates an I/O or file-format exception with a message and the cause it wraps.

B

backgroundImage() - Method in class io.keikai.axyra.sheets.Sheet: Returns the encoded bytes of the sheet background image, or null when there is none.
backgroundImageFormat() - Method in class io.keikai.axyra.sheets.Sheet: Returns the format token of the sheet background image, such as "png", or null when there is none.
backward() - Method in record class io.keikai.axyra.sheets.content.Trendline: Returns the value of the backward record component.
bar() - Static method in class io.keikai.axyra.sheets.content.Chart: A horizontal bar chart: categories up the side, values along the bottom.
barBorderColor() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The data-bar border color token, or null when borderless.
barBorderColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: Draws a data-bar border in color.
barDirection() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The data-bar direction (context / leftToRight / rightToLeft), or null.
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 barType record component.
baseColumnWidth() - Method in class io.keikai.axyra.sheets.Sheet: Returns the declared baseColWidth in characters, or 0 when the sheet declares none; the spec default of 8 then applies.
baseField() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs: Returns the value of the baseField record component.
baseItem() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs: Returns the value of the baseItem record component.
BASELINE - Enum constant in enum class io.keikai.axyra.sheets.style.FontVertical: Normal text on the baseline.
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: Numbers below the average of the column's data rows.
between(String, String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: A cellIs rule that matches values from low to high, both included.
BETWEEN - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items with low <= aggregate <= high; the only two-threshold condition.
bindings() - Method in record class io.keikai.axyra.sheets.content.XmlMap: Returns the value of the bindings record component.
BLACK - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque black, #000000.
blank() - Static method in interface io.keikai.axyra.sheets.CellValue: Returns CellValue.BLANK, the value of an empty cell.
Blank() - Constructor for record class io.keikai.axyra.sheets.CellValue.Blank: Creates an instance of a Blank record class.
BLANK - Enum constant in enum class io.keikai.axyra.sheets.io.FormulaPolicy: Writes the cell blank: the formula and its value are both left out.
BLANK - Static variable in interface io.keikai.axyra.sheets.CellValue: The value of an empty cell.
blue() - Method in class io.keikai.axyra.sheets.style.Color: The blue channel of an RGB color.
BLUE - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque blue, #0000FF.
bold() - Method in record class io.keikai.axyra.sheets.content.CommentRun: Returns the value of the bold record component.
bold() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: Makes matching cells bold.
bold() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the bold record component.
bold() - Method in class io.keikai.axyra.sheets.content.RichText.Run: Makes the run bold.
bold() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the bold record component.
bold() - Method in record class io.keikai.axyra.sheets.FindFormat: Returns the value of the bold record component.
bold() - Method in class io.keikai.axyra.sheets.io.StreamStyle: Whether the font is bold.
bold() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether the font is bold.
bold() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Makes the font bold; shorthand for bold(true).
bold(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets (true) or clears (false) bold.
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: Adds a PDF outline (bookmarks): one entry per exported sheet, pointing at the sheet's first page.
bool(boolean) - Static method in interface io.keikai.axyra.sheets.CellValue: A boolean value: CellValue.TRUE or CellValue.FALSE.
Bool(boolean) - Constructor for record class io.keikai.axyra.sheets.CellValue.Bool: Creates an instance of a Bool record class.
Bool(boolean) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Bool: Creates an instance of a Bool record class.
BOOL - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind: TRUE or FALSE, in any letter case; number() is 1.0 or 0.0.
booleanValue() - Method in record class io.keikai.axyra.sheets.format.ParsedValue: The boolean value: true only when kind() == BOOL and the input was TRUE.
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: One border edge: its line style plus color.
border(Side, BorderStyle, Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets one border edge.
borderBottom() - Method in class io.keikai.axyra.sheets.style.CellStyle: The bottom border edge; same as border(Side.BOTTOM).
borderDiagonal() - Method in class io.keikai.axyra.sheets.style.CellStyle: The diagonal border edge; its direction comes from CellStyle.diagonalDown() and CellStyle.diagonalUp().
BorderEdge - Record Class in io.keikai.axyra.sheets.style: One border edge read back from a CellStyle with CellStyle.border(Side): the line style and its color.
BorderEdge(BorderStyle, Color) - Constructor for record class io.keikai.axyra.sheets.style.BorderEdge: Creates an instance of a BorderEdge record class.
borderLeft() - Method in class io.keikai.axyra.sheets.style.CellStyle: The left border edge; same as border(Side.LEFT).
borderRight() - Method in class io.keikai.axyra.sheets.style.CellStyle: The right border edge; same as border(Side.RIGHT).
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: The line style of one cell border edge (ECMA-376 ST_BorderStyle).
borderTop() - Method in class io.keikai.axyra.sheets.style.CellStyle: The top border edge; same as border(Side.TOP).
bottom() - Method in record class io.keikai.axyra.sheets.PageMargins: Returns the value of the bottom record component.
bottom() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter: Returns the value of the bottom record component.
BOTTOM - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition: Below the plot area.
BOTTOM - Enum constant in enum class io.keikai.axyra.sheets.style.Side: The cell's bottom edge.
BOTTOM - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign: Content at the bottom of the cell; Excel's default.
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: A bubble chart; add series with Chart.Builder.bubbleSeries(java.lang.String, java.lang.String, java.lang.String, java.lang.String) so each bubble has a size.
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 plain series(...) 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: The immutable rule.
build() - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: The immutable control.
build() - Method in class io.keikai.axyra.sheets.content.RichText.Builder: The immutable rich text.
build() - Method in class io.keikai.axyra.sheets.content.Validation.Builder: The immutable rule.
build() - Method in class io.keikai.axyra.sheets.ImportOptions.Builder: Builds the ImportOptions.
build() - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder: Builds immutable options; later builder calls do not change them.
build() - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Builds immutable options; later builder calls do not change them.
build() - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Builds the immutable SheetProtection.
build() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Builds an immutable style; later builder calls do not change it.
build() - Method in class io.keikai.axyra.sheets.style.Theme.Builder: Builds an immutable theme; later builder calls do not change it.
builder() - Static method in class io.keikai.axyra.sheets.content.ConditionalFormat: A builder.
builder() - Static method in class io.keikai.axyra.sheets.content.RichText: A builder; add runs in reading order with RichText.Builder.run(String).
builder() - Static method in class io.keikai.axyra.sheets.content.Validation: A builder for any validation type.
builder() - Static method in record class io.keikai.axyra.sheets.ImportOptions: Returns a new builder holding the defaults (headers = true).
builder() - Static method in class io.keikai.axyra.sheets.io.ImageOptions: A builder with the defaults: scale 1.0, no target width, the sheet's own gridline setting, page 1 and no extra font directories.
builder() - Static method in class io.keikai.axyra.sheets.io.PdfOptions: A builder with every option unset; its result renders like the plain renderPdf(Path).
builder() - Static method in record class io.keikai.axyra.sheets.SheetProtection: Returns a new builder holding SheetProtection.defaults().
builder() - Static method in class io.keikai.axyra.sheets.style.CellStyle: An empty builder.
builder() - Static method in class io.keikai.axyra.sheets.style.Theme: A builder with every color slot unset and the fonts "Calibri Light" (major) and "Calibri" (minor).
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: A push button.
byPercent() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter: Returns the value of the byPercent record 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 byValueDataField record component.

C

cachedValueCount() - Method in record class io.keikai.axyra.sheets.content.ExternalLink: Returns the value of the cachedValueCount record component.
cacheName() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the cacheName record component.
cacheName() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the cacheName record component.
calcMode() - Method in class io.keikai.axyra.sheets.Workbook: The workbook calculation mode: the one the file carries, or AUTOMATIC for a new workbook.
CalcMode - Enum Class in io.keikai.axyra.sheets.calc: The workbook calculation mode, read with Workbook.calcMode() and set with Workbook.setCalcMode(CalcMode).
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 caption record component.
caption() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the caption record component.
category() - Method in class io.keikai.axyra.sheets.Workbook: The document category (cp:category), or null.
categoryAxisTitle() - Method in class io.keikai.axyra.sheets.ChartView: The category (X) axis title, or null when the axis has none or the chart has no category axis.
categoryAxisTitle() - Method in class io.keikai.axyra.sheets.content.Chart: The category (X) axis title, or null when none is set.
categoryAxisTitle(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the category (X) axis title; null sets none.
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: Shows or hides the category (X) axis; shown by default (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: Returns a single-cell view at (row, col).
Cell - Class in io.keikai.axyra.sheets: One cell of a sheet: a lightweight (sheet, row, column) view, 0-based, that holds no native resource.
cellIs(String, String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: A cellIs rule, for example cellIs("greaterThan", "100").
cellRef() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding: Returns the value of the cellRef record 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 CellRef record 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 for a CellStyle.
CellValue - Interface in io.keikai.axyra.sheets: One cell's value: a number, text, boolean, error or blank, or a matrix passed to and from a user-defined function.
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; use the shared CellValue.BLANK.
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.TYPE code (see CellValue.error(int) for the codes).
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: Centered in the cell.
CENTER - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign: Content centered vertically.
CENTER_CONTINUOUS - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign: Centers across the adjacent empty cells to the right (Excel's "Center Across Selection").
certificateNo() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the certificateNo record component.
chart(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns a live view of the chart at chartIndex, its 0-based position in Sheet.charts().
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: A fluent builder for a Chart.
chartAreaBorder(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the chart-area border color.
chartAreaFill() - Method in class io.keikai.axyra.sheets.ChartView: The chart-area fill color, or null when none is set and the default white applies.
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 border color, or null when none is set.
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 is set to have no border.
charts() - Method in class io.keikai.axyra.sheets.Sheet: Returns every chart on this sheet, in drawing order.
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 view Sheet.chart(int) returns.
chartSheetCount() - Method in class io.keikai.axyra.sheets.Workbook: Number of chart-sheet tabs in the workbook, authored and imported.
chartSheetName(int) - Method in class io.keikai.axyra.sheets.Workbook: The tab name of the chart sheet at index (0-based position among the chart sheets, in tab order).
ChartView - Class in io.keikai.axyra.sheets: A view of one existing chart, obtained with Sheet.chart(int) for a chart on a worksheet, or with Workbook.chartSheetChart(int) for the chart of a chart-sheet tab.
CHECK_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType: A check box with an on/off state.
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: Sets the state of a check box or option button.
clear() - Method in class io.keikai.axyra.sheets.Cell: Clears this cell's value and formula.
clear() - Method in class io.keikai.axyra.sheets.Range: Clears the value and formula of every cell in the rectangle.
clearAutoFilter() - Method in class io.keikai.axyra.sheets.Sheet: Removes the auto-filter and its criteria.
clearBackgroundImage() - Method in class io.keikai.axyra.sheets.Sheet: Removes the sheet background image.
clearCharts() - Method in class io.keikai.axyra.sheets.Sheet: Removes every chart from this sheet.
clearColumnFilter(int) - Method in class io.keikai.axyra.sheets.Sheet: Removes the criterion from one column and runs the filter, so rows that now pass are shown again.
clearConditionalFormats() - Method in class io.keikai.axyra.sheets.Sheet: Removes every conditional-formatting rule from this sheet.
clearFieldSort(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Restores manual or source item order for the row/column field field.
clearHyperlinks() - Method in class io.keikai.axyra.sheets.Range: Removes every hyperlink in the rectangle.
clearLabelFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Clears the caption (label) filter of the row/column field field.
clearPageBreaks() - Method in class io.keikai.axyra.sheets.Sheet: Removes every page break on this sheet: the manual ones and the automatic ones kept from the source file.
clearPaperSize() - Method in class io.keikai.axyra.sheets.Sheet: Removes the paper-size declaration, so the saved sheet has no paperSize attribute and Excel uses the printer's default paper.
clearPictures() - Method in class io.keikai.axyra.sheets.Sheet: Removes every picture from this sheet, embedded and linked.
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-area field and clears its base references.
clearTopNFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Clears the Top-N filter of the row/column field field.
clearTrendlines(int) - Method in class io.keikai.axyra.sheets.ChartView: Removes every trendline from a series.
clearValidations() - Method in class io.keikai.axyra.sheets.Sheet: Removes every data-validation rule from this sheet; the cell values stay.
clearValueFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Clears the value filter of the row/column field 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: Frees the native workbook and its registered user-defined functions.
code() - Method in enum class io.keikai.axyra.sheets.calc.CalcMode: The engine code: 0 automatic, 1 manual, 2 automatic except tables.
code() - Method in record class io.keikai.axyra.sheets.CellValue.Error: Returns the value of the code record 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: Returns the ECMA-376 token for this kind, e.g.
code() - Method in enum class io.keikai.axyra.sheets.FilterOperator: Returns the engine's operator code, 0 to 5 in declaration order.
code() - Method in enum class io.keikai.axyra.sheets.io.FormulaPolicy: The engine code: 0 keep, 1 blank, 2 values only.
code() - Method in enum class io.keikai.axyra.sheets.TotalsRowFunction: Returns the ECMA-376 token for this function, e.g.
col() - Method in class io.keikai.axyra.sheets.Cell: The 0-based column index.
col() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the col record component.
col() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the col record component.
colCount() - Method in record class io.keikai.axyra.sheets.CellValue.Array: Returns the number of columns, taken from the first row; 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 color record component.
color() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the color record component.
color() - Method in record class io.keikai.axyra.sheets.style.BorderEdge: Returns the value of the color record component.
color() - Method in record class io.keikai.axyra.sheets.style.GradientStop: Returns the value of the color record component.
color(Color) - Method in class io.keikai.axyra.sheets.content.RichText.Run: Sets the run's font color.
color(Theme.Slot) - Method in class io.keikai.axyra.sheets.style.Theme: The raw color token of a slot, e.g.
color(Theme.Slot, Color) - Method in class io.keikai.axyra.sheets.style.Theme.Builder: Sets a slot to an RGB color, stored as "RRGGBB".
color(Theme.Slot, String) - Method in class io.keikai.axyra.sheets.style.Theme.Builder: Sets a slot to a raw six-digit hex token, "RRGGBB", without a leading #.
Color - Class in io.keikai.axyra.sheets.style: An immutable spreadsheet color in one of four kinds: plain ARGB, a legacy indexed-palette reference, a theme-palette reference with an optional tint, or the automatic (window-text) color.
colors() - Method in class io.keikai.axyra.sheets.style.Theme: The 12 raw color tokens in Theme.Slot order.
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: #RRGGBB hex, raw AARRGGBB hex, 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 colorStyle record component.
column() - Method in record class io.keikai.axyra.sheets.CellRef: Returns the value of the column record component.
column() - Static method in class io.keikai.axyra.sheets.content.Chart: A vertical clustered column chart.
column() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding: Returns the value of the column record component.
column() - Method in record class io.keikai.axyra.sheets.SortKey: Returns the value of the column record component.
columnCount() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the columnCount record component.
columnFields() - Method in class io.keikai.axyra.sheets.PivotTableView: The column-axis fields in nesting order, outermost first.
columnLabels() - Method in record class io.keikai.axyra.sheets.ImportOptions: Returns the value of the columnLabels record component.
columnLabels(String...) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder: Sets the header texts, one per imported column; null uses the property names.
columnPageBreaks() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 0-based columns a vertical page break sits left of, ascending, as Sheet.rowPageBreaks() does for rows.
columns() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the columns record component.
columns() - Method in record class io.keikai.axyra.sheets.ImportOptions: Returns the value of the columns record component.
columns(String...) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder: Imports only these properties, in this order.
columnStyle(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the column-level style: the style that cells in this column without their own style render with (<col style>).
columnStyleId(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the column-level style id, or 0 when the column has no column-level style.
columnWidth(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns a column's width in character units.
combine(Workbook...) - Method in class io.keikai.axyra.sheets.Workbook: Appends a deep copy of every sheet (visible and hidden) of each source workbook, in argument order, auto-suffixing colliding names.
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: A drop-down list fed by a list-fill range.
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 command record component.
comment() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's plain-text comment (Excel's note).
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 Comment record 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 CommentRun record class.
commentRuns() - Method in class io.keikai.axyra.sheets.Cell: Returns the rich-text runs of this cell's note.
comments() - Method in class io.keikai.axyra.sheets.Workbook: The comments (OOXML dc:description), or null when none are set.
commit() - Method in class io.keikai.axyra.sheets.io.StreamRow: Writes the row to the file.
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 (Company of docProps/app.xml), or null.
ConditionalFormat - Class in io.keikai.axyra.sheets.content: A conditional-formatting rule (immutable).
ConditionalFormat.Builder - Class in io.keikai.axyra.sheets.content: A fluent builder for a ConditionalFormat.
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: Returns every conditional-formatting rule on this sheet, in stored order.
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, or xl/connections.bin for an .xlsb file.
connectionString() - Method in record class io.keikai.axyra.sheets.content.DataConnection: Returns the value of the connectionString record component.
consolidate(int, int, ConsolidateFunction, Range...) - Method in class io.keikai.axyra.sheets.Sheet: Consolidates several source ranges of the same shape, possibly on other sheets, into this sheet at (destRow, destColumn), as Excel's Data > Consolidate does 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...).
contains(String) - Static method in class io.keikai.axyra.sheets.formula.Functions: Whether a built-in function has this name, ignoring case.
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: Returns per-cell content flags, row-major.
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: Converts the named table back to an ordinary range, as Excel's Table Design > Convert to Range does: drops the table definition and keeps every cell value and style in place.
copySheet(Sheet, String) - Method in class io.keikai.axyra.sheets.Workbook: Appends a deep copy of source under newName and returns a view of the copy.
copySheetFrom(Workbook, int) - Method in class io.keikai.axyra.sheets.Workbook: Appends a deep copy of sheet sheetIndex (0-based) of another workbook and returns a view of the copy.
copySheetFrom(Workbook, int, String) - Method in class io.keikai.axyra.sheets.Workbook: Appends a deep copy of sheet sheetIndex (0-based) of another workbook under newName and returns a view of the copy.
copyTo(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Range: Copies this rectangle to (dstRow, dstCol) on dstSheet, as Excel's Copy and Paste do.
copyTo(Sheet, int, int, String) - Method in class io.keikai.axyra.sheets.Range: Copies this rectangle with an Excel Paste Special mode.
count() - Static method in class io.keikai.axyra.sheets.formula.Functions: The number of built-in functions; equal to list().length.
COUNT - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction: Number of non-empty values, numbers and text alike, as COUNTA counts (Excel's "Count").
COUNT - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: COUNT: how many numbers are at each position.
COUNT - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 2, COUNT: number of numeric cells.
COUNT - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(103, column): COUNTA, the number of non-empty visible cells.
COUNT_A - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: COUNTA: how many non-blank cells (numbers, text, booleans, errors) are at each position.
COUNT_NUMS - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction: Number of numeric values only, as COUNT counts (countNums, Excel's "Count Numbers").
COUNT_NUMS - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(102, column): COUNT, the number of numeric visible cells.
COUNTA - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 3, COUNTA: number of non-empty cells.
create() - Static method in class io.keikai.axyra.sheets.io.CsvOptions: Options with the defaults: the active sheet, comma, display text, no byte-order mark.
create() - Static method in class io.keikai.axyra.sheets.io.HtmlOptions: Options for the default shape: the package, a document plus its _files directory.
create() - Static method in class io.keikai.axyra.sheets.io.SaveOptions: Options with every field at its full-fidelity default: formulas kept, comments and hyperlinks written.
create() - Static method in class io.keikai.axyra.sheets.Workbook: Creates a new empty workbook with no sheets, on the sparse storage 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: Creates a new empty workbook, with no sheets, on the columnar storage backend.
created() - Method in class io.keikai.axyra.sheets.Workbook: The creation timestamp (dcterms:created, W3CDTF), or null.
createSheet(String) - Method in class io.keikai.axyra.sheets.Workbook: Appends a new empty worksheet after the last tab and returns a view of it.
createTable(String, String...) - Method in class io.keikai.axyra.sheets.Range: Creates a table (Excel's ListObject, "Format as Table") 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; see CsvOptions.values(Values).
custom(String) - Static method in class io.keikai.axyra.sheets.content.Validation: A custom-formula constraint: an entry is valid when the formula returns TRUE.
CUSTOM - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: The caller's own formula, written unchanged into the totals-row cell.
customerId() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the customerId record component.
customName() - Method in record class io.keikai.axyra.sheets.PivotField: Returns the value of the customName record component.
customOrder() - Method in record class io.keikai.axyra.sheets.SortKey: Returns the value of the customOrder record 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 CustomProperty record 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:cy currency): vtType is the original element name and value its text, both preserved verbatim in the file across open and 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 — or null when the workbook defines none.

D

DARK_DOWN - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thick diagonal stripes running down from left to right.
DARK_GRAY - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: 75 % gray dot pattern.
DARK_GRID - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thick horizontal and vertical crosshatch.
DARK_HORIZONTAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thick horizontal stripes.
DARK_TRELLIS - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thick diagonal crosshatch (trellis).
DARK_UP - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thick diagonal stripes running up from left to right.
DARK_VERTICAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thick vertical stripes.
DARK1 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: dk1, Excel's "Text 1"; usually black.
DARK2 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: dk2, Excel's "Text 2".
DASH_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Thin dash-dot line.
DASH_DOT_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Thin dash-dot-dot line.
DASHED - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Thin dashed line.
data() - Method in record class io.keikai.axyra.sheets.content.OleObject: Returns the value of the data record 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 null for 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 DataConnection record class.
dataField() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter: Returns the value of the dataField record component.
dataField() - Method in record class io.keikai.axyra.sheets.PivotValueFilter: Returns the value of the dataField record 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 label position, an optional numberFormat override (§21.2.2.79 numFmt) that formats the value independently of the value axis, plus optional label text styling (§21.2.2.216 <c:txPr>): rotation, color, bold and font size.
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 DataLabels record class.
dataRange() - Method in record class io.keikai.axyra.sheets.content.Sparkline: Returns the value of the dataRange record component.
dataType() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding: Returns the value of the dataType record component.
date(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation: A date constraint, for example date("between", "DATE(2020,1,1)", "DATE(2020,12,31)").
Date(LocalDate) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Date: Creates an instance of a Date record class.
DATE - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind: A date or time; number() holds the Excel serial.
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 dateAxisRange record component.
dateAxisRange() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the dateAxisRange record component.
dateBy() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup: Returns the value of the dateBy record component.
dateField() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the dateField record 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 DateGroupItem record 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: Returns the cell's value as a date and time, in the workbook's date system, with the day fraction rounded to the nearest second.
dateValue() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's value as a date: the whole-day part of the serial, in the workbook's date system.
day() - Method in record class io.keikai.axyra.sheets.DateGroupItem: Returns the value of the day record component.
day(int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem: An item that selects one day; month is 1-based, day is 1 to 31.
DAYS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy: Day of the month: items read "01" to "31".
decimal(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation: A decimal-number constraint, for example decimal("greaterThan", "0", null).
defaultColumnWidth() - Method in class io.keikai.axyra.sheets.Sheet: Returns the sheet's declared default column width in character units, or 0 when none is declared; column widths then derive from Sheet.baseColumnWidth().
defaultRowHeight() - Method in class io.keikai.axyra.sheets.Sheet: Returns the sheet's default row height in points: the height of every row without a height of its own.
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: Returns the default options: a header row of property names, every property, no header style.
defaults() - Static method in class io.keikai.axyra.sheets.io.StreamStyle: The neutral style: General number format, not bold, not italic.
defaults() - Static method in record class io.keikai.axyra.sheets.SheetProtection: Returns Excel's Protect Sheet dialog defaults: only cell selection is 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: Deletes the cells of this rectangle and moves the remaining cells into the gap: Shift.UP moves the cells below, in these columns, up; Shift.LEFT moves the cells to the right, in these rows, left.
deleteColumns() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the deleteColumns record component.
deleteColumns(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows deleting columns (default false).
deleteColumns(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Deletes count columns starting at startCol, shifting the columns to the right of them left.
deleteRows() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the deleteRows record component.
deleteRows(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows deleting rows (default false).
deleteRows(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Deletes count rows starting at startRow, shifting the rows below up.
deleteSheet(int) - Method in class io.keikai.axyra.sheets.Workbook: Deletes the sheet at index (0-based).
delimiter() - Method in class io.keikai.axyra.sheets.io.CsvOptions: The field separator.
delimiter(char) - Method in class io.keikai.axyra.sheets.io.CsvOptions: Sets the field separator.
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: Returns a descending key on column.
detail() - Method in record class io.keikai.axyra.sheets.SignatureInfo: Returns the value of the detail record component.
DIAGONAL - Enum constant in enum class io.keikai.axyra.sheets.style.Side: The diagonal line through the cell.
diagonalDown() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether the diagonal border runs from top-left to bottom-right.
diagonalDown(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Shows (true) or hides the diagonal line from top-left to bottom-right.
diagonalUp() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether the diagonal border runs from bottom-left to top-right.
diagonalUp(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Shows (true) or hides the diagonal line from bottom-left to top-right.
DIALOG - Enum constant in enum class io.keikai.axyra.sheets.SheetType: A legacy Excel 5.0 dialog sheet; saved back as an ordinary worksheet.
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: Returns whether the first printed page uses its own header and footer (ECMA-376 §18.3.1.46 differentFirst).
differentOddEven() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether odd and even printed pages use different headers and footers (ECMA-376 §18.3.1.46 differentOddEven).
direction() - Method in record class io.keikai.axyra.sheets.content.ErrorBars: Returns the value of the direction record component.
display() - Method in record class io.keikai.axyra.sheets.CellValue.Error: Returns 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 display record component.
displayName() - Method in record class io.keikai.axyra.sheets.PivotField: Returns the value of the displayName record component.
DISTRIBUTED - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign: Spreads the words evenly across the cell width (Excel's "Distributed (Indent)").
DISTRIBUTED - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign: Distributes the lines evenly over the cell height.
docSecurity() - Method in class io.keikai.axyra.sheets.Workbook: The DocSecurity flags of docProps/app.xml, or null when the workbook records none.
documentVersion() - Method in class io.keikai.axyra.sheets.Workbook: The author-recorded document version (cp:version of docProps/core.xml), or null.
DOTTED - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Thin dotted line.
DOUBLE - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Two thin parallel lines.
DOUBLE - Enum constant in enum class io.keikai.axyra.sheets.style.Underline: Two lines under the text.
DOUBLE_ACCOUNTING - Enum constant in enum class io.keikai.axyra.sheets.style.Underline: Two lines placed lower and spanning the cell width.
doughnut() - Static method in class io.keikai.axyra.sheets.content.Chart: A doughnut chart; set the hole with Chart.Builder.holeSize(int).
DOWN - Enum constant in enum class io.keikai.axyra.sheets.Shift: Cells move down; valid for Range.insertCells(io.keikai.axyra.sheets.Shift).
dropLines() - Method in class io.keikai.axyra.sheets.content.FormControl: Visible drop-down rows of a combo box; 0 when the control does not store it, in which case Excel shows 8.
dropLines(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets how many rows a combo box's drop-down shows; Excel uses 8 when not set.
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: Returns the sheet-level x14ac:dyDescent text-descent hint on <sheetFormatPr>, or 0 when 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: A text edit box (a dialog-sheet control).
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 edition record 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 end record component.
endCap() - Method in record class io.keikai.axyra.sheets.content.ErrorBars: Returns the value of the endCap record component.
endCol() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the endCol record component.
endCol() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the endCol record component.
endRow() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the endRow record component.
endRow() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the endRow record 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: The cell equals the value (=).
EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items whose aggregate equals value, within a relative tolerance of one machine epsilon.
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.CellStyle: Two styles are equal when they hold the same attributes with the same values, whether built, read from a cell or decoded from JSON.
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.TYPE code: 1 #NULL!, 2 #DIV/0!, 3 #VALUE!, 4 #REF!, 5 #NAME?, 6 #NUM!, 7 #N/A, 8 #GETTING_DATA, 9 #SPILL!, 14 #CALC!.
Error(int) - Constructor for record class io.keikai.axyra.sheets.CellValue.Error: Creates an instance of a Error record class.
errorBars(int) - Method in class io.keikai.axyra.sheets.ChartView: The error bars of a series, or null when it has none.
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 ErrorBars record class.
errorMessage() - Method in class io.keikai.axyra.sheets.content.Validation: The text of the error alert; an empty string when none.
errorMessage(String, String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets the error alert's title and text and turns the alert on.
errorString(int) - Static method in interface io.keikai.axyra.sheets.CellValue: Maps an Excel ERROR.TYPE code to its display string.
errorStyle() - Method in class io.keikai.axyra.sheets.content.Validation: How firmly a failure is reported: stop (rejects the entry), warning or information; an empty string when unset.
errorStyle(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets the alert style: stop (rejects the entry; the default), warning or information.
errorTitle() - Method in class io.keikai.axyra.sheets.content.Validation: The title of the error alert; an empty string when none.
evaluate(String) - Method in class io.keikai.axyra.sheets.Workbook: Evaluates an ad-hoc formula (leading = optional) in the first sheet's context.
evaluate(String, Sheet) - Method in class io.keikai.axyra.sheets.Workbook: Evaluates an ad-hoc formula in sheet's context: references without a sheet name read that sheet.
evenFooter() - Method in class io.keikai.axyra.sheets.Sheet: Returns the even-page footer text, or null when none is set.
evenHeader() - Method in class io.keikai.axyra.sheets.Sheet: Returns the even-page header text, or null when none is set.
EXPIRED - Enum constant in enum class io.keikai.axyra.sheets.LicenseStatus: The installed key ran out: past its end date and grace period, or a perpetual key whose maintenance window ended before this engine build.
expiresAt() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the expiresAt record component.
expiresAtInstant() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the expiry as an Instant, or null for a perpetual key or no key.
expression(String) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: An expression rule (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 — the chartEx part plus its chartColorStyle / chartStyle parts, 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*.xml part for an extended chart, or null for a classic chart.
extendedColorsData() - Method in class io.keikai.axyra.sheets.ChartView: Base64 of the extended chart's chartColorStyle part, or null.
extendedStyleData() - Method in class io.keikai.axyra.sheets.ChartView: Base64 of the extended chart's chartStyle part, or null.
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!A1 or [1]Sheet1!A1 resolve against.
ExternalLink(int, String, List<String>, int, List<Integer>) - Constructor for record class io.keikai.axyra.sheets.content.ExternalLink: Creates an instance of a ExternalLink record class.
externalLinkCount() - Method in class io.keikai.axyra.sheets.Workbook: Number of external workbook references (ECMA-376 §18.14), the size of Workbook.externalLinks().
externalLinks() - Method in class io.keikai.axyra.sheets.Workbook: Every external workbook reference — the linked workbooks that formulas such as [Book2]Sheet1!A1 resolve 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 (0-based), or null when the index is negative or 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: The boolean FALSE.
features() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the features record component.
field() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem: Returns the value of the field record component.
fieldGroup(String) - Method in class io.keikai.axyra.sheets.PivotTableView: The grouping of the row/column field field, matched ignoring case.
fieldSort(String) - Method in class io.keikai.axyra.sheets.PivotTableView: The declared sort of the row/column field field, matched ignoring case.
fill(Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets a solid fill in color: the pattern becomes PatternType.SOLID and color its foreground.
FILL - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign: Repeats the content to fill the cell width.
fillBackgroundColor() - Method in class io.keikai.axyra.sheets.style.CellStyle: The fill background color, drawn behind the pattern of a non-solid fill.
fillColor() - Method in record class io.keikai.axyra.sheets.FindFormat: Returns the value of the fillColor record component.
fillColor() - Method in class io.keikai.axyra.sheets.style.CellStyle: The fill foreground color: the visible color of a PatternType.SOLID fill, or the pattern color of the other patterns.
fillColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: Fills matching cells with a solid color.
fillPattern() - Method in class io.keikai.axyra.sheets.style.CellStyle: The fill pattern.
fillPattern(PatternType, Color, Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets a patterned fill: pattern drawn in foreground over background.
filterFields() - Method in class io.keikai.axyra.sheets.PivotTableView: The report-filter (page) fields in order.
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: Finds every text cell whose text contains text, ignoring case, across the whole sheet.
find(String, boolean, boolean, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Finds text cells as Sheet.find(String) does, with Excel's Find options.
find(String, boolean, boolean, boolean, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet: Finds cells by text and format, as Sheet.find(String, FindFormat) does, with Excel's Find options.
find(String, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet: Finds cells as Sheet.find(String) does, keeping only the cells whose resolved style matches format: Excel's Find with Format.
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 FindFormat record class.
findName(String) - Method in class io.keikai.axyra.sheets.Workbook: The first defined name spelled exactly name (case-sensitive), in definition order and in any scope, or null when none matches.
findRegex(String) - Method in class io.keikai.axyra.sheets.Sheet: Finds every text cell whose text matches the regular expression pattern, ignoring case, across the whole sheet.
findRegex(String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Finds text cells as Sheet.findRegex(String) does, with a choice of 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 firstColor record component.
firstColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the firstColor record component.
firstColumn() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The first column of the rule's first range (0-based, inclusive); 0 for a rule that was built, not read back.
firstColumn() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the firstColumn record component.
firstColumn() - Method in class io.keikai.axyra.sheets.content.Validation: The first column of the rule's first range (0-based, inclusive); 0 for a rule that was built, not read back.
firstColumn() - Method in class io.keikai.axyra.sheets.Range: First (left) column, 0-based inclusive.
firstFooter() - Method in class io.keikai.axyra.sheets.Sheet: Returns the first-page footer text, or null when none is set.
firstHeader() - Method in class io.keikai.axyra.sheets.Sheet: Returns the first-page header text, or null when none is set.
firstPageNumber() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number printed on the first page, or 0 when numbering is automatic.
firstRow() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The first row of the rule's first range (0-based, inclusive).
firstRow() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the firstRow record component.
firstRow() - Method in class io.keikai.axyra.sheets.content.Validation: The first row of the rule's first range (0-based, inclusive).
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 null to keep each sheet's own scaling.
fitTo(PdfOptions.Fit) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Overrides the scaling of every selected sheet; each sheet's own scale and fit-to-page setting is ignored.
fitToHeight() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of pages tall the printout is fitted to, or 0 for no limit (ECMA-376 §18.3.1.63 fitToHeight).
fitToPage(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Scales the printout to fit width pages wide by height pages tall, and turns on fit-to-page, so Sheet.pageScale() is ignored.
fitToWidth() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of pages wide the printout is fitted to, or 0 for no limit (ECMA-376 §18.3.1.63 fitToWidth).
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: Color of a visited hyperlink.
fontCharset() - Method in class io.keikai.axyra.sheets.style.CellStyle: The font character set code, 0-255 (0 = ANSI, 1 = DEFAULT, 128 = Shift-JIS, …); 0 when unset.
fontCharset(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the font character set code (0 = ANSI, 1 = DEFAULT, 128 = Shift-JIS, …).
fontColor() - Method in record class io.keikai.axyra.sheets.FindFormat: Returns the value of the fontColor record component.
fontColor() - Method in class io.keikai.axyra.sheets.style.CellStyle: The font color: RGB, theme, indexed or automatic.
fontColor(Color) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: Sets the font color of matching cells.
fontColor(Color) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the font color.
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: Sets the extra directories scanned for fonts, on top of the host's own font paths, replacing any set before.
fontDirs(List<String>) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Sets the extra directories scanned for fonts, on top of the host's own font paths, replacing any set before.
fontFamily() - Method in class io.keikai.axyra.sheets.style.CellStyle: The font family class: 0 = not applicable, 1 = Roman, 2 = Swiss, 3 = Modern, 4 = Script, 5 = Decorative.
fontFamily(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the font family class: 0 = not applicable, 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 fontName record component.
fontName() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the fontName record component.
fontName() - Method in class io.keikai.axyra.sheets.style.CellStyle: The font family name, e.g.
fontName(String) - Method in class io.keikai.axyra.sheets.content.RichText.Run: Sets the run's font name, such as "Arial"; without it the run uses the cell font.
fontName(String) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the font family name, e.g.
fontScheme() - Method in class io.keikai.axyra.sheets.style.CellStyle: The theme font scheme the font belongs to.
fontScheme(String) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the theme font scheme the font belongs to.
fontSize() - Method in record class io.keikai.axyra.sheets.content.CommentRun: Returns the value of the fontSize record component.
fontSize() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the fontSize record component.
fontSize() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the fontSize record component.
fontSize() - Method in class io.keikai.axyra.sheets.style.CellStyle: The font size in points (1/72 inch), to 1/100 pt.
fontSize(double) - Method in class io.keikai.axyra.sheets.content.RichText.Run: Sets the run's font size in points.
fontSize(double) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the font size.
fontVertical() - Method in class io.keikai.axyra.sheets.style.CellStyle: The font position: baseline, superscript or subscript; FontVertical.BASELINE when unset.
fontVertical(FontVertical) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the font position: baseline, superscript or subscript.
FontVertical - Enum Class in io.keikai.axyra.sheets.style: The vertical position of the font: normal baseline, superscript or subscript (ECMA-376 ST_VerticalAlignRun).
footer() - Method in record class io.keikai.axyra.sheets.PageMargins: Returns the value of the footer record component.
footer() - Method in class io.keikai.axyra.sheets.Sheet: Returns the page footer text, in Excel's header codes, or null when none is set.
format(double, String) - Static method in class io.keikai.axyra.sheets.format.Formats: Formats a number with an Excel format code under en-US conventions, e.g.
format(double, String, String) - Static method in class io.keikai.axyra.sheets.format.Formats: Formats a number with an Excel format code under a BCP-47 display locale.
formatCells() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the formatCells record component.
formatCells(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows formatting cells (default false).
formatColumns() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the formatColumns record component.
formatColumns(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows changing column width and format (default false).
formatRows() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the formatRows record component.
formatRows(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows changing row height and format (default false).
Formats - Class in io.keikai.axyra.sheets.format: Number and date formatting with Excel format codes, and classification of typed input.
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: Returns the 0-based indexes, ascending, of the columns that carry a column-level record: a width, a hidden flag, a column style or an outline level.
formattedRows() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 0-based indexes, ascending, of the rows that carry a row-level record: a height, a hidden flag, a row style or an outline level.
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: A fluent builder for a FormControl.
formControlCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of form controls on this sheet, the size of Sheet.formControls().
formControls() - Method in class io.keikai.axyra.sheets.Sheet: Returns every form control 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 objectType families (ECMA-376 Part 1 §18.3.1.13 plus the <formControlPr> part).
formula() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's formula text, without the leading =.
formula() - Method in class io.keikai.axyra.sheets.NamedRange: Returns the formula the name stands for: 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 formula record component.
formula() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem: Returns the value of the formula record component.
FORMULA - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind: Input that starts with = after leading spaces.
formula1() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The first formula, without a leading = and without _xlfn. prefixes, or null when none is set.
formula1() - Method in class io.keikai.axyra.sheets.content.Validation: The first operand as a formula without a leading = or _xlfn. prefixes, or null when none is set.
formula1(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets the first operand: a formula without a leading =, such as "10", "$A$1", "DATE(2020,1,1)" or, for a list, "\"A,B\"" or "$X$1:$X$9".
formula2() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The second formula of a between / notBetween rule, or null when none is set.
formula2() - Method in class io.keikai.axyra.sheets.content.Validation: The second operand of a between / notBetween rule, or null when none is set.
formula2(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets the second operand, used only by between and notBetween; same form as Validation.Builder.formula1(String).
formulaLocalized(String) - Method in class io.keikai.axyra.sheets.Cell: The cell's formula rendered in locale's display form (translated function names + ; separator), or null for a non-formula cell.
formulaPolicy() - Method in class io.keikai.axyra.sheets.io.SaveOptions: The formula policy; FormulaPolicy.KEEP by default.
formulaPolicy(FormulaPolicy) - Method in class io.keikai.axyra.sheets.io.SaveOptions: Sets how formulas are written.
FormulaPolicy - Enum Class in io.keikai.axyra.sheets.io: How formula cells are written by Workbook.save(path, SaveOptions).
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: Reads every cell's formula text, row-major.
formulaToA1(String, int, int) - Method in class io.keikai.axyra.sheets.Workbook: Converts a formula's references from R1C1 back to A1 style, relative to the 1-based (anchorRow, anchorColumn); the rest of this API is 0-based.
formulaToR1C1(String, int, int) - Method in class io.keikai.axyra.sheets.Workbook: Converts a formula's cell references from A1 to R1C1 style, relative to the 1-based (anchorRow, anchorColumn); the rest of this API is 0-based.
forward() - Method in record class io.keikai.axyra.sheets.content.Trendline: Returns the value of the forward record component.
freezeColumn() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of frozen columns at the left, or 0 when no columns are frozen.
freezePanes(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Freezes the top freezeRow rows and the left freezeCol columns, as Excel's View > Freeze Panes does with the cell at (freezeRow, freezeCol) selected.
freezeRow() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of frozen rows at the top, or 0 when no rows are frozen.
from(String) - Static method in enum class io.keikai.axyra.sheets.content.LegendPosition: The position for an engine token such as "topRight"; LegendPosition.RIGHT for an unknown, empty or null token.
from(String) - Static method in enum class io.keikai.axyra.sheets.content.TimePeriod: The enum for an ST_TimePeriod token, or null if unknown.
from(String) - Static method in enum class io.keikai.axyra.sheets.style.BorderStyle: Parses an ST_BorderStyle token, case-sensitively.
from(String) - Static method in enum class io.keikai.axyra.sheets.style.FontVertical: Parses an ST_VerticalAlignRun token, case-sensitively.
from(String) - Static method in enum class io.keikai.axyra.sheets.style.HAlign: Parses an ST_HorizontalAlignment token, case-sensitively.
from(String) - Static method in enum class io.keikai.axyra.sheets.style.PatternType: Parses an ST_PatternType token, case-sensitively.
from(String) - Static method in enum class io.keikai.axyra.sheets.style.Underline: Parses an ST_UnderlineValues token, case-sensitively.
from(String) - Static method in enum class io.keikai.axyra.sheets.style.VAlign: Parses an ST_VerticalAlignment token, case-sensitively.
fromCode(int) - Static method in enum class io.keikai.axyra.sheets.calc.CalcMode: The mode for an engine code.
fromCode(String) - Static method in enum class io.keikai.axyra.sheets.content.FormControlType: The type for a wire token; FormControlType.UNKNOWN for unrecognized tokens.
fromCol() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the fromCol record component.
fromColumn() - Method in class io.keikai.axyra.sheets.content.FormControl: The 0-based column of the anchor's top-left cell.
fromJson(Object) - Static method in class io.keikai.axyra.sheets.style.Color: Decodes the engine's JSON color form: a map such as {"rgb":"#AARRGGBB"}, {"indexed":N}, {"theme":I,"tint":T} or {"auto":true}, or a string in a form that Color.parse(String) accepts.
fromJson(String) - Static method in class io.keikai.axyra.sheets.content.Chart: Builds a chart spec from the engine's chart JSON, the form behind Sheet.charts().
fromJson(String) - Static method in class io.keikai.axyra.sheets.content.ConditionalFormat: Builds a rule from the engine's JSON, the form behind Sheet.conditionalFormats().
fromJson(String) - Static method in class io.keikai.axyra.sheets.content.FormControl: Builds a control from the engine's JSON, the form behind Sheet.formControls().
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: Builds a rule from the engine's JSON, the form behind Sheet.validations().
fromJson(String) - Static method in class io.keikai.axyra.sheets.style.CellStyle: Rebuilds a style from the engine's resolved-style JSON.
fromLabel(String) - Static method in enum class io.keikai.axyra.sheets.LicenseStatus: Maps a status label to its constant, ignoring case and surrounding spaces.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.DataConnection: Builds a DataConnection from a decoded JSON object.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.ExternalLink: Build an ExternalLink from one decoded FFI JSON object.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.Slicer: Build a Slicer from one decoded FFI JSON object.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.SmartArt: Build a SmartArt from one decoded FFI JSON object.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.Timeline: Build a Timeline from one decoded FFI JSON object.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.VbaModule: Builds a VbaModule from a decoded JSON object.
fromMap(Map<String, Object>) - Static method in record class io.keikai.axyra.sheets.content.XmlMap: Builds an XmlMap from 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 token, ignoring case.
fromRow() - Method in class io.keikai.axyra.sheets.content.FormControl: The 0-based row of the anchor's top-left cell.
fromRow() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the fromRow record component.
Functions - Class in io.keikai.axyra.sheets.formula: Queries the engine's catalog of built-in 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: The gap between bar or column clusters, as a percentage of one bar's width (0–500).
gapWidth(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the gap between bar or column clusters, as a percentage of one bar's width (0–500).
GENERAL - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign: Excel's General alignment: text left, numbers and dates right, booleans and errors centered.
get(int, int) - Method in record class io.keikai.axyra.sheets.CellValue.Array: Returns the value at (row, col), both 0-based.
goalSeek(Cell, double, Cell) - Method in class io.keikai.axyra.sheets.Workbook: Finds the value for the changing cell that makes the target cell equal targetValue (Excel's Goal Seek).
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: false when a data bar paints a solid fill instead of the default gradient; null when 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 -1 when the fill is not a gradient.
gradientFill(int, Color...) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets a linear gradient fill across colors, spread evenly from position 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 with CellStyle.gradientStops().
GradientStop(double, Color) - Constructor for record class io.keikai.axyra.sheets.style.GradientStop: Creates an instance of a GradientStop record class.
gradientStops() - Method in class io.keikai.axyra.sheets.style.CellStyle: The gradient color stops in position order (ECMA-376 §18.8.38).
gradientType() - Method in class io.keikai.axyra.sheets.style.CellStyle: The gradient kind: "linear" (rotated by CellStyle.gradientDegree()) or "path" (shape-bounded, from CellStyle.Builder.pathGradientFill(io.keikai.axyra.sheets.style.Color...)), or null when the fill is not a gradient.
grandTotalCaption() - Method in class io.keikai.axyra.sheets.PivotTableView: The grand-total caption override, or null when the default ("Grand Total") applies.
grandTotalColumn() - Method in class io.keikai.axyra.sheets.PivotTableView: Whether the grand-total column at the right is shown, as of the last PivotTableView.reload().
grandTotalRow() - Method in class io.keikai.axyra.sheets.PivotTableView: Whether the grand-total row at the bottom is shown, as of the last PivotTableView.reload().
GRAY - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque gray, #808080.
GRAY_0625 - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: 6.25 % gray dot pattern.
GRAY_125 - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: 12.5 % gray dot pattern.
GREATER_THAN - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator: The cell is greater than the value (>).
GREATER_THAN - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items with aggregate > value.
GREATER_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator: The cell is greater than or equal to the value (>=).
GREATER_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items with aggregate >= value.
green() - Method in class io.keikai.axyra.sheets.style.Color: The green channel of an RGB color.
GREEN - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque green, #008000 (HTML green, not #00FF00).
gridLines() - Method in class io.keikai.axyra.sheets.io.ImageOptions: The gridline override.
gridLines(boolean) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder: Forces gridlines on or off.
GROUP_BOX - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType: A frame that groups option buttons.
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: Groups columns startCol to endCol, 0-based and inclusive, at outline level 1.
groupFieldByDate(String, PivotDateGroupBy) - Method in class io.keikai.axyra.sheets.PivotTableView: Groups the row/column field field by a date component (ECMA-376 Part 1 §18.10.1.81 rangePr@groupBy): on PivotTableView.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 field into numeric bins of interval over [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 grouping record 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: Groups rows startRow to endRow, 0-based and inclusive, 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 gte record component.

H

HAIR - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Hairline: the finest dotted line, 1 px with the dots close together.
HAlign - Enum Class in io.keikai.axyra.sheets.style: Horizontal alignment of the cell content (ECMA-376 ST_HorizontalAlignment).
hasAutoFilter() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether this sheet has an auto-filter.
hasFeature(String) - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns whether this status enables feature: the feature list contains it or the wildcard "*".
hasGradientFill() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether this style has a gradient fill; then CellStyle.gradientStops() lists its colors.
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.CellStyle
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 under name (case-sensitive).
hasPageSetup() - Method in class io.keikai.axyra.sheets.Sheet: Returns 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 hasPassword record component.
hasPassword() - Method in record class io.keikai.axyra.sheets.content.WriteProtection: Returns the value of the hasPassword record 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 header record component.
header() - Method in class io.keikai.axyra.sheets.Sheet: Returns the page header text, or null when none is set.
headerFooterPictureData(String) - Method in class io.keikai.axyra.sheets.Sheet: Returns the image bytes of the header or footer picture in section, a token as for Sheet.setHeaderFooterPicture(java.lang.String, byte[], java.lang.String, double, double), or null when that section has no picture.
headerRowCount() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the headerRowCount record component.
headers() - Method in record class io.keikai.axyra.sheets.ImportOptions: Returns the value of the headers record component.
headers(boolean) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder: Writes a header row above the data when true (default true).
headerStyle() - Method in record class io.keikai.axyra.sheets.ImportOptions: Returns the value of the headerStyle record component.
headerStyle(CellStyle) - Method in class io.keikai.axyra.sheets.ImportOptions.Builder: Sets the style that replaces the header cells' style; null leaves it unchanged.
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: Whether the formula is hidden from the formula bar while the sheet is protected.
hidden(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Hides the formula from the formula bar while the sheet is protected (true).
HIDDEN - Enum constant in enum class io.keikai.axyra.sheets.Visibility: The tab is hidden; a user can show it again with Excel's Unhide.
highColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the highColor record component.
highColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the highColor record 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: The doughnut hole size, as a percentage of the outer radius.
holeSize(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the doughnut hole size as a percentage of the outer radius; 50 when not set.
horizontalAlign() - Method in class io.keikai.axyra.sheets.style.CellStyle: The horizontal alignment; HAlign.GENERAL when unset.
horizontalAlign(HAlign) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the horizontal alignment.
hour() - Method in record class io.keikai.axyra.sheets.DateGroupItem: Returns the value of the hour record component.
hour(int, int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem: An item that selects one hour of a day; hour is 0 to 23.
HOURS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy: Hour of the day: items read "00" to "23".
HtmlOptions - Class in io.keikai.axyra.sheets.io: Options for Workbook.saveHtml(path, options): choose between the HTML package and one self-contained document.
HtmlOptions() - Constructor for class io.keikai.axyra.sheets.io.HtmlOptions
hyperlink() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's hyperlink.
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 Hyperlink record class.
HYPERLINK - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: Color of an unvisited hyperlink.
hyperlinkBase() - Method in class io.keikai.axyra.sheets.Workbook: The base URI relative hyperlinks resolve against (HyperlinkBase of docProps/app.xml), or null.
hyperlinksChanged() - Method in class io.keikai.axyra.sheets.Workbook: The HyperlinksChanged flag of docProps/app.xml, or null when 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 id record component.
id() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment: Returns the value of the id record component.
id() - Method in record class io.keikai.axyra.sheets.content.XmlMap: Returns the value of the id record component.
ImageOptions - Class in io.keikai.axyra.sheets.io: Immutable options for sheet and range image export: Renderer.toPng(io.keikai.axyra.sheets.Workbook, int, io.keikai.axyra.sheets.io.ImageOptions), Renderer.toSvg(io.keikai.axyra.sheets.Workbook, int, io.keikai.axyra.sheets.io.ImageOptions), Renderer.toImage(io.keikai.axyra.sheets.Workbook, int, java.lang.String, io.keikai.axyra.sheets.io.ImageOptions) and the JPEG, GIF, BMP and TIFF shortcuts, and the matching Workbook.render* methods.
ImageOptions.Builder - Class in io.keikai.axyra.sheets.io: Fluent builder for ImageOptions; see ImageOptions.builder().
importData(int, int, List<T>) - Method in class io.keikai.axyra.sheets.Sheet: Imports a collection with ImportOptions.defaults(): a header row, then every discovered property as a column.
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), which writes a list of Java objects onto a sheet, one object per row and one property per column.
ImportOptions(String[], boolean, String[], CellStyle) - Constructor for record class io.keikai.axyra.sheets.ImportOptions: Creates an instance of a ImportOptions record class.
ImportOptions.Builder - Class in io.keikai.axyra.sheets: Fluent builder for ImportOptions.
increment() - Method in class io.keikai.axyra.sheets.content.FormControl: The step of one arrow click on a scroll bar or spin button; 0 when the control does not store it.
increment(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the step of one arrow click on a scroll bar or spin button.
indent() - Method in class io.keikai.axyra.sheets.style.CellStyle: The indent level; 0 when unset.
indent(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the indent level.
index() - Method in class io.keikai.axyra.sheets.ChartView: This chart's 0-based index on its sheet, or the chart-sheet index for a chart-sheet chart.
index() - Method in record class io.keikai.axyra.sheets.content.ExternalLink: Returns the value of the index record component.
index() - Method in class io.keikai.axyra.sheets.PivotTableView: This pivot table's 0-based index on its sheet, fixed when the view was created.
index() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 0-based position of this sheet's tab in its workbook, as it is now.
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).
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: The text of the input hint; an empty string when none.
inputMessage(String, String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets the input hint's title and text and turns the hint on.
inputTitle() - Method in class io.keikai.axyra.sheets.content.Validation: The title of the input hint; an empty string when none.
insertCells(Shift) - Method in class io.keikai.axyra.sheets.Range: Inserts blank cells over this rectangle and moves the existing cells away from it: Shift.DOWN moves the cells of these columns down by Range.rowCount(); Shift.RIGHT moves the cells of these rows right by Range.colCount().
insertColumns() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the insertColumns record component.
insertColumns(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows inserting columns (default false).
insertColumns(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Inserts count blank columns before startCol, shifting the columns to the right.
insertHyperlinks() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the insertHyperlinks record component.
insertHyperlinks(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows inserting hyperlinks (default false).
insertRows() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the insertRows record component.
insertRows(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows inserting rows (default false).
insertRows(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Inserts count blank rows before startRow, shifting the rows below down.
insertSheet(int, String) - Method in class io.keikai.axyra.sheets.Workbook: Inserts 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; saved back as an ordinary worksheet.
interval() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup: Returns the value of the interval record component.
INVALID - Enum constant in enum class io.keikai.axyra.sheets.LicenseStatus: The installed key is not valid here: forged or damaged, revoked, not yet valid, or issued for another product or platform.
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: Calculation settings of a workbook.
io.keikai.axyra.sheets.content - package io.keikai.axyra.sheets.content: The objects a workbook or sheet holds besides cell values: charts, tables, data validations, conditional formats, comments, hyperlinks, sparklines, form controls, slicers, timelines, external links, embedded objects and more.
io.keikai.axyra.sheets.format - package io.keikai.axyra.sheets.format: Number and date formatting with Excel format codes, without a workbook.
io.keikai.axyra.sheets.formula - package io.keikai.axyra.sheets.formula: User-defined formula functions and the built-in function catalog.
io.keikai.axyra.sheets.io - package io.keikai.axyra.sheets.io: Options for saving and rendering a workbook, and a streaming writer for large exports.
io.keikai.axyra.sheets.style - package io.keikai.axyra.sheets.style: Cell styles, colors and workbook themes.
io.keikai.axyra.sheets.template - package io.keikai.axyra.sheets.template: Data binding with template markers.
is3d() - Method in class io.keikai.axyra.sheets.ChartView: Whether the chart is drawn in 3-D; see ChartView.view3D() for its angles.
is3d() - Method in class io.keikai.axyra.sheets.content.Chart: Whether the chart is drawn in 3-D.
isAuto() - Method in class io.keikai.axyra.sheets.style.Color: Whether this is the automatic (window-text) color, Color.auto().
isColumnHidden(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the column is hidden.
isColumnWidthCustom(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the column has its own width, set by Sheet.setColumnWidth(int, double) or by <col width> in the source file, instead of following 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: Returns whether the default row height is flagged as fixed (the sheetFormatPr customHeight flag).
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: Returns 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: Returns whether the current license enables feature.
isFinished() - Method in class io.keikai.axyra.sheets.io.StreamWorkbook: Whether the package has been completed by StreamWorkbook.finish() or StreamWorkbook.close().
isFitToPage() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether fit-to-page scaling is on, as Sheet.fitToPage(int, int) sets it.
isIndexed() - Method in class io.keikai.axyra.sheets.style.Color: Whether this is a legacy indexed-palette color; then Color.indexedValue() works.
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: Returns whether the sheet prints in landscape; false means portrait, the default.
isLicensed() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns whether a valid license is in force: LicenseStatus.LICENSED or LicenseStatus.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: Returns whether this sheet declares a paper size.
isPerpetual() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns whether the key never expires: a licensed state with no LicenseInfo.expiresAt().
isPresent() - Method in record class io.keikai.axyra.sheets.style.BorderEdge: Whether this edge draws a line, i.e.
isProtected() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether this sheet is protected.
isProtectedWithPassword() - Method in class io.keikai.axyra.sheets.Sheet: Returns 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; then Color.argb() and the channel readers work.
isRowHeightCustom(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the row has its own height instead of following the sheet default.
isRowHidden(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the row's hidden flag is set, by Sheet.setRowHidden(int, boolean), by a filter or a collapsed group, or by the source file.
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()).
isTextBox(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the shape at shapeIndex is a text box (<xdr:cNvSpPr txBox="1"/>): one added by Sheet.addTextBox(java.lang.String, int, int, int, int) or read from a file.
isTheme() - Method in class io.keikai.axyra.sheets.style.Color: Whether this is a theme-palette color; then Color.themeIndex() and Color.tint() work.
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: Returns whether this name is workbook-scoped, that is 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 italic record 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: Makes the run italic.
italic() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the italic record component.
italic() - Method in record class io.keikai.axyra.sheets.FindFormat: Returns the value of the italic record component.
italic() - Method in class io.keikai.axyra.sheets.io.StreamStyle: Whether the font is italic.
italic() - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Makes the font italic; shorthand for italic(true).
italic() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether the font is italic.
italic(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets (true) or clears (false) italic.
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: Wraps the text and justifies every line but the last.
JUSTIFY - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign: Spreads the lines of wrapped text over the cell height.

K

KEEP - Enum constant in enum class io.keikai.axyra.sheets.io.FormulaPolicy: Writes the formula and its cached value; the default.
keyUsage() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the keyUsage record component.
keywords() - Method in class io.keikai.axyra.sheets.Workbook: The document keywords (cp:keywords), or null when none are set.
kind() - Method in record class io.keikai.axyra.sheets.content.DataConnection: Returns the value of the kind record component.
kind() - Method in record class io.keikai.axyra.sheets.content.Trendline: Returns the value of the kind record component.
kind() - Method in record class io.keikai.axyra.sheets.content.VbaModule: Returns the value of the kind record component.
kind() - Method in record class io.keikai.axyra.sheets.format.ParsedValue: Returns the value of the kind record 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: Static caption text.
labelFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: The caption (label) filter of the row/column field field, matched ignoring case.
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: The last seven days, today included.
LAST_MONTH - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: The previous calendar month.
LAST_MONTH - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the previous calendar month.
LAST_QUARTER - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the previous calendar quarter.
LAST_WEEK - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: The previous Sunday-to-Saturday week.
LAST_WEEK - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the previous Sunday-to-Saturday week.
LAST_YEAR - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the previous calendar year.
lastColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the lastColor record component.
lastColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the lastColor record component.
lastColumn() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The last column of the rule's first range (0-based, inclusive); 0 for a rule that was built, not read back.
lastColumn() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the lastColumn record component.
lastColumn() - Method in class io.keikai.axyra.sheets.content.Validation: The last column of the rule's first range (0-based, inclusive); 0 for a rule that was built, not read back.
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:lastModifiedBy of docProps/core.xml), or null.
lastPrinted() - Method in class io.keikai.axyra.sheets.Workbook: When the workbook was last printed (cp:lastPrinted, a W3CDTF timestamp), or null.
lastRow() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The last row of the rule's first range (0-based, inclusive); 0 for a rule that was built, not read back.
lastRow() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the lastRow record component.
lastRow() - Method in class io.keikai.axyra.sheets.content.Validation: The last row of the rule's first range (0-based, inclusive); 0 for a rule that was built, not read back.
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 or tabular), as of the last PivotTableView.reload().
layoutFamily() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the layoutFamily record component.
layoutId() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the layoutId record component.
left() - Method in record class io.keikai.axyra.sheets.PageMargins: Returns the value of the left record component.
LEFT - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition: Left of the plot area.
LEFT - Enum constant in enum class io.keikai.axyra.sheets.Shift: Cells move left; valid for Range.deleteCells(io.keikai.axyra.sheets.Shift).
LEFT - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign: Left-aligned; CellStyle.Builder.indent(int) shifts it right.
LEFT - Enum constant in enum class io.keikai.axyra.sheets.style.Side: The cell's left edge.
legend(LegendPosition) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the legend placement.
legendLayout() - Method in class io.keikai.axyra.sheets.ChartView: The manual legend layout as [x, y, w, h] chart-relative fractions, or null when 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/y top-left, w/h size, all in [0, 1]) — a manual legend layout.
legendPosition() - Method in class io.keikai.axyra.sheets.ChartView: Where the legend is placed; LegendPosition.NONE when the legend is marked deleted.
legendPosition() - Method in class io.keikai.axyra.sheets.content.Chart: Legend placement; LegendPosition.RIGHT when the spec does not set one.
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: Shows or hides the legend without changing its position.
LESS_THAN - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator: The cell is less than the value (<).
LESS_THAN - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items with aggregate < value.
LESS_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.FilterOperator: The cell is less than or equal to the value (<=).
LESS_THAN_OR_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items with aggregate <= value.
level() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the level record component.
License - Class in io.keikai.axyra.sheets: Process-global licensing facade.
licenseCount() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the licenseCount record component.
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 licensee record component.
licenseId() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the licenseId record 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: Creates a status with no LicenseInfo.reason() and no key details; those components are null.
LicenseInfo(LicenseStatus, String, String, List<String>, Long, String) - Constructor for record class io.keikai.axyra.sheets.LicenseInfo: Creates a status with a reason but no key details; the key-detail components (LicenseInfo.product() through LicenseInfo.maintenanceUntil()) are null.
LicenseInfo(LicenseStatus, String, String, List<String>, Long, String, String, String, String, String, String, String, String, String, Long, Long) - Constructor for record class io.keikai.axyra.sheets.LicenseInfo: Creates an instance of a LicenseInfo record 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-wide license state, checked against the clock now.
LicenseStatus - Enum Class in io.keikai.axyra.sheets: The runtime licensing status of the engine (process-global).
licenseType() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the licenseType record component.
LIGHT_DOWN - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thin diagonal stripes running down from left to right.
LIGHT_GRAY - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: 25 % gray dot pattern.
LIGHT_GRID - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thin horizontal and vertical crosshatch.
LIGHT_HORIZONTAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thin horizontal stripes.
LIGHT_TRELLIS - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thin diagonal crosshatch.
LIGHT_UP - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thin diagonal stripes running up from left to right.
LIGHT_VERTICAL - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Thin vertical stripes.
LIGHT1 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: lt1, Excel's "Background 1"; usually white.
LIGHT2 - Enum constant in enum class io.keikai.axyra.sheets.style.Theme.Slot: lt2, Excel's "Background 2".
line() - Static method in class io.keikai.axyra.sheets.content.Chart: A line 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: Sets the cell that mirrors the control's state, in A1 form ("A1", "Sheet2!B3"); null or an empty string sets none.
linksUpToDate() - Method in class io.keikai.axyra.sheets.Workbook: The LinksUpToDate flag of docProps/app.xml, or null when the workbook records none.
list() - Static method in class io.keikai.axyra.sheets.formula.Functions: The upper-case names of every built-in function, sorted alphabetically, without the _xlfn. prefix.
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: A list of items fed by a list-fill range.
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: Sets the range that supplies a combo box's or list box's items, in A1 form; null or an empty string sets none.
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 location record component.
location() - Method in class io.keikai.axyra.sheets.PivotTableView: The pivot's output location in A1 form, without a sheet name.
locked() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether the cell is locked while the sheet is protected.
locked(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Locks (true, the default) or unlocks the cell for sheet protection.
lowColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the lowColor record component.
lowColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the lowColor record component.

M

MACRO_SHEET - Enum constant in enum class io.keikai.axyra.sheets.SheetType: An Excel 4.0 macro sheet; saved back as an ordinary worksheet.
maintenanceUntil() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the maintenanceUntil record component.
maintenanceUntilInstant() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the maintenance end as an Instant, or null when there is none.
majorFont() - Method in class io.keikai.axyra.sheets.style.Theme: The major (heading) font name, e.g.
majorFont(String) - Method in class io.keikai.axyra.sheets.style.Theme.Builder: Sets the heading font name (the theme's major font).
manager() - Method in class io.keikai.axyra.sheets.Workbook: The manager (Manager of docProps/app.xml), or null.
MANUAL - Enum constant in enum class io.keikai.axyra.sheets.calc.CalcMode: Recalculates only when asked: Workbook.recalculate() or Workbook.recalculateDirty().
manualMax() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the manualMax record component.
manualMax() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the manualMax record component.
manualMin() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the manualMin record component.
manualMin() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the manualMin record 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 markersColor record component.
markersColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the markersColor record component.
max() - Method in class io.keikai.axyra.sheets.content.FormControl: Maximum value of a scroll bar or spin button; 0 when the control does not store it.
MAX - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction: Largest numeric value (Excel's "Max").
MAX - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: MAX: largest number at each position.
MAX - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 4, MAX: largest number.
MAX - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(104, column): largest visible value.
maxAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the maxAxisType record component.
maxAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the maxAxisType record component.
MEDIUM - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Medium solid line, 2 px.
MEDIUM_DASH_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Medium dash-dot line.
MEDIUM_DASH_DOT_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Medium dash-dot-dot line.
MEDIUM_DASHED - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Medium dashed line, 2 px.
MEDIUM_GRAY - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: 50 % gray: foreground dots over the background.
merge() - Method in class io.keikai.axyra.sheets.Range: Merges the rectangle into one cell, as Excel's Merge Cells does.
mergedRegions() - Method in class io.keikai.axyra.sheets.Sheet: Returns the merged-cell regions on this sheet, one Range per region.
min() - Method in class io.keikai.axyra.sheets.content.FormControl: Minimum value of a scroll bar or spin button; 0 when the control does not store it.
MIN - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction: Smallest numeric value (Excel's "Min").
MIN - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: MIN: smallest number at each position.
MIN - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 5, MIN: smallest number.
MIN - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(105, column): smallest visible value.
minAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the minAxisType record component.
minAxisType() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the minAxisType record component.
minorFont() - Method in class io.keikai.axyra.sheets.style.Theme: The minor (body) font name, e.g.
minorFont(String) - Method in class io.keikai.axyra.sheets.style.Theme.Builder: Sets the body font name (the theme's minor font).
minute() - Method in record class io.keikai.axyra.sheets.DateGroupItem: Returns the value of the minute record component.
minute(int, int, int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem: An item that selects one minute; hour is 0 to 23, minute 0 to 59.
MINUTES - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy: Minute of the hour: items read "00" to "59".
modified() - Method in class io.keikai.axyra.sheets.Workbook: The last-modified timestamp (dcterms:modified, W3CDTF), or null.
month() - Method in record class io.keikai.axyra.sheets.DateGroupItem: Returns the value of the month record component.
month(int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem: An item that selects a whole month; month is 1-based (1 to 12).
MONTHS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy: Month: items read "Jan" to "Dec".
moveColumnField(int, int) - Method in class io.keikai.axyra.sheets.PivotTableView: Moves the column field at from to position to; see PivotTableView.moveRowField(int, int).
moveDataField(int, int) - Method in class io.keikai.axyra.sheets.PivotTableView: Moves the values-area field at from to position to; see PivotTableView.moveRowField(int, int).
moveRowField(int, int) - Method in class io.keikai.axyra.sheets.PivotTableView: Moves the row field at from to position to; the fields between shift by one.
moveSheet(int, int) - Method in class io.keikai.axyra.sheets.Workbook: Moves the sheet at from to position to, shifting the sheets in between.
movingAverage(int) - Static method in record class io.keikai.axyra.sheets.content.Trendline: A moving-average trendline over period points.

N

name() - Method in record class io.keikai.axyra.sheets.content.DataConnection: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.ExternalLink: Returns the value of the name record 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 name record component.
name() - Method in record class io.keikai.axyra.sheets.content.ProtectedRange: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.TableColumn: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.VbaModule: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.content.XmlMap: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.CustomProperty: Returns the value of the name record component.
name() - Method in class io.keikai.axyra.sheets.NamedRange: Returns the defined name, as written in the workbook.
name() - Method in record class io.keikai.axyra.sheets.PivotCalculatedField: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.PivotCalculatedItem: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.PivotField: Returns the value of the name record component.
name() - Method in record class io.keikai.axyra.sheets.PivotStyle: Returns the value of the name record component.
name() - Method in class io.keikai.axyra.sheets.PivotTableView: The pivot table's name, as of the last PivotTableView.reload().
name() - Method in class io.keikai.axyra.sheets.Sheet: Returns the sheet's tab name, as shown in Excel.
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: Every defined name, in definition order, with its scope.
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: Sets the border color of negative-value data bars.
negativeColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the negativeColor record component.
negativeColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the negativeColor record 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: Sets the fill color of negative-value data bars.
NEXT_MONTH - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: The next calendar month.
NEXT_MONTH - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the next calendar month.
NEXT_QUARTER - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the next calendar quarter.
NEXT_WEEK - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: The next Sunday-to-Saturday week.
NEXT_WEEK - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the next Sunday-to-Saturday week.
NEXT_YEAR - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the next calendar year.
nodeTexts() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the nodeTexts record component.
NONE - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition: No legend shown; saved as a deleted legend element.
NONE - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: No line.
NONE - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: No fill; the cell shows the sheet background.
NONE - Enum constant in enum class io.keikai.axyra.sheets.style.Underline: No underline.
NONE - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: No total; the totals-row cell holds no formula.
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: The cell does not equal the value (<>).
NOT_EQUAL - Enum constant in enum class io.keikai.axyra.sheets.PivotValueFilterType: Keeps items whose aggregate differs from value by more than the PivotValueFilterType.EQUAL tolerance.
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 number record component.
number(double) - Static method in interface io.keikai.axyra.sheets.CellValue: A numeric value.
Number(double) - Constructor for record class io.keikai.axyra.sheets.CellValue.Number: Creates an instance of a Number record class.
Number(double) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Number: Creates an instance of a Number record class.
NUMBER - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind: A number, including percentages, fractions, currency and scientific notation.
numberFormat() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the numberFormat record component.
numberFormat() - Method in record class io.keikai.axyra.sheets.FindFormat: Returns the value of the numberFormat record component.
numberFormat() - Method in class io.keikai.axyra.sheets.io.StreamStyle: The Excel number-format code, or null for General.
numberFormat() - Method in class io.keikai.axyra.sheets.style.CellStyle: The Excel number format code, e.g.
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: Sets the Excel number format code, e.g.
numbers() - Method in class io.keikai.axyra.sheets.Range: Reads the rectangle as a row-major double[] of length rowCount() * colCount(): entry r * colCount() + c is the cell at (firstRow() + r, firstColumn() + c).

O

objects() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the objects record component.
objects(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows editing objects such as shapes and charts (default false).
of() - Static method in record class io.keikai.axyra.sheets.FindFormat: Returns the empty filter: no criteria, so a cell's style does not restrict the match.
of(int) - Static method in class io.keikai.axyra.sheets.style.Color: An RGB color from a packed 0xAARRGGBB value.
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 text with 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: The style name with Excel's Design-tab default flags: row and column headers on, banded rows and columns off, last column on.
of(String[], String, String) - Static method in class io.keikai.axyra.sheets.style.Theme: Builds a theme from raw tokens.
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 cust split 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>), or null when absent.
ofPieSplitPosition() - Method in class io.keikai.axyra.sheets.ChartView: The count or threshold the split rule compares against (<c:splitPos>), or null when absent.
ofPieSplitType() - Method in class io.keikai.axyra.sheets.ChartView: The of-pie split rule as the format's own token — auto, cust, percent, pos or val — or null when 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 OleObject record class.
oleObjects() - Method in class io.keikai.axyra.sheets.Workbook: The embedded OLE objects in this workbook, in index order: name, ProgID and raw bytes.
ooxml() - Method in enum class io.keikai.axyra.sheets.AggregateFunction: Returns the ST_DataConsolidateFunction token, e.g.
open(InputStream, String) - Static method in class io.keikai.axyra.sheets.Workbook: Parses a workbook by reading all of in; format is read as in Workbook.openBytes(byte[], String).
open(Path) - Static method in class io.keikai.axyra.sheets.Workbook: Opens a workbook from a file.
open(Path, String) - Static method in class io.keikai.axyra.sheets.Workbook: Opens a workbook file, decrypting it with password when it is encrypted.
openBytes(byte[], String) - Static method in class io.keikai.axyra.sheets.Workbook: Parses a workbook from bytes.
openBytes(byte[], String, String) - Static method in class io.keikai.axyra.sheets.Workbook: Parses a workbook from bytes, decrypting them with password when they are encrypted.
operator() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The cellIs operator, such as greaterThan or between; an empty string when the rule has none.
operator() - Method in class io.keikai.axyra.sheets.content.Validation: The comparison token.
operator(String) - Method in class io.keikai.axyra.sheets.content.Validation.Builder: Sets the comparison: between, notBetween, equal, notEqual, greaterThan, lessThan, greaterThanOrEqual or lessThanOrEqual.
OPTION_BUTTON - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType: An option (radio) button; buttons in one group box exclude each other.
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 order record 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: How much bars in one cluster overlap, as a percentage from -100 (a full bar-width gap) to 100 (full overlap).
overlap(int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets how much bars in one cluster overlap, as a percentage from -100 (a full bar-width gap) to 100 (full overlap).
ownerPassword() - Method in class io.keikai.axyra.sheets.io.PdfOptions: The password that grants full access, or null; see PdfOptions.Builder.ownerPassword(String).
ownerPassword(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Sets the password that grants full access and lifts the allow* restrictions; this turns on encryption.

P

page() - Method in class io.keikai.axyra.sheets.content.FormControl: The step of one click on a scroll bar's track; 0 when the control does not store it.
page() - Method in class io.keikai.axyra.sheets.io.ImageOptions: The printed page that renders, 1-based over the sheet's print pagination (the PDF page numbering).
page(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the step of one click on a scroll bar's track.
page(int) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder: Renders the given printed page, 1-based over the sheet's print pagination (the 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: The number of printed pages a sheet paginates to.
pageFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: The selected item of the report-filter (page) field field.
pageMargins() - Method in class io.keikai.axyra.sheets.Sheet: Returns the six page margins in inches, as a snapshot.
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 PageMargins record class.
pageOrderOverThenDown() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether pages print across, then down; false means down, then across.
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: Selects pages of the final document: comma-separated 1-based pages or inclusive spans, e.g.
pageScale() - Method in class io.keikai.axyra.sheets.Sheet: Returns the print scale in percent; 100 means actual size.
paperSize() - Method in class io.keikai.axyra.sheets.Sheet: Returns the paper size as its ECMA-376 numeric code; 9 (A4) when none is declared.
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: Classifies 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: Parses a color string.
ParsedValue - Record Class in io.keikai.axyra.sheets.format: The result of classifying user-typed cell text the way Excel does, returned by Formats.parse(String).
ParsedValue(ParsedValue.Kind, double, String) - Constructor for record class io.keikai.axyra.sheets.format.ParsedValue: Creates an instance of a ParsedValue record 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: Sets a path gradient fill that converges at the cell center (Excel's "From center" gradient), across colors spread evenly from position 0 to 1.
PatternType - Enum Class in io.keikai.axyra.sheets.style: The pattern of a cell fill (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: Produces a PDF/A-2b conformant document (ISO 19005-2 level B): XMP identification metadata, an sRGB output intent, a document ID and print-flagged annotations.
PdfOptions - Class in io.keikai.axyra.sheets.io: Immutable options for PDF export: Renderer.toPdf(io.keikai.axyra.sheets.Workbook, java.nio.file.Path) and Workbook.renderPdf.
PdfOptions.Builder - Class in io.keikai.axyra.sheets.io: Fluent builder for PdfOptions; see PdfOptions.builder().
PdfOptions.Fit - Enum Class in io.keikai.axyra.sheets.io: Fit-to-page override for PdfOptions.Builder.fitTo(Fit), with the meaning of Excel's page setup "Fit to" (ECMA-376 fitToWidth / fitToHeight).
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) / base item's cell (Excel's "% Difference From").
PERCENT_OF - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType: Cell / the base item's cell, shown as a percentage (Excel's "% Of").
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_PARENT_COLUMN - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType: Cell / the value of its next-outer column group in the same row (Excel's "% of Parent Column Total").
PERCENT_OF_PARENT_ROW - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType: Cell / the value of its next-outer row group in the same column (Excel's "% of Parent Row Total").
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 period record component.
pictureAnchor(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns {fromRow, fromCol, toRow, toCol} of the picture's two-cell anchor, 0-based, or an empty array when the index is out of range.
pictureAnchorFull(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns {fromRow, fromCol, fromRowOffset, fromColOffset, toRow, toCol, toRowOffset, toColOffset} of the picture's anchor: 0-based cells and offsets in EMU.
pictureCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of pictures on this sheet, embedded and linked.
pictureData(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the encoded image bytes of the picture at pictureIndex, or null when the index is out of range.
pictureFormat(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the format token of the picture at pictureIndex, such as "png" or "jpeg", or null when the index is out of range.
pictureLinkTarget(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the external link target of the picture at pictureIndex, or null when it is an embedded picture or the index is out of range.
pie() - Static method in class io.keikai.axyra.sheets.content.Chart: A pie chart; Excel draws only the first series.
pivotCacheId() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the pivotCacheId record 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 PivotCalculatedField record 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 PivotCalculatedItem record class.
pivotCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of pivot tables on this sheet.
PivotDateGroupBy - Enum Class in io.keikai.axyra.sheets: Date component a pivot row/column field is grouped by (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 PivotTableView area 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 PivotField record 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 PivotFieldGroup record 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 PivotFieldSort record 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 PivotLabelFilter record 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 / compactData attribute trio).
pivotLocation(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the location of the pivot table at pivotIndex as an A1 reference, such as "H1".
pivotName(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the name of the pivot table at pivotIndex.
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 PivotShowDataAs record 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!PivotName form (ECMA-376 §21.2.2.153), or null for a regular chart.
pivotSource(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the source data reference of the pivot table at pivotIndex, such as "Data!A1:D100".
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 via PivotTableView.style().
PivotStyle(String, boolean, boolean, boolean, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.PivotStyle: Creates an instance of a PivotStyle record class.
pivotTable(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns a live view of the pivot table at pivotIndex: field areas (row, column, filter, values), aggregation functions, layout, grand totals and PivotTableView.refresh().
pivotTable(String) - Method in class io.keikai.axyra.sheets.Sheet: Returns a live view of the pivot table named name.
pivotTables() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the pivotTables record component.
pivotTables() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the pivotTables record component.
pivotTables(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows using PivotTables (default false).
PivotTableView - Class in io.keikai.axyra.sheets: A view of one pivot table: its definition (fields, filters, sorts, layout, style) and the PivotTableView.refresh() that writes its output into the sheet.
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) value items / percent survive a refresh.
PivotTopNFilter(int, double, boolean, boolean) - Constructor for record class io.keikai.axyra.sheets.PivotTopNFilter: Creates an instance of a PivotTopNFilter record 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 PivotValueFilter record 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).
platform() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the platform record component.
plotAreaBorder(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the plot-area border color.
plotAreaFill() - Method in class io.keikai.axyra.sheets.ChartView: The plot-area fill color, or null when none is set.
plotAreaFill(Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the 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, or null when 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/y are the top-left corner and w/h the size, all in [0, 1].
plotAreaLineColor() - Method in class io.keikai.axyra.sheets.ChartView: The plot-area border color, or null when none is set.
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 is set to have no border.
pointExplosion(int, int) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Explode the pie/doughnut slice at pointIndex outward by percent of the radius (ECMA-376 §21.2.2.62 dPt/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 position record component.
position() - Method in record class io.keikai.axyra.sheets.style.GradientStop: Returns the value of the position record component.
precedents(Sheet, int, int) - Method in class io.keikai.axyra.sheets.Workbook: The direct precedents of a cell: the cells its formula reads, on any sheet.
printArea() - Method in class io.keikai.axyra.sheets.Sheet: Returns the print area as an A1 range string, or null when the sheet has none.
printBlackAndWhite() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the sheet prints in black and white.
printComments() - Method in class io.keikai.axyra.sheets.Sheet: Returns where cell comments print, as the code Sheet.setPrintComments(int) takes.
printDraft() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the sheet prints in draft quality.
printErrors() - Method in class io.keikai.axyra.sheets.Sheet: Returns how error cells print, as the code Sheet.setPrintErrors(int) takes.
printGridlines() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether gridlines are printed (ECMA-376 §18.3.1.65 printOptions/gridLines).
printHeadings() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether row numbers and column letters are printed.
printHorizontallyCentered() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the printout is centered horizontally on the page (<printOptions horizontalCentered>, ECMA-376 §18.3.1.70).
printResolution() - Method in class io.keikai.axyra.sheets.Sheet: Returns the printer resolution in dots per inch.
printTitleColumns() - Method in class io.keikai.axyra.sheets.Sheet: Returns the columns repeated at the left of every printed page, such as "$A:$A", or null when none are set.
printTitleRows() - Method in class io.keikai.axyra.sheets.Sheet: Returns the rows repeated at the top of every printed page, such as "$1:$2", or null when none are set.
printVerticallyCentered() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the printout 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: 1 is evaluated first; 0 when unset.
priority(int) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: Sets the evaluation priority: 1 is evaluated first.
process(Sheet, Map<String, Object>) - Static method in class io.keikai.axyra.sheets.template.TemplateMarkers: Replaces every ${...} marker in the used range of sheet with values from data, in place.
product() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the product record component.
PRODUCT - Enum constant in enum class io.keikai.axyra.sheets.AggregateFunction: Product of the numeric values (Excel's "Product").
PRODUCT - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: PRODUCT: product of the numbers at each position.
PRODUCT - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 6, PRODUCT: product of the numbers.
progId() - Method in record class io.keikai.axyra.sheets.content.OleObject: Returns the value of the progId record component.
protect() - Method in class io.keikai.axyra.sheets.Sheet: Protects this sheet with Excel's default allowances and no password.
protect(boolean) - Method in class io.keikai.axyra.sheets.Workbook: Sets or clears the workbook structure lock, without a password; the window lock is cleared.
protect(boolean, boolean) - Method in class io.keikai.axyra.sheets.Workbook: Sets or clears the workbook structure and window locks, without a password.
protect(String) - Method in class io.keikai.axyra.sheets.Sheet: Protects this sheet with a password and Excel's default allowances.
protect(String, SheetProtection) - Method in class io.keikai.axyra.sheets.Sheet: Protects this sheet with the given allowances (ECMA-376 §18.3.1.85) and an optional password.
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 ProtectedRange record class.
protectedRanges() - Method in class io.keikai.axyra.sheets.Sheet: Returns the sheet's allow-edit ranges, in the order they were defined.
protection() - Method in class io.keikai.axyra.sheets.Sheet: Returns the protection options, as what users may still do, or null when 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: Locks the workbook structure and optionally the windows (§18.2.29), with a password as for Workbook.protectStructure(String).

Q

QUARTERS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy: Calendar quarter: items read "Qtr1" to "Qtr4".
quickStyle() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the quickStyle record 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: A radar chart.
range(int, int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the minimum and maximum value of a scroll bar or spin button.
range(int, int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Returns a range over the rectangle from (r1, c1) to (r2, c2), both corners inclusive and 0-based.
range(String) - Method in class io.keikai.axyra.sheets.Sheet: Returns a range parsed from A1 notation on this sheet: "A1", "$A$1:C10", a column band "B:D" or a row band "2:5".
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 rectangle of cells on one sheet: 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 Raw record 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), using the workbook's date system.
readOnlyRecommended() - Method in record class io.keikai.axyra.sheets.content.WriteProtection: Returns the value of the readOnlyRecommended record component.
reason() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the reason record component.
recalculate() - Method in class io.keikai.axyra.sheets.Workbook: Recalculates every formula cell in the workbook, whatever is marked dirty (Excel's Ctrl+Alt+F9).
recalculateDirty() - Method in class io.keikai.axyra.sheets.Workbook: Recalculates only the formula cells marked dirty since the last calculation (Excel's F9).
red() - Method in class io.keikai.axyra.sheets.style.Color: The red channel of an RGB color.
RED - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque red, #FF0000.
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 refreshedBy attribute of pivotCacheDefinition, ECMA-376 Part 1 §18.10.1.67), or null when 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 refreshErrorSheets record component.
registerFunction(String, UserFunction) - Method in class io.keikai.axyra.sheets.Workbook: Registers a user-defined function callable from formulas by name.
registerNamedStyle(String, CellStyle) - Method in class io.keikai.axyra.sheets.Workbook: Registers a reusable named cell style (for example "Good" or "Title").
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-reads the chart from the engine and replaces this view's snapshot.
reload() - Method in class io.keikai.axyra.sheets.PivotTableView: Re-reads the pivot definition from the engine into this view's snapshot.
removeCalculatedField(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the calculated field name, matched ignoring ASCII case, together with every values-area placement referencing it.
removeCalculatedItem(String, String) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the calculated item name from field.
removeChart(int) - Method in class io.keikai.axyra.sheets.Sheet: Removes the chart at chartIndex, its 0-based position in Sheet.charts().
removeChartSheet(int) - Method in class io.keikai.axyra.sheets.Workbook: Removes the chart sheet at index (0-based position among the chart sheets).
removeColumnField(int) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the position-th column field; see PivotTableView.removeRowField(int).
removeComment() - Method in class io.keikai.axyra.sheets.Cell: Removes this cell's plain-text comment (note), if any.
removeConditionalFormat(int) - Method in class io.keikai.axyra.sheets.Sheet: Removes the conditional-formatting rule at formatIndex, its 0-based position in Sheet.conditionalFormats().
removeCustomProperty(String) - Method in class io.keikai.axyra.sheets.Workbook: Removes the custom document property name (case-sensitive); returns whether it existed.
removeDataField(int) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the position-th values-area field.
removeDuplicates(int[], boolean) - Method in class io.keikai.axyra.sheets.Range: Removes 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, in Workbook.externalLinks() order): drops both the descriptor and the preserved externalLink part so it is not written on save.
removeFilterField(int) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the position-th report-filter field and clears its selected item; see PivotTableView.removeRowField(int).
removeFormControl(int) - Method in class io.keikai.axyra.sheets.Sheet: Removes the form control at controlIndex, its 0-based position in Sheet.formControls().
removeHeaderFooterPicture(String) - Method in class io.keikai.axyra.sheets.Sheet: Removes the header or footer picture in section, a token as for Sheet.setHeaderFooterPicture(java.lang.String, byte[], java.lang.String, double, double).
removeHyperlink() - Method in class io.keikai.axyra.sheets.Cell: Removes this cell's hyperlink, if any.
removeName(String) - Method in class io.keikai.axyra.sheets.Workbook: Removes every defined name spelled exactly name (case-sensitive), in every scope.
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: Removes the embedded OLE object at index (0-based); returns whether it existed (false for a negative index).
removePicture(int) - Method in class io.keikai.axyra.sheets.Sheet: Removes the picture at pictureIndex, the 0-based index that Sheet.pictureData(int) uses.
removeProtectedRange(String) - Method in class io.keikai.axyra.sheets.Sheet: Removes the allow-edit range named name.
removeRowField(int) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the position-th row field.
removeShape(int) - Method in class io.keikai.axyra.sheets.Sheet: Removes the shape at shapeIndex, the 0-based index that Sheet.shapeType(int) uses.
removeTable(String) - Method in class io.keikai.axyra.sheets.Sheet: Removes the table definition named name and leaves its cells, values and styles in place.
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: Removes the data-validation rule at validationIndex, its 0-based position in Sheet.validations().
removeWriteProtection() - Method in class io.keikai.axyra.sheets.Workbook: Removes the write protection and the read-only recommendation, without checking a password.
renameSheet(int, String) - Method in class io.keikai.axyra.sheets.Workbook: Renames the sheet at index (0-based) to newName, rewriting formula references (OldName!A1 becomes NewName!A1) and named ranges.
renderChartToPng(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Renders the chart at chartIndex to PNG bytes.
renderChartToSvg(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Renders the chart at chartIndex to a standalone SVG document.
Renderer - Class in io.keikai.axyra.sheets.io: Renders workbooks to fixed-layout output: PDF documents, and sheet or range images in PNG, JPEG, GIF, BMP, TIFF or SVG.
renderPdf(PdfOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders the workbook to PDF bytes honoring options (page range, sheet subset, fit override, encryption).
renderPdf(Path) - Method in class io.keikai.axyra.sheets.Workbook: Renders every sheet to one PDF file, following each sheet's page setup.
renderPdf(Path, PdfOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders the workbook to a PDF file honoring options; see Workbook.renderPdf(io.keikai.axyra.sheets.io.PdfOptions).
renderRangeImage(int, String, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders an A1 range (for example "B2:F20") of a sheet to format, one of the tokens Workbook.renderSheetImage(int, String, io.keikai.axyra.sheets.io.ImageOptions) accepts.
renderRangePng(int, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders an A1 range (for example "B2:F20") of a sheet to PNG bytes.
renderRangeSvg(int, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders an A1 range of a sheet to SVG bytes; the range acts as for Workbook.renderRangePng(int, java.lang.String, io.keikai.axyra.sheets.io.ImageOptions).
renderSheetImage(int, String, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders one printed page of a sheet (page 1, or the page the options select) to format: "png", "svg", "jpeg" or "jpg", "gif", "bmp", "tiff" or "tif".
renderSheetPng(int, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders one printed page of a sheet to PNG bytes: page 1, or the page ImageOptions.page() selects.
renderSheetSvg(int, ImageOptions) - Method in class io.keikai.axyra.sheets.Workbook: Renders one printed page of a sheet to SVG bytes: page 1, or the page the options select.
replaceAll(String, String) - Method in class io.keikai.axyra.sheets.Sheet: Replaces find with replace in every text cell of the sheet that contains it, ignoring case.
replaceAll(String, String, boolean, boolean, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Replaces text as Sheet.replaceAll(String, String) does, with Excel's Replace options.
replaceAll(String, String, boolean, boolean, boolean, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet: Replaces text by format, as Sheet.replaceAll(String, String, FindFormat) does, with Excel's Replace options.
replaceAll(String, String, FindFormat) - Method in class io.keikai.axyra.sheets.Sheet: Replaces text as Sheet.replaceAll(String, String) does, only in the cells whose resolved style matches format.
replaceAllRegex(String, String) - Method in class io.keikai.axyra.sheets.Sheet: Replaces every match of the regular expression pattern, ignoring case, in every text cell of the sheet.
replaceAllRegex(String, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Replaces regular-expression matches as Sheet.replaceAllRegex(String, String) does, with a choice of case sensitivity.
replaceChart(int, Chart) - Method in class io.keikai.axyra.sheets.Sheet: Apply chart's spec onto the chart already at chartIndex, in place, keeping its position in Sheet.charts().
replies() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment: Returns the value of the replies record component.
REQUIRED - Enum constant in enum class io.keikai.axyra.sheets.LicenseMode: Throw AxyraException instead: 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: Resizes the named table to newRange, as Excel's Table Design > Resize Table does.
resolved() - Method in record class io.keikai.axyra.sheets.content.ThreadedComment: Returns the value of the resolved record 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), or null.
rgb(int, int, int) - Static method in class io.keikai.axyra.sheets.style.Color: An opaque RGB color (alpha 255).
rgb(Theme.Slot) - Method in class io.keikai.axyra.sheets.style.Theme: The color of a slot as an RGB Color.
richRunCount() - Method in class io.keikai.axyra.sheets.Cell: Returns the number of rich-text runs in this cell, or 0 when the cell is not rich text.
richText() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's rich text with per-run formatting.
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, created with RichText.run().
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 right record component.
RIGHT - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition: Right of the plot area; the default.
RIGHT - Enum constant in enum class io.keikai.axyra.sheets.Shift: Cells move right; valid for Range.insertCells(io.keikai.axyra.sheets.Shift).
RIGHT - Enum constant in enum class io.keikai.axyra.sheets.style.HAlign: Right-aligned; CellStyle.Builder.indent(int) shifts it left.
RIGHT - Enum constant in enum class io.keikai.axyra.sheets.style.Side: The cell's right edge.
rightToLeft() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether this sheet is displayed right-to-left: column A at the right edge.
rootElement() - Method in record class io.keikai.axyra.sheets.content.XmlMap: Returns the value of the rootElement record component.
rotation() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the rotation record component.
row() - Method in class io.keikai.axyra.sheets.Cell: The 0-based row index.
row() - Method in record class io.keikai.axyra.sheets.CellRef: Returns the value of the row record component.
row() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the row record component.
row() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the row record component.
row(int) - Method in class io.keikai.axyra.sheets.io.StreamWorkbook: Begins row index of the current sheet and returns the shared row builder.
rowCount() - Method in record class io.keikai.axyra.sheets.CellValue.Array: Returns the 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, outermost first.
rowHeight(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns a row's height in points (1/72 inch).
rowOutlineLevel(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns a row's outline level, from 0 (not grouped) to 7.
rowPageBreaks() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 0-based rows a horizontal page break sits above, ascending: the breaks added here and those read from an opened file, automatic ones included.
rows() - Method in record class io.keikai.axyra.sheets.CellValue.Array: Returns the value of the rows record component.
rowStyle(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the row-level style: the style that cells in this row without their own style render with.
rowStyleId(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the row-level style id (<row s="N" customFormat="1">), or 0 when the row has 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 index as 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 RunInfo record class.
RUNNING_TOTAL - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType: Cumulative sum along the base field in display order.
RUNNING_TOTAL_PERCENT - Enum constant in enum class io.keikai.axyra.sheets.PivotShowDataAsType: The running total along the base field as a share of that field's total (Excel's "% Running Total In"), so the last item reads 100%.
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: Serializes the workbook to format (the tokens Workbook.saveBytes(String) accepts) and writes the bytes to out.
save(Path) - Method in class io.keikai.axyra.sheets.Workbook: Writes the workbook to a file; the format comes from the extension.
save(Path, SaveOptions) - Method in class io.keikai.axyra.sheets.Workbook: Writes the workbook with export options; the format comes from the extension, as for Workbook.save(Path).
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: Writes 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 password as its password to open.
saveHtml(Path, HtmlOptions) - Method in class io.keikai.axyra.sheets.Workbook: Writes the workbook as HTML in the shape options asks for.
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: The zoom over the 96-DPI base: 1.0 = 96 DPI, 2.0 = 192 DPI.
scale(double) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder: Sets the zoom over the 96-DPI base: 1.0 = 96 DPI (1 pt = 4/3 px), 2.0 = 192 DPI.
scaleCrop() - Method in class io.keikai.axyra.sheets.Workbook: The ScaleCrop flag of docProps/app.xml, or null when the workbook records none.
scatter() - Static method in class io.keikai.axyra.sheets.content.Chart: An XY scatter chart; each series' categoriesRef holds its X values.
scenarioCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of what-if scenarios on this sheet.
scenarioName(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the name of the scenario at scenarioIndex.
scenarios() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the scenarios record component.
scenarios(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows editing what-if scenarios (default false).
schema() - Method in record class io.keikai.axyra.sheets.content.XmlMap: Returns the value of the schema record component.
schemaId() - Method in record class io.keikai.axyra.sheets.content.XmlMap: Returns the value of the schemaId record component.
SCROLL_BAR - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType: A scroll bar with a value between a minimum and a maximum.
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: Returns the 0-based first visible column of an unfrozen view; see Sheet.scrollRow().
scrollRow() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 0-based first visible row of an unfrozen view: the row part of <sheetView topLeftCell> (ECMA-376 Part 1 §18.3.1.87).
second() - Method in record class io.keikai.axyra.sheets.DateGroupItem: Returns the value of the second record component.
second(int, int, int, int, int, int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem: An item that selects one second; minute and second are 0 to 59.
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: Second of the minute: items read "00" to "59".
selectedIndex() - Method in class io.keikai.axyra.sheets.content.FormControl: The 1-based selected item of a combo box or list box; 0 means no selection, and also when the control does not store the value.
selectedIndex(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the 1-based selected item of a combo box or list box; 0 means no selection.
selectionSqref() - Method in class io.keikai.axyra.sheets.Sheet: Returns the view's selected ranges (<selection sqref>) as a space-separated list of A1 ranges, such as "A1:B2 D4", or null when nothing is selected.
selectLockedCells() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the selectLockedCells record component.
selectLockedCells(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows selecting locked cells (default true).
selectUnlockedCells() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the selectUnlockedCells record component.
selectUnlockedCells(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows selecting unlocked cells (default true).
series(String, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Adds a data series with no categories range.
series(String, String, String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Adds a data series with a categories (labels) range.
series(String, String, String, Color) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Adds a data series with a solid fill color.
seriesBubbleSizes(int) - Method in class io.keikai.axyra.sheets.ChartView: The series' bubble-size (Z) range reference (<c:bubbleSize>), or null on 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, or null when it has none or the index is out of range.
seriesCategories(int) - Method in class io.keikai.axyra.sheets.ChartView: The series categories range reference, or null when the series has none.
seriesColor() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the seriesColor record component.
seriesColor() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the seriesColor record component.
seriesCount() - Method in class io.keikai.axyra.sheets.ChartView: The number of series in the chart; series indices run from 0 to seriesCount() - 1.
seriesCount() - Method in class io.keikai.axyra.sheets.content.Chart: The number of series in this spec.
seriesDataLabels(int) - Method in class io.keikai.axyra.sheets.ChartView: The series-level data labels (<c:dLbls>), or null when the series carries none.
seriesFill(int) - Method in class io.keikai.axyra.sheets.ChartView: The solid fill color set on a series, or null when the series uses the theme color.
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"/>); empty when none is hidden.
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: literal text, or a sheet-qualified reference such as "Sheet1!$B$1".
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; false on an ordinary chart.
seriesSecondaryAxis(int) - Method in class io.keikai.axyra.sheets.content.Chart: Whether series seriesIndex is plotted against the secondary value axis of a combo chart; false for an index out of range.
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 seriesIndex in a combo chart: "column", "line", "area", "bar" or "scatter", or the group type of an imported combo ("radar", "bubble", "stock").
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, such as "Sheet1!$B$2:$B$9".
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: Makes the sheet at index (0-based) the active sheet; it is saved as the tab the file opens on.
setAnchor(int, int, int, int) - Method in class io.keikai.axyra.sheets.ChartView: Moves or resizes the chart by setting its two-cell anchor (0-based).
setApplication(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the Application name written to docProps/app.xml; null clears it.
setAppVersion(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets AppVersion; Excel's form is MM.mmmm, for example 16.0300.
setArrayFormula(String) - Method in class io.keikai.axyra.sheets.Range: Enters a legacy array formula (Ctrl+Shift+Enter) over the whole rectangle, anchored at the top-left cell.
setAuthor(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the author (OOXML dc:creator); null clears it.
setAutoFilter(Range) - Method in class io.keikai.axyra.sheets.Sheet: Defines an auto-filter over range; its top row holds the filter buttons.
setAutoTitle(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Marks or unmarks the title as an Excel auto title.
setBackgroundImage(byte[], String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the sheet background image.
setBaseColumnWidth(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the baseColWidth in characters.
setBlank(int, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets a blank at 0-based column that carries a style index.
setBoolean(int, boolean) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets TRUE or FALSE at 0-based column with the default style.
setBoolean(int, boolean, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets TRUE or FALSE at 0-based column with a style index.
setCalcMode(CalcMode) - Method in class io.keikai.axyra.sheets.Workbook: Sets the calculation mode (Excel's Calculation Options).
setCategory(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets cp:category; null clears it.
setCategoryAxisTitle(String) - Method in class io.keikai.axyra.sheets.ChartView: Sets the category (X) axis title, or removes it with null or an empty string.
setCategoryAxisVisible(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Shows or hides the category (X) axis; creates both axes when the chart has none.
setColumnColorFilter(int, boolean, Color) - Method in class io.keikai.axyra.sheets.Sheet: Filters a column by cell fill color, or by font color when cellColor is false: only rows whose cell has color stay visible.
setColumnCustomFilter(int, FilterOperator, String) - Method in class io.keikai.axyra.sheets.Sheet: Sets a one-condition custom filter on a column, such as "greater than 100", and runs the filter.
setColumnCustomFilter(int, FilterOperator, String, FilterOperator, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets a two-condition custom filter on a column and runs the filter.
setColumnDateFilter(int, boolean, DateGroupItem...) - Method in class io.keikai.axyra.sheets.Sheet: Sets a date grouping filter as Sheet.setColumnDateFilter(int, DateGroupItem...) does, optionally keeping 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 stays visible if it falls inside any of items.
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 / and so on.
setColumnFieldCaption(int, String) - Method in class io.keikai.axyra.sheets.PivotTableView: Renames the position-th column field for display; see PivotTableView.setRowFieldCaption(int, java.lang.String).
setColumnFieldSubtotals(int, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView: Shows or hides the subtotals of the position-th column field; see PivotTableView.setRowFieldSubtotals(int, boolean).
setColumnFilter(int, String...) - Method in class io.keikai.axyra.sheets.Sheet: Keeps only the rows whose cell in the filter column is one of values.
setColumnGroupCollapsed(int, int, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Collapses or expands a grouped column range, as Sheet.setRowGroupCollapsed(int, int, boolean) does for rows.
setColumnHidden(int, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Hides or shows a column.
setColumnsOutlineLevel(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the outline level on columns startCol to endCol, 0-based and inclusive.
setColumnStyle(int, CellStyle) - Method in class io.keikai.axyra.sheets.Sheet: Sets the column-level style: the style that cells in this column without their own style render with (<col style>).
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 value items — or value percent of the items when percent is true; bottom flips to the smallest values.
setColumnWidth(int, double) - Method in class io.keikai.axyra.sheets.Sheet: Sets a column's width in Excel character units: the number of '0' digits of the workbook's default font that fit in the column.
setComment(Comment) - Method in class io.keikai.axyra.sheets.Cell: Attaches or replaces this cell's plain-text comment (note) with the author and text of comment.
setComment(String, String) - Method in class io.keikai.axyra.sheets.Cell: Attaches a plain-text comment (Excel's note) to this cell, or replaces the existing one.
setCommentLayout(double, double, boolean) - Method in class io.keikai.axyra.sheets.Cell: Sets the box of this cell's existing note: its size and whether it stays visible without hovering (Excel's "Show Comment").
setComments(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the comments (OOXML dc:description); null clears them.
setCompany(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets Company; null clears it.
setConnectionCommand(String, String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the command text (for example a SQL statement or an M query reference) of the named connection.
setConnectionString(String, String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the connection string of the named connection.
setContentStatus(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets cp:contentStatus; null clears it.
setCreated(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets dcterms:created, a W3CDTF timestamp.
setCustomProperty(String, boolean) - Method in class io.keikai.axyra.sheets.Workbook: Sets (or replaces) the boolean-typed custom document property name.
setCustomProperty(String, double) - Method in class io.keikai.axyra.sheets.Workbook: Sets (or replaces) the number-typed custom document property name.
setCustomProperty(String, String) - Method in class io.keikai.axyra.sheets.Workbook: Sets (or replaces) the text-typed custom document property name.
setCustomProperty(String, LocalDate) - Method in class io.keikai.axyra.sheets.Workbook: Sets (or replaces) the date-typed custom document property name.
setCustomTableStyles(String) - Method in class io.keikai.axyra.sheets.Workbook: Installs 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 0-based column.
setDate(LocalDate) - Method in class io.keikai.axyra.sheets.Cell: Sets a date.
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 0-based column; the time of day becomes the fractional part of the serial.
setDateTime(LocalDateTime) - Method in class io.keikai.axyra.sheets.Cell: Sets a date and time.
setDefaultColumnWidth(double) - Method in class io.keikai.axyra.sheets.Sheet: Sets the 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: Sets the default row height in points.
setDefaultRowHeightCustom(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets the sheetFormatPr customHeight flag; see Sheet.isDefaultRowHeightCustom().
setDifferentFirst(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether the first printed page uses its own header and footer, Excel's "Different first page" option.
setDifferentOddEven(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether odd and even printed pages use different headers and footers, Excel's "Different odd and even pages" option.
setDocSecurity(Integer) - Method in class io.keikai.axyra.sheets.Workbook: Sets DocSecurity; null clears it.
setDocumentVersion(String) - Method in class io.keikai.axyra.sheets.Workbook: Set cp:version; null clears it.
setDyDescent(double) - Method in class io.keikai.axyra.sheets.Sheet: Sets the sheet-level x14ac:dyDescent hint; see Sheet.dyDescent().
setErrorBars(int, ErrorBars) - Method in class io.keikai.axyra.sheets.ChartView: Sets the error bars of a series, replacing any it has, or removes them with null.
setEvenFooter(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the even-page footer text.
setEvenHeader(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the even-page header text.
setExternalLinkSource(int, String) - Method in class io.keikai.axyra.sheets.Workbook: Repoints the external workbook reference at index (0-based, in Workbook.externalLinks() order) to a new source path.
setFilterFieldCaption(int, String) - Method in class io.keikai.axyra.sheets.PivotTableView: Renames the position-th report-filter field for display; see PivotTableView.setRowFieldCaption(int, java.lang.String).
setFirstFooter(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the first-page footer text.
setFirstHeader(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the first-page header text.
setFirstPageNumber(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the number printed on the first page (ECMA-376 §18.3.1.63 firstPageNumber together with useFirstPageNumber).
setFooter(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the page footer text, in Excel's header codes (see Sheet.setHeader(java.lang.String)).
setFormula(int, String) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets a formula at 0-based column, e.g.
setFormula(int, String, double, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets a formula plus the cached numeric result that readers show before they recalculate.
setFormula(int, String, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets a formula at 0-based column with a style index, without a cached result.
setFormula(String) - Method in class io.keikai.axyra.sheets.Cell: Sets this cell's formula.
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*B1 on C1:C3 becomes A2*B2 in C2 and A3*B3 in 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: Writes one formula per cell from a row-major String[rowCount()][colCount()].
setGapWidth(int) - Method in class io.keikai.axyra.sheets.ChartView: Sets the gap between bar or column clusters, as a percentage of one bar's width.
setGrandTotalCaption(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Sets the grand-total caption (ECMA-376 Part 1 §18.10.1.46).
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: Sets the page header text, in Excel's header codes, for example "&CQuarterly report&RPage &P".
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: Sets the doughnut hole size as a percentage of the outer radius.
setHyperlink(Hyperlink) - Method in class io.keikai.axyra.sheets.Cell: Attaches a hyperlink to this cell, or replaces the existing one.
setHyperlink(String) - Method in class io.keikai.axyra.sheets.Cell: Attaches a hyperlink to this cell, or replaces the existing one.
setHyperlinkBase(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets HyperlinkBase; null clears it.
setHyperlinksChanged(Boolean) - Method in class io.keikai.axyra.sheets.Workbook: Set HyperlinksChanged (null clears it).
setItemFilter(String, String...) - Method in class io.keikai.axyra.sheets.PivotTableView: Restricts field's manual item filter to visibleItems — Excel's filter dropdown with only those entries checked (ECMA-376 Part 1 §18.10.1.45 item@h).
setIterativeCalc(boolean, int, double) - Method in class io.keikai.axyra.sheets.Workbook: Enables or disables iterative calculation of circular references (Excel's Enable iterative calculation).
setKeywords(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the document keywords (cp:keywords); null clears them.
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: Sets the print orientation: true for landscape, false for portrait.
setLanguage(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets dc:language, an RFC 5646 language tag such as en-GB.
setLastModifiedBy(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets cp:lastModifiedBy; null clears it.
setLastPrinted(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets cp:lastPrinted, a W3CDTF timestamp such as 2024-03-01T09:00:00Z.
setLayout(PivotLayout) - Method in class io.keikai.axyra.sheets.PivotTableView: Sets the report layout (ECMA-376 Part 1 §18.10.1.73).
setLegend(LegendPosition) - Method in class io.keikai.axyra.sheets.ChartView: Moves the legend.
setLegendVisible(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Shows or hides 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.signature envelope) and return the resulting LicenseInfo.
setLicense(byte[], LicenseMode) - Static method in class io.keikai.axyra.sheets.Workbook: Installs a license token, choosing what happens when it does not put a license in force.
setLicense(InputStream) - Static method in class io.keikai.axyra.sheets.Workbook: Installs a license token by reading all of in; the stream is not closed.
setLicense(String) - Static method in class io.keikai.axyra.sheets.Workbook: Installs a license token from its text form, encoded as UTF-8.
setLicense(String, LicenseMode) - Static method in class io.keikai.axyra.sheets.Workbook: Installs a license token from its text form, encoded as UTF-8, choosing what happens when it is not in force; see Workbook.setLicense(byte[], LicenseMode).
setLinksUpToDate(Boolean) - Method in class io.keikai.axyra.sheets.Workbook: Set LinksUpToDate (null clears 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: Sets Manager; null clears it.
setModified(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets dcterms:modified, a W3CDTF timestamp.
setNumber(int, double) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets a number at 0-based column with the default style; see StreamRow.setNumber(int, double, int).
setNumber(int, double, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets a number at 0-based column (0-16383) with a style index from StreamWorkbook.addStyle(io.keikai.axyra.sheets.io.StreamStyle).
setNumber(int, int, double) - Method in class io.keikai.axyra.sheets.Sheet: Writes a number into one cell.
setNumbers(double[]) - Method in class io.keikai.axyra.sheets.Range: Writes the rectangle from a row-major double[] of length rowCount() * colCount().
setOleObjectData(int, byte[]) - Method in class io.keikai.axyra.sheets.Workbook: Replaces the embedded OLE object's bytes in place; returns whether the index existed (false for a negative index).
setOverlap(int) - Method in class io.keikai.axyra.sheets.ChartView: Sets how much bars in one cluster overlap, as a percentage from -100 (a full bar-width gap) to 100 (full overlap).
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.62 pageField@item).
setPageMargins(double, double, double, double, double, double) - Method in class io.keikai.axyra.sheets.Sheet: Sets the six page margins in inches (ECMA-376 §18.3.1.62 pageMargins).
setPageMargins(PageMargins) - Method in class io.keikai.axyra.sheets.Sheet: Sets the page margins from a PageMargins value, in inches.
setPageOrderOverThenDown(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets the page order: true prints across, then down ("Over, then down"); false prints down, then across, Excel's default (ECMA-376 §18.3.1.63 pageOrder).
setPageScale(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the print scale in percent and turns fit-to-page off.
setPaperSize(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the paper size from its ECMA-376 numeric code (§18.18.50 ST_PaperSize): 1 = Letter, 5 = Legal, 8 = A3, 9 = A4, 11 = A5, and so on.
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: Sets the print area as an A1 range on this sheet, such as "$A$1:$F$40".
setPrintBlackAndWhite(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether the sheet prints in black and white (ECMA-376 §18.3.1.63 blackAndWhite).
setPrintComments(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets where cell comments print (ECMA-376 §18.3.1.63 cellComments).
setPrintDraft(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether the sheet prints in draft quality, without graphics (ECMA-376 §18.3.1.63 draft).
setPrintErrors(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets how error cells print (ECMA-376 §18.3.1.70 printOptions/errors).
setPrintGridlines(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether gridlines are printed.
setPrintHeadings(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether row numbers and column letters are printed (ECMA-376 §18.3.1.70 printOptions/headings).
setPrintHorizontallyCentered(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether the printout is centered horizontally on the page.
setPrintResolution(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the printer resolution in dots per inch, for both axes.
setPrintTitleColumns(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the columns repeated at the left of every printed page, such as "$A:$A".
setPrintTitleRows(String) - Method in class io.keikai.axyra.sheets.Sheet: Sets the rows repeated at the top of every printed page, such as "$1:$2".
setPrintVerticallyCentered(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether the printout is centered vertically on the page.
setRevision(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets cp:revision.
setRichComment(String, CommentRun...) - Method in class io.keikai.axyra.sheets.Cell: Attaches a rich-text comment (note) to this cell, or replaces the existing one.
setRichText(RichText) - Method in class io.keikai.axyra.sheets.Cell: Sets this cell to rich text: one string with per-run font overrides.
setRightToLeft(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether this sheet is displayed right-to-left: column A at the right edge.
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.69 pivotField@name — Excel writes this attribute when a placed field is renamed in the pivot UI).
setRowFieldSubtotals(int, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView: Shows or hides the subtotals of the position-th row field (ECMA-376 pivotField@defaultSubtotal).
setRowGroupCollapsed(int, int, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Collapse or expand a grouped row range (Excel's outline +/- button): hides or shows the detail rows and sets the collapsed flag on the group's summary row: the row below the group when Sheet.summaryBelow() is true, else the row above.
setRowHeight(int, double) - Method in class io.keikai.axyra.sheets.Sheet: Sets a row's height in points (1/72 inch) and marks the height as the row's own, so Excel keeps it on open.
setRowHidden(int, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Hides or shows a row.
setRowsOutlineLevel(int, int, int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the outline level on rows startRow to endRow, 0-based and inclusive.
setRowStyle(int, CellStyle) - Method in class io.keikai.axyra.sheets.Sheet: Sets the row-level style: the style that cells in this row without their own style render with.
setScaleCrop(Boolean) - Method in class io.keikai.axyra.sheets.Workbook: Set ScaleCrop (null clears 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: Replaces the references of one series.
setSeriesDataLabels(int, DataLabels) - Method in class io.keikai.axyra.sheets.ChartView: Sets the data labels of one series, or removes them with null.
setSeriesFill(int, Color) - Method in class io.keikai.axyra.sheets.ChartView: Sets the solid fill of one series, or removes it with null so the theme color applies.
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 of Chart.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: Sets, or clears with null, the shape's alternative text.
setShapeFillColor(int, Color) - Method in class io.keikai.axyra.sheets.Sheet: Sets the shape's fill to a solid color, replacing any gradient or pattern fill.
setShapeFlip(int, boolean, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets the shape's horizontal and vertical flip flags.
setShapeHyperlink(int, String) - Method in class io.keikai.axyra.sheets.Sheet: Sets, or clears with null, the shape's hyperlink URL.
setShapeLineColor(int, Color) - Method in class io.keikai.axyra.sheets.Sheet: Sets the shape's 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: Sets the shape's rotation in degrees, clockwise.
setShapeStyleXml(int, String) - Method in class io.keikai.axyra.sheets.Sheet: Sets, or clears with null, the shape's <xdr:style> theme style-matrix reference from raw inner XML (the lnRef / fillRef / effectRef / fontRef children, without the enclosing <xdr:style> tags).
setShapeText(int, String) - Method in class io.keikai.axyra.sheets.Sheet: Replaces the shape's text, or clears it with null.
setSharedDoc(Boolean) - Method in class io.keikai.axyra.sheets.Workbook: Set SharedDoc (null clears 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 without base references.
setShowDataAs(int, PivotShowDataAsType, String, String) - Method in class io.keikai.axyra.sheets.PivotTableView: Sets the Show-Values-As mode of the position-th values-area field with base references.
setShowDataLabels(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Shows value labels on every series, or with false removes every data label from the chart, series and point labels included.
setShowFormulas(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Turns the show-formulas display mode on or off; see Sheet.showFormulas().
setShowGridlines(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Shows or hides gridlines in the on-screen view; printing is set by Sheet.setPrintGridlines(boolean).
setShowRowColHeaders(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Shows or hides the row numbers and column letters in the on-screen view; printing is set by Sheet.setPrintHeadings(boolean).
setShowZeros(boolean) - Method in class io.keikai.axyra.sheets.Sheet: Sets whether cells holding zero show 0 (true) or blank; the values do not change.
setSlicerSelection(String, String...) - Method in class io.keikai.axyra.sheets.Workbook: Replaces a slicer's item selection, as clicking slicer buttons does.
setSlicerStyle(String, String) - Method in class io.keikai.axyra.sheets.Workbook: Sets 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 whole style of the sparkline group at group: colors, point-highlight flags and axis settings.
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: Replaces this cell's style with style.
setStyle(CellStyle) - Method in class io.keikai.axyra.sheets.Range: Replaces the style of every cell in the rectangle with style.
setStyle(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Applies the style name with Excel's Design-tab default flags (PivotStyle.of(String)); null clears the style.
setSubject(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the document subject (dc:subject); null clears it.
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: Sets the tab color.
setTableColumnTotals(String, String, TotalsRowFunction) - Method in class io.keikai.axyra.sheets.Sheet: Sets the totals-row function 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: Sets the totals-row function, label and custom formula of one column of the named table.
setTableHeaderRow(String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Shows or hides the named table's header row (ECMA-376 §18.5.1.2 headerRowCount).
setTableStyle(String, TableStyleInfo) - Method in class io.keikai.axyra.sheets.Sheet: Replaces the style settings of the named table (ECMA-376 §18.5.1.20 tableStyleInfo): the style name and the banding and first/last-column flags.
setTableTotalsRow(String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Shows or hides 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 0-based column.
setText(int, String, int) - Method in class io.keikai.axyra.sheets.io.StreamRow: Sets text at 0-based column with a style index.
setTheme(Theme) - Method in class io.keikai.axyra.sheets.Workbook: Sets the workbook theme (color scheme plus major and minor fonts).
setThreadedCommentResolved(String, boolean) - Method in class io.keikai.axyra.sheets.Cell: Resolves or reopens the thread containing id.
setThreeD(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Turns 3-D drawing on or off.
setTimelineRange(String, LocalDate, LocalDate) - Method in class io.keikai.axyra.sheets.Workbook: Sets the selected date range of the named timeline.
setTitle(String) - Method in class io.keikai.axyra.sheets.ChartView: Sets a literal chart title, or removes it with null or an empty string.
setTitle(String) - Method in class io.keikai.axyra.sheets.Workbook: Sets the document title (dc:title); null clears it.
setTopNFilter(String, int, int, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView: Keeps only the top (or bottom) count items of the row/column field field, ranked by their aggregate of the dataField-th values-area field: Excel's "Top 10" filter.
setTopPercentFilter(String, int, double, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView: Keeps the top (or bottom) items of field whose aggregates, taken in rank order, first reach percent percent of the field's total: Excel's "Top 10 ...
setValidation(Validation) - Method in class io.keikai.axyra.sheets.Range: Adds a data-validation rule over this rectangle.
setValue(CellValue) - Method in class io.keikai.axyra.sheets.Cell: Sets this cell's value and drops any formula.
setValueAxisGridlines(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Shows or hides the major gridlines of the value (Y) axis; creates both axes when the chart has none.
setValueAxisScale(double, double) - Method in class io.keikai.axyra.sheets.ChartView: Fixes the value (Y) axis to the range [min, max].
setValueAxisTitle(String) - Method in class io.keikai.axyra.sheets.ChartView: Sets the value (Y) axis title, or removes it with null or an empty string.
setValueAxisVisible(boolean) - Method in class io.keikai.axyra.sheets.ChartView: Shows or hides the value (Y) axis; creates both axes when the chart has none.
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 the dataField-th values-area field is compared with value by type.
setValueFilterBetween(String, int, double, double) - Method in class io.keikai.axyra.sheets.PivotTableView: Hides the items of the row/column field field whose aggregate of the dataField-th values-area field is outside low <= aggregate <= high: Excel's "between" value filter.
setValues(CellValue[][]) - Method in class io.keikai.axyra.sheets.Range: Writes every cell from a row-major CellValue[rowCount()][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: Sets whether this sheet's tab is visible, hidden or very hidden.
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: password gates editing (null = none), userName records who reserved the file, and readOnlyRecommended shows the open-read-only prompt.
setZoom(int) - Method in class io.keikai.axyra.sheets.Sheet: Sets the on-screen zoom in percent.
shapeAltText(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the shape's alternative text (cNvPr/@descr), or null when it has none.
shapeAnchor(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns {fromRow, fromCol, toRow, toCol} of the shape's anchor, 0-based, or an empty array when the index has no shape.
shapeCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of shapes on this sheet, text boxes, connectors and groups included.
shapeFillColor(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the shape's solid fill color as an RGB color, or null when the shape has no solid RGB fill: no fill, a gradient, a pattern or a theme color.
shapeFlip(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns {flipHorizontal, flipVertical}, or an empty array when the index has no shape.
shapeHyperlink(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the hyperlink URL attached to the shape through DrawingML hlinkClick, or null when the shape has no hyperlink.
shapeLineColor(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the shape's outline color as an RGB color, or null when it has no solid RGB outline.
shapeName(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns 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: Returns the shape's rotation in degrees, clockwise.
shapeStyleXml(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the raw inner XML of the shape's <xdr:style> theme style-matrix reference (the lnRef / fillRef / effectRef / fontRef children), or null when the shape has no such block.
shapeText(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the shape's text, or null when it has none or the index has no shape.
shapeType(int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the geometry token of the shape at shapeIndex, such as "rect".
sharedDoc() - Method in class io.keikai.axyra.sheets.Workbook: The SharedDoc flag of docProps/app.xml, or null when the workbook records none.
sheet(int) - Method in class io.keikai.axyra.sheets.io.CsvOptions: Chooses the sheet to write by 0-based index, replacing a choice by name.
sheet(int) - Method in class io.keikai.axyra.sheets.Workbook: A view of the tab at index (0-based, in tab order).
sheet(String) - Method in class io.keikai.axyra.sheets.io.CsvOptions: Chooses the sheet to write by name, compared ignoring case as Excel does.
sheet(String) - Method in class io.keikai.axyra.sheets.Workbook: The sheet with the given name, compared ignoring case as Excel compares sheet names; a sheet whose name matches exactly wins.
Sheet - Class in io.keikai.axyra.sheets: A worksheet: a lightweight view bound to one tab of a Workbook.
sheetCount() - Method in class io.keikai.axyra.sheets.Workbook: Number of tabs, chart-sheet tabs included (see Workbook.chartSheetCount()).
sheetIndex() - Method in record class io.keikai.axyra.sheets.CellRef: Returns the value of the sheetIndex record component.
sheetIndex() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the sheetIndex record component.
sheetIndex() - Method in record class io.keikai.axyra.sheets.content.Timeline: Returns the value of the sheetIndex record component.
sheetIndex() - Method in class io.keikai.axyra.sheets.io.CsvOptions: The chosen 0-based sheet index, or -1 when the sheet is the default or chosen 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 null when not chosen by name.
sheetNames() - Method in record class io.keikai.axyra.sheets.content.ExternalLink: Returns the value of the sheetNames record component.
sheetNames() - Method in class io.keikai.axyra.sheets.io.PdfOptions: The selected sheet names.
sheetNames(String...) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Selects sheets to export by name, compared case-sensitively.
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 SheetProtection record class.
SheetProtection.Builder - Class in io.keikai.axyra.sheets: Builder for SheetProtection; every setter takes true = allowed.
sheets() - Method in class io.keikai.axyra.sheets.io.PdfOptions: The selected 0-based sheet indices.
sheets() - Method in class io.keikai.axyra.sheets.Workbook: A view of every tab, in tab order, chart-sheet tabs included.
sheets(int...) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Selects sheets to export by 0-based index.
sheetScope() - Method in class io.keikai.axyra.sheets.NamedRange: Returns the 0-based index of the sheet this name is scoped to, or -1 for workbook scope.
sheetType() - Method in class io.keikai.axyra.sheets.Sheet: Returns what kind of tab this is: worksheet, chart sheet, dialog sheet or Excel 4.0 macro sheet (international or not).
SheetType - Enum Class in io.keikai.axyra.sheets: What kind of tab a Sheet is.
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 showCaption record component.
showCategoryName() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the showCategoryName record component.
showColHeaders() - Method in record class io.keikai.axyra.sheets.PivotStyle: Returns the value of the showColHeaders record component.
showColStripes() - Method in record class io.keikai.axyra.sheets.PivotStyle: Returns the value of the showColStripes record component.
showColumnStripes() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo: Returns the value of the showColumnStripes record component.
showDataAs(int) - Method in class io.keikai.axyra.sheets.PivotTableView: The Show-Values-As state of the position-th values-area field, read from this view's snapshot.
showDataLabels() - Method in class io.keikai.axyra.sheets.ChartView: Whether the chart shows data labels: set through the builder or ChartView.setShowDataLabels(boolean), or value labels on every series — the form the setting takes in a file, so it reads back after reopening.
showDataLabels() - Method in class io.keikai.axyra.sheets.content.Chart: Whether the chart-wide data-label switch is on.
showDataLabels(boolean) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Turns value labels on every series on or off.
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 showEquation record component.
showErrorMessage() - Method in class io.keikai.axyra.sheets.content.Validation: Whether an invalid entry raises the error alert.
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 showFirst record component.
showFirst() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the showFirst record component.
showFirstColumn() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo: Returns the value of the showFirstColumn record component.
showFormulas() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the grid shows formula text instead of results (<sheetView showFormulas>).
showGridlines() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the on-screen 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 showHigh record component.
showHigh() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the showHigh record component.
showInputMessage() - Method in class io.keikai.axyra.sheets.content.Validation: Whether the input hint shows when the cell is selected.
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 showLast record component.
showLast() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the showLast record component.
showLastColumn() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo: Returns the value of the showLastColumn record component.
showLastColumn() - Method in record class io.keikai.axyra.sheets.PivotStyle: Returns the value of the showLastColumn record component.
showLegendKey() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the showLegendKey record component.
showLow() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the showLow record component.
showLow() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the showLow record component.
showMarkers() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the showMarkers record component.
showMarkers() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the showMarkers record component.
showNegative() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the showNegative record component.
showNegative() - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Returns the value of the showNegative record component.
showPercent() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the showPercent record component.
showRowColHeaders() - Method in class io.keikai.axyra.sheets.Sheet: Returns whether the on-screen view shows the row numbers and column letters (showRowColHeaders).
showRowHeaders() - Method in record class io.keikai.axyra.sheets.PivotStyle: Returns the value of the showRowHeaders record component.
showRowStripes() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo: Returns the value of the showRowStripes record component.
showRowStripes() - Method in record class io.keikai.axyra.sheets.PivotStyle: Returns the value of the showRowStripes record component.
showRSquared() - Method in record class io.keikai.axyra.sheets.content.Trendline: Returns the value of the showRSquared record component.
showScenario(int) - Method in class io.keikai.axyra.sheets.Sheet: Applies the scenario at scenarioIndex: writes each of its changing-cell values into the sheet.
showSeriesName() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the showSeriesName record component.
showSubtotals() - Method in record class io.keikai.axyra.sheets.PivotField: Returns the value of the showSubtotals record 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 showValue record 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: Returns whether a cell holding zero shows 0 (true) or 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: Shrinks the text to fit the cell width (true) instead of letting it overflow.
Side - Enum Class in io.keikai.axyra.sheets.style: One border edge of a cell.
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 privateKey is an EC P-256 key), returning the signed file bytes.
sign(Path, byte[], byte[]) - Method in class io.keikai.axyra.sheets.Workbook: Signs like Workbook.sign(byte[], byte[]) and writes the signed XLSX package to file, replacing an existing file.
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 SignatureInfo record 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 signedAt record component.
signerName() - Method in record class io.keikai.axyra.sheets.SignatureInfo: Returns the value of the signerName record component.
SINGLE - Enum constant in enum class io.keikai.axyra.sheets.style.Underline: One line under the text.
SINGLE_ACCOUNTING - Enum constant in enum class io.keikai.axyra.sheets.style.Underline: One line placed lower and spanning the cell width, as on financial statements.
singleFile() - Method in class io.keikai.axyra.sheets.io.HtmlOptions: Whether one self-contained document is written instead of the package.
singleFile(boolean) - Method in class io.keikai.axyra.sheets.io.HtmlOptions: Chooses one self-contained document (true) instead of the package: every sheet in one file, every image inlined.
skip() - Method in class io.keikai.axyra.sheets.io.StreamRow: Leaves the next column empty and moves past it; nothing is written for it.
skipComments() - Method in class io.keikai.axyra.sheets.io.SaveOptions: Whether comments are left out of the saved file.
skipComments(boolean) - Method in class io.keikai.axyra.sheets.io.SaveOptions: Leaves cell comments (notes) out of the saved XLSX file (true).
skipHyperlinks() - Method in class io.keikai.axyra.sheets.io.SaveOptions: Whether hyperlinks are left out of the saved file.
skipHyperlinks(boolean) - Method in class io.keikai.axyra.sheets.io.SaveOptions: Leaves hyperlinks out of the saved XLSX file (true).
SLANT_DASH_DOT - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Medium dash-dot line whose dashes have slanted ends.
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 Slicer record class.
slicerCount() - Method in class io.keikai.axyra.sheets.Workbook: Number of slicers in the workbook, the size of Workbook.slicers().
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, as text.
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 SmartArt record class.
smartArtCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of SmartArt diagrams anchored on this sheet.
smartArts() - Method in class io.keikai.axyra.sheets.Sheet: Returns the SmartArt diagrams anchored on this sheet as read-only descriptors: layout family, anchor and visible node texts.
SOLID - Enum constant in enum class io.keikai.axyra.sheets.style.PatternType: Solid fill in the foreground color.
sort() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns the value of the sort record component.
sort(boolean) - Method in class io.keikai.axyra.sheets.SheetProtection.Builder: Allows sorting (default false).
sort(int, boolean) - Method in class io.keikai.axyra.sheets.Range: Sorts the rows of the rectangle by one column, case-insensitively.
sort(SortKey...) - Method in class io.keikai.axyra.sheets.Range: Sorts the rows of the rectangle by one or more keys, primary key first.
sortByColor(Range, int, boolean, boolean, Color...) - Method in class io.keikai.axyra.sheets.Sheet: Sort the rows of range by cell fill color (or font color when cellColor is false) at sortColumnIndex (0-based, relative to the range start).
sortField(String, boolean) - Method in class io.keikai.axyra.sheets.PivotTableView: Sorts the row/column field field by item label (ECMA-376 Part 1 §18.10.1.69 sortType).
sortFieldByValue(String, boolean, int) - Method in class io.keikai.axyra.sheets.PivotTableView: Sorts the row/column field field by its aggregate of the dataField-th values-area field (ECMA-376 Part 1 §18.10.1.72 autoSortScope).
sortingTextAsNumber() - Method in record class io.keikai.axyra.sheets.SortKey: Returns 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: Creates a plain key: no custom ordering list, textAsNumber off.
SortKey(int, boolean, String[]) - Constructor for record class io.keikai.axyra.sheets.SortKey: Creates a key with a custom ordering list and textAsNumber off.
SortKey(int, boolean, String[], boolean) - Constructor for record class io.keikai.axyra.sheets.SortKey: Creates an instance of a SortKey record class.
sortLeftToRight(SortKey...) - Method in class io.keikai.axyra.sheets.Range: Sorts left to right (Excel's Sort Options → "Sort left to right"): reorders 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 source record component.
source() - Method in record class io.keikai.axyra.sheets.content.VbaModule: Returns the value of the source record component.
sourceField() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the sourceField record component.
sourceFields() - Method in class io.keikai.axyra.sheets.PivotTableView: The source column names available for field placement, in source order: the cache field names, or the header row of the source range for a pivot whose cache is still empty.
sourceIndex() - Method in record class io.keikai.axyra.sheets.PivotField: Returns the value of the sourceIndex record 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: Returns the workbook-level id this sheet was read with (<sheet sheetId> in xl/workbook.xml), or 0 for a sheet created through this API; 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 Sparkline record 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 SparklineGroup record class.
sparklineGroupCount() - Method in class io.keikai.axyra.sheets.Sheet: Returns the number of sparkline groups on this sheet.
sparklines() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the sparklines record 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 SparklineStyle record class.
spillRange() - Method in class io.keikai.axyra.sheets.Range: Returns the A1 extent of the dynamic-array spill, or of the legacy Ctrl+Shift+Enter array, that contains this range's top-left cell, e.g.
SPIN_BUTTON - Enum constant in enum class io.keikai.axyra.sheets.content.FormControlType: Up/down arrows that step a value between a minimum and a maximum.
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: Returns the 0-based column just right of the vertical split, or 0 when there is none.
splitPanes(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Splits the view into panes that scroll on their own, as Excel's View > Split does.
splitRow() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 0-based row just below the horizontal split, or 0 when there is none.
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 sqref record component.
start() - Method in record class io.keikai.axyra.sheets.PivotFieldGroup: Returns the value of the start record 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 state record component.
status() - Static method in class io.keikai.axyra.sheets.License: Returns the current licensing status of this process.
status() - Method in record class io.keikai.axyra.sheets.SignatureInfo: Returns the value of the status record 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: SUBTOTAL(107, column): sample standard deviation of the visible values.
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: sample standard deviation.
STDEV - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 7, STDEV: sample standard deviation.
STDEV_P - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: STDEVP: population standard deviation.
STDEVP - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 8, STDEVP: population standard deviation.
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: An immutable cell style for StreamWorkbook: the small subset that covers report authoring, a number format plus bold and 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: Strikes through the run.
strike() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the strike record component.
strikethrough() - Method in record class io.keikai.axyra.sheets.content.CommentRun: Returns the value of the strikethrough record 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: Whether the text is struck through.
strikethrough(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets (true) or clears (false) strikethrough.
style() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's resolved style: the workbook default style for a cell that has none.
style() - Method in class io.keikai.axyra.sheets.ChartView: The chart's built-in style number (<c:style val>), or -1 when it carries none.
style() - Method in class io.keikai.axyra.sheets.content.Chart: The chart's built-in style number (<c:style val>), or -1 when 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 style record component.
style() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: The group's style, for Sheet.setSparklineStyle.
style() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the style record component.
style() - Method in class io.keikai.axyra.sheets.PivotTableView: The named pivot style and its banding flags, read from this view's snapshot.
style() - Method in class io.keikai.axyra.sheets.Range: Returns 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 style record 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: Returns each cell's style id, row-major.
styleName() - Method in record class io.keikai.axyra.sheets.content.TableStyleInfo: Returns the value of the styleName record component.
subject() - Method in class io.keikai.axyra.sheets.Workbook: The document subject (dc:subject), or null when none is set.
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: Lowered and smaller, as the 2 in H2O.
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 in groupColumn, a summary row of function over subtotalColumns is 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 of the numeric values (Excel's "Sum").
SUM - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: SUM: total of the numbers at each position.
SUM - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 9, SUM: total of the numbers.
SUM - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(109, column): sum of the visible values.
summaryBelow() - Method in class io.keikai.axyra.sheets.Sheet: Returns 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: Returns 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: Raised and smaller, as in x squared.
surface() - Static method in class io.keikai.axyra.sheets.content.Chart: A surface chart.

T

tabColor() - Method in class io.keikai.axyra.sheets.Sheet: Returns the tab color, or null when the tab has none.
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 Table record 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 TableColumn record class.
tableColumns() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the tableColumns record component.
tableName() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding: Returns the value of the tableName record component.
tables() - Method in class io.keikai.axyra.sheets.Sheet: Returns every table on this sheet (Excel's ListObjects), with its range, columns, style and totals state.
tableSlicer() - Method in record class io.keikai.axyra.sheets.content.Slicer: Returns the value of the tableSlicer record 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 TableStyleInfo record 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: The exact output width in pixels, with the height keeping the page's aspect ratio.
targetWidthPx(int) - Method in class io.keikai.axyra.sheets.io.ImageOptions.Builder: Sets the exact output width in pixels.
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 text record component.
text() - Method in record class io.keikai.axyra.sheets.content.CommentRun: Returns the value of the text record component.
text() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The text operand of a notContainsText rule, or null.
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 text record 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 text record component.
text() - Method in record class io.keikai.axyra.sheets.format.ParsedValue: Returns the value of the text record component.
text(String) - Static method in interface io.keikai.axyra.sheets.CellValue: A text value, stored as typed: a numeric-looking string stays text.
text(String) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the caption of a button, check box, option button, label or group box; null or an empty string shows the control name.
Text(String) - Constructor for record class io.keikai.axyra.sheets.CellValue.Text: Creates an instance of a Text record class.
Text(String) - Constructor for record class io.keikai.axyra.sheets.CustomProperty.Text: Creates an instance of a Text record class.
TEXT - Enum constant in enum class io.keikai.axyra.sheets.format.ParsedValue.Kind: Anything else, kept as text.
textAsNumber() - Method in record class io.keikai.axyra.sheets.SortKey: Returns the value of the textAsNumber record component.
textColor() - Method in record class io.keikai.axyra.sheets.content.DataLabels: Returns the value of the textColor record component.
textLength(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation: A text-length constraint on the number of characters, for example textLength("lessThanOrEqual", "50", null).
textRotation() - Method in class io.keikai.axyra.sheets.style.CellStyle: The text rotation in the ECMA-376 §18.8.1 encoding.
textRotation(int) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the text rotation in the ECMA-376 §18.8.1 encoding: 0-90 rotates counter-clockwise by that many degrees, 91-180 rotates clockwise by (value - 90) degrees, and 255 stacks the characters vertically.
textToColumns(String, int, int, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Splits text as Sheet.textToColumns(String, String) does, writing the fields to another place: the fields of source row i go to row destRow + i, starting at destColumn.
textToColumns(String, String) - Method in class io.keikai.axyra.sheets.Sheet: Splits text in place, as Excel's Text to Columns does in delimited mode.
textToColumns(String, String, boolean) - Method in class io.keikai.axyra.sheets.Sheet: Splits text in place as Sheet.textToColumns(String, String) does, optionally treating a run of 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 null when 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(int, double) - Static method in class io.keikai.axyra.sheets.style.Color: A theme-palette color with a tint.
Theme - Class in io.keikai.axyra.sheets.style: An immutable 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; see Theme.builder() and Theme.toBuilder().
Theme.Slot - Enum Class in io.keikai.axyra.sheets.style: The 12 theme color slots, in ECMA-376 <a:clrScheme> order.
themeIndex() - Method in class io.keikai.axyra.sheets.style.Color: The theme index of a theme color, in the order of Color.theme(int, double) (0 = light 1, 1 = dark 1).
THICK - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Thick solid line, 3 px.
THIN - Enum constant in enum class io.keikai.axyra.sheets.style.BorderStyle: Thin solid line, 1 px at 100 % zoom.
THIS_MONTH - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: The current calendar month.
THIS_MONTH - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the current calendar month.
THIS_QUARTER - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the current calendar quarter.
THIS_WEEK - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: The current Sunday-to-Saturday week.
THIS_WEEK - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the current Sunday-to-Saturday week.
THIS_YEAR - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates in the current calendar year.
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 ThreadedComment record class.
threadedComments() - Method in class io.keikai.axyra.sheets.Cell: Returns this cell's Excel 365 comment threads.
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: Draws the chart in 3-D.
threeD(boolean) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the 3-D shading flag of Excel's Format Control dialog.
time(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation: A time constraint, for example time("between", "TIME(9,0,0)", "TIME(17,0,0)").
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 Timeline record class.
timelineCount() - Method in class io.keikai.axyra.sheets.Workbook: Number of timelines in the workbook, the size of Workbook.timelines().
timelineRange(String) - Method in class io.keikai.axyra.sheets.Workbook: The selected date range of the named timeline as [start, end], both inclusive, read in this workbook's date system.
timelines() - Method in class io.keikai.axyra.sheets.Workbook: Every timeline in the workbook, each joined with its cache so the filtered date field, the granularity level and the on-sheet anchor travel with it; see Timeline.
timePeriod() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The date window of a timePeriod rule, or null.
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 timestamp record component.
tint() - Method in class io.keikai.axyra.sheets.style.Color: The tint of a theme color.
title() - Method in class io.keikai.axyra.sheets.ChartView: The literal chart title, or null when the chart has none or uses an auto title (ChartView.titleAuto()).
title() - Method in class io.keikai.axyra.sheets.content.Chart: The literal title, or null when the chart has none or uses an auto title (Chart.titleAuto()).
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 (dc:title), or null when none is set.
title(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets a literal chart title and turns off autoTitle.
title(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Sets the document title in the PDF metadata.
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>), or null for 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>), or null for a literal or absent title.
titleFormula(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Makes the chart title follow a cell instead of 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, or null when 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: Renders one printed page of a 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: Returns a new builder holding this value's settings, to derive a changed copy.
toBuilder() - Method in class io.keikai.axyra.sheets.io.ImageOptions: A builder pre-loaded with these options, for changing a few of them.
toBuilder() - Method in class io.keikai.axyra.sheets.io.PdfOptions: A builder pre-loaded with these options, for changing a few of them.
toBuilder() - Method in record class io.keikai.axyra.sheets.SheetProtection: Returns a new builder holding this value's flags, to derive a changed copy.
toBuilder() - Method in class io.keikai.axyra.sheets.style.CellStyle: A builder pre-loaded with every attribute of this style.
toBuilder() - Method in class io.keikai.axyra.sheets.style.Theme: A builder pre-loaded with this theme's colors and fonts, for changing a few slots.
toCol() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the toCol record component.
toColumn() - Method in class io.keikai.axyra.sheets.content.FormControl: The 0-based column of the cell that holds the anchor's bottom-right corner; at zero column offset that cell is not covered.
TODAY - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: Dates equal to today.
TODAY - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates equal to today.
toGif(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders one printed page of a sheet to GIF bytes.
toHex() - Method in class io.keikai.axyra.sheets.style.Color: The hex form of an RGB color, upper case with alpha, e.g.
toImage(Workbook, int, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders one printed page of a sheet (page 1, or the page set in options) to format.
toImage(Workbook, int, String, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders an A1 range of a sheet to format, with the format tokens of Renderer.toImage(io.keikai.axyra.sheets.Workbook, int, String, ImageOptions).
toJpeg(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders one printed page of a sheet to JPEG bytes, composited over white.
toJson() - Method in class io.keikai.axyra.sheets.content.Chart: The chart spec as the JSON object sent to the engine.
toJson() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The rule as the JSON object sent to the engine.
toJson() - Method in class io.keikai.axyra.sheets.content.FormControl: The control as the JSON object sent to the engine.
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: The rule as the JSON object sent to the engine.
toJson() - Method in class io.keikai.axyra.sheets.style.CellStyle: The flat style JSON sent to the engine.
toJsonValue() - Method in class io.keikai.axyra.sheets.style.Color: The JSON value sent to the engine, in the forms that Color.fromJson(Object) reads.
token() - Method in enum class io.keikai.axyra.sheets.content.LegendPosition: The OOXML legendPos token sent to the engine, or "none".
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: The ECMA-376 ST_BorderStyle token, e.g.
token() - Method in enum class io.keikai.axyra.sheets.style.FontVertical: The ECMA-376 ST_VerticalAlignRun token, e.g.
token() - Method in enum class io.keikai.axyra.sheets.style.HAlign: The ECMA-376 ST_HorizontalAlignment token, e.g.
token() - Method in enum class io.keikai.axyra.sheets.style.PatternType: The ECMA-376 ST_PatternType token, e.g.
token() - Method in enum class io.keikai.axyra.sheets.style.Underline: The ECMA-376 ST_UnderlineValues token, e.g.
token() - Method in enum class io.keikai.axyra.sheets.style.VAlign: The ECMA-376 ST_VerticalAlignment token, e.g.
TOMORROW - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: Dates equal to today plus one day.
TOMORROW - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates equal to tomorrow.
tooltip() - Method in record class io.keikai.axyra.sheets.content.Hyperlink: Returns the value of the tooltip record component.
top() - Method in record class io.keikai.axyra.sheets.PageMargins: Returns the value of the top record component.
TOP - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition: Above the plot area.
TOP - Enum constant in enum class io.keikai.axyra.sheets.style.Side: The cell's top edge.
TOP - Enum constant in enum class io.keikai.axyra.sheets.style.VAlign: Content at the top of the cell.
TOP_RIGHT - Enum constant in enum class io.keikai.axyra.sheets.content.LegendPosition: In the top-right corner of the chart.
top10(int, boolean, boolean) - Method in class io.keikai.axyra.sheets.content.ConditionalFormat.Builder: A top-N (or bottom-N when bottom) rule; percent ranks by %.
toPdf(Workbook, PdfOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders the workbook to PDF bytes with options.
toPdf(Workbook, Path) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders every visible sheet to a PDF file, replacing an existing file.
toPdf(Workbook, Path, PdfOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders the workbook to a PDF file with options, replacing an existing file.
topNFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: The Top-N filter of the row/column field field, matched ignoring case.
toPng(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders one printed page of a sheet to PNG bytes: page 1, or the page set in options.
toPng(Workbook, int, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders an A1 range of a sheet to PNG bytes.
toRow() - Method in class io.keikai.axyra.sheets.content.FormControl: The 0-based row of the cell that holds the anchor's bottom-right corner; at zero row offset that cell is not covered.
toRow() - Method in record class io.keikai.axyra.sheets.content.SmartArt: Returns the value of the toRow record 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: Renders one printed page of a sheet to SVG bytes (UTF-8): page 1, or the page set with ImageOptions.Builder.page(int).
toSvg(Workbook, int, String, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders 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 totalsRowFunction record 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 totalsRowLabel record component.
totalsRowShown() - Method in record class io.keikai.axyra.sheets.content.Table: Returns the value of the totalsRowShown record component.
toTiff(Workbook, int, ImageOptions) - Static method in class io.keikai.axyra.sheets.io.Renderer: Renders one printed page of a 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 Trendline record class.
trendlines(int) - Method in class io.keikai.axyra.sheets.ChartView: The trendlines of a series, in file order; empty when none.
TRUE - Static variable in interface io.keikai.axyra.sheets.CellValue: The boolean TRUE.
type() - Method in class io.keikai.axyra.sheets.ChartView: The chart type token, such as "column", "bar", "line", "pie" or "combo"; "column" when the engine reports none.
type() - Method in class io.keikai.axyra.sheets.content.Chart: The chart type token (see Chart.of(String)); an empty string when the spec has none.
type() - Method in class io.keikai.axyra.sheets.content.ConditionalFormat: The rule kind: cellIs, expression, colorScale, dataBar, iconSet, top10, aboveAverage, duplicateValues, uniqueValues, containsBlanks, notContainsBlanks, containsErrors, notContainsErrors, notContainsText or timePeriod; an empty string when unset.
type() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject: Returns the value of the type record component.
type() - Method in class io.keikai.axyra.sheets.content.FormControl: The control kind; FormControlType.UNKNOWN for a token the SDK does not know.
type() - Method in record class io.keikai.axyra.sheets.content.SparklineGroup: Returns the value of the type record component.
type() - Method in class io.keikai.axyra.sheets.content.Validation: The validation type token; "none" for a read-back rule that allows any value, an empty string when unset.
type() - Method in record class io.keikai.axyra.sheets.PivotLabelFilter: Returns the value of the type record component.
type() - Method in record class io.keikai.axyra.sheets.PivotShowDataAs: Returns the value of the type record component.
type() - Method in record class io.keikai.axyra.sheets.PivotValueFilter: Returns the value of the type record 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: Sets the validation type: whole, decimal, list, date, time, textLength or custom.
TypedUserFunction - Interface in io.keikai.axyra.sheets.formula: A user-defined formula function that receives typed values, including ranges.

U

underline() - Method in record class io.keikai.axyra.sheets.content.CommentRun: Returns the value of the underline record 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: Single-underlines the run.
underline() - Method in record class io.keikai.axyra.sheets.content.RichText.RunInfo: Returns the value of the underline record component.
underline() - Method in class io.keikai.axyra.sheets.style.CellStyle: The underline style; Underline.NONE when unset.
underline(Underline) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the underline style.
Underline - Enum Class in io.keikai.axyra.sheets.style: The underline style of a font (ECMA-376 ST_UnderlineValues).
unfreeze() - Method in class io.keikai.axyra.sheets.Sheet: Removes any frozen panes; the same as freezePanes(0, 0).
ungroupField(String) - Method in class io.keikai.axyra.sheets.PivotTableView: Removes the grouping of field: items revert to the raw source values, and a multi-level date grouping collapses back to one level.
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: Returns the sheet's revision GUID (Excel's xr:uid on 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, read from a file.
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: Unmerges every merged region that lies wholly inside this rectangle.
unprotect() - Method in class io.keikai.axyra.sheets.Sheet: Removes sheet protection without checking any password.
unprotect() - Method in class io.keikai.axyra.sheets.Workbook: Clears both workbook locks without checking a password.
unprotect(String) - Method in class io.keikai.axyra.sheets.Sheet: Disable sheet protection after verifying password against the stored hash (ISO hash, or the legacy 16-bit password attribute of transitional files).
unprotectStructure(String) - Method in class io.keikai.axyra.sheets.Workbook: Clear the workbook protection after verifying password against 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 is given.
UP - Enum constant in enum class io.keikai.axyra.sheets.Shift: Cells move up; valid for Range.deleteCells(io.keikai.axyra.sheets.Shift).
updateFormControl(int, FormControl) - Method in class io.keikai.axyra.sheets.Sheet: Replaces the form control at controlIndex, its 0-based position in Sheet.formControls().
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: Returns the smallest range that covers every stored cell, or null when the sheet has no cells.
UserFunction - Interface in io.keikai.axyra.sheets.formula: A numeric user-defined formula function.
userName() - Method in record class io.keikai.axyra.sheets.content.WriteProtection: Returns the value of the userName record component.
userPassword() - Method in class io.keikai.axyra.sheets.io.PdfOptions: The password required to open the document, or null; see PdfOptions.Builder.userPassword(String).
userPassword(String) - Method in class io.keikai.axyra.sheets.io.PdfOptions.Builder: Sets the password required to open the document; this turns on AES-128 encryption.
utf8Bom() - Method in class io.keikai.axyra.sheets.io.CsvOptions: Whether the file starts with a UTF-8 byte-order mark.
utf8Bom(boolean) - Method in class io.keikai.axyra.sheets.io.CsvOptions: Starts the file with a UTF-8 byte-order mark (true), as Excel's "CSV UTF-8" format does.

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: A fluent builder for a Validation.
validations() - Method in class io.keikai.axyra.sheets.Sheet: Returns every data-validation rule on this sheet, in stored order.
validFrom() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the value of the validFrom record component.
validFromInstant() - Method in record class io.keikai.axyra.sheets.LicenseInfo: Returns the start of validity as an Instant, or null for no lower bound or no key.
VAlign - Enum Class in io.keikai.axyra.sheets.style: Vertical alignment of the cell content (ECMA-376 ST_VerticalAlignment).
value() - Method in class io.keikai.axyra.sheets.Cell: Returns the cell's value.
value() - Method in record class io.keikai.axyra.sheets.CellValue.Bool: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CellValue.Number: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CellValue.Text: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject: Returns the value of the value record 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 value record component.
value() - Method in class io.keikai.axyra.sheets.content.FormControl: Current value of a scroll bar or spin button; 0 when the control does not store it.
value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Bool: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Date: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Number: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CustomProperty.Text: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.CustomProperty: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.PivotLabelFilter: Returns the value of the value record component.
value() - Method in record class io.keikai.axyra.sheets.PivotTopNFilter: Returns the value of the value record component.
value(int) - Method in class io.keikai.axyra.sheets.content.FormControl.Builder: Sets the current value of a scroll bar or spin button.
value(int, int) - Method in class io.keikai.axyra.sheets.Sheet: Returns the value of one cell: its cached result for a formula cell, CellValue.BLANK for an empty cell.
value1() - Method in record class io.keikai.axyra.sheets.PivotValueFilter: Returns the value of the value1 record component.
value2() - Method in record class io.keikai.axyra.sheets.PivotValueFilter: Returns the value of the value2 record 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 fixed value-axis maximum, or null when the axis scales automatically.
valueAxisMin() - Method in class io.keikai.axyra.sheets.ChartView: The fixed value-axis minimum, or null when the axis scales automatically.
valueAxisScale(double, double) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Fixes the value (Y) axis to the range [min, max].
valueAxisTitle() - Method in class io.keikai.axyra.sheets.ChartView: The value (Y) axis title, or null when the axis has none or the chart has no value axis.
valueAxisTitle() - Method in class io.keikai.axyra.sheets.content.Chart: The value (Y) axis title, or null when none is set.
valueAxisTitle(String) - Method in class io.keikai.axyra.sheets.content.Chart.Builder: Sets the value (Y) axis title; null sets none.
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: Shows or hides the value (Y) axis; shown by default (ECMA-376 §21.2.2.226 valAx).
valueFilter(String) - Method in class io.keikai.axyra.sheets.PivotTableView: The value filter of the row/column field field, matched ignoring case.
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 ValueObject record 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: How numeric cells are written.
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: Reads every cell as a CellValue, row-major: result[r][c] is the cell at (firstRow() + r, firstColumn() + c).
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: Chooses how numeric cells are written: display text (CsvOptions.Values.FORMATTED, the default) or stored values (CsvOptions.Values.RAW).
VALUES_ONLY - Enum constant in enum class io.keikai.axyra.sheets.io.FormulaPolicy: Writes the cached value only and leaves out the formula, like Excel's Paste Special > Values.
valueType() - Method in record class io.keikai.axyra.sheets.content.ErrorBars: Returns the value of the valueType record 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: sample variance.
VAR - Enum constant in enum class io.keikai.axyra.sheets.SubtotalFunction: SUBTOTAL 10, VAR: sample variance.
VAR - Enum constant in enum class io.keikai.axyra.sheets.TotalsRowFunction: SUBTOTAL(110, column): sample variance of the visible values.
VAR_P - Enum constant in enum class io.keikai.axyra.sheets.ConsolidateFunction: VARP: population variance.
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: SUBTOTAL 11, VARP: population variance.
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 VbaModule record 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: Returns whether password matches the stored hash of the allow-edit range name, matched case-insensitively.
verifyProtectionPassword(String) - Method in class io.keikai.axyra.sheets.Sheet: Returns whether password matches the sheet's stored hash.
verifyWritePassword(String) - Method in class io.keikai.axyra.sheets.Workbook: Verifies password against the stored modify-password hash; false when the workbook is not write-protected.
verticalAlign() - Method in class io.keikai.axyra.sheets.style.CellStyle: The vertical alignment; VAlign.BOTTOM when unset.
verticalAlign(VAlign) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Sets the vertical alignment.
VERY_HIDDEN - Enum constant in enum class io.keikai.axyra.sheets.Visibility: The tab is hidden and absent from Excel's Unhide list; only code can show it again.
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], or null when 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): rotX is the elevation and rotY the rotation, both in degrees; depthPercent is the depth as a percentage of the plot height (100 = default).
viewType() - Method in class io.keikai.axyra.sheets.Sheet: Returns the 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: Returns whether this sheet's tab is visible, hidden or 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: The tab is shown.
vtType() - Method in record class io.keikai.axyra.sheets.CustomProperty.Raw: Returns the value of the vtType record 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: Paints text diagonally, in light gray, under every page's content, e.g.
WHITE - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque white, #FFFFFF.
wholeNumber(String, String, String) - Static method in class io.keikai.axyra.sheets.content.Validation: A whole-number constraint, for example wholeNumber("between", "1", "10").
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 groupBy token, 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 showDataAs token, 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: A copy with the horizontal-axis color; null uses the default.
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: A copy of this style that is bold; the usual header row.
withBold(boolean) - Method in record class io.keikai.axyra.sheets.FindFormat: Returns a copy matching cells whose resolved font bold flag equals b.
withBold(boolean) - Method in class io.keikai.axyra.sheets.io.StreamStyle: A copy of this style with bold set to value.
withBold(Boolean) - Method in record class io.keikai.axyra.sheets.content.DataLabels: Copy with the given label bold flag (null inherits).
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: Returns a copy of this key with 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: Returns 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 showFirst on.
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: Returns 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 (null inherits).
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 showHigh on.
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: A copy of this style that is italic.
withItalic(boolean) - Method in record class io.keikai.axyra.sheets.FindFormat: Returns a copy matching cells whose resolved font italic flag equals i.
withItalic(boolean) - Method in class io.keikai.axyra.sheets.io.StreamStyle: A copy of this style with italic set to value.
withLastColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Sets the last-point color and turns showLast on.
withLowColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Sets the low-point color and turns showLow on.
withMarkersColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Sets the marker color and turns showMarkers on.
withNegativeColor(String) - Method in record class io.keikai.axyra.sheets.content.SparklineStyle: Sets the negative-point color and turns showNegative on.
withNumberFormat(String) - Method in record class io.keikai.axyra.sheets.content.DataLabels: Copy with the given number-format override (null inherits the axis).
withNumberFormat(String) - Method in record class io.keikai.axyra.sheets.FindFormat: Returns a copy matching cells whose resolved number format code equals code, e.g.
withNumberFormat(String) - Method in class io.keikai.axyra.sheets.io.StreamStyle: A copy of 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 (null clears it).
withRotation(Integer) - Method in record class io.keikai.axyra.sheets.content.DataLabels: Copy with the given label rotation in whole degrees (null inherits).
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: A copy with the line or bar color ("FFRRGGBB" or "theme:N"); null uses the default.
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: A copy that draws (true) or hides (false) a marker on every point of a line sparkline; the marker color is kept.
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, an RGB color (null inherits).
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 owner of the native engine workbook.
WORKSHEET - Enum constant in enum class io.keikai.axyra.sheets.SheetType: An ordinary worksheet.
wrapText() - Method in class io.keikai.axyra.sheets.style.CellStyle: Whether text wraps onto several lines inside the cell.
wrapText(boolean) - Method in class io.keikai.axyra.sheets.style.CellStyle.Builder: Wraps text onto several lines inside the cell (true).
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 via Workbook.writeProtection().
WriteProtection(boolean, String, boolean) - Constructor for record class io.keikai.axyra.sheets.content.WriteProtection: Creates an instance of a WriteProtection record 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 XmlMap record 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 XmlMapBinding record 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, XSD schema text and cell bindings (XmlMap.bindings()), read from xl/xmlMaps.xml.
xpath() - Method in record class io.keikai.axyra.sheets.content.XmlMapBinding: Returns the value of the xpath record component.

Y

year() - Method in record class io.keikai.axyra.sheets.DateGroupItem: Returns the value of the year record component.
year(int) - Static method in record class io.keikai.axyra.sheets.DateGroupItem: An item that selects the whole calendar year.
YEAR_TO_DATE - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates from January 1 of this year up to and including today.
YEARS - Enum constant in enum class io.keikai.axyra.sheets.PivotDateGroupBy: Calendar year: items read "2024", "2025", and so on.
YELLOW - Static variable in class io.keikai.axyra.sheets.style.Color: Opaque yellow, #FFFF00.
YESTERDAY - Enum constant in enum class io.keikai.axyra.sheets.content.TimePeriod: Dates equal to today minus one day.
YESTERDAY - Enum constant in enum class io.keikai.axyra.sheets.DynamicFilterType: Dates equal to yesterday.

Z

zoom() - Method in class io.keikai.axyra.sheets.Sheet: Returns the on-screen zoom in percent; 100 by default.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form