Skip to content

GetSpritesRequest

Source code in docs_src/capo_geo_maps/types/get_sprites_request.py 
13
14
15
16
17
18
19
20
21
class GetSpritesRequest(TypedDict, closed=True):
    file_name: "str"
    r"""<p> <code>Sprites</code> API: The name of the sprite file to retrieve, following pattern <code>sprites(@2x)?\.(png|json)</code>.</p> <p>Example: <code>sprites.png</code> </p>"""
    style: "capo_geo_maps.types.map_style.MapStyle"
    """<p>Style specifies the desired map style for the <code>Sprites</code> APIs.</p>"""
    color_scheme: "capo_geo_maps.types.color_scheme.ColorScheme"
    """<p>Sets the color tone for the map sprites, such as dark and light.</p> <p>Example: <code>Light</code> </p> <p>Default value: <code>Light</code> </p> <note> <p>Valid values for ColorScheme are case sensitive.</p> </note>"""
    variant: "capo_geo_maps.types.variant.Variant"
    """<p>Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.</p> <p>Example: <code>Default</code> </p> <note> <p>Valid values for Variant are case sensitive.</p> </note>"""

color_scheme instance-attribute 

color_scheme: ColorScheme

Sets the color tone for the map sprites, such as dark and light.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

file_name instance-attribute 

file_name: str

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\.(png|json).

Example: sprites.png

style instance-attribute 

style: MapStyle

Style specifies the desired map style for the Sprites APIs.

variant instance-attribute 

variant: Variant

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.