:tocdepth: 3

:py:mod:`gws.base.search.finder`
================================

.. py:module:: gws.base.search.finder


**Source code:** :source:`gws.base.search.finder<gws/base/search/finder.py>`



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



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


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

   Finder configuration.

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

      Category for the finder. (added in 8.2)

   .. py:attribute:: models
      :type:  Optional[list[gws.ext.config.model]]

      Data models for features.

   .. py:attribute:: spatialContext
      :type:  Optional[SpatialContext]

      Spatial context for keyword searches.

   .. py:attribute:: templates
      :type:  Optional[list[gws.ext.config.template]]

      Feature formatting templates.

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

      Finder title.

   .. py:attribute:: withFilter
      :type:  bool
      :value: True


      Enable filter search.

   .. py:attribute:: withGeometry
      :type:  bool
      :value: True


      Enable geometry search.

   .. py:attribute:: withKeyword
      :type:  bool
      :value: True


      Enable keyword search.


.. py:class:: Object


   Bases: :py:obj:`gws.Finder`

   Finder object.

   .. py:attribute:: spatialContext
      :type:  SpatialContext

   .. py:method:: can_run(search, user)

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_models()

   .. py:method:: configure_templates()

   .. py:method:: context_shape(search: gws.SearchQuery) -> gws.Shape

   .. py:method:: run(search, user, layer=None)


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


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

   Spatial context for keyword searches.

   .. py:attribute:: map
      :value: 'map'


      Search in the map extent.

   .. py:attribute:: view
      :value: 'view'


      Search in the client view extent.