Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.Polygon.serialize
Stay organized with collections
Save and categorize content based on your preferences.
Returns the serialized representation of this object.
Usage | Returns | Polygon.serialize(legacy) | String |
Argument | Type | Details | this: geometry | Geometry | The Geometry instance. |
legacy | Boolean, optional | Enables legacy format. |
Examples
Code Editor (JavaScript)
// Define a Polygon object.
var polygon = ee.Geometry.Polygon(
[[[-122.092, 37.424],
[-122.086, 37.418],
[-122.079, 37.425],
[-122.085, 37.423]]]);
// Apply the serialize method to the Polygon object.
var polygonSerialize = polygon.serialize();
// Print the result to the console.
print('polygon.serialize(...) =', polygonSerialize);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(polygon,
{'color': 'black'},
'Geometry [black]: polygon');
Python setup
See the
Python Environment page for information on the Python API and using
geemap
for interactive development.
import ee
import geemap.core as geemap
Colab (Python)
# Define a Polygon object.
polygon = ee.Geometry.Polygon([[
[-122.092, 37.424],
[-122.086, 37.418],
[-122.079, 37.425],
[-122.085, 37.423],
]])
# Apply the serialize method to the Polygon object.
polygon_serialize = polygon.serialize()
# Print the result.
display('polygon.serialize(...) =', polygon_serialize)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(polygon, {'color': 'black'}, 'Geometry [black]: polygon')
m
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eserialize()\u003c/code\u003e method returns a serialized (string) representation of a given Earth Engine Geometry object, such as a Polygon.\u003c/p\u003e\n"],["\u003cp\u003eThis method can be used to convert a Geometry object into a format suitable for storage or transmission.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003elegacy\u003c/code\u003e argument can be provided to enable legacy formatting if needed.\u003c/p\u003e\n"],["\u003cp\u003eExamples in JavaScript and Python demonstrate using \u003ccode\u003eserialize()\u003c/code\u003e with a Polygon Geometry.\u003c/p\u003e\n"]]],["The `serialize` method returns a string representation of a Geometry object, specifically a Polygon in this case. It accepts an optional boolean argument, `legacy`, to enable a legacy format. The examples demonstrate creating a Polygon object and then serializing it using `polygon.serialize()`. The result is then printed, and the polygon is displayed on a map using both JavaScript and Python environments. The method serializes the polygon into a string.\n"],null,["# ee.Geometry.Polygon.serialize\n\n\u003cbr /\u003e\n\nReturns the serialized representation of this object.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|---------------------------------|---------|\n| Polygon.serialize`(`*legacy*`)` | String |\n\n| Argument | Type | Details |\n|------------------|-------------------|------------------------|\n| this: `geometry` | Geometry | The Geometry instance. |\n| `legacy` | Boolean, optional | Enables legacy format. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Define a Polygon object.\nvar polygon = ee.Geometry.Polygon(\n [[[-122.092, 37.424],\n [-122.086, 37.418],\n [-122.079, 37.425],\n [-122.085, 37.423]]]);\n\n// Apply the serialize method to the Polygon object.\nvar polygonSerialize = polygon.serialize();\n\n// Print the result to the console.\nprint('polygon.serialize(...) =', polygonSerialize);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(polygon,\n {'color': 'black'},\n 'Geometry [black]: polygon');\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\n# Define a Polygon object.\npolygon = ee.Geometry.Polygon([[\n [-122.092, 37.424],\n [-122.086, 37.418],\n [-122.079, 37.425],\n [-122.085, 37.423],\n]])\n\n# Apply the serialize method to the Polygon object.\npolygon_serialize = polygon.serialize()\n\n# Print the result.\ndisplay('polygon.serialize(...) =', polygon_serialize)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(polygon, {'color': 'black'}, 'Geometry [black]: polygon')\nm\n```"]]