@spec add_connector(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  float()
) :: :ok | {:error, atom()}

Adds a connector line between two cells in a spreadsheet.

A connector is a line that connects two cells, useful for creating flowcharts and diagrams.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to add the connector to
• from_cell - The starting cell address for the connector (e.g., "A1")
• to_cell - The ending cell address for the connector (e.g., "B5")
• line_color - The color of the connector line. Can be a named color (e.g., "black") or a hex color code
• line_width - The width of the connector line in points

Returns

• :ok - Connector was successfully added
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to add connector for another reason

Examples

# Add a red connector line from cell A1 to cell C3
UmyaSpreadsheet.add_connector(spreadsheet, "Sheet1", "A1", "C3", "red", 1.5)

@spec add_shape(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t(),
  String.t(),
  float(),
  float(),
  String.t(),
  String.t(),
  float()
) :: :ok | {:error, atom()}

Adds a shape to a spreadsheet at the specified cell position.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to add the shape to
• cell_address - The cell address where the shape should be placed (e.g., "A1")
• shape_type - The type of shape to add. Supported types:
  • "rectangle" - Rectangle shape
  • "ellipse" or "oval" or "circle" - Ellipse/oval shape
  • "rounded_rectangle" - Rectangle with rounded corners
  • "triangle" - Triangle shape
  • "right_triangle" - Right triangle shape
  • "pentagon" - Pentagon shape
  • "hexagon" - Hexagon shape
  • "octagon" - Octagon shape
  • "trapezoid" - Trapezoid shape
  • "diamond" - Diamond shape
  • "arrow" - Arrow shape
  • "line" - Line shape
  • "connector" - Connector line (use add_connector/6 for connecting two cells)
• width - The width of the shape in pixels
• height - The height of the shape in pixels
• fill_color - The fill color for the shape. Can be a named color (e.g., "red", "blue") or a hex color code (e.g., "FF0000")
• outline_color - The outline/border color for the shape. Can be a named color or hex code
• outline_width - The width of the outline/border in points

Returns

• :ok - Shape was successfully added
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to add shape for another reason

Examples

# Add a blue rectangle at cell A1
UmyaSpreadsheet.add_shape(spreadsheet, "Sheet1", "A1", "rectangle", 200, 100, "#0000FF", "black", 1.0)

# Add a red circle at cell B5
UmyaSpreadsheet.add_shape(spreadsheet, "Sheet1", "B5", "ellipse", 150, 150, "red", "black", 1.0)

@spec add_text_box(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t(),
  String.t(),
  float(),
  float(),
  String.t(),
  String.t(),
  String.t(),
  float()
) :: :ok | {:error, atom()}

Adds a text box to a spreadsheet at the specified cell position.

A text box is a rectangular shape with text inside it.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to add the text box to
• cell_address - The cell address where the text box should be placed (e.g., "A1")
• text - The text to display inside the text box
• width - The width of the text box in pixels
• height - The height of the text box in pixels
• fill_color - The background color for the text box. Can be a named color (e.g., "white") or a hex color code
• text_color - The color of the text. Can be a named color (e.g., "black") or a hex color code
• outline_color - The border color for the text box. Can be a named color or hex code
• outline_width - The width of the border in points

Returns

• :ok - Text box was successfully added
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to add text box for another reason

Examples

# Add a white text box with black text at cell A1
UmyaSpreadsheet.add_text_box(
  spreadsheet,
  "Sheet1",
  "A1",
  "Hello World",
  200,
  100,
  "white",
  "black",
  "gray",
  1.0
)

@spec count_drawing_objects(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t() | nil
) :: {:ok, non_neg_integer()} | {:error, atom()}

Counts drawing objects (shapes, text boxes, connectors) in a worksheet.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to count objects in
• cell_range - Optional cell range to filter by position (e.g., "A1:C10")

Returns

• {:ok, count} - The number of drawing objects found
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to count drawing objects for another reason

Examples

# Count all drawing objects in Sheet1
{:ok, count} = UmyaSpreadsheet.Drawing.count_drawing_objects(spreadsheet, "Sheet1")

