pg.to_html_str

Accessible via pg.to_html_str, pg.views.to_html_str.

to_html_str(value, *, name=None, root_path=None, view_id='html-tree-view', content_only=False, **kwargs)[source]

Returns a HTML str for a value.

Return type:

str

Parameters:

  • value – The value to render.

  • name – The name of the value.

  • root_path – The root path of the value.

  • view_id – The ID of the view to render the value. See pg.views.HtmlView.dir() for all available HTML view IDs.

  • content_only – If True, only the content will be returned.

  • **kwargs – Additional keyword arguments passed from pg.to_html, wich will be passed to the HtmlView.render_xxx() (thus Extension._html_xxx()) methods.

Returns:

The rendered HTML str.