PivotOpenXlsxStyles: R6 class that defines a collection of Excel styles as used by...
In cbailiss/pivottabler: Create Pivot Tables
PivotOpenXlsxStyles R Documentation
R6 class that defines a collection of Excel styles as used by the openxlsx
package.
Description
The 'PivotOpenXlsxStyles' class stores a collection of 'PivotOpenXlsxStyle'
style objects.
Format
R6Class object.
Active bindings
countThe number of 'PivotOpenXlsxStyle' objects in this
'PivotOpenXlsxStyles' collection.
stylesA list containing the 'PivotOpenXlsxStyle' objects in this
'PivotOpenXlsxStyles' collection.
Methods
Public methods
-
-
-
-
-
-
-
-
-
Method new()
Create a new 'PivotOpenXlsxStyles' object.
Usage
PivotOpenXlsxStyles$new(parentPivot)
Arguments
parentPivotThe pivot table that this 'PivotOpenXlsxStyles'
instance belongs to.
Returns
A new 'PivotOpenXlsxStyles' object.
Method clearStyles()
Clear the internal list of styles.
Usage
PivotOpenXlsxStyles$clearStyles()
Returns
No return value.
Method findNamedStyle()
Find an existing openxlsx style matching the name of a base style.
Usage
PivotOpenXlsxStyles$findNamedStyle(baseStyleName)
Arguments
baseStyleNameThe name of the base style to find.
Returns
A 'PivotOpenXlsxStyle' object with the specified name.
Method findOrAddStyle()
Find an existing openxlsx style, add a new openxlsx style matching a base
style and/or existing 'PivotStyle' object.
Usage
PivotOpenXlsxStyles$findOrAddStyle(
action = "findOrAdd",
baseStyleName = NULL,
isBaseStyle = NULL,
style = NULL,
mapFromCss = TRUE
)
Arguments
actionMust be one of "find" (to search for an existing style), "add"
(to add a new style) or "findOrAdd" (default, to first search for an existing
style, and if no match is found then add a new style)
baseStyleNameThe name of the base style to find.
isBaseStyle'TRUE' if the style being sought is a base style.
styleAn existing 'PivotStyle' object.
mapFromCssDefault 'TRUE', to create a new 'PivotOpenXlsxStyle' by
mapping from CSS style declarations.
Details
This function is used in two different ways:
(1) When adding base styles (i.e. named styles in the pivot table) to
this 'PivotOpenXlsxStyles' collection:
In this case, 'baseStyleName' is the name of the style and 'isBaseStyle=TRUE'
(so matching is by name only) and 'style' is the 'PivotStyle' object for the
base style.
(2) When finding styles that have been applied to individual cells using the
'PivotStyle' object that is attached to each cell:
In this case, 'baseStyleName' may or may not be present, 'isBaseStyle=FALSE'
and 'style' is the 'PivotStyle' object from the cell.
Returns
A 'PivotOpenXlsxStyle' object that has been found or added.
Method addNamedStyles()
Populate the OpenXlsx styles based on the styles defined in the pivot table.
Usage
PivotOpenXlsxStyles$addNamedStyles(mapFromCss = TRUE)
Arguments
mapFromCssDefault 'TRUE', to create a new 'PivotOpenXlsxStyle' by
mapping from CSS style declarations.
Returns
No return value.
Method asList()
Return the contents of this object as a list for debugging.
Usage
PivotOpenXlsxStyles$asList()
Returns
A list of various object properties.
Method asJSON()
Return the contents of this object as JSON for debugging.
Usage
PivotOpenXlsxStyles$asJSON()
Returns
A JSON representation of various object properties.
Method asString()
Return a representation of this object as a character value.
Usage
PivotOpenXlsxStyles$asString(seperator = ", ")
Arguments
seperatorA character value used when concatenating
multiple styles.
Returns
A character summary of various object properties.
Method clone()
The objects of this class are cloneable with this method.
Usage
PivotOpenXlsxStyles$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.
cbailiss/pivottabler documentation built on Oct. 14, 2023, 9:38 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| PivotOpenXlsxStyles | R Documentation |
R6 class that defines a collection of Excel styles as used by the openxlsx package.
Description
The 'PivotOpenXlsxStyles' class stores a collection of 'PivotOpenXlsxStyle' style objects.
Format
R6Class object.
Active bindings
countThe number of 'PivotOpenXlsxStyle' objects in this 'PivotOpenXlsxStyles' collection.
stylesA list containing the 'PivotOpenXlsxStyle' objects in this 'PivotOpenXlsxStyles' collection.
Methods
Public methods
Method new()
Create a new 'PivotOpenXlsxStyles' object.
Usage
PivotOpenXlsxStyles$new(parentPivot)
Arguments
parentPivotThe pivot table that this 'PivotOpenXlsxStyles' instance belongs to.
Returns
A new 'PivotOpenXlsxStyles' object.
Method clearStyles()
Clear the internal list of styles.
Usage
PivotOpenXlsxStyles$clearStyles()
Returns
No return value.
Method findNamedStyle()
Find an existing openxlsx style matching the name of a base style.
Usage
PivotOpenXlsxStyles$findNamedStyle(baseStyleName)
Arguments
baseStyleNameThe name of the base style to find.
Returns
A 'PivotOpenXlsxStyle' object with the specified name.
Method findOrAddStyle()
Find an existing openxlsx style, add a new openxlsx style matching a base style and/or existing 'PivotStyle' object.
Usage
PivotOpenXlsxStyles$findOrAddStyle( action = "findOrAdd", baseStyleName = NULL, isBaseStyle = NULL, style = NULL, mapFromCss = TRUE )
Arguments
actionMust be one of "find" (to search for an existing style), "add" (to add a new style) or "findOrAdd" (default, to first search for an existing style, and if no match is found then add a new style)
baseStyleNameThe name of the base style to find.
isBaseStyle'TRUE' if the style being sought is a base style.
styleAn existing 'PivotStyle' object.
mapFromCssDefault 'TRUE', to create a new 'PivotOpenXlsxStyle' by mapping from CSS style declarations.
Details
This function is used in two different ways: (1) When adding base styles (i.e. named styles in the pivot table) to this 'PivotOpenXlsxStyles' collection: In this case, 'baseStyleName' is the name of the style and 'isBaseStyle=TRUE' (so matching is by name only) and 'style' is the 'PivotStyle' object for the base style. (2) When finding styles that have been applied to individual cells using the 'PivotStyle' object that is attached to each cell: In this case, 'baseStyleName' may or may not be present, 'isBaseStyle=FALSE' and 'style' is the 'PivotStyle' object from the cell.
Returns
A 'PivotOpenXlsxStyle' object that has been found or added.
Method addNamedStyles()
Populate the OpenXlsx styles based on the styles defined in the pivot table.
Usage
PivotOpenXlsxStyles$addNamedStyles(mapFromCss = TRUE)
Arguments
mapFromCssDefault 'TRUE', to create a new 'PivotOpenXlsxStyle' by mapping from CSS style declarations.
Returns
No return value.
Method asList()
Return the contents of this object as a list for debugging.
Usage
PivotOpenXlsxStyles$asList()
Returns
A list of various object properties.
Method asJSON()
Return the contents of this object as JSON for debugging.
Usage
PivotOpenXlsxStyles$asJSON()
Returns
A JSON representation of various object properties.
Method asString()
Return a representation of this object as a character value.
Usage
PivotOpenXlsxStyles$asString(seperator = ", ")
Arguments
seperatorA character value used when concatenating multiple styles.
Returns
A character summary of various object properties.
Method clone()
The objects of this class are cloneable with this method.
Usage
PivotOpenXlsxStyles$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.