Functions to render the canonical HTML representation of a Toyplot figure.
Stores context data during rendering.
This is only of use for Toyplot developers and library developers who are implementing rendering code. It is not intended for end-users.
Track whether an object has already been rendered.
Used to prevent objects that can be shared, such as
toyplot.coordinates.Axis, from generating duplicate markup in the output HTML.
Parameters: o (any Python object, required) – Returns: rendered – If the given object hasn’t already been rendered, records it as rendered and returns False. Subsequent calls with the given object will always return True. Return type: bool
The following checks to see if mark has already been rendered:
if not context.already_rendered(mark): # Render the mark
attribute ‘toyplot.html.RenderContext.animation’ undocumented
Copy the current
Creates a copy of the current render context that can be used to render children of the currently-rendered object.
Parameters: parent (any Python object, required.) – Returns: context – The parent attribute will be set to the supplied parent object. Return type:
define(name, dependencies=None, factory=None, value=None)¶
The module will only be embedded in the output if it is listed as a dependency of another module, or code specified using
You must specify either factory or value.
- name (string, required) – Module name. Any string is valid, but alphanumerics separated with slashes are recommended. Multiple calls to define with the same name argument will be silently ignored.
- dependencies (sequence of strings, optional) – Names of modules that are dependencies of this module.
- value (Python object, optional) – Arbitrary value for this module, which must be compatible with
Return a globally unique identifier for an object.
The generated identifier is cached, so multiple lookups on the same object will return consistent results.
Current DOM node. Typical rendering code will append HTML content to this node.
require(dependencies=None, arguments=None, code=None)¶
The given code will be unconditionally embedded in the output markup, along with any modules listed as dependencies (plus their dependencies, and-so-on).
- dependencies (sequence of strings, optional) – Names of modules that are required by this code.
must be compatible with
Top-level DOM node.
attribute ‘toyplot.html.RenderContext.scenegraph’ undocumented
function ‘toyplot.html.apply_changes’ undocumented
Decorator for registering custom rendering code.
This is only of use when creating your own custom Toyplot marks. It is not intended for end-users.
To register your own rendering function:
@toyplot.html.dispatch(toyplot.coordinates.Cartesian, MyCustomMark, toyplot.html.RenderContext) def _render(axes, mark, context): # Rendering implementation here
render(canvas, fobj=None, animation=False, style=None)¶
Convert a canvas to its HTML DOM representation.
- canvas (
toyplot.canvas.Canvas) – The canvas to be rendered.
- fobj (file-like object or string, optional) – The file to write. Use a string filepath to write data directly to disk. If None (the default), the HTML tree will be returned to the caller instead.
- animation (boolean, optional) – If True, return a representation of the changes to be made to the HTML tree for animation.
- style (dict, optional) – Dictionary of CSS styles that will be applied to the top-level output <div>.
- html (
xml.etree.ElementTree.Elementor None) – HTML representation of canvas, as a DOM tree, or None if the caller specifies the fobj parameter.
- changes (JSON-compatible data structure, or None) – JSON-compatible representation of the animated changes to canvas.
The output HTML is the “canonical” representation of a Toyplot canvas - the other toyplot backends operate by converting the output from toyplot.html.render() to the desired end target.
Note that the output HTML is a fragment wrapped in a <div>, suitable for embedding in a larger document. It is the caller’s responsibility to supply the <html>, <body> etc. if the result is intended as a standalone HTML document.
- canvas (
Convert a canvas to its HTML string representation.
html – HTML representation of canvas as a string.
The output HTML is a fragment wrapped in a <div>, suitable for embedding in a larger document. It is the caller’s responsibility to supply the <html>, <body> etc. if the result is intended as a standalone HTML document.