Difference between revisions of "Addon:Graph View"

From Gramps
Jump to: navigation, search
(Issues)
(Linux)
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{languages|Graph View}}
 
{{Third-party plugin}}
 
{{Third-party plugin}}
 +
{{man warn|The larger the number of people in the Family Tree|The longer the chart will take to appear eg: about 7000 people takes 10 minutes.}}
 +
{{man note|Some options only appear in newer versions of Gramps 5.x.x}}
 +
[[File:Graph-View-addon-example-51.png|450px|thumb|right|Graph View - addon - In action showing both ancestors and descendant trees (Gramps 5.1.x version)]]
 +
'''Graph View''' is an interactive {{icon|ance}} {{man label|Charts}} category view addon that presents a navigable ancestors and descendant tree using the current active person as a starting point. Clicking another person in the family tree will make that person the active person and will redraw the family tree based on them.
  
[[File:Graph-View-plugin-addon-example-42.png|500px|thumb|right|Graph View - plugin addon - In action]]
 
  
== What is Graph View ==
+
== Usage ==
  
'''Graph View''' is a {{icon|ance}} {{man label|Charts}} category view addon that presents a navigable descendant tree using the current active person as a starting point. Clicking another person in the family tree will make that person the active person and will redraw the family tree based on them.
+
From the {{icon|ance}} {{man label|Charts}} category view select the '''Graph View''' icon or select {{man menu|View > Graph View}} from the menu.
  
== Features ==
+
=== Configure Options ===
 +
Select {{man menu|View > Configure...}} from the menu to change the settings on the following four tabs:
 +
 
 +
*Layout
 +
**{{checkbox|1}}{{man label|Show images}} (checkbox selected by default)
 +
**{{checkbox|1}}{{man label|Show avatars}} (checkbox selected by default)
 +
**{{checkbox|1}}{{man label|Highlight the home person}} (checkbox selected by default)
 +
**{{checkbox|0}}{{man label|Show full dates}} (checkbox unselected by default)
 +
**{{checkbox|0}}{{man label|Show places}} (checkbox unselected by default)
 +
**{{checkbox|0}}{{man label|Show tags}} (checkbox unselected by default)
 +
 
 +
*Themes
 +
**{{man label|Person theme:}}
 +
***'''Default'''
 +
*** Image on right side
 +
*** Image on left side
 +
**{{man label|Home person color:}} '''<code>#000000</code>'''(default)
 +
**{{man label|Font:}} - shows the default that can be changed by selecting from the
 +
*** {{man label|Pick a Font}} dialog
 +
 
 +
*Animation
 +
**{{checkbox|1}}{{man label|Show animation}} (checkbox selected by default)
 +
***{{man label|Animation speed (1..5 and 5 is the slower):}} (default is 3)
 +
***{{man label|Animation count (0..8 use 0 to turn off):}} (default is 4)
 +
 
 +
*Search
 +
**{{checkbox|1}}{{man label|Search in all database}}(checkbox selected by default)
 +
**{{checkbox|1}}{{man label|Show person image}}(checkbox selected by default)
 +
**{{checkbox|1}}{{man label|Show bookmarked first}}(checkbox selected by default)
 +
 
 +
==Features==
  
 
* Interactive.
 
* Interactive.
Line 13: Line 47:
 
* Clicking a person will redraw the family tree based on that person.
 
* Clicking a person will redraw the family tree based on that person.
 
* Clicking the active person will show the parent family of the active person, thereby allowing previous generations to be shown.
 
* Clicking the active person will show the parent family of the active person, thereby allowing previous generations to be shown.
 +
* Ability to show both ancestors and descendant trees (adjustable from the Graph View toolbar.
 
* The view can be panned by using mouse click and drag. Select the background of the tree and drag the mouse to pan the view.
 
* The view can be panned by using mouse click and drag. Select the background of the tree and drag the mouse to pan the view.
* The view can be zoomed using the slider.
+
* Use the {{man button|'''+'''(Zoom in)}}/{{man button|'''-'''(Zoom out)}} buttons to zoom in or out of the view.
 +
* Use the {{man button|'''☐'''(Zoom to best fit)}} button to fit the current family tree graph in the display and use the {{man button|'''1'''(Zoom to original)}} button to reset the view to the default size.
 
* A right mouse click on a person or family node shows the person or family editor as appropriate.
 
* A right mouse click on a person or family node shows the person or family editor as appropriate.
 
* Right click a family to add or delete a spouse or child.
 
* Right click a family to add or delete a spouse or child.
 
* The view redraws in response to changes made to a person or family.
 
* The view redraws in response to changes made to a person or family.
 +
* Save the dot file for a later printing.  This will save a .gv file and a svg file. You must select a .gv file.
 +
* Bookmark a person from the view and manage them using the {{man button|Go to bookmark}} button.
 +
* Ability to {{man button|🔍 Search...}} current family tree graph and total family tree database as well as any saved bookmarks.
 +
* Right click an empty section of the view to choose the type of connecting {{man label|Lines type}}, options are ''Direct'', ''Curves'', ''Ortho''
  
== Configure Options ==
+
[[File:Graph View Empty context menu.png|thumb|450px|Right click menu shown when selecting an empty section of the chart.]]
You can change the following:
+
[[File:Graph View person context menu.png|thumb|450px|Right click menu shown when selecting a Person on the chart.]]
 
+
[[File:Graph View family context menu.png|thumb|450px|Right click menu shown when selecting a Family (node) on the chart.]]
*Layout
 
**{{checkbox|1}}{{man label|Show images}} (checkbox selected by default)
 
**{{checkbox|1}}{{man label|Highlight the home person}} (checkbox selected by default)
 
**{{checkbox|0}}{{man label|Show full dates}} (checkbox unselected by default)
 
**{{checkbox|0}}{{man label|Show places}} (checkbox unselected by default)
 
 
 
*Colors
 
**{{man label|Home person color:}} '''<code>#bbe68a</code>'''(default)
 
  
 
== Prerequisites ==
 
== Prerequisites ==
 
Before '''Graph View''' can be used you will need the following installed:
 
Before '''Graph View''' can be used you will need the following installed:
* Graphviz. If you can run the Gramps [[Gramps_4.2_Wiki_Manual_-_Reports_-_part_5|Graph reports]] then you already have this installed.
+
* Graphviz. If you can run the Gramps [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_5|Graph reports]] then you already have this installed.
 
* [http://live.gnome.org/PyGoocanvas PyGoocanvas] (Gramps3) or [https://wiki.gnome.org/Projects/GObjectIntrospection Goocanvas2 or gir1.2-goocanvas] (Gramps4)
 
* [http://live.gnome.org/PyGoocanvas PyGoocanvas] (Gramps3) or [https://wiki.gnome.org/Projects/GObjectIntrospection Goocanvas2 or gir1.2-goocanvas] (Gramps4)
 
* [http://live.gnome.org/GooCanvas Goocanvas]
 
* [http://live.gnome.org/GooCanvas Goocanvas]
 +
 +
=== Linux ===
  
 
All of these should be available in common Linux distributions.  
 
All of these should be available in common Linux distributions.  
  
For example, Debian packages Goocanvas/PyGoocanvas as libgoocanvas3 and python-pygoocanvas.
+
For example,  
  
=== Note ===
+
;Debian
 +
Packages Goocanvas/PyGoocanvas as libgoocanvas3 and python-pygoocanvas.
 +
 
 +
Note: As of May 2020 the required packages for Debian Testing are gir1.2-goocanvas-2.0 and libgoocanvas-2.0-9 from the official repositories.
  
 
;Linux Mint Debian Edition (LMDE)
 
;Linux Mint Debian Edition (LMDE)
Line 52: Line 89:
  
 
== Issues ==
 
== Issues ==
{{man warn|The larger the number of people in the Family Tree|The longer the chart will take to appear eg: about 7000 people takes 10 minutes.}}
 
* See work around in {{bug|8506}} to enable saving of GraphView charts.
 
 
* {{bug|8054#c44291}} - Test code for Printing.
 
* {{bug|8054#c44291}} - Test code for Printing.
 +
* {{bug|9806}} Subprocess on [GraphView] can generate a memory issue
 +
* {{bug|8054}} Better label positioning in Graphview
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Views]]
 
[[Category:Views]]

Revision as of 01:11, 6 April 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.

Gnome-important.png
The larger the number of people in the Family Tree

The longer the chart will take to appear eg: about 7000 people takes 10 minutes.

Gramps-notes.png
Some options only appear in newer versions of Gramps 5.x.x

Graph View - addon - In action showing both ancestors and descendant trees (Gramps 5.1.x version)

Graph View is an interactive Charts Charts category view addon that presents a navigable ancestors and descendant tree using the current active person as a starting point. Clicking another person in the family tree will make that person the active person and will redraw the family tree based on them.


Usage

From the Charts Charts category view select the Graph View icon or select View > Graph View from the menu.

Configure Options

Select View > Configure... from the menu to change the settings on the following four tabs:

  • Layout
    • Show images (checkbox selected by default)
    • Show avatars (checkbox selected by default)
    • Highlight the home person (checkbox selected by default)
    • Show full dates (checkbox unselected by default)
    • Show places (checkbox unselected by default)
    • Show tags (checkbox unselected by default)
  • Themes
    • Person theme:
      • Default
      • Image on right side
      • Image on left side
    • Home person color: #000000(default)
    • Font: - shows the default that can be changed by selecting from the
      • Pick a Font dialog
  • Animation
    • Show animation (checkbox selected by default)
      • Animation speed (1..5 and 5 is the slower): (default is 3)
      • Animation count (0..8 use 0 to turn off): (default is 4)
  • Search
    • Search in all database(checkbox selected by default)
    • Show person image(checkbox selected by default)
    • Show bookmarked first(checkbox selected by default)

Features

  • Interactive.
  • The active person is highlighted.
  • Clicking a person will redraw the family tree based on that person.
  • Clicking the active person will show the parent family of the active person, thereby allowing previous generations to be shown.
  • Ability to show both ancestors and descendant trees (adjustable from the Graph View toolbar.
  • The view can be panned by using mouse click and drag. Select the background of the tree and drag the mouse to pan the view.
  • Use the +(Zoom in)/-(Zoom out) buttons to zoom in or out of the view.
  • Use the (Zoom to best fit) button to fit the current family tree graph in the display and use the 1(Zoom to original) button to reset the view to the default size.
  • A right mouse click on a person or family node shows the person or family editor as appropriate.
  • Right click a family to add or delete a spouse or child.
  • The view redraws in response to changes made to a person or family.
  • Save the dot file for a later printing. This will save a .gv file and a svg file. You must select a .gv file.
  • Bookmark a person from the view and manage them using the Go to bookmark button.
  • Ability to 🔍 Search... current family tree graph and total family tree database as well as any saved bookmarks.
  • Right click an empty section of the view to choose the type of connecting Lines type, options are Direct, Curves, Ortho
Right click menu shown when selecting an empty section of the chart.
Right click menu shown when selecting a Person on the chart.
Right click menu shown when selecting a Family (node) on the chart.

Prerequisites

Before Graph View can be used you will need the following installed:

Linux

All of these should be available in common Linux distributions.

For example,

Debian

Packages Goocanvas/PyGoocanvas as libgoocanvas3 and python-pygoocanvas.

Note: As of May 2020 the required packages for Debian Testing are gir1.2-goocanvas-2.0 and libgoocanvas-2.0-9 from the official repositories.

Linux Mint Debian Edition (LMDE)

These packages are not available for Linux Mint Debian Edition (LMDE). You can download these as .deb files from launchpad and install them in the usual manner. You need the Binary packages shown at the bottom of that pages, except for the development libraries.

Please make sure to download these for the proper architecture, like amd64 for 64-bit PCs (Intel included).

Opensuse

You may need to install typelib-1_0-GooCanvas-2_0 as mentioned in issue 8076.

Issues

  • 8054#c44291 - Test code for Printing.
  • 9806 Subprocess on [GraphView] can generate a memory issue
  • 8054 Better label positioning in Graphview