Class: Leafleter

Inherits:
Object
  • Object
show all
Defined in:
lib/leafleter.rb

Class Method Summary collapse

Class Method Details

.get_circle_marker(text, lat, lon, radius_in_px = 10, options = {}) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/leafleter.rb', line 143

def self.get_circle_marker(text, lat, lon, radius_in_px = 10, options = {})
  location = get_location(lat, lon)
  option_string = ""
  if options != {}
    option_string = ", {"
    options.each do |pair|
      option_string += "\t#{pair[0]}: #{pair[1]},"
    end
    option_string += "\n}"
  end
  # docs at https://leafletjs.com/reference-1.4.0.html#circlemarker
  return "L.circleMarker(" + location + option_string + ").setRadius(#{radius_in_px}).addTo(map).bindPopup(\"" + text + ".\");\n"
end

.get_gray_transformed_osm_carto_tile_layer ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/leafleter.rb', line 20

def self.get_gray_transformed_osm_carto_tile_layer
    return "L.tileLayer('https://tiles.wmflabs.org/bw-mapnik/${z}/${x}/${y}.png', {
      attribution: '#{openstreetmap_copyright_notice}',
      subdomains: 'abcd',
      maxZoom: 19
  })"
end

.get_grayscale_tile_layer ⇒ Object 



8
9
10
 
# File 'lib/leafleter.rb', line 8

def self.get_grayscale_tile_layer
  return self.get_positron_tile_layer
end

.get_html_page_prefix(title, lat_centered, lon_centered, zlevel_centered: 13, tile_layer: get_standard_OSM_tile_layer, width_percent: 100, sidebar_content: "", css: nil) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/leafleter.rb', line 89

def self.get_html_page_prefix(title, lat_centered, lon_centered, zlevel_centered: 13, tile_layer: get_standard_OSM_tile_layer, width_percent: 100, sidebar_content: "", css: nil)
  # asserts for parameters, I wasted over 1 hour on bug that would be caught by this
  zlevel_centered.to_f
  lat_centered.to_f
  lon_centered.to_f
  width_percent.to_f
  raise if width_percent > 100
  raise if width_percent <= 0
  raise if zlevel_centered <= 0
  ######

  returned = "
  #{get_standard_prefix_of_any_html_page(title)}
  #{get_leaflet_dependencies}
