R6 class for a Workbook Comments — wbComment • openxlsx2

R6 class for a Workbook Comments

R6 class for a Workbook Comments

Value

The wbComment object, invisibly; called for its side effects

Details

A comment

Public fields

text: Comment text
author: The comment author
style: A style for the comment
visible: logical, if FALSE is not visible
width: Width of the comment in ... units
height: Height of comment in ... units

Methods

Public methods

wbComment$new()
wbComment$print()
wbComment$clone()

Method `new()`

Creates a new wbComment object

Usage

wbComment$new(text, author, style, visible = TRUE, width = 2, height = 4)

Arguments

text: Comment text
author: The comment author
style: A style for the comment
visible: logical, if FALSE is not visible
width: Width of the comment in ... units
height: Height of comment in ... units

Returns

a wbComment object

Method `print()`

Prints the object

Usage

wbComment$print()

Method `clone()`

The objects of this class are cloneable with this method.

Usage

wbComment$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.