API Reference

Description

The Polygon type defines a closed, two-dimensional shape on the Earth's surface, formed by connecting a sequence of vertices with geodesic line segments (i.e., great circle arcs). It enables precise representation of geographical areas, including outer boundaries and optional inner rings, making it essential for tasks like mapping, spatial analysis, and geographic data management.

Vertices should be specified in an order such that the left of the edge denotes the inside. For small polygons, this means the exterior ring should be specified in counter-clockwise order, and holes should be clockwise. Inner rings must be contained by the outer ring and inner rings can't intersect each other.

Attributes

AttributeTypeDescription
outerRingThe Polygon's outer most ring.
innersrepeated RingThe Polygon's optional inner rings (i.e., holes).

Proto Definition

message Polygon {
  Ring outer = 1;
  repeated Ring inners = 2;
}