:tocdepth: 3

:py:mod:`gws.base.exporter`
===========================

.. py:module:: gws.base.exporter


**Source code:** :source:`gws.base.exporter<gws/base/exporter/__init__.py>`


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   action/index.rst
   core/index.rst
   manager/index.rst
   worker/index.rst



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



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   Exporter configuration.

   .. py:attribute:: target
      :type:  gws.ExportTarget

      Target export type.

   .. py:attribute:: targetPath
      :type:  Optional[str]

      Target export path (if applicable).

   .. py:attribute:: title
      :type:  str

      Exporter title.


.. py:class:: Object


   Bases: :py:obj:`gws.Exporter`

   Exporter object.

   .. py:attribute:: supportsRaster
      :type:  bool

   .. py:attribute:: supportsVector
      :type:  bool

   .. py:attribute:: title
      :type:  str

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: notify(ea: ExportArgs, event: str)

      Notify exporter of export events.


   .. py:method:: props(user) -> Props

      Return exporter properties.



.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.Props`

   Exporter properties.

   .. py:attribute:: supportsRaster
      :type:  bool

      Whether exporter supports raster features.

   .. py:attribute:: supportsVector
      :type:  bool

      Whether exporter supports vector features.

   .. py:attribute:: title
      :type:  str

      Exporter title.