Difference between revisions of "Addon:HeatmapWebReport"

From Gramps
Jump to: navigation, search
m (Usage: Cleanup)
m (Usage: reformatted and expanded.)
Line 3: Line 3:
 
{{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 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 ▼ Web Pages ▶ Heatmap...}}
 
  
* 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:}} ''defaults'' to Event places related to Filter for "Ancestors of <selected person>". "Descendants of <selected person> or a [[Gramps_{{man version}}_Wiki_Manual_-_Filters#Custom_Filter_Editor|custom person filter]].
 
** {{man label|Person:}} ''defaults'' to the currently [[Gramps_Glossary#active_person|Active Person]].
 
** {{man label|Map tiles:}} Changes the appearance of the map backdrop.
 
** {{man label|Filepath:}} The file directory where the web Page file should be saved.
 
** {{man label|File name:}} The file name. (Only allows letter A-Z, a-z, numbers 0-9 and the characters space, underline and hyphen)
 
* The {{man label|Event types}} tab is displayed with the following:
 
** {{checkbox|0|{{man label|Birth}}}} If selected, the reports plots Birth event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
 
** {{checkbox|0|{{man label|Death}}}} If selected, the reports plots Death event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
 
** {{checkbox|0|{{man label|Residence}}}} If selected, the reports plots Residence event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
 
** {{checkbox|0|{{man label|Occupation}}}} If selected, the reports 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 of notification will be shown.
+
===The Graphical User Interface===
 +
Select Menu {{man menu|Reports &#x25BC; Web Pages &#x25B6; Heatmap...}}
 +
====The {{man label|Options}} tab====
 +
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_-_Filters#Custom_Filter_Editor|custom filter]] for the Person category.
 +
* {{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 />{{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 or any bookmarked persons. <br />{{checkbox|0|{{man label|Show all}}}} checkbox allows choosing from an unfiltered People list.
 +
 
 +
* {{man label|Map tiles:}} Changes Map service providing the appearance of the map backdrop and overlay processing.
 +
* {{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|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 ==
 
== See also ==

Revision as of 02:20, 21 November 2020

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 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.
    STOCK_INDEX (used for share)Share button allows the <selected person> to be re-selected.
    The Share list is initially filtered to the current Active Person, Home Person or any bookmarked persons.
    Show all checkbox allows choosing from an unfiltered People list.
  • Map tiles: Changes Map service providing the appearance of the map backdrop and overlay processing.
  • 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 Event types tab

This tab allows selects following options to be selected:

  • Birth If selected, the report plots Birth event Place data as heatmap datapoints.
  • Death If selected, the report plots Death event Place data as heatmap datapoints.
  • Residence If selected, the report plots Residence event Place data as heatmap datapoints.
  • Occupation If selected, the report plots Occupation event Place data as heatmap datapoints.

Once you have selected your options, pressing 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