org.soulspace.cmp.poi.excel — org.soulspace.clj/cmp.poi 0.6.2

*cell* clj

*row* clj

*sheet* clj

*workbook* clj

add-merged-region clj

(add-merged-region cell-range-address)

(add-merged-region sheet cell-range-address)

(add-merged-region start-row end-row start-column end-column)

(add-merged-region sheet start-row end-row start-column end-column)

Defines merged cells in a sheet.

all-cell-values clj

(all-cell-values)

(all-cell-values row)

(all-cell-values row min-cells)

Returns a sequence of the cell values of the row.

all-row-cells clj

(all-row-cells)

(all-row-cells sheet)

(all-row-cells sheet min-cells)

Returns a sequence of values of the sheets in the workbook.

all-row-values clj

(all-row-values)

(all-row-values sheet)

(all-row-values sheet min-cells)

Returns a sequence of values of the sheets in the workbook.

all-sheet-cells clj

(all-sheet-cells)

(all-sheet-cells workbook)

(all-sheet-cells workbook min-cells)

Returns a sequence of all the cells of the sheets in the workbook. Returns at least 'min-cells' cells per row.

all-sheet-values clj

(all-sheet-values)

(all-sheet-values workbook)

(all-sheet-values workbook min-cells)

Returns a sequence of all the values of the sheets in the workbook. Returns at least 'min-cells' values per row.

cell-border clj

Maps keywords to BorderFormatting values.

cell-border-key clj

cell-fill-style clj

Maps keywords to PatternFormatting cell fill style values.

cell-fill-style-key clj

cell-insert-index clj

(cell-insert-index row)

Returns the index of next 'free' cell in the row.

cell-result clj

(cell-result cell)

Returns the result of the formula evaluation if the cell is of type :formula.

cell-type clj

Maps keywords to CellType values.

cell-type-key clj

cell-value clj multimethod

Returns the value of the cell (based on the type of the cell).

cell-values clj

(cell-values)

(cell-values row)

Returns a sequence of the cell values of the row.

color clj

(color rgb)

(color r g b)

Creates an 'extended' color.

color-index clj

(color-index color)

Returns the index of the color.

create-cell clj

(create-cell row opts value)

(create-cell row cell-no opts value)

Creates a new cell.

Useful options: :cellStyle (CellStyle) :cellType (CellType)

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/Cell.html

create-cell-range-address clj

(create-cell-range-address v)

(create-cell-range-address start-row end-row start-column end-column)

Creates a cell range address.

Useful options: :firstColumn (int) :firstRow (int) :lastColumn (int) :lastRow (int)

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/util/CellRangeAddress.html

create-cell-style clj

(create-cell-style wb opts)

Creates a new cell style.

Useful options: :alignment (HorizontalAlignment) :borderBottom (BorderStyle) :borderLeft (BorderStyle) :borderRight (BorderStyle) :borderTop (BorderStyle) :font (Font) :verticalAlignment (VerticalAlignment) :wrapText (boolean)

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/CellStyle.html

create-data-format clj

(create-data-format wb opts)

Creates a new data format.

Useful options:

For a complete list and description see setters in

create-font clj

(create-font wb opts)

Creates a new font.

Useful options:

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/Font.html

create-hssf-workbook clj

(create-hssf-workbook opts)

Creates a new HSSF workbook.

Useful options:

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/Workbook.html

create-row clj

(create-row sheet opts)

(create-row sheet row-no opts)

Creates a new row.

Useful options: :rowStyle (CellStyle)

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/Row.html

create-sheet clj

(create-sheet wb opts)

(create-sheet wb sheet-name opts)

Creates a new sheet.

Useful options: :autoBreaks (boolean) :autoFilter (CellRangeAddress) :defaultColumnWidth (int) :defaultRowHeight (int) :displayFormulas (boolean) :displayGridLines (boolean) :displayRowColHeadings (boolean) :displayZeros (boolean) :fitToPage (boolean) :forceFormulaRecalculation (boolean) :horizontallyCenter (boolean) :printGridLines (boolean) :verticallyCenter (boolean) :zoom (int)

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/Sheet.html

create-workbook clj

(create-workbook opts)

(create-workbook file opts)

Creates a new workbook.

Useful options:

For a complete list and description see setters in https://poi.apache.org/apidocs/dev/org/apache/poi/ss/usermodel/Workbook.html

first-cell-num clj

(first-cell-num)

(first-cell-num row)

Returns the index of the first cell in the row.

first-row-num clj

(first-row-num sheet)

Returns the index of the first row in the sheet.

get-all-cells clj

(get-all-cells)

