Umya Spreadsheet

https://hexdocs.pm/umya_spreadsheet_ex/
Admin
Umya Spreadsheet is an Elixir NIF wrapper for the Rust umya-spreadsheet library that provides...
Tokens:303,958
Snippets:2,052
Trust Score:9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Quick Start: Add and Get Hyperlinks

Source: https://hexdocs.pm/umya_spreadsheet_ex/hyperlinks.html

Demonstrates creating a new spreadsheet, adding web and internal hyperlinks with tooltips, retrieving hyperlink information, and saving the file.

```elixir
# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Add a web URL hyperlink
{:ok, _} = UmyaSpreadsheet.add_hyperlink(
  spreadsheet,
  "Sheet1",
  "A1",
  "https://example.com",
  "Visit our website"
)

# Add an internal reference
{:ok, _} = UmyaSpreadsheet.add_hyperlink(
  spreadsheet,
  "Sheet1",
  "B1",
  "Sheet2!A1",
  "Go to Sheet2",
  true  # is_internal = true
)

# Get hyperlink information
{:ok, hyperlink_info} = UmyaSpreadsheet.get_hyperlink(spreadsheet, "Sheet1", "A1")
IO.inspect(hyperlink_info)
# Output: %
#   "url" => "https://example.com",
#   "tooltip" => "Visit our website",
#   "location" => "A1"
# }

# Save the spreadsheet
:ok = UmyaSpreadsheet.write(spreadsheet, "output/hyperlinks_example.xlsx")
```

--------------------------------

### Install umya_spreadsheet_ex

Source: https://hexdocs.pm/umya_spreadsheet_ex/index.html

Use igniter for installation or add the dependency manually to mix.exs.

```bash
# install igniter if you haven't already
mix archive.install hex igniter_new
# then install umya_spreadsheet_ex
mix igniter.install umya_spreadsheet_ex
```

```elixir
def deps do
  [
    {:umya_spreadsheet_ex, "~> 0.7.0"}
  ]
end
```

--------------------------------

### Quick Start Guide for umya_spreadsheet_ex

Source: https://hexdocs.pm/umya_spreadsheet_ex/readme.html

Create, write data to, format, and save a new spreadsheet using umya_spreadsheet_ex. Includes reading the spreadsheet back.

```elixir
# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Write data to cells
:ok = UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A1", "Hello")
:ok = UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "B1", "World")
:ok = UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "C1", "42")

# Format your data
:ok = UmyaSpreadsheet.set_background_color(spreadsheet, "Sheet1", "A1", "FF0000") # Red
:ok = UmyaSpreadsheet.set_font_bold(spreadsheet, "Sheet1", "A1", true)
:ok = UmyaSpreadsheet.set_number_format(spreadsheet, "Sheet1", "C1", "#,##0.00")

# Save your spreadsheet
:ok = UmyaSpreadsheet.write(spreadsheet, "hello_world.xlsx")

# Read it back
{:ok, loaded_spreadsheet} = UmyaSpreadsheet.read("hello_world.xlsx")
{:ok, value} = UmyaSpreadsheet.get_cell_value(loaded_spreadsheet, "Sheet1", "A1")
# => {:ok, "Hello"}

```

--------------------------------

### Install umya_spreadsheet_ex with igniter

Source: https://hexdocs.pm/umya_spreadsheet_ex/readme.html

Install the umya_spreadsheet_ex library using the igniter tool. Ensure igniter is installed first.

```bash
# install igniter if you haven't already
mix archive.install hex igniter_new
# then install umya_spreadsheet_ex
mix igniter.install umya_spreadsheet_ex

```

--------------------------------

### Mix Task for Installation

Source: https://hexdocs.pm/umya_spreadsheet_ex/api-reference.html

Instructions on how to install the umya_spreadsheet_ex package using a mix task.

```APIDOC
## Mix Tasks

### `mix umya_spreadsheet_ex.install`

**Description**: Installs the umya_spreadsheet_ex package with Igniter.

**Usage**: 
```bash
mix umya_spreadsheet_ex.install
```
```

--------------------------------

### Install Rust

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Install Rust using the official script. Ensure to source the environment variables after installation.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

```

--------------------------------

### Complete Example: Create Spreadsheet with Pivot Table

Source: https://hexdocs.pm/umya_spreadsheet_ex/pivot_tables.html

A complete example demonstrating the creation of a new spreadsheet, adding source data to 'Sheet1', and setting up a pivot table.

```elixir
# Create headers in Sheet1
```

```elixir
# Generate random sales data
```

--------------------------------

### Complete Example: Applying Multiple Rules

Source: https://hexdocs.pm/umya_spreadsheet_ex/conditional_formatting.html

A comprehensive example demonstrating the creation and application of various conditional formatting rules.

```APIDOC
## Complete Example: Conditional Formatting

### Description
This example illustrates how to create a new spreadsheet, add test data, apply multiple conditional formatting rules (cell value and color scale), and then save and read the spreadsheet back.

