Skip to contents

TextBlock

Source: R/TextBlock.R
TextBlock.Rd

Specialized ContentBlock for embedding styled text within reports. It supports multiple styling options to accommodate various text roles, such as headers or verbatim text, in the report content.

Super class

teal.reporter::ContentBlock -> TextBlock

Methods

Public methods

Inherited methods

Method new()

Initialize a TextBlock object.

Usage 

TextBlock$new(content = character(0), style = private$styles[1])

Arguments

content

(character) a string assigned to this TextBlock

style

(character(1)) one of: "default", "header2", "header3" "verbatim"

Details

Constructs a TextBlock object with no content and the default style.

Returns

Object of class TextBlock, invisibly.

Examples 

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()

Method set_style()

Sets the style of this TextBlock.

Usage 

TextBlock$set_style(style)

Arguments

style

(character(1)) one of: "default", "header2", "header3" "verbatim"

Details

The style has bearing on the rendering of this block.

Returns

self, invisibly.

Examples 

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$set_style("header2")

Method get_style()

Get the style of this TextBlock.

Usage 

TextBlock$get_style()

Returns

character(1) the style of this TextBlock.

Examples 

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$get_style()

Method get_available_styles()

Get available an array of styles available to this TextBlock.

Usage 

TextBlock$get_available_styles()

Returns

A character array of styles.

Examples 

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$get_available_styles()

Method from_list()

Create the TextBlock from a list.

Usage 

TextBlock$from_list(x)

Arguments

x

(named list) with two fields text and style. Use the get_available_styles method to get all possible styles.

Returns

self, invisibly.

Examples 

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$from_list(list(text = "sth", style = "default"))

Method to_list()

Convert the TextBlock to a list.

Usage 

TextBlock$to_list()

Returns

named list with a text and style.

Examples 

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$to_list()

Method clone()

The objects of this class are cloneable with this method.

Usage 

TextBlock$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples 


## ------------------------------------------------
## Method `TextBlock$new`
## ------------------------------------------------

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()


## ------------------------------------------------
## Method `TextBlock$set_style`
## ------------------------------------------------

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$set_style("header2")


## ------------------------------------------------
## Method `TextBlock$get_style`
## ------------------------------------------------

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$get_style()
#> [1] "default"


## ------------------------------------------------
## Method `TextBlock$get_available_styles`
## ------------------------------------------------

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$get_available_styles()
#> [1] "default"  "header2"  "header3"  "verbatim"


## ------------------------------------------------
## Method `TextBlock$from_list`
## ------------------------------------------------

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$from_list(list(text = "sth", style = "default"))


## ------------------------------------------------
## Method `TextBlock$to_list`
## ------------------------------------------------

TextBlock <- getFromNamespace("TextBlock", "teal.reporter")
block <- TextBlock$new()
block$to_list()
#> $text
#> character(0)
#> 
#> $style
#> [1] "default"
#>