Setting the width of a column in a worksheet

Sets the width of a column in a worksheet.

Usage

# S4 method for class 'workbook,character'
setColumnWidth(object,sheet,column,width)
# S4 method for class 'workbook,numeric'
setColumnWidth(object,sheet,column,width)

Arguments

object

The workbook to use

sheet

The name or index of the sheet

column

The index of the column to resize

width

The width of the specified column in units of 1/256th of a character width. If width = -1 (default), the column is auto-sized. If negative otherwise, the column will be sized to the sheet's default column width.

Details

Note that the arguments sheet, column and width are vectorized. As such the column width of multiple columns (potentially on different sheets) can be set with one method call.

Author

Martin Studer
Mirai Solutions GmbH https://mirai-solutions.ch

See also

workbook, setRowHeight

Examples

if (FALSE) { # \dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
mtcarsFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

# Load workbook
wb <- loadWorkbook(mtcarsFile)

# Sets the column width of the 3rd column on sheet 'mtcars' 
# to 4000/256th (= 15.625) character width
setColumnWidth(wb, sheet = "mtcars", column = 3, width = 4000)
} # }