### Code Example
```elixir
alias UmyaSpreadsheet.ConditionalFormatting

# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Add test data to Sheet1
for i <- 1..10 do
  UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A#{i}", "#{i * 10}")
end

# Cell value rule: values less than 30 (red)
ConditionalFormatting.add_cell_value_rule(
  spreadsheet, "Sheet1", "A1:A10", "lessThan", "30", nil, "#FF0000"
)

# Cell value rule: values between 30 and 70 (yellow)
ConditionalFormatting.add_cell_value_rule(
  spreadsheet, "Sheet1", "A1:A10", "between", "30", "70", "#FFFF00"
)

# Cell value rule: values greater than 70 (green)
ConditionalFormatting.add_cell_value_rule(
  spreadsheet, "Sheet1", "A1:A10", "greaterThan", "70", nil, "#00FF00"
)

# Add a new sheet for color scales
UmyaSpreadsheet.add_sheet(spreadsheet, "ColorScales")
for i <- 1..10 do
  UmyaSpreadsheet.set_cell_value(spreadsheet, "ColorScales", "A#{i}", "#{i * 10}")
end

# Add a three-color scale
ConditionalFormatting.add_color_scale(
  spreadsheet, "ColorScales", "A1:A10",
  "min", "", "percentile", "50", "max", "",
  "#FF0000", "#FFFF00", "#00FF00"
)

# Save the spreadsheet
UmyaSpreadsheet.write(spreadsheet, "conditional_formatting_example.xlsx")

# Read back and analyze the rules
{:ok, read_spreadsheet} = UmyaSpreadsheet.read("conditional_formatting_example.xlsx")
rules = ConditionalFormatting.get_conditional_formatting_rules(read_spreadsheet, "Sheet1")

IO.puts("Found #{length(rules)} conditional formatting rules in Sheet1")
```
```

--------------------------------

### Install System Dependencies on Linux

Source: https://hexdocs.pm/umya_spreadsheet_ex/limitations.html

Installs necessary system dependencies for building on Linux using apt-get.

```bash
sudo apt-get install build-essential pkg-config libssl-dev
```

--------------------------------

### Install Windows Build Tools

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Install the necessary Visual Studio Build Tools via winget to resolve compilation issues on Windows.

```batch
winget install Microsoft.VisualStudio.2022.BuildTools
```

--------------------------------

### Install System Dependencies on macOS

Source: https://hexdocs.pm/umya_spreadsheet_ex/limitations.html

Installs necessary system dependencies on macOS by installing Xcode Command Line Tools.

```bash
xcode-select --install
```

--------------------------------

### Complete Conditional Formatting Example

Source: https://hexdocs.pm/umya_spreadsheet_ex/conditional_formatting.html

This comprehensive example demonstrates creating a new spreadsheet, adding various conditional formatting rules (cell value, color scale), and saving the file. It also includes reading the file back to verify the rules.

```elixir
alias UmyaSpreadsheet.ConditionalFormatting

# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Add test data
for i <- 1..10 do
  UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A#{i}", "#{i * 10}")
end

# Cell value rule: values less than 30 (red)
ConditionalFormatting.add_cell_value_rule(
  spreadsheet, "Sheet1", "A1:A10", "lessThan", "30", nil, "#FF0000"
)

# Cell value rule: values between 30 and 70 (yellow)
ConditionalFormatting.add_cell_value_rule(
  spreadsheet, "Sheet1", "A1:A10", "between", "30", "70", "#FFFF00"
)

# Cell value rule: values greater than 70 (green)
ConditionalFormatting.add_cell_value_rule(
  spreadsheet, "Sheet1", "A1:A10", "greaterThan", "70", nil, "#00FF00"
)

# Add a new sheet for color scales
UmyaSpreadsheet.add_sheet(spreadsheet, "ColorScales")
for i <- 1..10 do
  UmyaSpreadsheet.set_cell_value(spreadsheet, "ColorScales", "A#{i}", "#{i * 10}")
end

# Add a three-color scale
ConditionalFormatting.add_color_scale(
  spreadsheet, "ColorScales", "A1:A10",
  {"min", ""}, {"percentile", "50"}, {"max", ""},
  "#FF0000", "#FFFF00", "#00FF00"
)

# Save the spreadsheet
UmyaSpreadsheet.write(spreadsheet, "conditional_formatting_example.xlsx")

# Read back and analyze the rules
{:ok, read_spreadsheet} = UmyaSpreadsheet.read("conditional_formatting_example.xlsx")
rules = ConditionalFormatting.get_conditional_formatting_rules(read_spreadsheet, "Sheet1")

IO.puts("Found #{length(rules)} conditional formatting rules in Sheet1")
```

--------------------------------

### Get Cell Value Rules Example

Source: https://hexdocs.pm/umya_spreadsheet_ex/conditional_formatting.html

Demonstrates how to retrieve cell value rules from a spreadsheet. Each rule contains details about the formatting condition and the applied style.

```elixir
# Example: Getting cell value rules
cell_value_rules = ConditionalFormatting.get_cell_value_rules(spreadsheet, "Sheet1")

# Each rule contains details about the formatting condition
Enum.each(cell_value_rules, fn rule ->
  IO.puts("Range: #{rule.range}")
  IO.puts("Operator: #{rule.operator}")
  IO.puts("Formula: #{rule.formula}")
  IO.puts("Format style: #{rule.format_style}")
end)
```

--------------------------------

### Install Rust for Apple Silicon

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Install Rust specifically for Apple Silicon (M1/M2) using Homebrew. This is a prerequisite for compiling UmyaSpreadsheet on these platforms.

```bash
arch -arm64 brew install rust

