UmyaSpreadsheet.RowColumnFunctions (umya_spreadsheet_ex v0.7.0)

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
# Copy styling for all cells in column A to column B
:ok = UmyaSpreadsheet.RowColumnFunctions.copy_column_styling(spreadsheet, "Sheet1", 1, 2, nil, nil)

# Copy styling only for rows 1 through 10
:ok = UmyaSpreadsheet.RowColumnFunctions.copy_column_styling(spreadsheet, "Sheet1", 1, 2, 1, 10)

copy_row_styling(spreadsheet, sheet_name, source_row, target_row, start_column \\ nil, end_column \\ nil)

Copies styling from one row to another.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
source_row - The source row number (1-based)
target_row - The target row number (1-based)
start_column - Optional starting column index (1-based)
end_column - Optional ending column index (1-based)

Returns

:ok on success
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
# Copy styling for all cells in row 1 to row 2
:ok = UmyaSpreadsheet.RowColumnFunctions.copy_row_styling(spreadsheet, "Sheet1", 1, 2, nil, nil)

# Copy styling only for columns A through C (columns 1-3)
:ok = UmyaSpreadsheet.RowColumnFunctions.copy_row_styling(spreadsheet, "Sheet1", 1, 2, 1, 3)

get_column_auto_width(spreadsheet, sheet_name, column)

Gets whether a column width is automatically adjusted.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
column - The column letter (e.g., "A", "B")

Returns

{:ok, auto_width} on success where auto_width is a boolean
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
{:ok, auto_width} = UmyaSpreadsheet.RowColumnFunctions.get_column_auto_width(spreadsheet, "Sheet1", "A")

get_column_hidden(spreadsheet, sheet_name, column)

Gets whether a column is hidden.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
column - The column letter (e.g., "A", "B")

Returns

{:ok, hidden} on success where hidden is a boolean
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
{:ok, hidden} = UmyaSpreadsheet.RowColumnFunctions.get_column_hidden(spreadsheet, "Sheet1", "A")

get_column_width(spreadsheet, sheet_name, column)

Gets the width of a column.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
column - The column letter (e.g., "A", "B")

Returns

{:ok, width} on success where width is a float
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
{:ok, width} = UmyaSpreadsheet.RowColumnFunctions.get_column_width(spreadsheet, "Sheet1", "A")

get_row_height(spreadsheet, sheet_name, row_number)

Gets the height of a row.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
row_number - The row number (1-based)

Returns

{:ok, height} on success where height is a float
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
{:ok, height} = UmyaSpreadsheet.RowColumnFunctions.get_row_height(spreadsheet, "Sheet1", 1)

get_row_hidden(spreadsheet, sheet_name, row_number)

Gets whether a row is hidden.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
row_number - The row number (1-based)

Returns

{:ok, hidden} on success where hidden is a boolean
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
{:ok, hidden} = UmyaSpreadsheet.RowColumnFunctions.get_row_hidden(spreadsheet, "Sheet1", 1)

set_column_auto_width(spreadsheet, sheet_name, column, auto_width)

Sets whether a column width should be automatically adjusted.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
column - The column letter (e.g., "A", "B")
auto_width - Boolean indicating whether auto-width should be enabled

Returns

:ok on success
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
:ok = UmyaSpreadsheet.RowColumnFunctions.set_column_auto_width(spreadsheet, "Sheet1", "A", true)

set_column_width(spreadsheet, sheet_name, column, width)

Sets the width of a column.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
column - The column letter (e.g., "A", "B")
width - The width value

Returns

:ok on success
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
:ok = UmyaSpreadsheet.RowColumnFunctions.set_column_width(spreadsheet, "Sheet1", "A", 15.5)

set_row_height(spreadsheet, sheet_name, row_number, height)

Sets the height of a row.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
row_number - The row number (1-based)
height - The height value (in points)

Returns

:ok on success
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
:ok = UmyaSpreadsheet.RowColumnFunctions.set_row_height(spreadsheet, "Sheet1", 1, 20.5)

set_row_style(spreadsheet, sheet_name, row_number, bg_color, font_color)

Sets styles for an entire row.

Parameters

spreadsheet - The spreadsheet struct
sheet_name - The name of the sheet
row_number - The row number (1-based)
bg_color - The background color code (e.g., "#FF0000" for red)
font_color - The font color code (e.g., "#FFFFFF" for white)

Returns

:ok on success
{:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
# Set row background to red and text to white
:ok = UmyaSpreadsheet.RowColumnFunctions.set_row_style(spreadsheet, "Sheet1", 1, "#FF0000", "#FFFFFF")