:tocdepth: 3

:py:mod:`gws.plugin.alkis.data.exporter`
========================================

.. py:module:: gws.plugin.alkis.data.exporter

.. autoapi-nested-parse::

   ALKIS exporter.

   Export Flurstuecke to CSV or GeoJSON.



**Source code:** :source:`gws.plugin.alkis.data.exporter<gws/plugin/alkis/data/exporter.py>`



Module Contents
---------------



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


   Bases: :py:obj:`gws.Data`

   Arguments for the export operation.

   .. py:attribute:: format
      :type:  Format

      Export format.

   .. py:attribute:: fsList
      :type:  Iterable[gws.plugin.alkis.data.types.Flurstueck]

      Iterable of Flurstuecke to export.

   .. py:attribute:: groups
      :type:  list[Group]

      List of export groups to use.

   .. py:attribute:: progress
      :type:  Optional[gws.lib.cli.ProgressIndicator]

      Progress indicator to update during export.

   .. py:attribute:: user
      :type:  gws.User

      User who requested the export.


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


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

   Export configuration

   .. py:attribute:: format
      :type:  Optional[Format]

      Export format. (added in 8.2)

   .. py:attribute:: groups
      :type:  Optional[list[GroupConfig]]

      User-selectable export groups. (added in 8.2)


.. py:class:: Format(*args, **kwds)


   Bases: :py:obj:`gws.Enum`

   Export format.

   .. py:attribute:: csv
      :value: 'csv'


   .. py:attribute:: geojson
      :value: 'geojson'



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


   Bases: :py:obj:`gws.Data`

   Export group.

   .. py:attribute:: fieldNames
      :type:  list[str]

      List of field names from Model fields.

   .. py:attribute:: index
      :type:  int

      Ordinal index of the group.

   .. py:attribute:: keys
      :type:  set[str]

      Set of keys that are used in this group, e.g. `fs_recs_gemarkung_text`.

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

      Title to display in the ui.

   .. py:attribute:: withBuchung
      :type:  bool

      Whether to include Buchung data.

   .. py:attribute:: withEigentuemer
      :type:  bool

      Whether to include Eigentuemer data.


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


   Bases: :py:obj:`gws.Config`

   Export group configuration.

   .. py:attribute:: fields
      :type:  list[gws.ext.config.modelField]

      Fields to export.

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

      Title to display in the ui


.. py:class:: Model


   Bases: :py:obj:`gws.base.model.Object`

   .. py:method:: configure()


.. py:class:: Object


   Bases: :py:obj:`gws.Node`

   GWS object tree node.

   .. py:attribute:: format
      :type:  str

   .. py:attribute:: groups
      :type:  list[Group]

   .. py:attribute:: model
      :type:  Model

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: run(args: Args) -> tuple[str, str]

      Export a Flurstueck list to a temp file.

      :returns: A tuple (path, mime) where `path` is the path to the exported file and `mime` is the MIME type.