Liking cljdoc? Tell your friends :D

org.soulspace.cmp.poi.excel


*cell*clj

source

*row*clj

source

*sheet*clj

source

*workbook*clj

source

add-merged-regionclj

(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.

Defines merged cells in a sheet.
sourceraw docstring

all-cell-valuesclj

(all-cell-values)
(all-cell-values row)
(all-cell-values row min-cells)

Returns a sequence of the cell values of the row.

Returns a sequence of the cell values of the row.
sourceraw docstring

all-row-cellsclj

(all-row-cells)
(all-row-cells sheet)
(all-row-cells sheet min-cells)

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

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

all-row-valuesclj

(all-row-values)
(all-row-values sheet)
(all-row-values sheet min-cells)

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

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

all-sheet-cellsclj

(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.

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

all-sheet-valuesclj

(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.

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

cell-borderclj

Maps keywords to BorderFormatting values.

Maps keywords to BorderFormatting values.
sourceraw docstring

cell-border-keyclj

source

cell-fill-styleclj

Maps keywords to PatternFormatting cell style values.

Maps keywords to PatternFormatting cell style values.
sourceraw docstring

cell-fill-style-keyclj

source

cell-insert-indexclj

(cell-insert-index row)

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

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

cell-resultclj

(cell-result cell)

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

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

cell-typeclj

Maps keywords to CellType values.

Maps keywords to CellType values.
sourceraw docstring

cell-type-keyclj

source

cell-valuecljmultimethod

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

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

cell-valuesclj

(cell-values)
(cell-values row)

Returns a sequence of the cell values of the row.

Returns a sequence of the cell values of the row.
sourceraw docstring

colorclj

(color rgb)
(color wb rgb)
(color r g b)
(color wb r g b)

Creates an 'extended' color.

Creates an 'extended' color.
sourceraw docstring

color-indexclj

(color-index color)

Returns the index of the color.

Returns the index of the color.
sourceraw docstring

create-cellclj

(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

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
sourceraw docstring

create-cell-range-addressclj

(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

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
sourceraw docstring

create-cell-styleclj

(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

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
sourceraw docstring

create-data-formatclj

(create-data-format wb opts)

Creates a new data format.

Useful options:

For a complete list and description see setters in

Creates a new data format.

Useful options:

For a complete list and description see setters in 
sourceraw docstring

create-fontclj

(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

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
sourceraw docstring

create-hssf-workbookclj

(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

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
sourceraw docstring

create-rowclj

(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

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
sourceraw docstring

create-sheetclj

(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

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
sourceraw docstring

create-workbookclj

(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

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
sourceraw docstring

fill-pattern-typeclj

Maps keywords to FillPatternType cell style values.

Maps keywords to FillPatternType cell style values.
sourceraw docstring

fill-pattern-type-keyclj

source

first-cell-numclj

(first-cell-num)
(first-cell-num row)

Returns the index of the first cell in the row.

Returns the index of the first cell in the row.
sourceraw docstring

first-row-numclj

(first-row-num sheet)

Returns the index of the first row in the sheet.

Returns the index of the first row in the sheet.
sourceraw docstring

get-all-cellsclj

(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.

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

get-all-rowsclj

(get-all-rows sheet)

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

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

get-cellclj

(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.

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

get-cell-formulaclj

(get-cell-formula)
(get-cell-formula cell)

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

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

(get-cell-hyperlink)
(get-cell-hyperlink cell)

Returns the hyperlink of the cell (if any).

Returns the hyperlink of the cell (if any).
sourceraw docstring

get-cell-typeclj

(get-cell-type)
(get-cell-type cell)

Returns the type of the cell.

Returns the type of the cell.
sourceraw docstring

get-cellsclj

(get-cells row)

Returns a sequence with the cells of the row.

Returns a sequence with the cells of the row.
sourceraw docstring

get-column-indexclj

(get-column-index)
(get-column-index cell)

Returns the column index of the cell.

Returns the column index of the cell.
sourceraw docstring

get-indexed-color-mapclj

(get-indexed-color-map wb)

Returns the indexed color map of the workbooks styles source.

Returns the indexed color map of the workbooks styles source.
sourceraw docstring

get-rowclj

(get-row cell)
(get-row sheet row-no)

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

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

get-row-indexclj

(get-row-index)
(get-row-index cell)

Returns the row index of the cell.

Returns the row index of the cell.
sourceraw docstring

get-rowsclj

(get-rows sheet)

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

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

get-sheetclj

(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.

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.
sourceraw docstring

get-sheetsclj

(get-sheets wb)

Returns a sequence of the sheets in the workbook.

Returns a sequence of the sheets in the workbook.
sourceraw docstring

horizontal-alignmentclj

Maps keywords to HorizontalAlignment values.

Maps keywords to HorizontalAlignment values.
sourceraw docstring

horizontal-alignment-keyclj

source

last-cell-numclj

(last-cell-num)
(last-cell-num row)

Returns the index of the last cell in the row.

Returns the index of the last cell in the row.
sourceraw docstring

last-row-numclj

(last-row-num sheet)

Returns the index of the last row in the sheet.

Returns the index of the last row in the sheet.
sourceraw docstring

max-cell-numclj

(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.

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

missing-cell-policyclj

Maps keywords to Row$MissingCellPolicy values.

Maps keywords to Row$MissingCellPolicy values.
sourceraw docstring

missing-cell-policy-keyclj

source

new-cellcljmacro

(new-cell opts value & body)

Creates a new cell in the current row.

Creates a new cell in the current row.
sourceraw docstring

new-cell-styleclj

(new-cell-style opts)

Creates a new cell style in the current workbook.

Creates a new cell style in the current workbook.
sourceraw docstring

new-data-formatclj

(new-data-format opts)

Creates a new data format in the current workbook.

Creates a new data format in the current workbook.
sourceraw docstring

new-fontclj

(new-font opts)

Creates a new font in the current workbook.

Creates a new font in the current workbook.
sourceraw docstring

new-rowcljmacro

(new-row opts & body)

Creates a new row in the current sheet.

Creates a new row in the current sheet.
sourceraw docstring

new-sheetcljmacro

(new-sheet opts & body)

Creates a new sheet in the current workbook.

Creates a new sheet in the current workbook.
sourceraw docstring

new-workbookcljmacro

(new-workbook opts & body)

Creates a new workbook.

Creates a new workbook.
sourceraw docstring

physical-number-of-cellsclj

(physical-number-of-cells)
(physical-number-of-cells row)

Returns the physical number of cells in the row.

Returns the physical number of cells in the row.
sourceraw docstring

physical-number-of-rowsclj

(physical-number-of-rows sheet)

Returns the physical number of rows in the sheet.

Returns the physical number of rows in the sheet.
sourceraw docstring

picture-typeclj

Maps keywords to Workbook picture type values.

Maps keywords to Workbook picture type values.
sourceraw docstring

picture-type-keyclj

source

read-workbookclj

(read-workbook file)
(read-workbook wb file)

Reads a workbook from file.

Reads a workbook from file.
sourceraw docstring

row-insert-indexclj

(row-insert-index sheet)

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

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

row-valuesclj

(row-values sheet)

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

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

select-cellcljmacro

(select-cell cell-no & body)

Updates the cell in the current row.

Updates the cell in the current row.
sourceraw docstring

select-rowcljmacro

(select-row row-no & body)

Updates the row in the current sheet.

Updates the row in the current sheet.
sourceraw docstring

select-sheetcljmacro

(select-sheet sheet-no & body)

Updates the sheet in the current workbook.

Updates the sheet in the current workbook.
sourceraw docstring

set-cell-typeclj

(set-cell-type type)
(set-cell-type cell type)

Sets the type of the cell to type.

Sets the type of the cell to type.
sourceraw docstring

set-cell-valueclj

(set-cell-value cell value)

Sets the value of the cell.

Sets the value of the cell.
sourceraw docstring

sheet-stateclj

Maps keywords to SheetVisibility values.

Maps keywords to SheetVisibility values.
sourceraw docstring

sheet-state-keyclj

source

sheet-valuesclj

(sheet-values)
(sheet-values workbook)

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

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

to-intclj

(to-int value)

Coerces a (numeric) value to an integer.

Coerces a (numeric) value to an integer.
sourceraw docstring

vertical-alignmentclj

Maps keywords to VerticalAlignment values.

Maps keywords to VerticalAlignment values.
sourceraw docstring

vertical-alignment-keyclj

source

with-workbookcljmacro

(with-workbook file & body)

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

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

write-workbookclj

(write-workbook file)
(write-workbook file wb)

Writes a workbook to file.

Writes a workbook to file.
sourceraw docstring

xssf-workbook?clj

(xssf-workbook? wb)

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

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

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close