to_html(self, buf: 'FilePath | WriteBuffer[str] | None' = None, encoding: 'str | None' = None, classes: 'str | list | tuple | None' = None, notebook: 'bool' = False, border: 'int | None' = None, table_id: 'str | None' = None, render_links: 'bool' = False) -> 'str | None'

Parameters

buf : str, path object, file-like object, or None, default None

String, path object (implementing os.PathLike[str] ), or file-like object implementing a string write() function. If None, the result is returned as a string.

encoding : str, default “utf-8”

Set character encoding.

classes : str or list-like

classes to include in the :None:None:`class` attribute of the opening <table> tag, in addition to the default "dataframe".

notebook : {True, False}, optional, default False

Whether the generated HTML is for IPython Notebook.

border : int

A border=border attribute is included in the opening <table> tag. Default pd.options.display.html.border .

table_id : str, optional

A css id is included in the opening :None:None:`<table>` tag if specified.

render_links : bool, default False

Convert URLs to HTML links.

Render a DataFrame to a html table.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /pandas/io/formats/format.py#1054
type: <class 'function'>
Commit: