Module: RGeo::GeoJSON

Defined in:
lib/rgeo/geo_json/coder.rb,
lib/rgeo/geo_json/version.rb,
lib/rgeo/geo_json/entities.rb,
lib/rgeo/geo_json/interface.rb

Defined Under Namespace

Classes: Coder, EntityFactory, Feature, FeatureCollection

Constant Summary collapse

VERSION =
"2.1.1"

Class Method Summary collapse

Class Method Details

.coder(opts = {}) ⇒ Object

Creates and returns a coder object of type RGeo::GeoJSON::Coder that encapsulates encoding and decoding settings (principally the RGeo::Feature::Factory and the RGeo::GeoJSON::EntityFactory to be used).

The geo factory is a required argument. Other options include:

:geo_factory

Specifies the geo factory to use to create geometry objects. Defaults to the preferred cartesian factory.

:entity_factory

Specifies an entity factory, which lets you override the types of GeoJSON entities that are created. It defaults to the default RGeo::GeoJSON::EntityFactory, which generates objects of type RGeo::GeoJSON::Feature or RGeo::GeoJSON::FeatureCollection. See RGeo::GeoJSON::EntityFactory for more information.


56
57
58
# File 'lib/rgeo/geo_json/interface.rb', line 56

def coder(opts = {})
  Coder.new(opts)
end

.decode(input_, opts = {}) ⇒ Object

High-level convenience routine for decoding an object from GeoJSON. The input may be a JSON hash, a String, or an IO object from which to read the JSON string.

Options include:

:geo_factory

Specifies the geo factory to use to create geometry objects. Defaults to the preferred cartesian factory.

:entity_factory

Specifies an entity factory, which lets you override the types of GeoJSON entities that are created. It defaults to the default RGeo::GeoJSON::EntityFactory, which generates objects of type RGeo::GeoJSON::Feature or RGeo::GeoJSON::FeatureCollection. See RGeo::GeoJSON::EntityFactory for more information.


36
37
38
# File 'lib/rgeo/geo_json/interface.rb', line 36

def decode(input_, opts = {})
  Coder.new(opts).decode(input_)
end

.encode(object, opts = {}) ⇒ Object

High-level convenience routine for encoding an object as GeoJSON. Pass the object, which may one of the geometry objects specified in RGeo::Feature, or an appropriate GeoJSON wrapper entity such as RGeo::GeoJSON::Feature or RGeo::GeoJSON::FeatureCollection.

The only option supported is :entity_factory, which lets you override the types of GeoJSON entities supported. See RGeo::GeoJSON::EntityFactory for more information. By default, encode supports objects of type RGeo::GeoJSON::Feature and RGeo::GeoJSON::FeatureCollection.


17
18
19
# File 'lib/rgeo/geo_json/interface.rb', line 17

def encode(object, opts = {})
  Coder.new(opts).encode(object)
end