Skip to content

Region shapes

Chosen by "type" in shape.

Type What it is
rectangle An axis-aligned rectangle in the surface's coordinates.
circle A circle in the surface's coordinates, its radius in metres.

rectangle

An axis-aligned rectangle in the surface's coordinates.

Key Type Default Range Unit Description
min_x number 0.0 Lower edge along x in the surface's coordinates; the longitude in degrees on a sphere.
min_y number 0.0 Lower edge along y in the surface's coordinates; the latitude in degrees on a sphere.
max_x number 0.0 Upper edge along x in the surface's coordinates; the longitude in degrees on a sphere.
max_y number 0.0 Upper edge along y in the surface's coordinates; the latitude in degrees on a sphere.
Every key with its default
{
    "type": "rectangle",
    "min_x": 0.0,
    "min_y": 0.0,
    "max_x": 0.0,
    "max_y": 0.0
}

Used in: example_layers_regions

circle

A circle in the surface's coordinates, its radius in metres.

Key Type Default Range Unit Description
x number 0.0 Centre along x in the surface's coordinates; the longitude in degrees on a sphere.
y number 0.0 Centre along y in the surface's coordinates; the latitude in degrees on a sphere.
radius number 0.0 [0, inf) m Radius of the circle in metres, also on a sphere.
Every key with its default
{
    "type": "circle",
    "x": 0.0,
    "y": 0.0,
    "radius": 0.0
}

Used in: example_layers_regions