Difference between revisions of "Addon:Graph View"
ErickLedger (talk | contribs) (→Context menus: Add in page links like above section) |
Codefarmer (talk | contribs) (GraphViz configuration for PortableApps installation) |
||
| (19 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{languages|Addon:Graph View}} | {{languages|Addon:Graph View}} | ||
{{Third-party addon}} | {{Third-party addon}} | ||
| − | [[File:Graph-View-addon-example- | + | [[File:Graph-View-addon-example-60.png|450px|thumb|right|"Graph View" - addon - In action showing both ancestors and descendant trees]] |
'''{{man label|Graph View}}''' is an interactive {{icon|ance}} {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Categories#Charts_Category|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. | '''{{man label|Graph View}}''' is an interactive {{icon|ance}} {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Categories#Charts_Category|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. | ||
| Line 16: | Line 16: | ||
* Able to show both ancestors and descendant trees (adjustable from the Graph View toolbar). | * 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 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. | ||
| + | * Connecting full line style represents biological relationships and dashed lines non biological. | ||
=== Graph View Toolbar === | === Graph View Toolbar === | ||
| − | [[File:Graph-View-addon-toolbar- | + | [[File:Graph-View-addon-toolbar-overview-60.png]] |
Graph View has a smaller toolbar of its own with the following options (from left to right): | Graph View has a smaller toolbar of its own with the following options (from left to right): | ||
| Line 73: | Line 74: | ||
* {{man label|Font:}} shows the default that can be changed by selecting from the | * {{man label|Font:}} shows the default that can be changed by selecting from the | ||
** {{man label|Pick a Font}} dialog | ** {{man label|Pick a Font}} dialog | ||
| − | * {{man label|Avatars style:}} | + | * {{man label|Avatars style:}} for person nodes. |
** ''Custom'' - adds four more popup entries to allow you to select your own avatar images: | ** ''Custom'' - adds four more popup entries to allow you to select your own avatar images: | ||
*** {{man label|Male avatar:}} ''File selector'' | *** {{man label|Male avatar:}} ''File selector'' | ||
| Line 82: | Line 83: | ||
** ''Light'' | ** ''Light'' | ||
** ''Cartoon'' | ** ''Cartoon'' | ||
| + | ** ''Modern'' | ||
| + | ** ''Updated'' | ||
| + | ** ''Generic (dark)'' | ||
| + | ** ''Generic (grey)'' | ||
| + | ** ''Generic (light)'' | ||
[[File:Graph-View Avatar set.png|471px|thumb|right|Graph View - Avatar styles (Left to right: '''Dark''' / '''Light''' / '''Cartoon''')]] | [[File:Graph-View Avatar set.png|471px|thumb|right|Graph View - Avatar styles (Left to right: '''Dark''' / '''Light''' / '''Cartoon''')]] | ||
* {{man label|Active person border size:}} <code>3</code>(default) | * {{man label|Active person border size:}} <code>3</code>(default) | ||
| Line 108: | Line 114: | ||
[[File:GraphView-empty-context menu-52.png|thumb|450px|Right click menu shown when selecting an empty section of the chart.]] | [[File:GraphView-empty-context menu-52.png|thumb|450px|Right click menu shown when selecting an empty section of the chart.]] | ||
Right-click an empty section of the Graph View to offer the following display options: | Right-click an empty section of the Graph View to offer the following display options: | ||
| − | * {{checkbox|1}}{{man | + | * {{checkbox|1}}{{man menu|Show images}} - Display thumbnails or avatars |
| − | * {{checkbox|1}}{{man | + | * {{checkbox|1}}{{man menu|Highlight the home person}} - set the background of the Home Person to green |
| − | * {{checkbox|0}}{{man | + | * {{checkbox|0}}{{man menu|Show full dates}} - format the birth and death date as only the year or as the complete date |
| − | * {{checkbox|0}}{{man | + | * {{checkbox|0}}{{man menu|Show places}} - show or hide birth and death places |
| − | * {{checkbox|0}}{{man | + | * {{checkbox|0}}{{man menu|Show tags}} - show color markers on tagged Persons and Families |
| − | * {{checkbox|1}}{{man | + | * {{checkbox|1}}{{man menu|Show animation}} - after redraws, wiggle the Active Person to draw focus |
| − | + | * {{man menu|Lines type}} - choose the style of lines connecting People and Families | |
| − | * {{man | + | ** {{man menu|''Direct''}} |
| − | ** Direct | + | ** {{man menu|'''Curves'''}} (default) |
| − | ** Curves | + | ** {{man menu|''Ortho''}} |
| − | ** Ortho | + | * {{man menu|About Graph View}} - this help wiki webpage |
| − | * {{man | ||
{{-}} | {{-}} | ||
| Line 127: | Line 132: | ||
<hr> | <hr> | ||
| − | * Edit | + | * {{man menu|Edit}} |
| − | * Copy | + | * {{man menu|Copy}} |
| − | * Delete | + | * {{man menu|Delete}} |
<hr> | <hr> | ||
| − | * Events | + | * {{man menu|Events}} |
| − | * Tags | + | * {{man menu|Tags}} |
| − | * Spouses | + | * {{man menu|Spouses}} |
| − | * Siblings | + | * {{man menu|Siblings}} |
| − | * Children | + | * {{man menu|Children}} |
| − | * Parents | + | * {{man menu|Parents}} |
| − | * Related - shows people sharing an event | + | * {{man menu|Related}} - shows people sharing an event |
<hr> | <hr> | ||
| − | * Set as home person | + | * {{man menu|Set as home person}} |
| − | * Show path to home person - changes the view to show how these two people connect to their common ancestor | + | * {{man menu|Show path to home person}} - changes the view to show how these two people connect to their common ancestor |
| − | * Add to bookmarks | + | * {{man menu|Add to bookmarks}} |
<hr> | <hr> | ||
| − | * [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Quick_View|Quick View]] | + | * {{man menu|[[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Quick_View|Quick View]]}} |
| − | * [[Addon:Web_Connect_Pack|Web Connection]] | + | * {{man menu|[[Addon:Web_Connect_Pack|Web Connection]]}} |
<hr> | <hr> | ||
| − | * About Graph View | + | * {{man menu|About Graph View}} |
{{-}} | {{-}} | ||
| Line 153: | Line 158: | ||
Right click a family (node) to add or delete a spouse or child. | Right click a family (node) to add or delete a spouse or child. | ||
| − | * Edit | + | * {{man menu|Edit}} |
| − | * Delete | + | * {{man menu|Delete}} |
<hr> | <hr> | ||
| − | * Events | + | * {{man menu|Events}} |
| − | * Tags | + | * {{man menu|Tags}} |
| − | * Spouses | + | * {{man menu|Spouses}} |
| − | * Children | + | * {{man menu|Children}} |
<hr> | <hr> | ||
| − | * [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Quick_View|Quick View]] | + | * {{man menu|[[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#Quick_View|Quick View]]}} |
<hr> | <hr> | ||
| − | * About Graph View | + | * {{man menu|About Graph View}} |
<hr> | <hr> | ||
{{-}} | {{-}} | ||
==={{man label|Incomplete graph}} warning === | ==={{man label|Incomplete graph}} warning === | ||
| − | [[File:Incomplete-graph-warning-graphview-addon- | + | [[File:Incomplete-graph-warning-graphview-addon-60.png|thumb|450px|right]]<!--Update message --> |
''This graph would contain at least {people_count} people, which exceeds the limit of {people_limit} people. For performance reasons, at least {people_missing} people won't be shown. You can change this limit in the view configuration.'' | ''This graph would contain at least {people_count} people, which exceeds the limit of {people_limit} people. For performance reasons, at least {people_missing} people won't be shown. You can change this limit in the view configuration.'' | ||
| Line 175: | Line 180: | ||
<!--{{man warn|Feature is slow in larger Trees|The larger the number of people in the Family Tree, the longer the chart will take to appear.<br />e.g.: a test with about 7000 people took 10 minutes.</br>This can be adjusted by changing the number of generations to be shown.}}--> | <!--{{man warn|Feature is slow in larger Trees|The larger the number of people in the Family Tree, the longer the chart will take to appear.<br />e.g.: a test with about 7000 people took 10 minutes.</br>This can be adjusted by changing the number of generations to be shown.}}--> | ||
| + | {{-}} | ||
== 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: | ||
| − | * [[Output_formats#Graphviz|Graphviz]]. If you can run the Gramps [[Gramps_{{ | + | * [[Output_formats#Graphviz|Graphviz]]. If you can run the Gramps [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_5|Graph reports]] then you already have this installed. |
| − | * [https://wiki.gnome.org/ | + | * [https://wiki.gnome.org/Projects/GObjectIntrospection Goocanvas2 or gir1.2-goocanvas] (Gramps 4.x or greater) |
| + | ** [https://wiki.gnome.org/Attic/PyGoocanvas PyGoocanvas] (Gramps 3.x) | ||
* [https://wiki.gnome.org/action/show/Projects/GooCanvas Goocanvas] | * [https://wiki.gnome.org/action/show/Projects/GooCanvas Goocanvas] | ||
| Line 185: | Line 192: | ||
=== Windows === | === Windows === | ||
| − | These are already installed if you are using the Gramps All In One installer eg: <code>GrampsAIOxxxxx.exe</code> | + | These are already installed if you are using the Gramps All In One installer eg: <code>GrampsAIOxxxxx.exe</code>. If you are using the Gramps v6.0.6 PortableApps installer, GraphViz is installed but not configured. Execute these steps once after installing to fix that: |
| + | |||
| + | # Open a command prompt | ||
| + | # Change to the GrampsPortable\App\Gramps folder, e.g. <code>cd C:\GrampsPortable\App\Gramps</code> | ||
| + | # Ask dot to configure plugins and write a configuration file by executing: <code>lib\dot.exe -c</code> | ||
| + | # Launch GrampsPortable and switch to the GraphView and you should see a chart. | ||
=== Linux === | === Linux === | ||
| Line 213: | Line 225: | ||
You can see related issues at [https://gramps-project.org/bugs/search.php?tag_string=GraphView bug tracker]. | You can see related issues at [https://gramps-project.org/bugs/search.php?tag_string=GraphView bug tracker]. | ||
* {{bug|8054#c44291}} - print options. | * {{bug|8054#c44291}} - print options. | ||
| − | * {{bug|9806}} - Subprocess on [GraphView] can generate a memory issue | + | * {{bug|9806}} - Subprocess on [GraphView] can generate a memory issue. |
| − | * {{bug|8054}} - Better label positioning in Graphview | + | * {{bug|8054}} - Better label positioning in Graphview. |
| − | * [https://gramps-project.org/bugs/view.php?id=8964 8964: Enable filter on GraphView] Feature Request | + | * [https://gramps-project.org/bugs/view.php?id=8964 8964: Enable filter on GraphView] Feature Request. |
| − | * [https://github.com/gramps-project/addons-source/pull/459 [GraphView] add custom avatars #459] | + | * [https://github.com/gramps-project/addons-source/pull/459 [GraphView] add custom avatars #459]. |
| + | **[https://gramps.discourse.group/t/customizable-avatars-for-graphview/696 Themed avatar discussion]. | ||
| + | * {{bug|14120}} - GraphView configuration for PortableApp installers. This has been [https://portableapps.com/comment/263547#comment-263547 reported to the PortableApps team]. | ||
==See also== | ==See also== | ||
| Line 225: | Line 239: | ||
[[Category:Developers/General]] | [[Category:Developers/General]] | ||
[[Category:Views]] | [[Category:Views]] | ||
| − | [[Category:Prerequisites]] | + | [[Category:Prerequisites|G]] |
Latest revision as of 15:58, 8 April 2026
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. |
Graph View is an interactive
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.
Contents
Usage
From the 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.
- Connecting full line style represents biological relationships and dashed lines non biological.
Graph View Toolbar
Graph View has a smaller toolbar of its own with the following options (from left to right):
- + button - Zoom in the view.
- - button - Zoom out the view.
- 1 button - Zoom to original resets the view to the default size.
- ☐ button - Zoom to best fit fits the current family tree graph to the displayed area.
- ⏎ button - Go to active person centering them in the graph area.
- 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 that brings up the Organize bookmarks dialog.
- 🔍 Search... - typing shows Persons from current graph: (who are being display) and Other persons from database: (who are not being displayed) as well as any being able to add or remove directly to bookmarks. Search people in the current visible graph and database.
Use <Ctrl + F> to make search entry active. - Generations - setting to change the generations shown for Ancestor generations 3 by default and Descendants generations 10 by default.
- Spacing - changes the Vertical spacing between generations (5 default) and Horizontal spacing between the generations (2 default).
- All connected - Show all connected persons limited by generation restrictions. Works slow, so don't set large generation values. ( Limited to 1000 persons, if your family tree has more than that you get the Incomplete graph warning and only the first 1000 connected persons are drawn.)
On main Gramps Toolbar
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. (Gramps Print -SVG does not show photo)
- Configure the active view with options 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 IDs (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)
- Placeformat:
- Default
- Full
- Show tags (checkbox unselected by default)
- Time Direction:
- Vertical: Top to Bottom
- Vertical: Bottom to Top
- Horizontal: Left to Right
- Horizontal: Right to Left
- Limit number of people displayed (use 0 for unlimited): (
1000default) - lets users set or disable a limit to the number of individuals that may be shown on an All connected chart. If you see the Incomplete graph warning dialog then change this to suit you. [1]
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
- Avatars style: for person nodes.
- Custom - adds four more popup entries to allow you to select your own avatar images:
- Male avatar: File selector
- Female avatar: File selector
- Unknown avatar: File selector
- Other avatar: File selector
- Dark (default)
- Light
- Cartoon
- Modern
- Updated
- Generic (dark)
- Generic (grey)
- Generic (light)
- Custom - adds four more popup entries to allow you to select your own avatar images:
- Active person border size:
3(default) - Person border size:
1(default)
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 images (checkbox selected by default)
- Show bookmarked first (checkbox selected by default)
Graph view has three context menus that allow the following:
Empty section
Right-click an empty section of the Graph View to offer the following display options:
- Show images - Display thumbnails or avatars
- Highlight the home person - set the background of the Home Person to green
- Show full dates - format the birth and death date as only the year or as the complete date
- Show places - show or hide birth and death places
- Show tags - show color markers on tagged Persons and Families
- Show animation - after redraws, wiggle the Active Person to draw focus
- Lines type - choose the style of lines connecting People and Families
- Direct
- Curves (default)
- Ortho
- About Graph View - this help wiki webpage
Person node
Right-click a person (node) to show a context menu offering the following options for the indicated person:
- Edit
- Copy
- Delete
- Events
- Tags
- Spouses
- Siblings
- Children
- Parents
- Related - shows people sharing an event
- Set as home person
- Show path to home person - changes the view to show how these two people connect to their common ancestor
- Add to bookmarks
- About Graph View
Family node
Right click a family (node) to add or delete a spouse or child.
- Edit
- Delete
- Events
- Tags
- Spouses
- Children
- About Graph View
Incomplete graph warning
This graph would contain at least {people_count} people, which exceeds the limit of {people_limit} people. For performance reasons, at least {people_missing} people won't be shown. You can change this limit in the view configuration.
The limit may be removed or changed by setting the Layout tabs Limit number of people displayed (use 0 for unlimited): option.
Prerequisites
Before Graph View can be used you will need the following installed:
- Graphviz. If you can run the Gramps Graph reports then you already have this installed.
- Goocanvas2 or gir1.2-goocanvas (Gramps 4.x or greater)
- PyGoocanvas (Gramps 3.x)
- Goocanvas
Windows
These are already installed if you are using the Gramps All In One installer eg: GrampsAIOxxxxx.exe. If you are using the Gramps v6.0.6 PortableApps installer, GraphViz is installed but not configured. Execute these steps once after installing to fix that:
- Open a command prompt
- Change to the GrampsPortable\App\Gramps folder, e.g.
cd C:\GrampsPortable\App\Gramps - Ask dot to configure plugins and write a configuration file by executing:
lib\dot.exe -c - Launch GrampsPortable and switch to the GraphView and you should see a chart.
Linux
All of these should be available in common Linux distributions.
For example,
- Debian
Packages Goocanvas and 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.
Please make sure to download these for the proper architecture, like amd64 for 64-bit PCs (Intel included).
- Fedora
Try package goocanvas2-devel.
- Opensuse
You may need to install typelib-1_0-GooCanvas-2_0 as mentioned in issue 8076.
macOS
These are already installed if you are using the Gramps All In One installer eg: Gramps-Intel-xxxxx.dmg or Gramps-Arm-xxxxx.dmg
Issues
You can see related issues at bug tracker.
- 8054#c44291 - print options.
- 9806 - Subprocess on [GraphView] can generate a memory issue.
- 8054 - Better label positioning in Graphview.
- 8964: Enable filter on GraphView Feature Request.
- [GraphView] add custom avatars #459.
- 14120 - GraphView configuration for PortableApp installers. This has been reported to the PortableApps team.
See also
- Addon:AvatarGenerator - allows you to add and remove one or several images for a selected set of filtered people.
