Text

class alfred3.element.display.Text(text: Optional[str] = None, path: Optional[Union[str, pathlib.Path]] = None, emojize: bool = True, render_markdown: bool = True, **kwargs)

Bases: alfred3.element.core.Element

Displays text.

You can use GitHub-flavored Markdown syntax and common emoji shortcodes . Additionally, you can use html for advanced formatting.

Parameters

• text (str, Path, optional) – Text to be displayed.

• path (str, Path, optional) – Filepath to a textfile (relative to the experiment directory).

• emojize (bool, optional) – If True (default), emoji shortcodes in the text will be converted to unicode (i.e. emojis will be displayed).

• render_markdown (bool, optional) – If True (default), markdown will be rendered to html.

• **kwargs –

  Inherited keyword arguments

  align	Horizontal alignment of text in the element. Does not usually apply to labels. Think of it as an alignment that applies to the innermost layer of an element (while labels are generally located at outer layers). See LabelledElement for more on labelled elements. Can be left (default), center, right, or justify.
  font_size	Font size for text in the element. You can use a keyword or an exact specification. The available keywords are tiny, small, normal, big, and huge. The exact specification shoul ideally include a unit, such as 1rem, or 12pt. If you supply an integer without a unit, a unit of pt will be assumed. Defaults to normal.
  height	Vertical height of the elements display area. Supply a string with a unit, e.g. 80px. Usually, the default is fine. For adding vertical space to a page, you should prefer the VerticalSpace element, as it is sematically more clear.
  instance_log	If True, the element will use an instance-specific logger, thereby allowing detailed fine- tuning of its logging behavior.
  name	Name of the element. This should be a unique identifier. It will be used to identify the corresponding data in the final data set.
  position	Horizontal position of the full element on the page. Values can be left, center (default), end, or any valid value for the justify-content flexbox utility. Takes effect only, when the element is not full-width.
  showif	A dictionary, defining conditions that must be met for the element to be shown. The conditions take the form of key-value pairs, where each key is an element name and the value is the required input. See showif for details.
  width	Defines the horizontal width of the element from small screens upwards. It is always full-width on extra small screens. Possible values are narrow, medium, wide, and full. For more detailed control, you can define the element_width attribute.

Examples

A simple text element, including a 😊 (:blush:) emoji added to a page:

import alfred3 as al
exp = al.Experiment()

@exp.member
class HelloWorld(al.Page):
    name = "hello_world"

    def on_exp_access(self):
        self += al.Text("This is text :blush:")

Methods

add_css	Adds CSS to the element.
add_js	Adds Javascript to the element.
added_to_experiment	Tells the element that it was added to an experiment.
added_to_page	Tells the element that it was added to a page.
prepare_web_widget	Hook for computations for preparing an element's web widget.
render_inner_html	Renders the element template element_template.
render_text	Renders the markdown and emoji shortcodes in text

Attributes

base_template	Base template for the element, which will be used to hold the rendered element template.
converted_width	List of bootstrap column widths at different screen sizes.
css_class_container	Returns the name the element container's CSS class.
css_class_element	Returns the name of the element's CSS class.
css_code	A list of tuples, which contain a priority and CSS code.
css_urls	A list of tuples, which contain a priority and an url pointing to CSS code.
display_standalone	If True (default), the element will be displayed as usual on its own.
element_template	The element's specific, inner template.
element_width	Returns a string of column width definitions.
exp	The experiment session to which this element belongs.
experiment	Alias for exp
font_size	Font size
js_code	A list of tuples, which contain a priority and Javascript.
js_urls	A list of tuples, which contain a priority and an url pointing to JavaScript.
name	Unique identifier for the element.
page	The page to which this element belongs.
position	Position of the whole element on the page.
section	The direct parent section of this element's page.
short_tree	String, giving the exact position in the experiment.
should_be_shown	Boolean, indicating whether the element is meant to be shown.
showif	Conditions that have to be met for the element to be shown.
template_data	Dictionary of data to be passed on to jinja templates.
text	The text to be displayed
tree	String, giving the exact position in the experiment.
web_widget	The element's rendered html code for display on a page.
width	Element width
path	Path to a textfile, if specified in the init
emojize	Boolean flag, indicating whether emoji shortcodes should be interpreted