aio_taginfo.api.v4.site.config.geodistribution

/api/4/site/geodistribution endpoint.

 1"""`/api/4/site/geodistribution` endpoint."""
 2
 3from aio_taginfo.api.v4._internal import api_get_json
 4
 5from aiohttp import ClientSession
 6from pydantic import Field
 7from pydantic.dataclasses import dataclass
 8
 9
10__all__ = (
11    "call",
12    "SiteConfigGeodistribution",
13)
14
15
16async def call(session: ClientSession | None = None) -> "SiteConfigGeodistribution":
17    """
18    Get information about the background map for distribution charts.
19
20    https://taginfo.openstreetmap.org/taginfo/apidoc#api_4_site_config_geodistribution
21
22    Args:
23        session: request client session
24
25    Raises:
26        TaginfoError
27    """
28    return await api_get_json(
29        path="/api/4/site/config/geodistribution",
30        cls=SiteConfigGeodistribution,
31        session=session,
32    )
33
34
35@dataclass(kw_only=True, frozen=True)
36class SiteConfigGeodistribution:
37    """
38    Information about the background map for distribution charts.
39
40    Attributes:
41        width: width of background image
42        height: height of background image
43        scale_image: scale factor for images
44        scale_compare_image: scale factor for comparison images
45        background_image: URL of background image
46        image_attribution: map attribution for comparison background
47    """
48
49    width: int = Field(gt=0, repr=True)
50    height: int = Field(gt=0, repr=True)
51    scale_image: float = Field(gt=0.0, allow_inf_nan=False, repr=True)
52    scale_compare_image: float = Field(gt=0.0, allow_inf_nan=False, repr=True)
53    background_image: str = Field(repr=True)
54    image_attribution: str = Field(repr=True)
55
56
57__docformat__ = "google"
async def call( session: aiohttp.client.ClientSession | None = None) -> SiteConfigGeodistribution: 
17async def call(session: ClientSession | None = None) -> "SiteConfigGeodistribution":
18    """
19    Get information about the background map for distribution charts.
20
21    https://taginfo.openstreetmap.org/taginfo/apidoc#api_4_site_config_geodistribution
22
23    Args:
24        session: request client session
25
26    Raises:
27        TaginfoError
28    """
29    return await api_get_json(
30        path="/api/4/site/config/geodistribution",
31        cls=SiteConfigGeodistribution,
32        session=session,
33    )

Get information about the background map for distribution charts.

https://taginfo.openstreetmap.org/taginfo/apidoc#api_4_site_config_geodistribution

Arguments:
  • session: request client session
Raises:
  • TaginfoError
@dataclass(kw_only=True, frozen=True)
class SiteConfigGeodistribution: 
36@dataclass(kw_only=True, frozen=True)
37class SiteConfigGeodistribution:
38    """
39    Information about the background map for distribution charts.
40
41    Attributes:
42        width: width of background image
43        height: height of background image
44        scale_image: scale factor for images
45        scale_compare_image: scale factor for comparison images
46        background_image: URL of background image
47        image_attribution: map attribution for comparison background
48    """
49
50    width: int = Field(gt=0, repr=True)
51    height: int = Field(gt=0, repr=True)
52    scale_image: float = Field(gt=0.0, allow_inf_nan=False, repr=True)
53    scale_compare_image: float = Field(gt=0.0, allow_inf_nan=False, repr=True)
54    background_image: str = Field(repr=True)
55    image_attribution: str = Field(repr=True)

Information about the background map for distribution charts.

Attributes:
  • width: width of background image
  • height: height of background image
  • scale_image: scale factor for images
  • scale_compare_image: scale factor for comparison images
  • background_image: URL of background image
  • image_attribution: map attribution for comparison background
SiteConfigGeodistribution(*args: Any, **kwargs: Any) 
139    def __init__(__dataclass_self__: PydanticDataclass, *args: Any, **kwargs: Any) -> None:
140        __tracebackhide__ = True
141        s = __dataclass_self__
142        s.__pydantic_validator__.validate_python(ArgsKwargs(args, kwargs), self_instance=s)
width: int = FieldInfo(annotation=int, required=True, metadata=[Gt(gt=0)])
height: int = FieldInfo(annotation=int, required=True, metadata=[Gt(gt=0)])
scale_image: float = FieldInfo(annotation=float, required=True, metadata=[Gt(gt=0.0), _PydanticGeneralMetadata(allow_inf_nan=False)])
scale_compare_image: float = FieldInfo(annotation=float, required=True, metadata=[Gt(gt=0.0), _PydanticGeneralMetadata(allow_inf_nan=False)])
background_image: str = FieldInfo(annotation=str, required=True)
image_attribution: str = FieldInfo(annotation=str, required=True)