xlsx (version 0.6.5)

is.Border: Create an Border object.

Description

Create an Border object, useful when working with cell styles.

Usage

is.Border(x)
Border(color = "black", position = "BOTTOM", pen = "BORDER_THIN")

Arguments

x

An Border object, as returned by Border.

color

a character vector specifiying the font color. Any color names as returned by colors can be used. Or, a hex character, e.g. "#FF0000" for red. For Excel 95 workbooks, only a subset of colors is available, see the constant INDEXED_COLORS_.

position

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

pen

a character vector specifying the pen style. Valid values come from constant BORDER_STYLES_.

Value

Border returns a list with components from the input argument, and a class attribute "Border". Border objects are used when constructing cell styles.

is.Border returns TRUE if the argument is of class "Border" and FALSE otherwise.

Details

The values for the color, position, or pen arguments are replicated to the longest of them.

See Also

CellStyle for using the a Border object.

Examples

# NOT RUN {

  border <-  Border(color="red", position=c("TOP", "BOTTOM"),
    pen=c("BORDER_THIN", "BORDER_THICK"))

# }