xlsx (version 0.1.1)

CellStyle: Functions to manipulate cells.

Description

Create and set cell styles.

Usage

createCellStyle(wb, hAlign=NULL, vAlign=NULL, borderPosition=NULL,
  borderPen="BORDER_NONE", borderColor=NULL, fillBackgroundColor=NULL,
  fillForegroundColor=NULL, fillPattern=NULL, font=NULL, dataFormat=NULL)
setCellStyle(cell, cellStyle)
getCellStyle(cell)

Arguments

wb

a workbook object as returned by createWorkbook or loadWorkbook.

hAlign

a character specifiying the horizontal alignment. Valid values are "ALIGN_CENTER", "ALIGN_CENTER_SELECTION", "ALIGN_FILL", "ALIGN_GENERAL", "ALIGN_JUSTIFY", "ALIGN_LEFT", "ALIGN_RIGHT".

vAlign

a character specifiying the vertical alignment. Valid values are "VERTICAL_BOTTOM", "VERTICAL_CENTER", "VERTICAL_JUSTIFY", "VERTICAL_TOP".

borderPosition

a character specifiying the border position. Valid values are "BOTTOM", "LEFT", "TOP", "RIGHT".

borderPen

a character specifiying the border pen. Valid values are "BORDER_DASH_DOT", "BORDER_DASH_DOT_DOT1", "BORDER_DASHED", "BORDER_DOTTED", "BORDER_DOUBLE", "BORDER_HAIR", "BORDER_MEDIUM", "BORDER_MEDIUM_DASH_DOT1", "BORDER_MEDIUM_DASH_DOT_DOT1",

borderColor

a character specifiying the border color. Any color names as returned by colors can be used.

fillBackgroundColor

a character specifiying the fill background color. Any color names as returned by colors can be used.

fillForegroundColor

a character specifiying the fill foreground color. Any color names as returned by colors can be used.

fillPattern

a character specifiying the fill pattern. Valid values are "BRICKS1", "DIAMONDS1", "FINE_DOTS", "LEAST_DOTS1", "LESS_DOTS1", "NO_FILL", "SOLID_FOREGROUND", "SPARSE_DOTS", "SQUARES1", "THICK_BACKWARD_DIAG", "THICK_FORWARD_DIAG", "THICK_HOR

font

a Font object.

dataFormat

a character specifying the data format. See Details.

cell

a Cell object.

cellStyle

a CellStyle object as returned by createCellStyle.

Value

• createCellStyle creates a CellStyle object.

  getCellStyle returns the associated CellStyle object for the given Cell.

Details

setCellStyle sets the CellStyle to one Cell object.

Specifying the dataFormat argument allows you to format the cell. For example, "#,##0.00" corresponds to using a comma separator for powers of 1000 with two decimal places, "m/d/yyyy" can be used to format dates and is the equivalent of R's MM/DD/YYYY format. To format datetimes use "m/d/yyyy h:mm:ss;@". To show negative values in red within parantheses with two decimals and commas after power of 1000 use "#,##0.00_);[Red](#,##0.00)". I am not aware of an official way to discover these strings. I find them out by recording a macro that formats a specific cell and then checking out the resulting VBA code. From there you can read the dataFormat code. NOTE: You need to have a Workbook object to attach a CellStyle object to it.

Examples

wb <- createWorkbook()
  sheet <- createSheet(wb, "Sheet1")

  rows  <- createRow(sheet, rowIndex=1)    

  cell.1 <- createCell(rows, colIndex=1)[[1,1]]     
  setCellValue(cell.1, "Hello R!")

  cellStyle1 <- createCellStyle(wb, borderPosition="RIGHT",
    borderPen="BORDER_DASHED", fillBackgroundColor="yellow",
    fillForegroundColor="tomato", fillPattern="BIG_SPOTS")
  setCellStyle(cell.1, cellStyle1)  

  # you need to save the workbook now if you want to see this art