logo
  • Getting Started
  • User Guide
  • Examples
  • API Reference
  • Extras

API Reference

  • Core API
    • DataObject
      • pyvista.DataObject
        • add_field_array
        • add_field_data
        • clear_field_arrays
        • clear_field_data
        • copy
        • copy_attributes
        • copy_meta_from
        • copy_structure
        • deep_copy
        • get_data_range
        • head
        • save
        • shallow_copy
        • actual_memory_size
        • field_arrays
        • field_data
        • memory_address
      • pyvista.Table
    • Data Sets
    • Point Sets
    • Gridded Data
    • Composite Datasets
    • Filters
    • Cameras
    • Lights
    • Helpers
  • Plotting
  • Utilities
  • Readers
  • Examples

head#

DataObject.head(display=True, html: Optional[bool] = None)[source]#

Return the header stats of this dataset.

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

Parameters
displaybool, optional

Display this header in iPython.

htmlbool, optional

Generate the output as HTML.

Returns
str

Header statistics.

© Copyright 2017-2022, The PyVista Developers.

Created using Sphinx 4.5.0.