markups#

Various kinds of markup (static content) widgets.

Warning

The explicit purpose of these Bokeh Models is to embed raw HTML text for a browser to execute. If any portion of the text is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

class Div(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

A block (div) of text.

This Bokeh model corresponds to an HTML <div> element.

Example

from bokeh.io import show
from bokeh.models import Div

div = Div(text="""Your <a href="https://en.wikipedia.org/wiki/HTML">HTML</a>-supported text is initialized with the <b>text</b> argument.  The
remaining div arguments are <b>width</b> and <b>height</b>. For this example, those values
are <i>200</i> and <i>100</i>, respectively.""",
width=200, height=100)

show(div)

render_as_text#: Whether the contents should be rendered as raw text or as interpreted HTML. The default value is False, meaning contents are rendered as HTML.

class Markup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Base class for Bokeh models that represent HTML markup elements.

Markups include e.g., <div>, <p>, and <pre>.

Content can be interpreted as TeX and LaTeX input when rendering as HTML. TeX/LaTeX processing can be disabled by setting disable_math to True.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

disable_math#: Whether the contents should not be processed as TeX/LaTeX input.

text#: The text or HTML contents of the widget.

Note

If the HTML content contains elements which size depends on on external, asynchronously loaded resources, the size of the widget may be computed incorrectly. This is in particular an issue with images (<img>). To remedy this problem, one either has to set explicit dimensions using CSS properties, HTML attributes or model’s width and height properties, or inline images’ contents using data URIs.

class Paragraph(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

A block (paragraph) of text.

This Bokeh model corresponds to an HTML <p> element.

Example

from bokeh.io import show
from bokeh.models import Paragraph

p = Paragraph(text="""Your text is initialized with the 'text' argument.  The
remaining Paragraph arguments are 'width' and 'height'. For this example, those values
are 200 and 100, respectively.""",
width=200, height=100)

show(p)

class PreText(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

A block (paragraph) of pre-formatted text.

This Bokeh model corresponds to an HTML <pre> element.

Example

from bokeh.io import show
from bokeh.models import PreText

pre = PreText(text="""Your text is initialized with the 'text' argument.

The remaining Paragraph arguments are 'width' and 'height'. For this example,
those values are 500 and 100, respectively.""",
width=500, height=100)

show(pre)