Difference between revisions of "Addon:NetworkChart"
(→Main) |
|||
| Line 28: | Line 28: | ||
===Main=== | ===Main=== | ||
| − | The main menu controls the output filename, | + | The main menu (see image on left) controls the output filename, folder, and chart title. The filename defaults originally to the database name + '_network' (the '.svg' is added automatically). The title defaults to the database name and the folder to the top level user default home. Once an entry is changed it will be remembered and used for the next time as well. Clearing the entry will set it back to default. Additionally, name and date formats for the chart can be modified using the Gramps available formatting. |
| + | |||
| + | Graph style menu selects the type of connectors with choices being Orthogonal, Straight, and Curved. In the example default output shown on the right, the default orthogonal option was selected resulting in straight connectors with right angles. Graphs with over 1500 people should probably use the Curved or Straight options with noticeable reduction in the time needed for graph generation. Graph direction control which of the four different orientations are used. | ||
| + | |||
| + | |||
[[File:Network_chart_menu_Main.png|thumb|400px|left|Network Chart Main Menu]][[File:Shakespeare_network_1_dynamic_url.svg|thumb|290px|Example Default Output]] | [[File:Network_chart_menu_Main.png|thumb|400px|left|Network Chart Main Menu]][[File:Shakespeare_network_1_dynamic_url.svg|thumb|290px|Example Default Output]] | ||
Revision as of 23:31, 9 March 2017
Network Chart is a website plugin for Gramps. The objectives of Network Chart:
- Generate a single graph showing connectivity between individuals
- Clickable nodes (individuals) that contain a hyperlink for a visual index
- Display connectivity paths and highlight them
The default output is a Scalable Vector Graphics (SVG) file that can be viewed in a browser. Network Chart uses the python networkx module to assist in selecting what to display and the pygraphviz module to generate the chart.
To start the Network Chart plugin use the following menu option Reports > Web Pages > Network Chart...
Prerequisites
Requires the following to be installed:
pip install networkx
To get "libcgraph" for pygraphviz you first need to install the development package of graphviz eg:
apt install graphviz-dev
or
dnf install graphviz-devel
then run:
pip install pygraphviz
Usage
Main
The main menu (see image on left) controls the output filename, folder, and chart title. The filename defaults originally to the database name + '_network' (the '.svg' is added automatically). The title defaults to the database name and the folder to the top level user default home. Once an entry is changed it will be remembered and used for the next time as well. Clearing the entry will set it back to default. Additionally, name and date formats for the chart can be modified using the Gramps available formatting.
Graph style menu selects the type of connectors with choices being Orthogonal, Straight, and Curved. In the example default output shown on the right, the default orthogonal option was selected resulting in straight connectors with right angles. Graphs with over 1500 people should probably use the Curved or Straight options with noticeable reduction in the time needed for graph generation. Graph direction control which of the four different orientations are used.
Color
Privacy
Trim
Trim Descendants This option attempts to trim all descendants "below" the selected individuals. Individuals by marriage can also be removed. If an individual is connected by another path or branch they will not be removed.
Trim Ancestors This option attempts to trim all ancestors "above" the selected individuals. Individuals by marriage can also be removed. If an individual is connected by another path or branch they will not be removed.
Trim Groups This option will trim smaller groups/trees that are disconnected. You must enter the minimum number of individuals in a group/tree to display. For databases with more than 1500 individuals this option is required and the minimum number is set to 2. This will force all disconnected single individuals to be removed from the graph. Selecting a number greater than the largest group/tree will return only the largest tree or those trees that are equal in size.
Highlight
Show Path Only This is the last method to select what portion of the database to display. The choices are "Direct" or "Any". The Direct option will attempt to find a direct path between the two individuals selected and display only that path. The Any option will attempt to find any path between the two selected individuals and display only that path.
Center Person This is an option in selecting the portion of the database to display. Selecting a center person and radius for the graph will isolate the graph to just that selected person and anyone within the radius. The radius is the maximum allowable steps or edges between the center person and anyone else in the graph. All others outside of the maximum steps or edges will not be shown. Any connection via parent, child, or marriage counts as a step or edge.
