Skip to main content

Maidr.show

Maidr.show(renderer='auto', clear_fig=True, use_cdn='auto', *, hover_mode=None)

Preview the HTML content using the specified renderer.

Parameters

Name Type Description Default
renderer Literal['auto', 'ipython', 'browser'] The renderer to use for the HTML preview. "auto"
clear_fig bool Whether to close the matplotlib figure after showing. True
use_cdn bool or {'auto'} * True: load maidr.js from the CDN only. * False: render using the copy of maidr.js bundled with the installed package. For the browser renderer the assets are copied next to the temporary HTML file. * "auto" (default): attempt the CDN first and fall back to the bundled copy client-side if the CDN request fails. "auto"
hover_mode ('pointermove', 'click', 'off') The chart’s starting value for the reader’s Hover Mode setting, written to the schema as hoverMode. None leaves it out, so maidr.js uses its default, "pointermove". See :func:maidr.render. "pointermove"