props_mod: Update Graphical Properties for Selected Table Elements

In tablesgg: Presentation-Quality Tables, Displayed Using 'ggplot2'

Update Graphical Properties for Selected Table Elements

Description

Update the graphical properties for selected table entries, hvrules, or blocks in a plotted table. This is an internal function, not intended to be called by package users.

Usage

props_mod(x, value, id=NULL, e=NULL, arows=NULL, acols=NULL, 
    setEnabled=TRUE)

Arguments

x	A pltdTable object containing a plotted table.
value	An element_entry, element_refmark, element_hvrule, or element_block object that contains the new values for graphical properties.
id, e, arows, acols	Arguments that identify which elements in x are to have their graphical properties updated by value. Exactly one of id, e, or the pair (arows, acols) should be specified. See props<- for documentation for id, propsd<- for e (where it is derived from argument subset), and propsa<- for documentation for arows and acols.
setEnabled	Logical scalar. If TRUE then any element whose properties are updated by this function will have its enabled value set to TRUE (and thus will be displayed in a plot). enabled will not be changed for elements that are not updated. If setEnabled is FALSE, enabled is not changed for any elements.

Details

This is a backend for public functions props<-, propsa<-, and propsd<-. The latter are wrappers that accept different sets of arguments to specify which elements are to be updated. See their documentation for the details.

This function overrides graphical properties in x that may have been set by a style. Therefore the value of style_row is set to NA for any elements whose graphical properties are updated by this function.

Value

An object like x, with updated graphical properties for the selected elements.

See Also

props<-, propsa<-, propsd<-

tablesgg documentation built on June 22, 2024, 11:02 a.m.