# Count drawing objects in cells A1 through C10
{:ok, count} = UmyaSpreadsheet.Drawing.count_drawing_objects(spreadsheet, "Sheet1", "A1:C10")

@spec get_connectors(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t() | nil
) :: {:ok, [map()]} | {:error, atom()}

Gets all connectors in a worksheet.

This function retrieves all connector lines from the specified worksheet.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to get connectors from
• cell_range - Optional cell range to filter connectors by position (e.g., "A1:C10")

Returns

• {:ok, connectors} - List of connector maps, each containing:
  • :from_cell - The starting cell address for the connector
  • :to_cell - The ending cell address for the connector
  • :line_color - The color of the connector line (hex code)
  • :line_width - The width of the connector line in points
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to get connectors for another reason

Examples

# Get all connectors in Sheet1
{:ok, connectors} = UmyaSpreadsheet.Drawing.get_connectors(spreadsheet, "Sheet1")

# Get connectors in cells A1 through C10
{:ok, connectors} = UmyaSpreadsheet.Drawing.get_connectors(spreadsheet, "Sheet1", "A1:C10")

@spec get_shapes(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t() | nil
) :: {:ok, [map()]} | {:error, atom()}

Gets all shapes in a worksheet.

This function retrieves all shapes (rectangles, ellipses, etc.) from the specified worksheet.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to get shapes from
• cell_range - Optional cell range to filter shapes by position (e.g., "A1:C10")

Returns

• {:ok, shapes} - List of shape maps, each containing:
  • :type - The type of shape ("rectangle", "ellipse", etc.)
  • :cell - The cell address where the shape is placed
  • :width - The width of the shape in pixels
  • :height - The height of the shape in pixels
  • :fill_color - The fill color for the shape (hex code)
  • :outline_color - The outline/border color for the shape (hex code)
  • :outline_width - The width of the outline/border in points
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to get shapes for another reason

Examples

# Get all shapes in Sheet1
{:ok, shapes} = UmyaSpreadsheet.Drawing.get_shapes(spreadsheet, "Sheet1")

# Get shapes in cells A1 through C10
{:ok, shapes} = UmyaSpreadsheet.Drawing.get_shapes(spreadsheet, "Sheet1", "A1:C10")

@spec get_text_boxes(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t() | nil
) :: {:ok, [map()]} | {:error, atom()}

Gets all text boxes in a worksheet.

This function retrieves all text boxes from the specified worksheet.

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to get text boxes from
• cell_range - Optional cell range to filter text boxes by position (e.g., "A1:C10")

Returns

• {:ok, text_boxes} - List of text box maps, each containing:
  • :cell - The cell address where the text box is placed
  • :text - The text content of the text box
  • :width - The width of the text box in pixels
  • :height - The height of the text box in pixels
  • :fill_color - The background color for the text box (hex code)
  • :text_color - The color of the text (hex code)
  • :outline_color - The border color for the text box (hex code)
  • :outline_width - The width of the border in points
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to get text boxes for another reason

Examples

# Get all text boxes in Sheet1
{:ok, text_boxes} = UmyaSpreadsheet.Drawing.get_text_boxes(spreadsheet, "Sheet1")

# Get text boxes in cells A1 through C10
{:ok, text_boxes} = UmyaSpreadsheet.Drawing.get_text_boxes(spreadsheet, "Sheet1", "A1:C10")

@spec has_drawing_objects(
  UmyaSpreadsheet.Spreadsheet.t(),
  String.t(),
  String.t() | nil
) :: {:ok, boolean()} | {:error, atom()}

Checks if a worksheet has any drawing objects (shapes, text boxes, connectors).

Parameters

• spreadsheet - A spreadsheet struct
• sheet_name - The name of the sheet to check
• cell_range - Optional cell range to filter by position (e.g., "A1:C10")

Returns

• {:ok, has_objects} - Boolean indicating whether the sheet has drawing objects
• {:error, :not_found} - Sheet was not found
• {:error, :error} - Failed to check for drawing objects for another reason

Examples

# Check if Sheet1 has any drawing objects
{:ok, has_objects} = UmyaSpreadsheet.Drawing.has_drawing_objects(spreadsheet, "Sheet1")