Skip to main content

Places, coordinates, and administrative areas

Generated from the same registry as the Chinese reference. Contract version: 0.5-session. Edit the registry and reviewed English catalog, then rerun script_contract; do not edit this file. See the script guide.

Platform labels below are registry declarations, not device acceptance. Consult the platform coverage guide for actual host coverage and limits. These are the existing gis compatibility-module APIs; the shared sqsmap map facade is documented separately.

gis.places

gis.places.search

Search province/city/county/township candidates by name, abbreviation, or administrative path. Return match scores, center, and bounds; preserve ambiguous candidates.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.search(arg0: string, arg1?: PlaceSearchOptions): Operation<Page<Place>>

gis.places.get

Read place details, center, bounds, and parent by administrative code or an unambiguous name.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.get(arg0: PlaceInput): Operation<Place>

gis.places.children

List immediate administrative children.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.children(arg0: PlaceInput, arg1?: PageOptions): Operation<Page<Place>>

gis.places.reverse

Find the province, city, county, and township containing coordinates using downloaded administrative boundaries.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.reverse(arg0: [number,number]): Operation<PlaceHierarchy>

gis.places.nearest

Find nearest places, townships by default, ordered by distance in meters.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.nearest(arg0: [number,number], arg1?: PlaceNearestOptions): Operation<NearbyPlace[]>

gis.places.boundary

Acquire WGS84 administrative polygon boundaries over the network for display, clipping, or statistics; children:true requests all immediate child boundaries.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.boundary(arg0: PlaceInput, arg1?: PlaceBoundaryOptions): Operation<DatasetRef>

gis.places.parseCoordinate

Parse user-supplied geographic coordinates in decimal or DMS notation, including E/N or Chinese direction labels; correct reversed order when unambiguous.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: places.parseCoordinate(arg0: string): Operation<[number,number] | null>