Difference between revisions of "Addon:Life Line Chart View"

From Gramps
Jump to: navigation, search
m (LifeLineChartView-addon-Configure-dialogs-51.png)
 
(48 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{languages|Life Line Chart View}}
+
{{languages|Addon:Life Line Chart View}}
 
{{Third-party plugin}}
 
{{Third-party plugin}}
 +
{{man warn|To enable SVG file export use the minimum requirement of Python 3.6 for svgwrite [[#Prerequisites|prerequisite]]}}
 
[[File:LifeLineChartViewScreenshot1-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing an ancestors tree (Gramps 5.1.x version)]]
 
[[File:LifeLineChartViewScreenshot1-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing an ancestors tree (Gramps 5.1.x version)]]
 
[[File:LifeLineChartViewScreenshot2-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a descendant tree with photos (Gramps 5.1.x version)]]
 
[[File:LifeLineChartViewScreenshot2-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a descendant tree with photos (Gramps 5.1.x version)]]
 
[[File:LifeLineChartViewScreenshot3-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a larger ancestor tree (Gramps 5.1.x version)]]
 
[[File:LifeLineChartViewScreenshot3-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a larger ancestor tree (Gramps 5.1.x version)]]
[[File:LifeLineChartViewScreenshot4-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a ancestor tree with photots (Gramps 5.1.x version)]]
+
[[File:LifeLineChartViewScreenshot4-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a ancestor tree with photos (Gramps 5.1.x version)]]
[[File:ConfigureScreenshot-51.png|450px|thumb|right|Life Line Chart View - addon - Configure dialog (Gramps 5.1.x version)]]
+
[[File:LifeLineChartViewScreenshot6-51.png|450px|thumb|right|Life Line Chart View - addon - Visualizing a descendant tree in cactus shape (Gramps 5.1.x version)]]
  
'''Life Line Chart View''' is an interactive {{icon|ance}} {{man label|Charts}} category view addon which shows individuals as lines in an ancestor or descendant chart. The length and position of the line depends on the actual life span and the marriages. The ancestor collapse is addressed. Labels for birth / names, death, and marriages can be added.
+
'''Life Line Chart View''' is an interactive {{icon|ance}} [[Gramps Glossary#charts view|{{man label|Charts}}]] category view addon which shows individuals as lines in an ancestor or descendant chart. The length and position of the line depends on the actual life span and the marriages. The pedigree/ancestor collapse is handled. Labels for birth / names, death, and marriages can be added.
  
 
The active person on the person tab is starting point in both charts. Birth/christening/baptism, death/burial, and marriage dates need to be available to properly draw this chart. If they are incomplete reasonable guess values are chosen if possible. If not, then these individuals are not shown
 
The active person on the person tab is starting point in both charts. Birth/christening/baptism, death/burial, and marriage dates need to be available to properly draw this chart. If they are incomplete reasonable guess values are chosen if possible. If not, then these individuals are not shown
  
 +
= Usage =
  
 +
Two new chart icons will appear in the {{icon|ance}} {{man label|Charts}} category view tool bar if the addon was loaded successfully and the [[Addon:Life_Line_Chart_View#Prerequisites|prerequisites]] have been installed:
 +
[[File:LifeLineChartView default Toolbar-Icons-51.png]]
 +
* Life Line Ancestor Chart View (left icon)
 +
* Life Line Descendant Chart View (right icon)
  
== Usage ==
 
  
If the addon was loaded sucessfully, then the new chart icons will appear in the tool bar:
+
* The charts can be configured using the [[Addon:Life_Line_Chart_View#Configure_Options|Configure the active view]] dialog.
[[File:Buttons.png]]
 
  
 
+
* You may zoom (if the chart is focused) with
* The charts can be configured in a dialog
+
** {{man key press|Ctrl|+}} and {{man key press|Ctrl|-}}
 
+
** {{man key press|Ctrl|mouse wheel}}
* You may zoom (if the chart is focussed) with
 
** Ctrl + "+" and "-"
 
** Ctrl + mouse wheel
 
 
** the GUI control buttons (+, -, fit to view, reset to 1)
 
** the GUI control buttons (+, -, fit to view, reset to 1)
  
* Scrolling is possible (if the chart is focussed) with
+
* Scrolling is possible (if the chart is focused) with
** mouse wheel, shift + mouse wheel
+
** {{man key press|mouse wheel}}, {{man key press|shift|mouse wheel}}
** Ctrl + left mouse button (grabbing)
+
** {{man key press|Ctrl|left mouse button}}  (grabbing)
  
 
* Context menu enables  
 
* Context menu enables  
 
** Opening the edit dialog
 
** Opening the edit dialog
 
** Change active person
 
** Change active person
** Show/hide persons and ther ancestors / descendants
+
** Show / hide persons and their ancestors / descendants
 
** Showing siblings in the ancestor chart
 
** Showing siblings in the ancestor chart
  
 +
* You may lock {{man key press|Ctrl}} with the GUI control button "M"
 
* You may also use the filter to fade out individuals
 
* You may also use the filter to fade out individuals
 
* A tooltip shows the name, gramps id, birth and death date of the person.
 
* A tooltip shows the name, gramps id, birth and death date of the person.
  
 +
== Configure Options ==
  
== Prerequisites ==
+
[[File:LifeLineChartView-addon-Configure-dialogs-51.png|450px|thumb|right|Life Line Chart View - addon - Configure dialog (Gramps 5.1.x version)]]
  
'''The requirements for this addon are downloaded automatically if they are not available.'''
+
The Configure the active view dialog shows two tabs of option that you can configure independently for the charts.
  
The addon is based on the python module [https://pypi.org/project/life-line-chart life_line_chart]. This python module and the dependent modules (svgwrite) are required. If these modules are not available, then downloaded to the plugins folder and used from there.
+
=== General Layout ===
  
== Configure Options ==
+
* number of generations.
 +
* relative line width.
 +
* vertical and horizontal chart size.
 +
* warping of the whole chart (normal grid, sine, triangle).
 +
* show or hide pedigree collapse.
 +
* unique line color or coloring based on surname.
 +
* line fading represents the uncertainty of dates or the age.
 +
* show or hide lables for birth, death, marriages.
 +
* line weighting (only descendant diagram).
 +
* general chart layout "parents enclose children" or "cactus" (only descendant diagram).
 +
* optimizations (only ancestor diagram):
 +
** flip family to reduce the cross chart connection lengths.
 +
** horizontal chart compression.
 +
* softness of the family shape.
 +
* vertical flipping of the whole chart.
 +
* show photos of the person on the line.
 +
* size of the photos.
  
* number of generations
+
=== Label Configuration ===
* shape and warp variants
+
* birth and death label.
* labels
+
** position.
 +
** rotation.
 +
** alignment.
 +
** word wrapping.
 +
** font name and size.
 +
* marriage label font size and name.
  
 
== Features ==
 
== Features ==
  
* Photos of the persons can be displayed along the line. Their position is either based on the date that is set in the media object, or displayed in the order of appearance in the db.
+
* Photos of the persons can be displayed along the line. Their position is either based on the date that is set in the media object, or displayed in the order of appearance in the family tree.
* Layout optimization algorithms
+
* Overview map on the bottom left.
* The diagram can be exported as SVG.
+
* The diagram can be exported as an SVG file using the {{man button|Save the Life Line Chart View}} button (not available using Python 3.5).
 +
* Layout optimization algorithms.
 +
* Dark theme.
 +
* Handling of [https://en.wikipedia.org/wiki/Pedigree_collapse pedigree collapse].
 +
 
 +
= Prerequisites =
 +
 
 +
'''If the requirements for this addon have not already been installed you will be prompted to download them semi-automatically by selecting the {{man button|Download module}} button for each.'''
 +
 
 +
The addon is based on the Python module [https://pypi.org/project/life-line-chart life_line_chart], this Python module is required.
 +
 
 +
[[File:LifeLineChartView-life line chart.png]]
 +
 
 +
To enable SVG file export, the module ([https://pypi.org/project/svgwrite svgwrite]) is required (which has a minimum requirement of Python 3.6).
 +
 
 +
[[File:LifeLineChartView-svgwrite.png]]
 +
 
 +
= Issues =
 +
* "smooth scrolling" is supported since GTK 3.24 ([https://docs.gtk.org/gtk3/class.EventControllerScroll.html GTK documentation]), the Windows AIO currently uses an older version.
 +
* Touch screens are not properly supported on Windows. This is an unresolved GTK issue ([https://gitlab.gnome.org/GNOME/gtk/-/issues/3162#note_911387 GTK issue])
 +
 
 +
For current issues see the related tag [https://gramps-project.org/bugs/tag_view_page.php?tag_id=372 LifeLineChartView] on the bugtracker.
 +
 
  
 
<!--default categories-->
 
<!--default categories-->
 +
[[Category:Views]]
 
[[Category:Addons]]
 
[[Category:Addons]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 06:44, 11 June 2022

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.

Gnome-important.png
To enable SVG file export use the minimum requirement of Python 3.6 for svgwrite prerequisite

Life Line Chart View - addon - Visualizing an ancestors tree (Gramps 5.1.x version)
Life Line Chart View - addon - Visualizing a descendant tree with photos (Gramps 5.1.x version)
Life Line Chart View - addon - Visualizing a larger ancestor tree (Gramps 5.1.x version)
Life Line Chart View - addon - Visualizing a ancestor tree with photos (Gramps 5.1.x version)
Life Line Chart View - addon - Visualizing a descendant tree in cactus shape (Gramps 5.1.x version)

Life Line Chart View is an interactive Charts Charts category view addon which shows individuals as lines in an ancestor or descendant chart. The length and position of the line depends on the actual life span and the marriages. The pedigree/ancestor collapse is handled. Labels for birth / names, death, and marriages can be added.

The active person on the person tab is starting point in both charts. Birth/christening/baptism, death/burial, and marriage dates need to be available to properly draw this chart. If they are incomplete reasonable guess values are chosen if possible. If not, then these individuals are not shown

Usage

Two new chart icons will appear in the Charts Charts category view tool bar if the addon was loaded successfully and the prerequisites have been installed: LifeLineChartView default Toolbar-Icons-51.png

  • Life Line Ancestor Chart View (left icon)
  • Life Line Descendant Chart View (right icon)


  • You may zoom (if the chart is focused) with
    • Ctrl++ and Ctrl+-
    • Ctrl+mouse wheel
    • the GUI control buttons (+, -, fit to view, reset to 1)
  • Scrolling is possible (if the chart is focused) with
    • mouse wheel, Shift+mouse wheel
    • Ctrl+left mouse button (grabbing)
  • Context menu enables
    • Opening the edit dialog
    • Change active person
    • Show / hide persons and their ancestors / descendants
    • Showing siblings in the ancestor chart
  • You may lock Ctrl with the GUI control button "M"
  • You may also use the filter to fade out individuals
  • A tooltip shows the name, gramps id, birth and death date of the person.

Configure Options

Life Line Chart View - addon - Configure dialog (Gramps 5.1.x version)

The Configure the active view dialog shows two tabs of option that you can configure independently for the charts.

General Layout

  • number of generations.
  • relative line width.
  • vertical and horizontal chart size.
  • warping of the whole chart (normal grid, sine, triangle).
  • show or hide pedigree collapse.
  • unique line color or coloring based on surname.
  • line fading represents the uncertainty of dates or the age.
  • show or hide lables for birth, death, marriages.
  • line weighting (only descendant diagram).
  • general chart layout "parents enclose children" or "cactus" (only descendant diagram).
  • optimizations (only ancestor diagram):
    • flip family to reduce the cross chart connection lengths.
    • horizontal chart compression.
  • softness of the family shape.
  • vertical flipping of the whole chart.
  • show photos of the person on the line.
  • size of the photos.

Label Configuration

  • birth and death label.
    • position.
    • rotation.
    • alignment.
    • word wrapping.
    • font name and size.
  • marriage label font size and name.

Features

  • Photos of the persons can be displayed along the line. Their position is either based on the date that is set in the media object, or displayed in the order of appearance in the family tree.
  • Overview map on the bottom left.
  • The diagram can be exported as an SVG file using the Save the Life Line Chart View button (not available using Python 3.5).
  • Layout optimization algorithms.
  • Dark theme.
  • Handling of pedigree collapse.

Prerequisites

If the requirements for this addon have not already been installed you will be prompted to download them semi-automatically by selecting the Download module button for each.

The addon is based on the Python module life_line_chart, this Python module is required.

LifeLineChartView-life line chart.png

To enable SVG file export, the module (svgwrite) is required (which has a minimum requirement of Python 3.6).

LifeLineChartView-svgwrite.png

Issues

  • "smooth scrolling" is supported since GTK 3.24 (GTK documentation), the Windows AIO currently uses an older version.
  • Touch screens are not properly supported on Windows. This is an unresolved GTK issue (GTK issue)

For current issues see the related tag LifeLineChartView on the bugtracker.