Open main menu

Gramps β

Changes

Addon:HeatmapWebReport

5,335 bytes added, 01:04, 20 May 2025
Development history
{{Third-party pluginaddon}}[[File:Heatmap webreport 51.jpeg|thumb|right|450px|Heatmap report ([https://stamen.com/about/ Stamen Design] Terrain map tiles)]]{{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 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].
{{-}}
==Usage==
Once this Report addon has been installed, Heatmap web pages can be generated from the Graphical User 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 webpage contains an embedded list To create a {{man label|Heatmap}} select menu {{man menu|Reports &#x25BC; Web Pages &#x25B6; Heatmap...}} Once you have selected your options from the tabs, pressing {{man button|OK}} begins the preparation and generation of GPS coordinates for places with the number of Events occurring at each placeWeb Page. No progress bar or notification will be shown. The list is set up for output to Open the Heatmapping overlay feature of a selected [https://wikipedia.org/wiki/Web_Map_Service Web map service]Page in any browser with internet access==Dialog tabs==
===The Graphical User Interface===Select Menu {{man menulabel|Reports &#x25BC; Web Pages &#x25B6; Heatmap...}}report dialog has the following three tabs:====The * {{man label|Options}} tab====[[FileAddon:Gramplet_HeatmapOptions.png|thumb|rightHeatmapWebReport#General_tab|301px|Heatmap Options tabGeneral]]This tab allows the following options to be selected:}}* {{man label|Filter:}} ''defaults'' 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_-_FiltersAddon:HeatmapWebReport#Custom_Filter_EditorEvents_tab|custom filterEvents]] for the Person category.}}* {{man label|Person:}} Sets the <code><selected person></code> for the filter. <br />This ''defaults'' to the currently [[Gramps_GlossaryAddon:HeatmapWebReport#active_person|Active Person]]. <br />[[File:Gramplet_HeatmapSelectPerson.pngAdvanced_tab|thumb|right|417px|Heatmap Select Person dialogAdvanced]]{{icon|share}}Share button allows the <code><selected person></code> to be re-selected. <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}}}} checkbox allows choosing from an unfiltered People list.
==={{man label|General}} tab===[[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:}} ** '''Entire database''' (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 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 changed. * {{man label|Name format:}}* {{man label|Map tiles:}} Changes the Map service Service providing the HeatMap overlay processing and the appearance of the map backdrop and overlay processing.<br /><br />Map Service selections include:**'''OpenStreetMap''' (default)**Stamen Terrain**Stamen Toner**Stamen Watercolor**CartoDB Positron**CartoDB DarkMatter* {{man label|Point size:}} <code>15</code> Set the size of the heatmap points.** {{man button| - (Decrease)}} / {{man button| + (Increase)}}* {{man label|FilepathFile path:}} The file directory where the web 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 for the report dialog====
[[File:Gramplet_HeatmapSelectPerson.png|thumb|right|450px|Heatmap - Select a person for the report - dialog]]
====The {{man label|Event types}} tab====[[File:Gramplet_HeatmapEventTypes.png|thumb|right|301px|Heatmap Event Types tab]]This tab allows selects following options Share list is initially filtered 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 report plots Residence event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.* {{checkbox|0|{{man label|Occupation}}}} If selectedcurrent Active Person, the report plots Occupation event [[Gramps_Glossary#place|Place]] data as heatmap datapointsHome Person and any bookmarked persons.
Once you have * {{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 your . The report then plots the 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}}}} {{-}} ==={{man label|Advanced}} tab===[[File:HeatmapWebPage-advanced-tab-default-60.png|thumb|right|450px|Heatmap - Web Page - Advanced - tab]]This tab allows the following optionsto be selected:* {{checkbox|0|{{man label|Enable custom start position}}}} If selected, pressing the map centers on a specific location and zoom scale.* {{man buttonlabel|Start latitude:}} <code>50</code> (default) - +90 (north pole) to -90 (south pole). The central latitude for a displayed map.* {{man label|OKStart longitude:}} begins <code>10</code> (default) - -180 to 0 for the preparation western hemisphere and generation 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. 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|Min. zoom:}} 1 to 18 [1 default]. Limits the Web Pagezoom out scale that a map rendering will accept.* {{man label|Max. zoom:}} 1 to 18 [14 default]. No progress bar or notification Limits the zoom in scale that a map rendering will be shownaccept.* {{man label|Upper left corner latitude:}} +90 (north pole) to -90 (south pole). The upper latitudinal limit for scrolling a displayed map.* {{man label|Upper left corner longitude:}} -180 to 0 for the western hemisphere and 0 to +180 for the eastern hemisphere. The leftmost longitudinal limit for scrolling a displayed map.* {{man label|Lower right corner latitude:}} +90 (north pole) to -90 (south pole). The lower latitudinal limit for scrolling a displayed map.* {{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. Open (Shows as a rectangle for standard Mercator Projection of the Web Page in any browser with internet accessglobe.)--> ==Issues==* Help button goes to https://gramps-project.org/wiki/index.php?title=Gramps_6.0_Wiki_Manual_-_Reports#Heatmap === 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 ==
* GitHub pre-release: New web report (Heatmap) Gramps addons by Matthias Kemmer** [https://mattkmmr.github.comio/gramps-project/addons-sourcelistings/pullGramps Addons web catalog]** [[Addon:HeatmapWebReport|Heatmap Web Report]]** [[Addon:AvatarGenerator|Avatar Generator]]** [[Addon:EventDescriptionEditor|Event Description Editor]]** [[Addon:NumberOfAncestorsQuickView|Number Of Ancestors Quick View]]** [[Addon:FamilyRelationship|Family Relationship]]** [[Addon:MediaReport|Media Report]]** [[Addon:DoubleCousinReport|Double Cousin Report]]** [[Addon:SetPrivacyTool|Set Privacy Tool]]** [[Addon:AddRemoveTagTool|Add/470 Remove Tag Tool]]** [[Addon:Rule_expansions#470FilterRules_:_Plugin_Manager_Rulebook_Collection|FilterRules]] : Plugin Manager Rulebook Collection 1*** People related to <filter>* ** People with events with a selected role*** Families with Events with a selected role*** Source matching parameters*** People Separated less than <N> degrees of <Home person>*** People Separated less than <N> degrees of <person>*** Events of families matching a <family filter>*** Families matching <event filter>*** People who are part of families matching <filter>*** Filter people by their age at death*** Match associations of <person filter>*** People with multiple parent records** [[httpsAddon:Rule_expansions#FilterRules2_:_Plugin_Manager_Rulebook_Collection|FilterRules2]] ://gramps.discourse.group/t/hotspotPlugin Manager Rulebook Collection 2*** Matrilineal progenitrix of <person>*** Mitochondrial inheritance of <filter>*** Mitochondrial inheritance of <person>*** Patrilineal progenitor of <person>*** X-heatmapchromosomal ancestors of <person>*** X-for-eventchromosomal descendants of <person>*** Y-clusters/776 Discourse forum thread]chromosomal inheritance of <person filter>* [https://leafletjs.com/ Leaflet]** Y-chromosomal inheritance of <person>
[[Category:Addons]]
[[Category:Plugins]]
[[Category:Developers/General]]
15,091
edits