`gws.base.search.action`¶

Search API.

Source code: gws.base.search.action

Module Contents¶

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

Bases: gws.base.action.Config

Search action

limit: int = 1000¶: search results limit

tolerance: gws.UomValueStr | None¶: default tolerance

class gws.base.search.action.Props(*args, **kwargs)¶

Bases: gws.base.action.Props

Object properties.

class gws.base.search.action.Request(*args, **kwargs)¶

Bases: gws.Request

Command request.

crs: gws.CrsName | None¶

extent: gws.Extent | None¶

keyword: str = ''¶

layerUids: list[str]¶

limit: int | None¶

resolution: float¶

shapes: list[gws.base.shape.Props] | None¶

tolerance: str | None¶

views: list[str] | None¶

class gws.base.search.action.Response(*args, **kwargs)¶

Bases: gws.Response

Command response.

features: list[gws.FeatureProps]¶

class gws.base.search.action.Object¶

Bases: gws.base.action.Object

Generic action object, the parent of all action objects.

limit = 0¶

tolerance: gws.UomValue¶

configure()¶: Configuration hook.

find(req: gws.WebRequester, p: Request) → Response¶: Perform a search