Module: Cartographie

Defined in:
lib/cartographie.rb,
lib/cartographie/map.rb,
lib/cartographie/config.rb,
lib/cartographie/version.rb

Overview

Cartographie is the root module for all of Cartographie’s components

Defined Under Namespace

Modules: Config Classes: Map

Constant Summary collapse

VERSION =
'0.0.4'

Class Method Summary collapse

Class Method Details

.configure(&block) ⇒ Object



29
30
31
# File 'lib/cartographie.rb', line 29

def self.configure(&block)
  Cartographie::Config.configure(&block)
end

.map(location = 'Paris, France', options = {}) ⇒ Object

Public: Create a new Map instance.

location - The String for the map’s location (default: ‘Paris, France’). options - The Hash options used to configure the map (default: {}):

:width       - The Integer width of the map (optional).
:height      - The Integer height of the map (optional).
:zoom        - The Integer zoom level (optional).
:file_format - The String file format for the image (optional).
:sensor      - The Boolean indicating GPS usage (optional).

Examples

Cartographie.map('Tokyo, Japan')
Cartographie.map('San Francisco, CA', zoom: 10)

Returns an instance of Cartographie::Map



25
26
27
# File 'lib/cartographie.rb', line 25

def self.map(location = 'Paris, France', options={})
  Map.new(location, options)
end