```

--------------------------------

### Get Count of OLE Objects

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Retrieves the number of OLE objects within a collection. This example first gets the OLE objects from a worksheet.

```elixir
iex> {:ok, spreadsheet} = UmyaSpreadsheet.new()
iex> {:ok, ole_objects} = UmyaSpreadsheet.get_ole_objects_from_worksheet(spreadsheet, "Sheet1")
iex> {:ok, _count} = UmyaSpreadsheet.get_ole_objects_count(ole_objects)
```

--------------------------------

### Get auto filter range example

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.AutoFilterFunctions.html

Demonstrates retrieving the auto filter range after setting it on a worksheet.

```elixir
iex> {:ok, spreadsheet} = UmyaSpreadsheet.new()
iex> UmyaSpreadsheet.set_auto_filter(spreadsheet, "Sheet1", "A1:E10")
iex> UmyaSpreadsheet.get_auto_filter_range(spreadsheet, "Sheet1")
"A1:E10"
```

--------------------------------

### Build a sales calculator with defined names

Source: https://hexdocs.pm/umya_spreadsheet_ex/formula_functions.html

A comprehensive example demonstrating how to set up inputs, define names for parameters, and structure output calculations.

```elixir
alias UmyaSpreadsheet

# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Create a sheet for our calculator
UmyaSpreadsheet.add_sheet(spreadsheet, "Sales Calculator")

# Set up headers and formatting
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A1", "Sales Calculator")
UmyaSpreadsheet.set_font_bold(spreadsheet, "Sales Calculator", "A1", true)
UmyaSpreadsheet.set_font_size(spreadsheet, "Sales Calculator", "A1", 16)

# Input section
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A3", "Input Parameters")
UmyaSpreadsheet.set_font_bold(spreadsheet, "Sales Calculator", "A3", true)

# Create input fields
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A4", "Product Price")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "B4", 100)

UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A5", "Quantity")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "B5", 5)

UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A6", "Tax Rate (%)")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "B6", 15)

UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A7", "Discount Rate (%)")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "B7", 10)

# Create defined names for all the parameters (easier to maintain formulas)
UmyaSpreadsheet.create_defined_name(spreadsheet, "Price", "Sales Calculator!B4")
UmyaSpreadsheet.create_defined_name(spreadsheet, "Quantity", "Sales Calculator!B5")
UmyaSpreadsheet.create_defined_name(spreadsheet, "TaxRatePercent", "Sales Calculator!B6")
UmyaSpreadsheet.create_defined_name(spreadsheet, "DiscountRatePercent", "Sales Calculator!B7")

# Create defined names for calculations (constants)
UmyaSpreadsheet.create_defined_name(spreadsheet, "TaxRate", "TaxRatePercent/100")
UmyaSpreadsheet.create_defined_name(spreadsheet, "DiscountRate", "DiscountRatePercent/100")

# Output section
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A9", "Calculation Results")
UmyaSpreadsheet.set_font_bold(spreadsheet, "Sales Calculator", "A9", true)

UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A10", "Subtotal")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A11", "Discount Amount")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A12", "Net Amount")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A13", "Tax Amount")
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sales Calculator", "A14", "Total Due")
```

--------------------------------

### Get pivot table target cell

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.PivotTable.html

Retrieves the starting cell coordinate for a specific pivot table.

```elixir
case PivotTable.get_pivot_table_target_cell(spreadsheet, "Sheet1", "Sales Analysis") do
  {:ok, target_cell} ->
    IO.puts("Pivot table starts at: " <> target_cell)
  {:error, reason} ->
    IO.puts("Error: " <> inspect(reason))
end
```

--------------------------------

### Initialize Spreadsheet for Array Formulas

Source: https://hexdocs.pm/umya_spreadsheet_ex/formula_functions.html

Basic setup for creating a new spreadsheet instance.

```elixir
# Create a sample spreadsheet with data
{:ok, spreadsheet} = UmyaSpreadsheet.new()
```

--------------------------------

### Set and Get OLE Object ProgID

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Illustrates setting and retrieving the ProgID for an OLE object. The ProgID is set to 'Excel.Sheet.12' in this example.

```elixir
iex> {:ok, ole_object} = UmyaSpreadsheet.new_ole_object()
iex> :ok = UmyaSpreadsheet.set_ole_object_prog_id(ole_object, "Excel.Sheet.12")
iex> {:ok, "Excel.Sheet.12"} = UmyaSpreadsheet.get_ole_object_prog_id(ole_object)
```

--------------------------------

### Get Cell Pattern Type

Source: https://hexdocs.pm/umya_spreadsheet_ex/styling_and_formatting.html

Retrieve the pattern type used for the cell's background fill. Examples include 'solid'.

```elixir
{:ok, pattern_type} = UmyaSpreadsheet.get_cell_pattern_type(spreadsheet, "Sheet1", "A1")
```

--------------------------------

### Set and Get OLE Object Extension

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Shows how to set and then retrieve the file extension for an OLE object. The extension is set to 'xlsx' in this example.

```elixir
iex> {:ok, ole_object} = UmyaSpreadsheet.new_ole_object()
iex> :ok = UmyaSpreadsheet.set_ole_object_extension(ole_object, "xlsx")
iex> {:ok, "xlsx"} = UmyaSpreadsheet.get_ole_object_extension(ole_object)
```

--------------------------------

### Complete Print Settings Example

Source: https://hexdocs.pm/umya_spreadsheet_ex/print_settings.html

Demonstrates setting various print configurations and then verifying them. This includes orientation, paper size, fit-to-page, margins, header, footer, print area, and print titles, followed by writing the spreadsheet to a file.

```elixir
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Configure print settings
UmyaSpreadsheet.set_page_orientation(spreadsheet, "Sheet1", "landscape")
UmyaSpreadsheet.set_paper_size(spreadsheet, "Sheet1", 9)  # A4
UmyaSpreadsheet.set_fit_to_page(spreadsheet, "Sheet1", 1, 0)  # Fit to 1 page wide
UmyaSpreadsheet.set_page_margins(spreadsheet, "Sheet1", 0.75, 0.75, 0.75, 0.75)
UmyaSpreadsheet.set_header(spreadsheet, "Sheet1", "&L&D&R&F")
UmyaSpreadsheet.set_footer(spreadsheet, "Sheet1", "&RPage &P of &N")
UmyaSpreadsheet.set_print_area(spreadsheet, "Sheet1", "A1:G20")
UmyaSpreadsheet.set_print_titles(spreadsheet, "Sheet1", "1:1", "")

