ColorProvider: ColorProvider

In charlatan: Make Fake Data

ColorProvider

Description

methods for colors

Super class

charlatan::BaseProvider -> ColorProvider

Public fields

locale

(character) xxx

all_colors

(character) xxx

safe_colors

(character) xxx

Methods

Public methods

• ColorProvider$allowed_locales()

• ColorProvider$new()

• ColorProvider$color_name()

• ColorProvider$safe_color_name()

• ColorProvider$hex_color()

• ColorProvider$safe_hex_color()

• ColorProvider$rgb_color()

• ColorProvider$rgb_css_color()

• ColorProvider$clone()

Inherited methods

• charlatan::BaseProvider$bothify()
• charlatan::BaseProvider$check_locale()
• charlatan::BaseProvider$lexify()
• charlatan::BaseProvider$numerify()
• charlatan::BaseProvider$random_digit()
• charlatan::BaseProvider$random_digit_not_zero()
• charlatan::BaseProvider$random_digit_not_zero_or_empty()
• charlatan::BaseProvider$random_digit_or_empty()
• charlatan::BaseProvider$random_element()
• charlatan::BaseProvider$random_element_prob()
• charlatan::BaseProvider$random_int()
• charlatan::BaseProvider$random_letter()
• charlatan::BaseProvider$randomize_nb_elements()

---

Method allowed_locales()

fetch the allowed locales for this provider

Usage

ColorProvider$allowed_locales()

---

Method new()

Create a new ColorProvider object

Usage

ColorProvider$new(locale = NULL)

Arguments

locale

(character) the locale to use. See ⁠$allowed_locales()⁠ for locales supported (default: en_US)

Returns

A new ColorProvider object

---

Method color_name()

color name

Usage

ColorProvider$color_name()

---

Method safe_color_name()

safe color name

Usage

ColorProvider$safe_color_name()

---

Method hex_color()

hex color

Usage

ColorProvider$hex_color()

---

Method safe_hex_color()

safe hex color

Usage

ColorProvider$safe_hex_color()

---

Method rgb_color()

RGB color

Usage

ColorProvider$rgb_color()

---

Method rgb_css_color()

RGB CSS color

Usage

ColorProvider$rgb_css_color()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ColorProvider$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

x <- ColorProvider$new()
x$locale
x$color_name()
x$safe_color_name()
x$hex_color()
x$safe_hex_color()
x$rgb_color()
x$rgb_css_color()

x <- ColorProvider$new(locale = "uk_UA")
x$locale
x$color_name()
x$safe_color_name()

charlatan documentation built on Sept. 13, 2023, 5:08 p.m.