Difference between revisions of "Addon:HeatmapWebReport"

From Gramps
Jump to: navigation, search
(Created page with "{{Third-party plugin}} thumb|right|450px|Heatmap report (Steamen Terrain map tiles) {{man label|Heatmap}} is a web report which creates an [...")
 
m (See also)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Third-party plugin}}
 
{{Third-party plugin}}
[[File:Heatmap webreport 51.jpeg|thumb|right|450px|Heatmap report (Steamen Terrain map tiles)]]
+
[[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 heatmap generated from Gramps event place data.
+
{{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.
  
 +
{{-}}
 
==Usage==
 
==Usage==
Once this addon has been installed:
+
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.
* Select Menu {{man menu|Reports > Text Reports -> Double Cousin...}}
 
  
* The {{man label|Options}} tab is displayed with the following:
+
The 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].
** {{man label|Filter:}} Filters the persons for "Ancestors of <selected person>""Descendants of <selected person> or a [[Gramps_5.0_Wiki_Manual_-_Filters#Custom_Filter_Editor| custom person filter]].
+
 
** {{man label|Person:}} The selected person.
+
===The Graphical User Interface===
** {{man label|Map tiles:}} Changes the appearance of the map.
+
Select Menu {{man menu|Reports &#x25BC; Web Pages &#x25B6; Heatmap...}}
** {{man label|Filepath:}} The file directory the the file should be saved.
+
====The {{man label|General}} tab====
** {{man label|File name:}} The file name. (Only allows letter A-Z, a-z, numbers 0-9 and the charaters space, underline and hyphen)
+
[[File:Gramplet_HeatmapOptions.png|thumb|right|450px|Heatmap Options tab]]
* The {{man label|Event types}} tab is displayed with the following:
+
This tab allows the following options to be selected:
** {{man label|[ ] Birth:}} If checked the reports used birth event place data for the heatmap generation.
+
* {{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_-_Filters#Custom_Filter_Editor|custom filter]] for the Person category.
** {{man label|[ ] Death:}} If checked the reports used death event place data for the heatmap generation.
+
* {{man label|Person:}} Sets the <code><selected person></code> for the filter. <br />This ''defaults'' to the currently [[Gramps_Glossary#active_person|Active Person]]. <br />[[File:Gramplet_HeatmapSelectPerson.png|thumb|right|417px|Heatmap Select Person dialog]]{{icon|share}}Select Existing button allows the <code><selected person></code> to be re-designated. <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|[ ] Residence:}} If checked the reports used residence event place data for the heatmap generation.
+
 
** {{man label|[ ] Occupation:}} If checked the reports used occupation event place data for the heatmap generation.
+
* {{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
 +
**Stamen Terrain
 +
**Stamen Toner
 +
**Stamen Watercolor
 +
**CartoDB Positron
 +
**CartoDB DarkMatter
 +
* {{man label|Filepath:}} The file directory where the Web Page file should be saved.
 +
* {{man label|File name:}} The file name. (Only allows letters A-Z, a-z, numbers 0-9 and the characters space, underline and hyphen)
 +
{{-}}
 +
====The {{man label|Advanced}} tab====
 +
* {{checkbox|0|{{man label|Enable custom start position}}}} If selected, the map centers on a specific location and zoom scale.
 +
* {{man label|Start latitude:}} +90 (north pole) to -90 (south pole). The central latitude for a displayed map.
 +
* {{man label|Start longitude:}} -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:}} 1 to 18 [8 default]. 1 shows the entire planet surface in about 5 inches square.
 +
 
 +
====The {{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 zoom out scale that a map rendering will accept.
 +
* {{man label|Max. zoom:}} 1 to 18 [14 default]. Limits the zoom in scale that a map rendering will accept.
 +
* {{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. (Shows as a rectangle for standard Mercator Projection of the globe.)
 +
<!--
 +
====The {{man label|Event types}} tab====
 +
[[File:Gramplet_HeatmapEventTypes.png|thumb|right|450px|Heatmap Event Types tab]]
 +
This tab allows selects following 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 report plots Residence event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
 +
* {{checkbox|0|{{man label|Occupation}}}} If selected, the report plots Occupation event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
 +
 
 +
Once you have selected your options, pressing {{man button|OK}} begins the preparation and generation of the Web Page. No progress bar or notification will be shown. Open the Web Page in any browser with internet access.
 +
-->
 +
 
 +
== See also ==
 +
* 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 Discourse forum thread]
 +
* [https://leafletjs.com/ Leaflet]
 +
 
 +
* Gramps add-ons by Matthias Kemmer
 +
** [https://mattkmmr.github.io/gramps-addons-listings/Gramps Add-ons 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/Remove Tag Tool]]
 +
** [[Rule_expansions#FilterRules_:_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
 +
** [[Rule_expansions#FilterRules2_:_Plugin_Manager_Rulebook_Collection|FilterRules2]] : Plugin Manager Rulebook Collection 2
 +
*** Matrilineal progenitrix of <person>
 +
*** Mitochondrial inheritance of <filter>
 +
*** Mitochondrial inheritance of <person>
 +
*** Patrilineal progenitor of <person>
 +
*** X-chromosomal ancestors of <person>
 +
*** X-chromosomal descendants of <person>
 +
*** Y-chromosomal inheritance of <person filter>
 +
*** Y-chromosomal inheritance of <person>
  
Once you have made your choices, you can either choose {{man button|Cancle}} or {{man button|Ok}} to apply the report generation.
 
  
== More information:==
 
* [https://gramps.discourse.group/t/hotspot-heatmap-for-event-clusters/776| Discourse forum thread]
 
* [https://leafletjs.com/| Leaflet]
 
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 22:33, 27 October 2021

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager

Heatmap report (Stamen Design Terrain map tiles)

Heatmap is a web report which creates an interactive map containing a heatmap generated from Gramps event place data.


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 PlacesPlaces found within a subset of the EventsEvents related to a group of PeoplePeople.

The 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 Web map service.

The Graphical User Interface

Select Menu Reports ▼ Web Pages ▶ Heatmap...

The General tab

Heatmap Options tab

This tab allows the following options to be selected:

  • Filter: defaults to restrict PeoplePerson results to match the "Ancestors of <selected person>" filter.
    Other filters include the "Descendants of <selected person>" or any of the custom filter for the Person category.
  • Person: Sets the <selected person> for the filter.
    This defaults to the currently Active Person.
    Heatmap Select Person dialog
    STOCK_INDEX (used for share)Select Existing button allows the <selected person> to be re-designated.
    The Share list is initially filtered to the current Active Person, Home Person and any bookmarked persons.
    Show all checkbox allows choosing from an unfiltered People list.
  • Map tiles: Changes the Map Service providing the HeatMap overlay processing and the appearance of the map backdrop.

    Map Service selections include:
    • OpenStreetMap
    • Stamen Terrain
    • Stamen Toner
    • Stamen Watercolor
    • CartoDB Positron
    • CartoDB DarkMatter
  • Filepath: The file directory where the Web Page file should be saved.
  • File name: The file name. (Only allows letters A-Z, a-z, numbers 0-9 and the characters space, underline and hyphen)


The Advanced tab

  • Enable custom start position If selected, the map centers on a specific location and zoom scale.
  • Start latitude: +90 (north pole) to -90 (south pole). The central latitude for a displayed map.
  • Start longitude: -180 to 0 for the western hemisphere and 0 to +180 for the eastern hemisphere. The central longitude for a displayed map.
  • Start zoom: 1 to 18 [8 default]. 1 shows the entire planet surface in about 5 inches square.

The Limits tab

  • Enable map limits If selected, the map is restricted to a range of zoom scales and a viewing window.
  • Min. zoom: 1 to 18 [1 default]. Limits the zoom out scale that a map rendering will accept.
  • Max. zoom: 1 to 18 [14 default]. Limits the zoom in scale that a map rendering will accept.
  • Upper left corner latitude: +90 (north pole) to -90 (south pole). The upper latitudinal limit for scrolling a displayed map.
  • 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.
  • Lower right corner latitude: +90 (north pole) to -90 (south pole). The lower latitudinal limit for scrolling a displayed map.
  • 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.
  • 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.)

See also

  • Gramps add-ons by Matthias Kemmer
    • Add-ons web catalog
    • Heatmap Web Report
    • Avatar Generator
    • Event Description Editor
    • Number Of Ancestors Quick View
    • Family Relationship
    • Media Report
    • Double Cousin Report
    • Set Privacy Tool
    • Add/Remove Tag Tool
    • 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
    • FilterRules2 : Plugin Manager Rulebook Collection 2
      • Matrilineal progenitrix of <person>
      • Mitochondrial inheritance of <filter>
      • Mitochondrial inheritance of <person>
      • Patrilineal progenitor of <person>
      • X-chromosomal ancestors of <person>
      • X-chromosomal descendants of <person>
      • Y-chromosomal inheritance of <person filter>
      • Y-chromosomal inheritance of <person>