# Verify the settings were applied
{:ok, orientation} = UmyaSpreadsheet.get_page_orientation(spreadsheet, "Sheet1")
{:ok, paper_size} = UmyaSpreadsheet.get_paper_size(spreadsheet, "Sheet1")
{fit_width, fit_height} = UmyaSpreadsheet.get_fit_to_page(spreadsheet, "Sheet1")
{:ok, print_area} = UmyaSpreadsheet.get_print_area(spreadsheet, "Sheet1")

IO.puts("Applied settings:")
IO.puts("  Orientation: #{orientation}")      # "landscape"
IO.puts("  Paper size: #{paper_size}")        # 9
IO.puts("  Fit to: #{fit_width}x#{fit_height}") # 1x0
IO.puts("  Print area: #{print_area}")        # "A1:G20"

# Write the file
UmyaSpreadsheet.write(spreadsheet, "print_settings_example.xlsx")
```

--------------------------------

### Set and Get OLE Object Requires Attribute

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Shows how to set and retrieve the 'requires' attribute for an OLE object. The attribute is set to 'xl' in this example.

```elixir
iex> {:ok, ole_object} = UmyaSpreadsheet.new_ole_object()
iex> :ok = UmyaSpreadsheet.set_ole_object_requires(ole_object, "xl")
iex> {:ok, "xl"} = UmyaSpreadsheet.get_ole_object_requires(ole_object)
```

--------------------------------

### Complete Example: Create and Analyze a Diagram

Source: https://hexdocs.pm/umya_spreadsheet_ex/shapes_and_drawing.html

Demonstrates the creation of a flowchart with shapes, text boxes, and connectors, followed by analysis of the drawing objects. Requires the UmyaSpreadsheet and Drawing modules.

```elixir
alias UmyaSpreadsheet.Drawing

# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Add title
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A1", "Process Diagram")
UmyaSpreadsheet.set_font_bold(spreadsheet, "Sheet1", "A1", true)
UmyaSpreadsheet.set_font_size(spreadsheet, "Sheet1", "A1", 14)

# Add shapes for a flowchart
Drawing.add_text_box(spreadsheet, "Sheet1", "B3", "Start", 100, 40, "#D9EAD3", "black", "#274E13", 1.0)
Drawing.add_text_box(spreadsheet, "Sheet1", "B5", "Process 1", 100, 40, "#FCE5CD", "black", "#B45F06", 1.0)
Drawing.add_shape(spreadsheet, "Sheet1", "B7", "diamond", 100, 80, "#CFE2F3", "black", 1.0)
Drawing.add_text_box(spreadsheet, "Sheet1", "E7", "Process 2", 100, 40, "#FCE5CD", "black", "#B45F06", 1.0)
Drawing.add_text_box(spreadsheet, "Sheet1", "B9", "End", 100, 40, "#F4CCCC", "black", "#990000", 1.0)

# Add connectors to create a flowchart
Drawing.add_connector(spreadsheet, "Sheet1", "B3", "B5", "black", 1.0)
Drawing.add_connector(spreadsheet, "Sheet1", "B5", "B7", "black", 1.0)
Drawing.add_connector(spreadsheet, "Sheet1", "B7", "E7", "black", 1.0)
Drawing.add_connector(spreadsheet, "Sheet1", "B7", "B9", "black", 1.0)
Drawing.add_connector(spreadsheet, "Sheet1", "E7", "B9", "black", 1.0)

# Save the spreadsheet
UmyaSpreadsheet.write_file(spreadsheet, "flowchart.xlsx")

# Analyze the drawing objects
{:ok, shape_count} = Drawing.count_drawing_objects(spreadsheet, "Sheet1")
IO.puts("Total number of drawing objects: #{shape_count}")

{:ok, connectors} = Drawing.get_connectors(spreadsheet, "Sheet1")
IO.puts("Number of connector lines: #{length(connectors)}")

