pandas.io.formats.style.Styler.render#

Styler.render(sparse_index=None, sparse_columns=None, **kwargs)[source]#

Render the Styler including all applied styles to HTML.

Deprecated since version 1.4.0.

Parameters
sparse_indexbool, optional

Whether to sparsify the display of a hierarchical index. Setting to False will display each explicit level element in a hierarchical key for each row. Defaults to pandas.options.styler.sparse.index value.

sparse_columnsbool, optional

Whether to sparsify the display of a hierarchical index. Setting to False will display each explicit level element in a hierarchical key for each row. Defaults to pandas.options.styler.sparse.columns value.

**kwargs

Any additional keyword arguments are passed through to self.template.render. This is useful when you need to provide additional variables for a custom template.

Returns
renderedstr

The rendered HTML.

Notes

This method is deprecated in favour of Styler.to_html.

Styler objects have defined the _repr_html_ method which automatically calls self.to_html() when it’s the last item in a Notebook cell.

When calling Styler.render() directly, wrap the result in IPython.display.HTML to view the rendered HTML in the notebook.

Pandas uses the following keys in render. Arguments passed in **kwargs take precedence, so think carefully if you want to override them:

  • head

  • cellstyle

  • body

  • uuid

  • table_styles

  • caption

  • table_attributes

previous

pandas.io.formats.style.Styler.pipe

next

pandas.io.formats.style.Styler.set_caption