"
  unless css.nil?
    returned += '<link rel="stylesheet" type="text/css" href="' + css + '" />'
  end
  returned += "<style>\n"
  returned += self.map_area_part_of_styling(width_percent)
  returned += self.internal_leaflet_styling_part()
  returned += self.recoloured_markers_styling()
  returned +=
    "\n    </style>
    </head>
    <body>
      <div id=\"map\"></div><div id=\"pane\">#{sidebar_content}</div>

      <script>
        var map = L.map('map').setView([" + "#{lat_centered}, #{lon_centered}], #{zlevel_centered}" + ");
        mapLink = '<a href=\"http://openstreetmap.org\">OpenStreetMap</a>';
        #{tile_layer}.addTo(map);
"
  return returned
end

.get_html_page_suffix ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/leafleter.rb', line 125

def self.get_html_page_suffix
  return "
</script>
</body>
</html>
"
end

.get_leaflet_dependencies ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/leafleter.rb', line 44

def self.get_leaflet_dependencies
  # see https://leafletjs.com/download.html for updates
  '<link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/leaflet.css"
integrity="sha512-puBpdR0798OZvTTbP4A8Ix/l+A4dHDD0DGqYW6RQ+9jxkRFclaxxQb/SJAWZfWAkuyeQUytO7+7N4QKrDh+drA=="
crossorigin=""/>
<script src="https://unpkg.com/[email protected]/dist/leaflet.js"
integrity="sha512-QVftwZFqvtRNi0ZyCtsznlKSWOStnDORoefr1enyq5mVL4tmKB3S/EnC3rRJcxCPavG10IcrVGSmPh6Qw5lwrg=="
crossorigin=""></script>'
end

.get_line(lat1, lon1, lat2, lon2, color = 'red', weight = 3, opacity = 0.7) ⇒ Object 



157
158
159
160
 
# File 'lib/leafleter.rb', line 157

def self.get_line(lat1, lon1, lat2, lon2, color = 'red', weight = 3, opacity = 0.7)
  dummy_color = "black"
  return get_polyline([[lat1, lon1], [lat2, lon2]], color, dummy_color, weight, opacity)
end

.get_location(lat, lon) ⇒ Object 



133
134
135
 
# File 'lib/leafleter.rb', line 133

def self.get_location(lat, lon)
  return "[" + lat.to_s + ", " + lon.to_s + "]"
end

.get_marker(text, lat, lon) ⇒ Object 



137
138
139
140
141
 
# File 'lib/leafleter.rb', line 137

def self.get_marker(text, lat, lon)
  # TODO: implement what is implemented for Python variant
  location = get_location(lat, lon)
  return "L.marker(" + location + ").addTo(map).bindPopup(\"" + text + ".\");\n"
end

.get_polygon(positions, color = 'red', fill_color = 'red', weight = 3, opacity = 0.7) ⇒ Object 



162
163
164
 
# File 'lib/leafleter.rb', line 162

def self.get_polygon(positions, color = 'red', fill_color = 'red', weight = 3, opacity = 0.7)
  return get_polyline(positions, color, fill_color, weight, opacity)
end

.get_polyline(positions, color = 'red', fill_color = 'red', weight = 3, opacity = 0.7) ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/leafleter.rb', line 166

def self.get_polyline(positions, color = 'red', fill_color = 'red', weight = 3, opacity = 0.7)
  locations_string = ""
  positions.each do |position|
    locations_string += ", " if locations_string != ""
    locations_string += get_location(position[0], position[1])
  end
  styling = " {color: '" + color.to_s + "', fill: '" + fill_color.to_s + "', weight: " + weight.to_s + ", opacity: " + opacity.to_s + ", lineJoin: 'round'}"
  return "L.polyline([" + locations_string + "]," + styling + ").addTo(map);\n"
end

.get_positron_tile_layer ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/leafleter.rb', line 12

def self.get_positron_tile_layer
   return "L.tileLayer('https://cartodb-basemaps-{s}.global.ssl.fastly.net/light_all/{z}/{x}/{y}.png', {
       attribution: '#{openstreetmap_copyright_notice}, basemap: &copy; <a href=\"http://cartodb.com/attributions\">CartoDB</a>',
       subdomains: 'abcd',
       maxZoom: 19
   })"
end

.get_standard_OSM_tile_layer ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/leafleter.rb', line 28

def self.get_standard_OSM_tile_layer
  return "L.tileLayer('http://tile.openstreetmap.org/{z}/{x}/{y}.png', {
      attribution: '#{openstreetmap_copyright_notice}, basemap made by <a href=\"https://github.com/gravitystorm/openstreetmap-carto/\">openstreetmap-carto project</a>',
      maxZoom: 19
  })"
end

.get_standard_prefix_of_any_html_page(title) ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/leafleter.rb', line 35

def self.get_standard_prefix_of_any_html_page(title)
  return "<!DOCTYPE html>
  <html>
  <head>
    <title>" + title + "</title>
    <meta charset=\"utf-8\" />
    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">"
end

.internal_leaflet_styling_part ⇒ Object 



78
79
80
81
 
# File 'lib/leafleter.rb', line 78

def self.internal_leaflet_styling_part()
  # workaround for https://github.com/Leaflet/Leaflet/issues/4686
  return "\n .leaflet-fade-anim .leaflet-tile,.leaflet-zoom-anim .leaflet-zoom-animated { will-change:auto !important; }"
end

.map_area_part_of_styling(width_percent) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/leafleter.rb', line 54

def self.map_area_part_of_styling(width_percent)
  return "        body {
    padding: 0;
    margin: 0;
}
html, body {
    height: 100%;
    width: 100%;
}
#map {
    height: 100%;
    width: #{width_percent}%;
    float: left;
}"
  if width_percent != 100
    returned += "
#pane {
height: 100%;
width: #{100 - width_percent}%;
float: right;
}"
  end
end

.openstreetmap_copyright_notice ⇒ Object

consider importing more from leaflet-extras.github.io/leaflet-providers/preview/ or using this extension



4
5
6
 
# File 'lib/leafleter.rb', line 4

def self.openstreetmap_copyright_notice
  return 'data: &copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors'
end

.recoloured_markers_styling ⇒ Object 



83
84
85
86
87
 
# File 'lib/leafleter.rb', line 83

def self.recoloured_markers_styling()
  return ""\
    "img.huechange_pinkish_marker { filter: hue-rotate(120deg); }"\
    "img.huechange_green_marker { filter: hue-rotate(240deg); }"\
end