Open main menu

Gramps β

Changes

Addon:HeatmapWebReport

913 bytes added, 01:04, 20 May 2025
Development history
{{Third-party addon}}
{{man label|Heatmap}} is a web report which creates an [https://wiki.openstreetmap.org/wiki/Slippy_Map interactive map] containing a [https://wikipedia.org/wiki/Heat_map heatmap] generated from Gramps event place data.
[[File:Heatmap webreport 51.jpeg|thumb|right|450px|Heatmap report ([https://stamen.com/about/ Stamen Design] Terrain map tiles)example]]<!-- how do I create this example, my attempts show the map zoomed out (I've selected all events and have the entire database selected) but I'm unable to find the heatmap!-->
==Usage==
Once this Report addon has been installed, Heatmap web pages can be generated from the Graphical User Interface Report interface or the Book interface. Report only looks for {{icon|plac}}Places found within a subset of the {{icon|even}}Events related to a group of {{icon|peop}}People.
The output webpage contains an embedded list of GPS coordinates for places with the number of Events occurring at each place. The list is set up for output to the Heatmapping overlay feature of a selected [https://wikipedia.org/wiki/Web_Map_Service Web map service].
{{-}}
[[File:HeatmapWebPage-general-tab-default-60.png|thumb|right|450px|Heatmap Web Pages - Options tab (defaults)]]
This tab allows the following options to be selected:
* {{man label|Filter:}} ** ''defaults'Entire database''' to (default)** To restrict {{icon|peop}}Person results to match the "<code>Ancestors of <selected person></code>" filter. <br />Other filters include the "<code>Descendants of <selected person></code>" or any of the [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Custom_Filter_Editor|custom filter]] for the Person category.* {{man label|Filter Person:}} Sets the <code><selected person></code> for the filter. <br />This ''defaults'' to the currently [[Gramps_Glossary#active_person|Active Person]]. **{{man button|{{icon|share}}Select Existing a different person}} button opens the {{man label|[[Addon:HeatmapWebReport#Select_a_person_for_the_report_dialog|Select a person for the report]]}} dialog that allows the <code><selected person></code> to be re-designatedchanged. <br />The Share list is initially filtered to the current Active Person, Home Person and any bookmarked persons. <br />{{checkbox|0|* {{man label|Show all}}Name format:}} checkbox allows choosing from an unfiltered People list. 
* {{man label|Map tiles:}} Changes the Map Service providing the HeatMap overlay processing and the appearance of the map backdrop.<br /><br />Map Service selections include:
**'''OpenStreetMap''' (default)
**Stamen Terrain
**Stamen Toner
**CartoDB Positron
**CartoDB DarkMatter
* {{man label|FilepathPoint size:}} <code>15</code> Set the size of the heatmap points.** {{man button| - (Decrease)}} / {{man button| + (Increase)}}* {{man label|File path:}} The file directory where the Web Page file should be saved.** {{man button| Select path }}
* {{man label|File name:}} The file name. (Only allows letters A-Z, a-z, numbers 0-9 and the characters space, underline and hyphen)
{{-}}
====Select a Person person for the report dialog====[[File:Gramplet_HeatmapSelectPerson.png|thumb|right|417px450px|Heatmap - Select Person a person for the report - dialog]] The Share list is initially filtered to the current Active Person, Home Person and any bookmarked persons.  * {{checkbox|0|{{man label|Show all}}}} checkbox allows choosing from an unfiltered People list.
{{-}}
==={{man label|Event}} tab===
[[File:HeatmapWebPage-events-tab-default-60.png|thumb|right|450px|Heatmap - Web Pages -Events tab]]
This tab allows the following Event type options to be selected:* {{checkbox|0|{{man label|Birth}}}} If selected, the report plots Birth event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.* {{checkbox|0|{{man label|Death}}}} If selected, the report plots Death event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.* {{checkbox|0|{{man label|Residence}}}} If selected, the The report then plots Residence event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.* {{checkbox|0|{{man label|Occupation}}}} If selected, the report plots Occupation event events [[Gramps_Glossary#place|Place]] data as heatmap datapoints.:
* {{checkbox|0|{{man label|Adopted}}}}
* {{checkbox|0|{{man label|Adult Christening}}}}
* {{checkbox|0|{{man label|Alternate Marriage}}}}
* {{checkbox|0|{{man label|Annulment}}}}
* {{checkbox|0|{{man label|Baptism}}}}
* {{checkbox|0|{{man label|Bar Mitzvah}}}}
* {{checkbox|0|{{man label|Bat Mitzvah}}}}
* {{checkbox|0|{{man label|Birth}}}}
* {{checkbox|0|{{man label|Blessing}}}}
* {{checkbox|0|{{man label|Burial}}}}
* {{checkbox|0|{{man label|Cause Of Death}}}}
* {{checkbox|0|{{man label|Census}}}}
{{-}}
This tab allows the following options to be selected:
* {{checkbox|0|{{man label|Enable custom start position}}}} If selected, the map centers on a specific location and zoom scale.
* {{man label|Start latitude:}} <code>50</code> (default) - +90 (north pole) to -90 (south pole). The central latitude for a displayed map.* {{man label|Start longitude:}} <code>10</code> (default) - -180 to 0 for the western hemisphere and 0 to +180 for the eastern hemisphere. The central longitude for a displayed map.* {{man label|Start zoom:}} <code>5</code> (default) - 1 to 18 [8 default]. 1 shows the entire planet surface in about 5 inches square.
{{-}}
<!-- Tab no longer exist ?
==={{man label|Limits}} tab===
* {{checkbox|0|{{man label|Enable map limits}}}} If selected, the map is restricted to a range of zoom scales and a viewing window.
* {{man label|Lower right corner longitude:}} -180 to 0 for the western hemisphere and 0 to +180 for the eastern hemisphere. The rightmost longitudinal limit for scrolling a displayed map.
* {{checkbox|0|{{man label|Render custom map limit border}}}} If selected, a semi-transparent blue polygon illustrates the limits of the view window box. (Shows as a rectangle for standard Mercator Projection of the globe.)
-->
==Issues==
* Help button goes to https://gramps-project.org/wiki/index.php?title=Gramps_6.0_Wiki_Manual_-_Reports#Heatmap
== See also = Development history ===
* GitHub pre-release: New web report (Heatmap) [https://github.com/gramps-project/addons-source/pull/470 #470]
* [https://gramps.discourse.group/t/hotspot-heatmap-for-event-clusters/776 Hotspot heatmap for event clusters] Discourse forum thread]- October 2020* It avoids new libraries by using a folium/leaflet generated html file as template.** [https://leafletjs.com/ Leaflet]
== See also ==
* Gramps addons by Matthias Kemmer
** [https://mattkmmr.github.io/gramps-addons-listings/Gramps Addons web catalog]
15,091
edits