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

API Reference

  • Core API
    • DataObject
    • Data Sets
    • Point Sets
      • pyvista.PointSet
      • pyvista.PolyData
      • pyvista.UnstructuredGrid
      • pyvista.StructuredGrid
      • pyvista.ExplicitStructuredGrid
        • add_field_array
        • add_field_data
        • cast_to_pointset
        • cast_to_unstructured_grid
        • cell_bounds
        • cell_centers
        • cell_coords
        • cell_data_to_point_data
        • cell_id
        • cell_n_points
        • cell_points
        • cell_type
        • center_of_mass
        • clear_arrays
        • clear_cell_arrays
        • clear_cell_data
        • clear_data
        • clear_field_arrays
        • clear_field_data
        • clear_point_arrays
        • clear_point_data
        • clear_textures
        • clip
        • clip_box
        • clip_scalar
        • clip_surface
        • compute_cell_quality
        • compute_cell_sizes
        • compute_connections
        • compute_connectivity
        • compute_derivative
        • compute_implicit_distance
        • connectivity
        • contour
        • copy
        • copy_attributes
        • copy_meta_from
        • copy_structure
        • ctp
        • decimate_boundary
        • deep_copy
        • delaunay_3d
        • elevation
        • extract_all_edges
        • extract_cells
        • extract_feature_edges
        • extract_geometry
        • extract_largest
        • extract_points
        • extract_surface
        • find_cells_along_line
        • find_cells_within_bounds
        • find_closest_cell
        • find_closest_point
        • find_containing_cell
        • flip_normal
        • flip_x
        • flip_y
        • flip_z
        • get_array
        • get_array_association
        • get_data_range
        • glyph
        • head
        • hide_cells
        • interpolate
        • merge
        • neighbors
        • outline
        • outline_corners
        • overwrite
        • plot
        • plot_curvature
        • plot_over_circular_arc
        • plot_over_circular_arc_normal
        • plot_over_line
        • point_data_to_cell_data
        • points_to_double
        • probe
        • ptc
        • reflect
        • remove_cells
        • rename_array
        • rotate_vector
        • rotate_x
        • rotate_y
        • rotate_z
        • sample
        • sample_over_circular_arc
        • sample_over_circular_arc_normal
        • sample_over_line
        • sample_over_multiple_lines
        • save
        • scale
        • select_enclosed_points
        • set_active_scalars
        • set_active_tensors
        • set_active_vectors
        • shallow_copy
        • show_cells
        • shrink
        • slice
        • slice_along_axis
        • slice_along_line
        • slice_orthogonal
        • split_bodies
        • streamlines
        • streamlines_evenly_spaced_2D
        • streamlines_from_source
        • surface_indices
        • tessellate
        • texture_map_to_plane
        • texture_map_to_sphere
        • threshold
        • threshold_percent
        • transform
        • translate
        • triangulate
        • warp_by_scalar
        • warp_by_vector
        • active_normals
        • active_scalars
        • active_scalars_info
        • active_scalars_name
        • active_t_coords
        • active_tensors
        • active_tensors_info
        • active_tensors_name
        • active_vectors
        • active_vectors_info
        • active_vectors_name
        • actual_memory_size
        • array_names
        • arrows
        • bounds
        • cell_arrays
        • cell_data
        • center
        • dimensions
        • extent
        • field_arrays
        • field_data
        • length
        • memory_address
        • n_arrays
        • n_cells
        • n_points
        • number_of_cells
        • number_of_points
        • point_arrays
        • point_data
        • points
        • t_coords
        • textures
        • vectors
        • visible_bounds
        • volume
    • Gridded Data
    • Composite Datasets
    • Filters
    • Cameras
    • Lights
    • Helpers
  • Plotting
  • Utilities
  • Readers
  • Examples

head#

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

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.