pyvista.DataObject.head

DataObject.head(display: bool = True, html: bool | None = None) → str

Return the header stats of this dataset.

If in IPython, this will be formatted to HTML. Otherwise returns a console friendly string.

Parameters:

displaybool, default: True

Display this header in iPython.

htmlbool, optional

Generate the output as HTML.

Returns:

str

Header statistics.