.. _gv-reference-api:
.. _tippy-gv-reference-api:

:fa:`file-lines` API Reference
******************************

GeoVista
========

.. py:module:: geovista

.. autoapi-nested-parse::

   
   Cartographic rendering and mesh analytics powered by PyVista.

   Provides:
     1. An agnostic bridge to transform rectilinear, curvilinear and unstructured
        geospatial data to native geolocated PyVista mesh instances.
     2. Compliments PyVista with cartographic features for processing, projecting
        and rendering geolocated meshes.
     3. Support for interactive 3D visualization of geolocated meshes.
     4. Coordinate Reference System (CRS) support, with an awareness of Cartopy
        CRSs through the commonality of the Python interface to PROJ (PyPROJ)
        package.












   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!


Submodules
----------

.. toctree::
   :maxdepth: 1

   /reference/generated/api/geovista/bridge/index
   /reference/generated/api/geovista/cache/index
   /reference/generated/api/geovista/common/index
   /reference/generated/api/geovista/config/index
   /reference/generated/api/geovista/core/index
   /reference/generated/api/geovista/crs/index
   /reference/generated/api/geovista/filters/index
   /reference/generated/api/geovista/geodesic/index
   /reference/generated/api/geovista/geometry/index
   /reference/generated/api/geovista/geoplotter/index
   /reference/generated/api/geovista/gridlines/index
   /reference/generated/api/geovista/pantry/index
   /reference/generated/api/geovista/qt/index
   /reference/generated/api/geovista/raster/index
   /reference/generated/api/geovista/report/index
   /reference/generated/api/geovista/search/index
   /reference/generated/api/geovista/themes/index
   /reference/generated/api/geovista/transform/index


Attributes
----------

.. autoapisummary::

   geovista.__version__


Functions
---------

.. autoapisummary::

   geovista.set_plot_theme


Package Contents
----------------

.. py:function:: set_plot_theme(theme, /, *, bootstrap = False)

   
   Set plotting parameters to a predefined theme.

   The enabled plot theme will be used by all plotters and rendering.

   Requests to enable a plot theme will be ignored when the environment variable
   ``GEOVISTA_DISABLE_PLOT_THEME`` is set.

   Note that the replaced theme is cached and may be restored with
   :func:`geovista.themes.restore_plot_theme`.

   :Parameters:

       **theme** : :obj:`Theme <pyvista.plotting.themes.Theme>` or :class:`python:str`
           The theme to apply, which may be either:
           
           * The string name of a registered theme. See :func:`pyvista.registered_themes`
             for the available :doc:`pyvista <pyvista:index>` built-in and
             third-party entry-point group themes.
           * A string ``package.module:ClassName`` dotted path to an importable
             :class:`pyvista.plotting.themes.Theme` subclass.
           * A :class:`pyvista.plotting.themes.Theme` subclass instance.

       **bootstrap** : :class:`python:bool`, default=False
           When ``True``, theme configuration is skipped if the environment
           variable ``PYVISTA_PLOT_THEME`` is set. Otherwise, the provided `theme`
           will be enabled regardless of that environment variable. This behaviour
           allows a pre-defined ``PYVISTA_PLOT_THEME`` to take precedence.



   :Returns:

       :class:`python:bool`
           ``True`` if the theme was successfully enabled, otherwise ``False``.




   :Raises:

       :obj:`ValueError`
           When `theme` is an invalid dotted path specification or cannot be imported.



   .. seealso::

       
       :func:`geovista.themes.restore_plot_theme`
           Reinstates the plot theme to the previous replaced theme.
       :func:`pyvista.registered_themes`
           The list of available registered themes.
       :class:`pyvista.plotting.themes.Theme`
           Base class for all themes. Subclasses with the class property ``_default_name`` are discoverable by :doc:`pyvista <pyvista:index>`.
       
       
   .. rubric:: Notes

   .. versionadded:: 0.6.0


   .. rubric:: Examples

   .. pyvista-plot::

      Set the default ``geovista`` theme.

      >>> import geovista as gv
      >>> gv.set_plot_theme("geovista")
      True

      Set the pyvista dark theme.

      >>> gv.set_plot_theme("dark")
      True

      Load a theme from an importable package module specified as a dotted path.

      >>> gv.set_plot_theme("geovista.themes:GeoVistaTheme")
      True

      Set the pyvista paraview theme.

      >>> from pyvista import themes
      >>> gv.set_plot_theme(themes.ParaViewTheme())
      True

      ..
          !! processed by numpydoc !!

.. py:data:: __version__
   :value: 'unknown'


   
   The ``major.minor.patch`` version string.
















   ..
       !! processed by numpydoc !!