https://github.com/xou/elixlsx

An Elixir XLSX writer
https://github.com/xou/elixlsx

Last synced: 3 months ago
JSON representation

An Elixir XLSX writer

• Host: GitHub
• URL: https://github.com/xou/elixlsx
• Owner: xou
• License: mit
• Created: 2015-11-24T03:12:15.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-07T23:49:10.000Z (6 months ago)
• Last Synced: 2024-10-05T23:28:04.398Z (4 months ago)
• Language: Elixir
• Size: 245 KB
• Stars: 293
• Watchers: 13
• Forks: 113
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - A writer for XLSX files. (Office)
• fucking-awesome-elixir - elixlsx - A writer for XLSX files. (Office)
• awesome-elixir - elixlsx - A writer for XLSX files. (Office)

README

        
# Elixlsx

[![Build Status](https://travis-ci.com/xou/elixlsx.svg?branch=master)](https://travis-ci.org/xou/elixlsx)

[![Module Version](https://img.shields.io/hexpm/v/elixlsx.svg)](https://hex.pm/packages/elixlsx)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/elixlsx/)

[![Total Download](https://img.shields.io/hexpm/dt/elixlsx.svg)](https://hex.pm/packages/elixlsx)

[![License](https://img.shields.io/hexpm/l/elixlsx.svg)](https://github.com/xou/elixlsx/blob/master/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/xou/elixlsx.svg)](https://github.com/xou/elixlsx/commits/master)

Elixlsx is a writer for the MS Excel OpenXML format (`.xlsx`).

Features:

- Multiple (named) sheets with custom column widths & column heights.

- (Unicode-)strings, Numbers, Dates

- Font formatting (size, bold, italic, underline, strike)

- Horizontal alignment and text wrapping

- Font and cell background color, borders

- Merged cells

## Installation

As of version 0.6, elixlsx requires Elixir 1.12 or above.

Installation via Hex, in `mix.exs`:

```elixir

defp deps do

  [{:elixlsx, "~> 0.6.0"}]

end

```

Via GitHub:

```elixir

defp deps do

  [{:elixlsx, github: "xou/elixlsx"}]

end

```

## Usage

1-Line tutorial:

```elixir

(alias Elixlsx.Workbook, alias Elixlsx.Sheet)

iex(1)> Workbook.append_sheet(%Workbook{}, Sheet.with_name("Sheet 1") |> Sheet.set_cell("A1", "Hello", bold: true)) |> Elixlsx.write_to("hello.xlsx")

```

See [example.exs](https://github.com/xou/elixlsx/blob/master/example.exs) for examples how to use the various features.

- The workbook is a XML file ultimately, so remember that formulas containing "<" or ">" must be escaped properly.

- `:xmerl_lib.export_text/1` can be used to escape formulas properly

## Number and date formatting reference

A quick introduction how number formattings look like can be found

[here](https://social.msdn.microsoft.com/Forums/office/en-US/e27aaf16-b900-4654-8210-83c5774a179c/xlsx-numfmtid-predefined-id-14-doesnt-match).

## License

Copyright (c) 2015 Nikolai Weh

This library is MIT licensed. See the [LICENSE](https://github.com/xou/elixlsx/blob/master/LICENSE) for details.