{:ok, text_boxes} = Drawing.get_text_boxes(spreadsheet, "Sheet1")
IO.puts("Number of text boxes: #{length(text_boxes)}")
```

--------------------------------

### Get BX Property of Formula

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Retrieves the 'bx' property of a formula in a cell. This property indicates if the formula calculation should occur upon exiting the cell. The example shows a case where it is not set.

```elixir
iex> {:ok, spreadsheet} = UmyaSpreadsheet.new()
iex> UmyaSpreadsheet.set_formula(spreadsheet, "Sheet1", "A1", "=SUM(B1:B10)")
iex> UmyaSpreadsheet.get_bx(spreadsheet, "Sheet1", "A1")
nil
```

--------------------------------

### Combine Window Settings

Source: https://hexdocs.pm/umya_spreadsheet_ex/window_settings.html

Demonstrates applying multiple window configuration settings simultaneously to a workbook.

```elixir
# Create a new spreadsheet with multiple sheets
spreadsheet = UmyaSpreadsheet.new()
UmyaSpreadsheet.add_sheet(spreadsheet, "Data")
UmyaSpreadsheet.add_sheet(spreadsheet, "Analysis")

# Add data to sheets
# ...

# Configure window settings
UmyaSpreadsheet.set_active_tab(spreadsheet, 1)  # "Analysis" sheet is active
UmyaSpreadsheet.set_selection(spreadsheet, "Analysis", "B5")  # B5 is selected
UmyaSpreadsheet.set_workbook_window_position(spreadsheet, 50, 50, 1200, 800)  # Large window

# Save the spreadsheet
UmyaSpreadsheet.write(spreadsheet, "configured_workbook.xlsx")
```

--------------------------------

### Quick Start Spreadsheet Operations

Source: https://hexdocs.pm/umya_spreadsheet_ex/index.html

Create a new spreadsheet, write data, apply formatting, and save the file.

```elixir
# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Write data to cells
:ok = UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A1", "Hello")
:ok = UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "B1", "World")
:ok = UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "C1", "42")

# Format your data
:ok = UmyaSpreadsheet.set_background_color(spreadsheet, "Sheet1", "A1", "FF0000") # Red
:ok = UmyaSpreadsheet.set_font_bold(spreadsheet, "Sheet1", "A1", true)
:ok = UmyaSpreadsheet.set_number_format(spreadsheet, "Sheet1", "C1", "#,##0.00")

# Save your spreadsheet
:ok = UmyaSpreadsheet.write(spreadsheet, "hello_world.xlsx")

# Read it back
{:ok, loaded_spreadsheet} = UmyaSpreadsheet.read("hello_world.xlsx")
{:ok, value} = UmyaSpreadsheet.get_cell_value(loaded_spreadsheet, "Sheet1", "A1")
# => {:ok, "Hello"}
```

--------------------------------

### GET /api/spreadsheet/comments_count

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Gets the total number of comments present in a specified spreadsheet sheet.

```APIDOC
## GET /api/spreadsheet/comments_count

### Description
Gets the number of comments in a sheet.

### Method
GET

### Endpoint
`/api/spreadsheet/comments_count`

### Parameters
#### Query Parameters
- **spreadsheet** (object) - Required - The spreadsheet object.
- **sheet_name** (string) - Required - The name of the sheet.
```

--------------------------------

### Get OLE Objects Count

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.OleObjects.html

Gets the number of OLE objects present in a collection.

```APIDOC
## GET /api/spreadsheet/oleobjects/count

### Description
Gets the count of OLE objects in a collection.

### Method
GET

### Endpoint
/api/spreadsheet/oleobjects/count

### Parameters
#### Query Parameters
- **ole_objects** (collection) - Required - The OLE objects collection

### Response
#### Success Response (200)
- **count** (integer) - Number of OLE objects in the collection

#### Response Example
```json
{
  "count": 5
}
```
```

--------------------------------

### Setup Monthly Summary Section Header

Source: https://hexdocs.pm/umya_spreadsheet_ex/formula_functions.html

Adds a header for the 'Monthly Summary' section and applies bold formatting to it.

```elixir
UmyaSpreadsheet.set_cell_value(spreadsheet, "Dashboard", "A3", "Monthly Summary")
UmyaSpreadsheet.set_font_bold(spreadsheet, "Dashboard", "A3", true)
```

--------------------------------

### Get Input 2 Deleted Property

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Gets the input 2 deleted property of a formula.

```APIDOC
## GET /api/spreadsheet/formula/input2deleted

### Description
Gets the input 2 deleted property of a formula.

### Method
GET

### Endpoint
/api/spreadsheet/formula/input2deleted

### Parameters
#### Query Parameters
- **spreadsheet** (object) - Required - The spreadsheet object.
- **sheet_name** (string) - Required - The name of the sheet.
- **cell_address** (string) - Required - The address of the cell.

### Response
#### Success Response (200)
- **input2_deleted** (boolean or null) - The input 2 deleted property.

#### Response Example
```json
{
  "input2_deleted": null
}
```
```

--------------------------------

### Create and Set OLE Object Data

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Demonstrates creating a new OLE object and setting its data. Ensure the OLE object is initialized before setting data.

```iex
iex> {:ok, ole_object} = UmyaSpreadsheet.new_ole_object()
iex> :ok = UmyaSpreadsheet.set_ole_object_data(ole_object, "test data")
```

--------------------------------

### Get Input 1 Deleted Property

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Gets the input 1 deleted property of a formula.

```APIDOC
## GET /api/spreadsheet/formula/input1deleted

### Description
Gets the input 1 deleted property of a formula.

### Method
GET

### Endpoint
/api/spreadsheet/formula/input1deleted

