:tocdepth: 3

:py:mod:`core`
==============

.. py:module:: core

.. autoapi-nested-parse::

   Interface with GekoS-Bau software.

   See https://www.gekos.de/

   GekoS settings for gws (Verfahrensadministration/GIS Schnittstelle)

   base address:

       GIS-URL-Base  = http://my-server

   client-side call, handled in the client by the Marker element

       GIS-URL-ShowXY  = /project/PROJECT_ID/?x=<x>&y=<y>&z=SCALE_VALUE

   client-side call, handled in the client by js/index.tsx

       GIS-URL-GetXYFromMap = /project/PROJECT_ID/?&x=<x>&y=<y>&gekosUrl=<returl>

   client-side call, handled in the Alkis plugin

       GIS-URL-ShowFs = /project/PROJECT_ID/?alkisFs=<land>_<gem>_<flur>_<zaehler>_<nenner>_<folge>

   callback urls, handled by the GekoS action

       GIS-URL-GetXYFromFs   = /_/gekosGetXY/projectUid/PROJECT_ID/fs/<land>_<gem>_<flur>_<zaehler>_<nenner>_<folge>
       GIS-URL-GetXYFromGrd  = /_/gekosGetXY/projectUid/PROJECT_ID/ad/<str>_<hnr><hnralpha>_<plz>_<ort>_<bishnr><bishnralpha>

   NB: the order of placeholders must match COMBINED_FLURSTUECK_FIELDS and COMBINED_ADRESSE_FIELDS in the Alkis Plugin



**Source code:** :source:`core<gws/plugin/gekos/core.py>`



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



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


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

   Configuration for the GekoS index.

   .. py:attribute:: crs
      :type:  gws.CrsName

      CRS for GekoS data.

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

      Database provider uid.

   .. py:attribute:: position
      :type:  Optional[PositionConfig]

      Position correction for points.

   .. py:attribute:: sources
      :type:  list[SourceConfig]

      List of gek-online sources.

   .. py:attribute:: tableName
      :type:  str

      SQL table name for storing GekoS data.


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


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

   Position correction for points.

   .. py:attribute:: angle
      :type:  int
      :value: 0


      Angle for points repelling.

   .. py:attribute:: distance
      :type:  int
      :value: 0


      Radius for points repelling.

   .. py:attribute:: offsetX
      :type:  int

      X-offset for points.

   .. py:attribute:: offsetY
      :type:  int

      Y-offset for points.


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


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

   Configuration for a gek-online source.

   .. py:attribute:: instance
      :type:  str

      Instance name for gek-online calls, used to create unique uids.

   .. py:attribute:: params
      :type:  dict

      Parameters for gek-online calls.

   .. py:attribute:: url
      :type:  gws.Url

      Base URL for gek-online calls.