Difference between revisions of "Graph View"

From Gramps
Jump to: navigation, search
(Configure Options)
 
(53 intermediate revisions by 6 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 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|Ancestors tree only available in the Gramps 5.0.x version of Graph View}}
+
{{man note|Some options only appear in newer versions of Gramps 5.x.x}}
[[File:Graph-View-addon-example-50.png|450px|thumb|right|Graph View - addon - In action showing both ancestors and descendant trees (Gramps 5.0.x version)]]
+
[[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)]]
[[File:Graph-View-plugin-addon-example-42.png|450px|thumb|right|Graph View - addon - In action showing only descendant trees (Gramps 4.2.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.
'''Graph View''' is an interactive {{icon|ance}} {{man label|Charts}} category view addon that presents a navigable ancestors(Gramps 5.0.x version only) 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 ==
 
== Usage ==
  
 
From the {{icon|ance}} {{man label|Charts}} category view select the '''Graph View''' icon or select {{man menu|View > Graph View}} from the menu.
 
From the {{icon|ance}} {{man label|Charts}} category view select the '''Graph View''' icon or select {{man menu|View > Graph View}} from the menu.
 +
 +
In general the Graph View is:
 +
* Interactive, the view redraws in response to changes made to a person or family.
 +
* The active person is highlighted.
 +
* Clicking on another 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.
 +
* A right mouse click on a person or family node shows the person or family editor as appropriate.
 +
* Able to show both ancestors and descendant trees (adjustable from the Graph View toolbar).
 +
* Graph view can be panned by using mouse click and drag. Select the background of the tree and drag the mouse to pan the view. Also you can use mouse scroll button to pan view in any place of view.
 +
 +
=== Graph View Toolbar ===
 +
[[File:Graph-View-addon-toolbar-highlighted-51.png]]
 +
 +
Graph View has a smaller toolbar of its own with the following options (from left to right):
 +
 +
* {{man button|'''+'''(Zoom in)}} button - Zoom in the view.
 +
* {{man button|'''-'''(Zoom out)}} button - Zoom out the view.
 +
* {{man button|'''1'''(Zoom to original)}} button to reset the view to the default size.
 +
* {{man button|'''☐'''(Zoom to best fit)}} button to fit the current family tree graph in the display
 +
* {{man button|'''⏎''' (Go to active person)}}
 +
* {{man button|Go to bookmark}} button - Center view on selected bookmark - also shows "Bookmarks for current graph:" (who are being display) and "Other Bookmarks:" (who are not being displayed) - along with two buttons to "Add active person" to bookmarks and "Edit" the bookmarks.
 +
* {{man button|🔍 Search...}} - typing shows "Persons from current graph:" (who are being display) and "Other persons from the database:" (who are not being displayed) as well as any saved bookmarks. You can use <Ctrl+F> to make search entry active.
 +
* {{man button|Generations}} - setting to change the generations shown for Ancestor 3 generations by default and Descendants 10 generations by default.
 +
* {{man button|Spacing}} - changes the vertical(5 default) and horizontal(2 default) spacing between the generations.
 +
 +
On the main Gramps Toolbar you also have:
 +
* {{man button|'''⎙'''(Print)}} button that does not print but instead allows you to save the currently displayed Graph into a dot format file for a later printing.  This will save a .gv file and a svg file. You must select a .gv file.
 +
* {{man button|* (Configure Options)}} button with option shown in the next section.
  
 
=== Configure Options ===
 
=== Configure Options ===
Select {{man menu|View > Configure...}} from the menu to change the following:
+
Select {{man menu|View > Configure...}} from the menu to change the settings on the following four tabs:
  
 
*Layout
 
*Layout
 
**{{checkbox|1}}{{man label|Show images}} (checkbox selected by default)
 
**{{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|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 full dates}} (checkbox unselected by default)
 
**{{checkbox|0}}{{man label|Show places}} (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|Path color to home person:}} '''<code>#000000</code>'''(default)
 +
**{{man label|Font:}} - shows the default that can be changed by selecting from the
 +
*** {{man label|Pick a Font}} dialog
  
*Colors
+
*Animation
**{{man label|Home person color:}} '''<code>#bbe68a</code>'''(default)
+
**{{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)
  
== Features ==
+
*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)
  
* Interactive.
+
===Context menus===
* The active person is highlighted.
+
Graph view has three [https://en.wikipedia.org/wiki/Context_menu context menus] that allow the following
* 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.
+
====Empty section====
* 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.
+
* Right click an empty section of the view to choose the type of connecting {{man label|Lines type}}, options are ''Direct'', ''Curves'', ''Ortho''
* Use the {{man label|Zoom:}} slider to zoom in or out of the view.
+
[[File:Graph View Empty context menu.png|thumb|450px|Right click menu shown when selecting an empty section of the chart.]]
* 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.
+
====Person node====
* The view redraws in response to changes made to a person or family.
+
* Right click a person (node) to do the following.
* Save the dot file for a later printing.  This will save a .gv file and a svg file. You must select a .gv file.
+
[[File:Graph View person context menu.png|thumb|450px|Right click menu shown when selecting a Person on the chart.]]
 +
{{-}}
 +
====Family node====
 +
* Right click a family (node) to add or delete a spouse or child.
 +
[[File:Graph View family context menu.png|thumb|450px|Right click menu shown when selecting a Family (node) on the chart.]]
 +
{{-}}
  
 
== 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_5.0_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]
Line 49: Line 99:
 
;Debian
 
;Debian
 
Packages Goocanvas/PyGoocanvas as libgoocanvas3 and python-pygoocanvas.
 
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 59: Line 111:
  
 
== Issues ==
 
== Issues ==
* {{bug|8054#c44291}} - Test code for Printing.
+
You can see related issues at [https://gramps-project.org/bugs/search.php?tag_string=GraphView bug tracker].
* {{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]]

Latest revision as of 18:28, 20 July 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 plugin 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.

In general the Graph View is:

  • Interactive, the view redraws in response to changes made to a person or family.
  • The active person is highlighted.
  • Clicking on another 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.
  • A right mouse click on a person or family node shows the person or family editor as appropriate.
  • Able to show both ancestors and descendant trees (adjustable from the Graph View toolbar).
  • Graph view can be panned by using mouse click and drag. Select the background of the tree and drag the mouse to pan the view. Also you can use mouse scroll button to pan view in any place of view.

Graph View Toolbar

Graph-View-addon-toolbar-highlighted-51.png

Graph View has a smaller toolbar of its own with the following options (from left to right):

  • +(Zoom in) button - Zoom in the view.
  • -(Zoom out) button - Zoom out the view.
  • 1(Zoom to original) button to reset the view to the default size.
  • (Zoom to best fit) button to fit the current family tree graph in the display
  • (Go to active person)
  • Go to bookmark button - Center view on selected bookmark - also shows "Bookmarks for current graph:" (who are being display) and "Other Bookmarks:" (who are not being displayed) - along with two buttons to "Add active person" to bookmarks and "Edit" the bookmarks.
  • 🔍 Search... - typing shows "Persons from current graph:" (who are being display) and "Other persons from the database:" (who are not being displayed) as well as any saved bookmarks. You can use <Ctrl+F> to make search entry active.
  • Generations - setting to change the generations shown for Ancestor 3 generations by default and Descendants 10 generations by default.
  • Spacing - changes the vertical(5 default) and horizontal(2 default) spacing between the generations.

On the main Gramps Toolbar you also have:

  • (Print) button that does not print but instead allows you to save the currently displayed Graph into a dot format file for a later printing. This will save a .gv file and a svg file. You must select a .gv file.
  • * (Configure Options) button with option shown in the next section.

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
    • Path color to home person: #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)

Context menus

Graph view has three context menus that allow the following

Empty section

  • 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.


Person node

  • Right click a person (node) to do the following.
Right click menu shown when selecting a Person on the chart.


Family node

  • Right click a family (node) to add or delete a spouse or child.
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

You can see related issues at bug tracker.