### Parameters
#### Query Parameters
- **spreadsheet** (object) - Required - The spreadsheet object.
- **sheet_name** (string) - Required - The name of the sheet.
- **cell_address** (string) - Required - The address of the cell.

### Response
#### Success Response (200)
- **input1_deleted** (boolean or null) - The input 1 deleted property.

#### Response Example
```json
{
  "input1_deleted": null
}
```
```

--------------------------------

### Create and Write a Spreadsheet with Formulas

Source: https://hexdocs.pm/umya_spreadsheet_ex/formula_functions.html

Initializes a new spreadsheet, populates cells, and applies a sum formula. Do not include the leading equals sign in the formula string.

```elixir
alias UmyaSpreadsheet

# Create a new spreadsheet
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Set some values to use in our formula
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A1", 10)
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A2", 20)
UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A3", 30)

# Set a formula in cell B1 that sums the values in A1:A3
UmyaSpreadsheet.set_formula(spreadsheet, "Sheet1", "B1", "SUM(A1:A3)")

# Save the spreadsheet
UmyaSpreadsheet.write(spreadsheet, "formulas.xlsx")
```

--------------------------------

### Add file path hyperlinks

Source: https://hexdocs.pm/umya_spreadsheet_ex/hyperlinks.html

Examples of linking to local files on Windows, macOS/Linux, and network shares.

```Elixir
# Windows local file
:ok = UmyaSpreadsheet.add_hyperlink(
  spreadsheet, "Sheet1", "C1",
  "file:///C:/Documents/report.pdf", "Windows Report"
)

# macOS/Linux local file
:ok = UmyaSpreadsheet.add_hyperlink(
  spreadsheet, "Sheet1", "C2",
  "file:///Users/username/Documents/data.xlsx", "Data File"
)

# Network share (Windows)
:ok = UmyaSpreadsheet.add_hyperlink(
  spreadsheet, "Sheet1", "C3",
  "file://server/share/documents/manual.docx", "Network Manual"
)
```

--------------------------------

### Configure ARM64 Rust Environment

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Use this command sequence to set up the native ARM64 Rust toolchain on macOS for building the library.

```bash
arch -arm64 brew install rust
export UMYA_SPREADSHEET_BUILD=true
mix deps.compile --force
```

--------------------------------

### Install Linux System Dependencies

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Ensure required build tools and libraries are present on Linux systems.

```bash
sudo apt-get update
sudo apt-get install build-essential pkg-config libssl-dev
```

--------------------------------

### Create OLE Object with Data

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Initializes a new OLE object with provided binary data.

```elixir
iex> _data = "test data"
iex> {:ok, _ole_object} = UmyaSpreadsheet.new_ole_object()
```

--------------------------------

### Create New Spreadsheet and Set Cell Values

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Demonstrates the basic usage of creating a new spreadsheet and setting values in specific cells. Ensure the spreadsheet module is imported.

```elixir
 {:ok, spreadsheet} = UmyaSpreadsheet.new()

 UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "A1", "Hello")
 UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "B1", "World")
```

--------------------------------

### Get All Page Breaks

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.PageBreaks.html

Retrieves all row and column page breaks for a specified sheet. This function is a convenience for getting all page break information at once.

```elixir
{:ok, %{row_breaks: rows, column_breaks: cols}} =
  UmyaSpreadsheet.PageBreaks.get_all_page_breaks(spreadsheet, "Sheet1")

IO.puts("Row breaks at: #{inspect(rows)}")
IO.puts("Column breaks at: #{inspect(cols)}")

# Check if any page breaks exist
{:ok, breaks} = UmyaSpreadsheet.PageBreaks.get_all_page_breaks(spreadsheet, "Report")
has_breaks = length(breaks.row_breaks) > 0 or length(breaks.column_breaks) > 0
```

--------------------------------

### Install umya_spreadsheet_ex with Igniter

Source: https://hexdocs.pm/umya_spreadsheet_ex/Mix.Tasks.UmyaSpreadsheetEx.Install.html

Use this command to add the umya_spreadsheet_ex package to your project via Igniter.

```elixir
mix igniter.install umya_spreadsheet_ex
```

--------------------------------

### Inspect sheet settings

Source: https://hexdocs.pm/umya_spreadsheet_ex/advanced_sheet_features.html

A practical example demonstrating how to retrieve and display various sheet settings like tab color, view type, zoom, grid lines, and selection.

```elixir
defmodule SheetInspector do
  def inspect_sheet_settings(spreadsheet, sheet_name) do
    IO.puts("=== Sheet Settings for #{sheet_name} ===")

    # Check tab color
    case UmyaSpreadsheet.get_tab_color(spreadsheet, sheet_name) do
      {:ok, ""} -> IO.puts("Tab Color: Default (no color)")
      {:ok, color} -> IO.puts("Tab Color: #{color}")
      {:error, reason} -> IO.puts("Error getting tab color: #{reason}")
    end

    # Check view type
    case UmyaSpreadsheet.get_sheet_view(spreadsheet, sheet_name) do
      {:ok, view} -> IO.puts("View Type: #{view}")
      {:error, reason} -> IO.puts("Error getting view: #{reason}")
    end

    # Check zoom level
    case UmyaSpreadsheet.get_zoom_scale(spreadsheet, sheet_name) do
      {:ok, zoom} -> IO.puts("Zoom Scale: #{zoom}%")
      {:error, reason} -> IO.puts("Error getting zoom: #{reason}")
    end

    # Check grid lines
    case UmyaSpreadsheet.get_show_grid_lines(spreadsheet, sheet_name) do
      {:ok, visible} -> IO.puts("Grid Lines: #{if visible, do: "Visible", else: "Hidden"}")
      {:error, reason} -> IO.puts("Error getting grid lines: #{reason}")
    end

    # Check selection
    case UmyaSpreadsheet.get_selection(spreadsheet, sheet_name) do
      {:ok, selection} ->
        IO.puts("Active Cell: #{selection["active_cell"]}")
        IO.puts("Selected Range: #{selection["sqref"]}")
      {:error, reason} -> IO.puts("Error getting selection: #{reason}")
    end
  end
