# dask.dataframe.DataFrame.to_html

DataFrame.to_html(max_rows=5)

  Render a DataFrame as an HTML table.

  > This docstring was copied from pandas.core.frame.DataFrame.to_html.

  > Some inconsistencies with the Dask version may exist.

  Parameters:
    buf str, Path or StringIO-like, optional, default None (Not supported in Dask)

      > Buffer to write to. If None, the output is returned as a string.

      columnsarray-like, optional, default None (Not supported in Dask)

        The subset of columns to write. Writes all columns by default.

      col_spacestr or int, list or dict of int or str, optional (Not supported in Dask)

        The minimum width of each column in CSS length units. An int is assumed to be px units..

      headerbool, optional (Not supported in Dask)

        Whether to print column labels, default True.

      indexbool, optional, default True (Not supported in Dask)

        Whether to print index (row) labels.

      na_repstr, optional, default ‘NaN’ (Not supported in Dask)

        String representation of `NaN` to use.

      formatterslist, tuple or dict of one-param. functions, optional (Not supported in Dask)

        Formatter functions to apply to columns’ elements by position or name. The result of each function must be a unicode string. List/tuple must be of length equal to the number of columns.

      float_formatone-parameter function, optional, default None (Not supported in Dask)

        Formatter function to apply to columns’ elements if they are floats. This function must return a unicode string and will be applied only to the non-`NaN` elements, with `NaN` being handled by `na_rep`.

      sparsifybool, optional, default True (Not supported in Dask)

        Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row.

      index_namesbool, optional, default True (Not supported in Dask)

        Prints the names of the indexes.

      justifystr, default None (Not supported in Dask)

        How to justify the column labels. If None uses the option from the print configuration (controlled by set_option), ‘right’ out of the box. Valid values are

        - left

        - right

        - center

        - justify

        - justify-all

        - start

        - end

        - inherit

        - match-parent

        - initial

        - unset.

      max_rowsint, optional

        Maximum number of rows to display in the console.

      max_colsint, optional (Not supported in Dask)

        Maximum number of columns to display in the console.

      show_dimensionsbool, default False (Not supported in Dask)

        Display DataFrame dimensions (number of rows by number of columns).

      decimalstr, default ‘.’ (Not supported in Dask)

        Character recognized as decimal separator, e.g. ‘,’ in Europe.

    bold_rows bool, default True (Not supported in Dask)

      Make the row labels bold in the output.

    classes str or list or tuple, default None (Not supported in Dask)

      CSS class(es) to apply to the resulting html table.

    escape bool, default True (Not supported in Dask)

      Convert the characters <, >, and & to HTML-safe sequences.

    notebook{True, False}, default False (Not supported in Dask)

      Whether the generated HTML is for IPython Notebook.

    border int (Not supported in Dask)

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

    table_id str, optional (Not supported in Dask)

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

    render_links bool, default False (Not supported in Dask)

      Convert URLs to HTML links.

    encoding str, default “utf-8” (Not supported in Dask)

      Set character encoding.

  Returns:
    str or None

      If buf is None, returns the result as a string. Otherwise returns None.

  See also

  `to_string`

    Convert DataFrame to a string.

  Examples

      >>> df = pd.DataFrame(data={'col1': [1, 2], 'col2': [4, 3]})
      >>> html_string = '''<table border="1" class="dataframe">
      ...   <thead>
      ...     <tr style="text-align: right;">
      ...       <th></th>
      ...       <th>col1</th>
      ...       <th>col2</th>
      ...     </tr>
      ...   </thead>
      ...   <tbody>
      ...     <tr>
      ...       <th>0</th>
      ...       <td>1</td>
      ...       <td>4</td>
      ...     </tr>
      ...     <tr>
      ...       <th>1</th>
      ...       <td>2</td>
      ...       <td>3</td>
      ...     </tr>
      ...   </tbody>
      ... </table>'''
      >>> assert html_string == df.to_html()