GeoDataFrame.to_json

Returns a GeoJSON representation of the GeoDataFrame as a string.

Signature

to_json(
    na: Literal['null', 'drop', 'keep'] = 'null',
    show_bbox: bool = False,
    drop_id: bool = False,
    to_wgs84: bool = False,
    **kwargs,
) -> str

Parameters

Literal['null', 'drop', 'keep']

default:"'null'"

Dictates how to represent missing (NaN) values in the output.

null: Outputs missing entries as JSON null.
drop: Removes the entire property from a feature if its value is missing.
keep: Outputs missing entries as NaN.

bool

default:"False"

If True, the bbox (bounds) of the geometries is included in the output.

bool

default:"False"

If True, the GeoDataFrame index is not written to the ‘id’ field of each GeoJSON Feature.

bool

default:"False"

If True, all geometries are transformed to WGS84 (EPSG:4326) to meet the 2016 GeoJSON specification. When False, the current CRS is exported if it’s set.

Additional keyword arguments passed to json.dumps().

Returns

str

A GeoJSON representation of the GeoDataFrame.

See also

GeoDataFrame.to_file: Write a GeoDataFrame to a file, which can be
used for GeoJSON format.

See also

GeoDataFrame.to_file: write GeoDataFrame to file

Examples

>>> from sedona.spark.geopandas import GeoDataFrame
>>> from shapely.geometry import Point
>>> d = {'col1': ['name1', 'name2'], 'geometry': [Point(1, 2), Point(2, 1)]}
>>> gdf = GeoDataFrame(d, crs="EPSG:3857")
>>> gdf.to_json()
'{"type": "FeatureCollection", "features": [{"id": "0", "type": "Feature", "properties": {"col1": "name1"}, "geometry": {"type": "Point", "coordinates": [1.0, 2.0]}}, {"id": "1", "type": "Feature", "properties": {"col1": "name2"}, "geometry": {"type": "Point", "coordinates": [2.0, 1.0]}}], "crs": {"type": "name", "properties": {"name": "urn:ogc:def:crs:EPSG::3857"}}}'

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples