Class GeoJsonCodec<TFeature, TForeignMembers>

A GeoJsonCodec is responsible for main tasks:

• Encoding Feature instances into a JavaScript object that adheres to the GeoJSON specification The codec encodes the shape of the feature to GeoJSON geometries as follows:

  • Point Polyline and Polygon instances are mapped to GeoJSON Points, LineStrings, and Polygons respectively.
  • ComplexPolygon instances are all mapped to GeoJSON Polygons.
  • A LuciadRIA feature without a shape is encoded into a GeoJSON feature without a geometry
  • ShapeList is always mapped to a GeoJSON GeometryCollection when GeoJsonCodecConstructorOptions.encodeShapeListAsGeometryCollection is set to 'true'.

    Otherwise ShapeList is mapped based on its contents:

    • Point and Polyline instances are mapped to GeoJSON MultiPoint and MultiLineString geometries respectively.
    • Polygon and ComplexPolygon instances are mapped to GeoJSON MultiPolygon.
    • ShapeList that contains an arbitrary mix of shapes is mapped to GeoJSON GeometryCollections.

• Decoding a GeoJSON JavaScript object into a set of LuciadRIA Feature instances, each containing corresponding LuciadRIA geometries and properties.

  Since there's no direct mapping from a GeoJSON geometry to a LuciadRIA shape, the codec decodes GeoJSON geometries as follows:

  • GeoJSON Points, LineStrings, and single ring Polygons are mapped to LuciadRIA Point, Polyline, and Polygon instances respectively.
  • A GeoJSON single multi ring Polygon is mapped to ComplexPolygon.
  • MultiPoints, MultiLineStrings, MultiPolygons are all mapped to a ShapeList of Point, Polyline, and Polygon instances respectively.
  • GeometryCollections are mapped to ShapeList instances.
  • A null geometry translates into a Feature with a null shape.

  Note: According to the GeoJSON specification, the first and last position of a GeoJSON polygon must be equivalent. The codec removes this duplicate point when decoding the GeoJSON polygon to a LuciadRIA geometry.

Spatial reference

The reference used during the shape decoding process is determined in the following order:

• The reference supplied to the decode method. This can be used if you need to override the reference for a specific decode request.
• The reference supplied to the constructor. This can be used to set a consistent reference across all decoding. Note that this can still be overridden on a per-request basis via the decode
• The reference specified in the data using the legacy crs field. This will be used if no reference is provided in either of the first two steps.
• If no reference is specified in any of the above methods, the default WGS:84 reference from the GeoJSON specification is used.

Limitations

GeoJSON does not support any other shapes than Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, GeometryCollection. Therefore, it cannot support all LuciadRIA shapes. For instance, a Circle cannot be directly represented as a circle in GeoJSON. Handling such shapes requires a custom codec, as demonstrated in the CreateEdit sample.