figures

figures#

Containers for conveniently rendering multiple objects together.

These containers make it possible to group together multiple children so that they render as a single figure-like display object in IPython, and allow embedding arbitrary treescope-renderable objects or treescope-compatible styles as figures.

Classes

AllowWordWrap

Allows line breaks in its child..

CSSStyled

Adjusts the CSS style of its child.

InlineBlock

Renders an object in "inline-block" mode.

PreventWordWrap

Allows line breaks in its child..

RendersAsRootInIPython

Base class / mixin that implements _repr_html_ for treescope parts.

TreescopeRenderingFigure

Wrapper that renders its child rendering as a HTML figure.

Functions

bolded(subfigure)

Returns a bolded version of the first figure.

indented(subfigure)

Returns a figure object that displays a value with an indent.

inline(*parts[, wrap])

Returns a figure that arranges a set of displayable objects along a line.

styled(subfigure, style)

Returns a CSS-styled version of the first figure.

with_color(subfigure, color)

Returns a colored version of the first figure.

with_font_size(subfigure, size)

Returns a scaled version of the first figure.

wrap_as_treescope_figure(value)

Converts an arbitrary object to a renderable treescope part if possible.