Skip to content

API reference

Page Contents
Constructors & bulk factories Construct geometry values and packed coordinate columns.
Predicates Binary spatial relationships, coordinate probes, and DE-9IM predicates.
Measurement Area, length, distance, nearest points, and similarity measures.
Overlay & dissolve Binary set operations and reductions over geometry collections.
Constructive & validation Split, snap, polygonize, and validate geometry.
Coverage (polygonal) Validate, clean, simplify, and union edge-sharing polygon coverages.
Geodesy & navigation Bearings, destinations, route interpolation, and cross-track distance.
Index & join Spatial joins and nearest-neighbor queries over geometry columns.
I/O & interop Parse external representations, export coordinates, and build GeoJSON feature records.
Geometry Methods and properties shared by all geometry types.
Geometry types The seven typed geometry classes and the members unique to each type. Shared operations live on Geometry.
GeometryArray The immutable columnar geometry container, with NumPy-native results and the same operation names as Geometry.
Coordinates, parts & groups Coordinate views, multipart views, and grouped results.
CRS Coordinate reference systems, transformations, catalogs, and grid resources.
Grids & cells Grid-generic cells and the shared columnar CellArray container.
H3 H3 hexagonal cells, area covers, neighbors, directed edges, and vertices.
S2 S2 spherical cells, fixed-level and adaptive covers, and hierarchical cell sets.
Geohash Geohash tokens, rectangular cells, neighbors, and area covers.
XYZ tiles Web Mercator XYZ tiles, quadkeys, tile hierarchies, and area covers.
Point codes Plus-code and OSM-shortlink codecs using explicit longitude/latitude order.
Spatial index Bulk spatial indexing for repeated relationship queries.
Result types Named result values and aligned feature records returned by multi-output operations.
Errors Warnings and exceptions for geometry, CRS, transformation, and parsing failures.
Optional interoperability Convert dataframe columns, read and write GeoParquet, and display maps.
Public annotation forms Annotation meanings, named result records, and structured value shapes.

Route by result shape

Need Start here Contract
One scalar geometry or scalar fact Geometry A scalar input returns a scalar value or geometry.
Packed array and dense numeric result GeometryArray Array operations return row-aligned read-only NumPy arrays or a GeometryArray.
Missing rows Missing rows Missing rows remain row-aligned; fixed-width columns use sentinels and .is_missing is authoritative.
Coordinate axes Coordinates & dimensions Scalar coordinate_axes is one layout; array coordinate_axes is per row and common_coordinate_axes is shared-or-None.
Ragged matches or grouped output Groups ยท Features Groups stores row offsets; named result records keep related fields together.
Optional dataframe, storage, or map interop Optional interoperability Optional adapters are explicit extras; each page states copy, CRS, epoch, missing-row, and loss behavior.

Route by operation