`gws.base.search.finder`¶

Source code: gws.base.search.finder

Module Contents¶

class gws.base.search.finder.Config(*args, **kwargs)¶

Bases: gws.ConfigWithAccess

Finder configuration.

category: str | None¶: Category for the finder. (added in 8.2)

models: list[gws.ext.config.model] | None¶: Data models for features.

spatialContext: SpatialContext | None¶: Spatial context for keyword searches.

templates: list[gws.ext.config.template] | None¶: Feature formatting templates.

title: str | None¶: Finder title.

withFilter: bool = True¶: Enable filter search.

withGeometry: bool = True¶: Enable geometry search.

withKeyword: bool = True¶: Enable keyword search.

class gws.base.search.finder.Object¶

Bases: gws.Finder

Finder object.

spatialContext: SpatialContext¶

can_run(search, user)¶

configure()¶: Configuration hook.

configure_models()¶

configure_templates()¶

context_shape(search: gws.SearchQuery) → gws.Shape¶

run(search, user, layer=None)¶

class gws.base.search.finder.SpatialContext(*args, **kwds)¶

Bases: gws.Enum

Spatial context for keyword searches.

map = 'map'¶: Search in the map extent.

view = 'view'¶: Search in the client view extent.