Difference between revisions of "Addon:HeatmapWebReport"

From Gramps
Jump to: navigation, search
m (minor typos & replace outdated "Double cousin" reference)
m (Usage: Cleanup)
Line 5: Line 5:
 
==Usage==
 
==Usage==
 
Once this addon has been installed:
 
Once this addon has been installed:
* Select Menu {{man menu|Reports > Text Reports -> Heatmap...}}
+
* Select Menu {{man menu|Reports ▼ Web Pages ▶ Heatmap...}}
  
 
* The {{man label|Options}} tab is displayed with the following:
 
* The {{man label|Options}} tab is displayed with the following:
** {{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|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:}} The selected person.
+
** {{man label|Person:}} ''defaults'' to the currently [[Gramps_Glossary#active_person|Active Person]].
** {{man label|Map tiles:}} Changes the appearance of the map.
+
** {{man label|Map tiles:}} Changes the appearance of the map backdrop.
** {{man label|Filepath:}} The file directory the the file should be saved.
+
** {{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)
 
** {{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:
 
* The {{man label|Event types}} tab is displayed with the following:
** {{man label|[ ] Birth:}} If checked the reports used birth event place data for the heatmap generation.
+
** {{checkbox|0|{{man label|Birth}}}} If selected, the reports plots Birth event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
** {{man label|[ ] Death:}} If checked the reports used death event place data for the heatmap generation.
+
** {{checkbox|0|{{man label|Death}}}} If selected, the reports plots Death event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
** {{man label|[ ] Residence:}} If checked the reports used residence event place data for the heatmap generation.
+
** {{checkbox|0|{{man label|Residence}}}} If selected, the reports plots Residence event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
** {{man label|[ ] Occupation:}} If checked the reports used occupation event place data for the heatmap generation.
+
** {{checkbox|0|{{man label|Occupation}}}} If selected, the reports plots Occupation event [[Gramps_Glossary#place|Place]] data as heatmap datapoints.
  
Once you have made your choices, you can either choose {{man button|Cancel}} or {{man button|OK}} to apply the report generation.
+
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.
  
 
== See also ==
 
== See also ==

Revision as of 22:11, 20 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 addon has been installed:

  • Select Menu Reports ▼ Web Pages ▶ Heatmap...
  • The Options tab is displayed with the following:
    • Filter: defaults to Event places related to Filter for "Ancestors of <selected person>". "Descendants of <selected person> or a custom person filter.
    • Person: defaults to the currently Active Person.
    • Map tiles: Changes the appearance of the map backdrop.
    • Filepath: The file directory where the web Page file should be saved.
    • File name: The file name. (Only allows letter A-Z, a-z, numbers 0-9 and the characters space, underline and hyphen)
  • The Event types tab is displayed with the following:
    • Birth If selected, the reports plots Birth event Place data as heatmap datapoints.
    • Death If selected, the reports plots Death event Place data as heatmap datapoints.
    • Residence If selected, the reports plots Residence event Place data as heatmap datapoints.
    • Occupation If selected, the reports 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 of notification will be shown.

See also