Addon:HeatmapWebReport

From Gramps
Gramps-notes.png
This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager.

Please use carefully on data that is backed up, and help make it better by reporting any 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.

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

Heatmap report (Stamen Design Terrain map tiles) example

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

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

To create a Heatmap select menu Reports ▼ Web Pages ▶ Heatmap...

Once you have selected your options from the tabs, 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.

Dialog tabs

The Heatmap report dialog has the following three tabs:

General tab

Heatmap Web Pages - Options tab (defaults)

This tab allows the following options to be selected:

  • Filter:
    • Entire database (default)
    • 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.
  • Filter Person: Sets the <selected person> for the filter.
    This defaults to the currently Active Person.
  • Name format:
  • Map tiles: Changes the Map Service providing the HeatMap overlay processing and the appearance of the map backdrop.

    Map Service selections include:
    • OpenStreetMap (default)
    • Stamen Terrain
    • Stamen Toner
    • Stamen Watercolor
    • CartoDB Positron
    • CartoDB DarkMatter
  • Point size: 15 Set the size of the heatmap points.
    • - (Decrease) / + (Increase)
  • File path: The file directory where the Web Page file should be saved.
    • Select path
  • 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

Heatmap - Select a person for the report - dialog

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.


Event tab

Heatmap - Web Pages -Events tab

This tab allows the following Event type options to be selected. The report then plots the events Place data as heatmap datapoints.:

  • Adopted
  • Adult Christening
  • Alternate Marriage
  • Annulment
  • Baptism
  • Bar Mitzvah
  • Bat Mitzvah
  • Birth
  • Blessing
  • Burial
  • Cause Of Death
  • Census


Advanced tab

Heatmap - Web Page - Advanced - tab

This tab allows the following options to be selected:

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


Issues

Development history

See also

  • Gramps addons by Matthias Kemmer
    • Addons 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>