The xlsx Reference Manual

This is the xlsx Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:22:25 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 xlsx

Basic reader for Excel files.

Author

Carlos Ungil <>

License

MIT

Dependencies
  • zip (system).
  • flexi-streams (system).
  • xmls (system).
Source

xlsx.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 xlsx/xlsx.asd

Source

xlsx.asd.

Parent Component

xlsx (system).

ASDF Systems

xlsx.


3.1.2 xlsx/package.lisp

Source

xlsx.asd.

Parent Component

xlsx (system).

Packages

xlsx.


3.1.3 xlsx/xlsx.lisp

Dependency

package.lisp (file).

Source

xlsx.asd.

Parent Component

xlsx (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 xlsx

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: as-matrix (xlsx &optional na-string)

Creates an array from a list of cells of the form ((:A . 1) . 42)
Empty columns or rows are ignored (column and row names are returned as additional values). When a value is equal to na-string, nil is returned instead.

Package

xlsx.

Source

xlsx.lisp.

Function: list-sheets (file)

Retrieves the id and name of the worksheets in the .xlsx/.xlsm file.

Package

xlsx.

Source

xlsx.lisp.

Function: read-sheet (file &optional sheet)

Retrives the contents of the given worksheet as a list of cells of the form ((:A . 1) . 42) A numeric id or name is required unless the file contains a single worksheet.

Package

xlsx.

Source

xlsx.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: column-and-row (colrow)
Package

xlsx.

Source

xlsx.lisp.

Function: excel-date (int)
Package

xlsx.

Source

xlsx.lisp.

Function: get-entry (name zip)
Package

xlsx.

Source

xlsx.lisp.

Function: get-number-formats (zip)
Package

xlsx.

Source

xlsx.lisp.

Function: get-relationships (zip)
Package

xlsx.

Source

xlsx.lisp.

Function: get-unique-strings (zip)
Package

xlsx.

Source

xlsx.lisp.

Function: list-entries (file)
Package

xlsx.

Source

xlsx.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables