gws.base.map.action

Map related commands.

Source code: gws.base.map.action

Module Contents

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

Bases: gws.base.action.Config

Basic config with permissions.

class gws.base.map.action.DescribeLayerRequest(*args, **kwargs)

Bases: gws.Request

Command request.

layerUid: str

class gws.base.map.action.DescribeLayerResponse(*args, **kwargs)

Bases: gws.Request

Command request.

content: str

class gws.base.map.action.GetBoxRequest(*args, **kwargs)

Bases: gws.Request

Command request.

bbox: gws.Extent

crs: gws.CrsName | None

dpi: int | None

height: int

layers: list[str] | None

layerUid: str

width: int

class gws.base.map.action.GetFeaturesRequest(*args, **kwargs)

Bases: gws.Request

Command request.

bbox: gws.Extent | None

crs: gws.CrsName | None

layerUid: str

limit: int = 0

modelUid: str | None

resolution: float | None

views: list[str] | None

class gws.base.map.action.GetFeaturesResponse(*args, **kwargs)

Bases: gws.Response

Command response.

features: list[gws.FeatureProps]

class gws.base.map.action.GetLegendRequest(*args, **kwargs)

Bases: gws.Request

Command request.

layerUid: str

class gws.base.map.action.GetXyzRequest(*args, **kwargs)

Bases: gws.Request

Command request.

layerUid: str

x: int

y: int

z: int

class gws.base.map.action.ImageResponse(*args, **kwargs)

Bases: gws.Response

Command response.

content: bytes

mime: str

class gws.base.map.action.Object

Bases: gws.base.action.Object

Generic action object, the parent of all action objects.

api_get_box(req: gws.WebRequester, p: GetBoxRequest) → ImageResponse

Get a part of the map inside a bounding box

api_get_features(req: gws.WebRequester, p: GetFeaturesRequest) → GetFeaturesResponse

Get a list of features in a bounding box

api_get_legend(req: gws.WebRequester, p: GetLegendRequest) → ImageResponse

Get a legend for a layer

api_get_xyz(req: gws.WebRequester, p: GetXyzRequest) → ImageResponse

Get an XYZ tile

describe_layer(req: gws.WebRequester, p: DescribeLayerRequest) → DescribeLayerResponse

http_get_box(req: gws.WebRequester, p: GetBoxRequest) → gws.ContentResponse

http_get_features(req: gws.WebRequester, p: GetFeaturesRequest) → gws.ContentResponse

http_get_legend(req: gws.WebRequester, p: GetLegendRequest) → gws.ContentResponse

http_get_xyz(req: gws.WebRequester, p: GetXyzRequest) → gws.ContentResponse

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

Bases: gws.base.action.Props

Object properties.