(get-all-cells row)

(get-all-cells row min-cells)

(get-all-cells row min-cells missing-cell-policy)

Returns a sequence of all the defined cells in the row.

get-all-rows clj

(get-all-rows sheet)

Returns a sequence of all the defined rows in the sheet.

get-cell clj

(get-cell cell-no)

(get-cell row cell-no)

(get-cell row cell-no missing-cell-policy)

Returns the cell with the index cell-no of the row.

get-cell-formula clj

(get-cell-formula)

(get-cell-formula cell)

Returns the formula of the cell if the cell is of type :formula.

get-cell-hyperlink clj

(get-cell-hyperlink)

(get-cell-hyperlink cell)

Returns the hyperlink of the cell (if any).

get-cell-type clj

(get-cell-type)

(get-cell-type cell)

Returns the type of the cell.

get-cells clj

(get-cells row)

Returns a sequence with the cells of the row.

get-column-index clj

(get-column-index)

(get-column-index cell)

Returns the column index of the cell.

get-row clj

(get-row cell)

(get-row sheet row-no)

Returns the row of a cell or by sheet and row index.

get-row-index clj

(get-row-index)

(get-row-index cell)

Returns the row index of the cell.

get-rows clj

(get-rows sheet)

Returns a sequence of the physically defined rows of the sheet.

get-sheet clj

(get-sheet o)

(get-sheet wb sheet-no)

Returns the sheet of a row or cell or at the given sheet index of the workbook. When given a sheet, the sheet is returned.

get-sheets clj

(get-sheets wb)

Returns a sequence of the sheets in the workbook.

horizontal-alignment clj

Maps keywords to HorizontalAlignment values.

horizontal-alignment-key clj

last-cell-num clj

(last-cell-num)

(last-cell-num row)

Returns the index of the last cell in the row.

last-row-num clj

(last-row-num sheet)

Returns the index of the last row in the sheet.

max-cell-num clj

(max-cell-num o)

Returns the maximum of the last cell index of all the rows in the sheet. The argument can be a sheet or a row.

missing-cell-policy clj

Maps keywords to Row$MissingCellPolicy values.

missing-cell-policy-key clj

new-cell clj macro

(new-cell opts value & body)

Creates a new cell in the current row.

new-cell-style clj

(new-cell-style opts)

Creates a new cell style in the current workbook.

new-data-format clj

(new-data-format opts)

Creates a new data format in the current workbook.

new-font clj

(new-font opts)

Creates a new font in the current workbook.

new-row clj macro

(new-row opts & body)

Creates a new row in the current sheet.

new-sheet clj macro

(new-sheet opts & body)

Creates a new sheet in the current workbook.

new-workbook clj macro

(new-workbook opts & body)

Creates a new workbook.

physical-number-of-cells clj

(physical-number-of-cells)

(physical-number-of-cells row)

Returns the physical number of cells in the row.

physical-number-of-rows clj

(physical-number-of-rows sheet)

Returns the physical number of rows in the sheet.

picture-type clj

Maps keywords to Workbook picture type values.

picture-type-key clj

read-workbook clj

(read-workbook file)

(read-workbook wb file)

Reads a workbook from file.

row-insert-index clj

(row-insert-index sheet)

Returns the index of next 'free' row in the sheet.

row-values clj

(row-values sheet)

Returns a sequence of values of the sheets in the workbook.

select-cell clj macro

(select-cell cell-no & body)

Updates the cell in the current row.

select-row clj macro

(select-row row-no & body)

Updates the row in the current sheet.

select-sheet clj macro

(select-sheet sheet-no & body)

Updates the sheet in the current workbook.

set-cell-type clj

(set-cell-type type)

(set-cell-type cell type)

Sets the type of the cell to type.

set-cell-value clj

(set-cell-value cell value)

Sets the value of the cell.

sheet-state clj

Maps keywords to SheetVisibility values.

sheet-state-key clj

sheet-values clj

(sheet-values)

(sheet-values workbook)

Returns a sequence of phyically defined values of the sheets in the workbook.

to-int clj

(to-int value)

Coerces a (numeric) value to an integer.

vertical-alignment clj

Maps keywords to VerticalAlignment values.

vertical-alignment-key clj

with-workbook clj macro

(with-workbook file & body)

Reads the workbook from file, executes the body with the workbook and writes the workbook back to file.

write-workbook clj

(write-workbook file)

(write-workbook file wb)

Writes a workbook to file.

xssf-workbook? clj

(xssf-workbook? wb)

Checks if the given workbook is a xssf workbook (a.k.a. an '.xlsx' file).