Difference between revisions of "Addon:HeatmapWebReport"

From Gramps
Jump to: navigation, search
(link to what a heat map means in this context)
m (The Graphical User Interface)
Line 11: Line 11:
 
===The Graphical User Interface===
 
===The Graphical User Interface===
 
Select Menu {{man menu|Reports ▼ Web Pages ▶ Heatmap...}}
 
Select Menu {{man menu|Reports ▼ Web Pages ▶ Heatmap...}}
====The {{man label|Options}} tab====
+
====The {{man label|General}} tab====
 
[[File:Gramplet_HeatmapOptions.png|thumb|right|450px|Heatmap Options tab]]
 
[[File:Gramplet_HeatmapOptions.png|thumb|right|450px|Heatmap Options tab]]
 
This tab allows the following options to be selected:
 
This tab allows the following options to be selected:
Line 27: Line 27:
 
* {{man label|File name:}} The file name. (Only allows letters A-Z, a-z, numbers 0-9 and the characters space, underline and hyphen)
 
* {{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 latitude 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 central latitude for 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 central latitude for a displayed map.
 +
* {{man label|Lower right corner latitude:}} +90 (north pole) to -90 (south pole). The central latitude for 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 central latitude for a displayed map.
 +
* {{checkbox|0|{{man label|Render custom map limit border}}}} If selected, a semi-transparent blue rectangle illustrates the limits of the view window box.
 +
<!--
 
====The {{man label|Event types}} tab====
 
====The {{man label|Event types}} tab====
 
[[File:Gramplet_HeatmapEventTypes.png|thumb|right|450px|Heatmap Event Types tab]]
 
[[File:Gramplet_HeatmapEventTypes.png|thumb|right|450px|Heatmap Event Types tab]]
Line 37: Line 51:
  
 
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.
 
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:50, 23 February 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)Share button allows the <selected person> to be re-selected.
    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 latitude 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 central latitude for a displayed map.
  • Upper left corner longitude: -180 to 0 for the western hemisphere and 0 to +180 for the eastern hemisphere. The central latitude for a displayed map.
  • Lower right corner latitude: +90 (north pole) to -90 (south pole). The central latitude for a displayed map.
  • Lower right corner longitude: -180 to 0 for the western hemisphere and 0 to +180 for the eastern hemisphere. The central latitude for a displayed map.
  • Render custom map limit border If selected, a semi-transparent blue rectangle illustrates the limits of the view window box.

See also