end

# Usage
SheetInspector.inspect_sheet_settings(spreadsheet, "Sheet1")
```

--------------------------------

### Cell Value Rule Schema Example

Source: https://hexdocs.pm/umya_spreadsheet_ex/conditional_formatting.html

Example structure for a cell value rule, detailing the range, rule type, operator, formula for comparison, and the format style (color) applied.

```elixir
%{
  range: "A1:A10",
  rule_type: :cell_is,
  operator: :greater_than,
  formula: "50",
  format_style: "FFFF0000"
}
```

--------------------------------

### Remove Columns by Index

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.SheetFunctions.html

Removes a specified number of columns starting from a given index. Requires the spreadsheet struct, sheet name, starting column index, and the amount of columns to remove.

```elixir
:ok = UmyaSpreadsheet.SheetFunctions.remove_column_by_index(spreadsheet, "Sheet1", 3, 2)
```

--------------------------------

### POST /new

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Creates a new empty spreadsheet instance.

```APIDOC
## POST /new

### Description
Creates a new empty spreadsheet with a default sheet.

### Method
POST

### Endpoint
/new
```

--------------------------------

### Remove Rows from Sheet

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.SheetFunctions.html

Removes a specified number of rows starting from a given row index. Requires the spreadsheet struct, sheet name, starting row index, and the amount of rows to remove.

```elixir
{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
# Remove 2 rows starting from row 3
:ok = UmyaSpreadsheet.SheetFunctions.remove_row(spreadsheet, "Sheet1", 3, 2)
```

--------------------------------

### Add web URL hyperlinks

Source: https://hexdocs.pm/umya_spreadsheet_ex/hyperlinks.html

Examples of adding HTTPS, HTTP, and FTP links.

```Elixir
# HTTPS (secure)
:ok = UmyaSpreadsheet.add_hyperlink(
  spreadsheet, "Sheet1", "A1",
  "https://secure.example.com", "Secure Site"
)

# HTTP (unsecure)
:ok = UmyaSpreadsheet.add_hyperlink(
  spreadsheet, "Sheet1", "A2",
  "http://example.com", "Regular Site"
)

# FTP
:ok = UmyaSpreadsheet.add_hyperlink(
  spreadsheet, "Sheet1", "A3",
  "ftp://files.example.com", "FTP Server"
)
```

--------------------------------

### Get Hyperlinks

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.html

Retrieves all hyperlinks from a worksheet.

```APIDOC
## GET /api/spreadsheet/hyperlinks

### Description
Retrieves all hyperlinks from a worksheet.

### Method
GET

### Endpoint
/api/spreadsheet/hyperlinks

### Parameters
#### Query Parameters
- **spreadsheet** (object) - Required - The spreadsheet object.
- **sheet_name** (string) - Required - The name of the sheet.

### Response
#### Success Response (200)
- **hyperlinks** (array) - An array of hyperlink objects.

#### Response Example
```json
{
  "hyperlinks": [
    {
      "cell": "A1",
      "url": "http://example.com",
      "text": "Example Link"
    }
  ]
}
```
```

--------------------------------

### get_element_text

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.RichText.html

Gets the text content from a TextElement.

```APIDOC
## GET /umya_spreadsheet_ex/richtext/get_element_text

### Description
Gets the text content from a TextElement.

### Method
GET

### Endpoint
/umya_spreadsheet_ex/richtext/get_element_text

### Parameters
#### Query Parameters
- **text_element** (TextElement) - Required - TextElement resource

### Response
#### Success Response (200)
- **text** (string) - The text content of the TextElement.

#### Response Example
```json
{
  "text": "Example text"
}
```
```

--------------------------------

### Use Light Writer for Simple Files

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Employ `UmyaSpreadsheet.write_light/2` for writing simple spreadsheets without complex formatting to improve performance and reduce memory usage.

```elixir
# For simple spreadsheets without complex formatting
UmyaSpreadsheet.write_light(spreadsheet, "output.xlsx")

```

--------------------------------

### get_element_font_properties

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.RichText.html

Gets font properties from a TextElement.

```APIDOC
## GET /umya_spreadsheet_ex/richtext/get_element_font_properties

### Description
Gets font properties from a TextElement.

### Method
GET

### Endpoint
/umya_spreadsheet_ex/richtext/get_element_font_properties

### Parameters
#### Query Parameters
- **text_element** (TextElement) - Required - TextElement resource

### Response
#### Success Response (200)
- **font_properties** (map) - A map containing the font properties of the TextElement.

#### Response Example
```json
{
  "font_properties": {
    "bold": true,
    "color": "#FF0000"
  }
}
```
```

--------------------------------

### Configure macOS Development

Source: https://hexdocs.pm/umya_spreadsheet_ex/troubleshooting.html

Adjust system settings for development binaries on macOS.

```bash
# Solution: Allow unsigned binaries (development only)
sudo spctl --master-disable
```

--------------------------------

### Get Title

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.DocumentProperties.html

Retrieves the title of the document.

```APIDOC
## GET /spreadsheet/properties/title

### Description
Retrieves the document title.

### Method
GET

### Endpoint
/spreadsheet/properties/title

### Parameters
#### Query Parameters
- **spreadsheet** (struct) - Required - The spreadsheet struct

### Response
#### Success Response (200)
- **title** (string) - The document title as a string

#### Response Example
```json
{
  "title": "Spreadsheet Title"
}
```
```

--------------------------------

### Copy settings between sheets

Source: https://hexdocs.pm/umya_spreadsheet_ex/advanced_sheet_features.html

A practical example showing how to copy view settings from one sheet to another.

```elixir
defmodule SheetSettingsCopier do
  def copy_view_settings(spreadsheet, from_sheet, to_sheet) do
    # Copy tab color
    case UmyaSpreadsheet.get_tab_color(spreadsheet, from_sheet) do
      {:ok, color} when color != "" ->
        UmyaSpreadsheet.set_tab_color(spreadsheet, to_sheet, color)
      _ -> :ok
    end

    # Copy view type
    case UmyaSpreadsheet.get_sheet_view(spreadsheet, from_sheet) do
      {:ok, view_type} ->
        UmyaSpreadsheet.set_sheet_view(spreadsheet, to_sheet, view_type)
      _ -> :ok
    end

    # Copy zoom level
    case UmyaSpreadsheet.get_zoom_scale(spreadsheet, from_sheet) do
      {:ok, zoom} ->
        UmyaSpreadsheet.set_zoom_scale(spreadsheet, to_sheet, zoom)
      _ -> :ok
    end

    # Copy grid lines setting
    case UmyaSpreadsheet.get_show_grid_lines(spreadsheet, from_sheet) do
      {:ok, show_grid} ->
        UmyaSpreadsheet.set_show_grid_lines(spreadsheet, to_sheet, show_grid)
      _ -> :ok
    end

    IO.puts("View settings copied from #{from_sheet} to #{to_sheet}")
  end
end

# Usage
SheetSettingsCopier.copy_view_settings(spreadsheet, "Template", "NewSheet")
```

--------------------------------

### Get Subject

Source: https://hexdocs.pm/umya_spreadsheet_ex/UmyaSpreadsheet.DocumentProperties.html

Retrieves the subject of the document.

```APIDOC
## GET /spreadsheet/properties/subject

### Description
Retrieves the document subject.

### Method
GET

### Endpoint
/spreadsheet/properties/subject

### Parameters
#### Query Parameters
- **spreadsheet** (struct) - Required - The spreadsheet struct

### Response
#### Success Response (200)
- **subject** (string) - The document subject as a string

#### Response Example
```json
{
  "subject": "Financial Analysis"
}
```
```

--------------------------------

### Create Financial Report with Auto Filters

Source: https://hexdocs.pm/umya_spreadsheet_ex/auto_filters.html

Demonstrates creating a detailed financial report with formatted headers and transaction data, applying auto filters to the entire dataset. Includes currency formatting for financial columns.

```elixir
{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Set up headers with formatting
headers = ["Date", "Transaction", "Category", "Amount", "Balance"]
Enum.with_index(headers, fn header, idx ->
  col = Enum.at(~w(A B C D E), idx)
  UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "#{col}1", header)
  UmyaSpreadsheet.set_font_bold(spreadsheet, "Sheet1", "#{col}1", true)
  UmyaSpreadsheet.set_background_color(spreadsheet, "Sheet1", "#{col}1", "DDEBF7")
end)

# Add some transaction data
transactions = [
  ["2025-05-01", "Salary", "Income", 5000, 5000],
  ["2025-05-02", "Rent", "Housing", -1200, 3800],
  ["2025-05-03", "Groceries", "Food", -150, 3650],
  ["2025-05-04", "Restaurant", "Food", -75, 3575],
  ["2025-05-05", "Gas", "Transportation", -40, 3535],
  ["2025-05-06", "Internet", "Utilities", -60, 3475],
  ["2025-05-07", "Movie Tickets", "Entertainment", -30, 3445]
]

Enum.with_index(transactions, fn transaction, idx ->
  row = idx + 2 # Start from row 2
  Enum.with_index(transaction, fn value, col_idx ->
    col = Enum.at(~w(A B C D E), col_idx)
    UmyaSpreadsheet.set_cell_value(spreadsheet, "Sheet1", "#{col}#{row}", value)

    # Format amounts and balance as currency
    if col_idx >= 3 do
      UmyaSpreadsheet.set_number_format(spreadsheet, "Sheet1", "#{col}#{row}", "$#,##0.00")
    end
  end)
end)

# Add an auto filter to the entire data range
UmyaSpreadsheet.set_auto_filter(spreadsheet, "Sheet1", "A1:E9")

# Save the spreadsheet
UmyaSpreadsheet.write(spreadsheet, "financial_report.xlsx")
```
Tokens:
Raw