Skip to content

magicsunday/webtrees-fan-chart

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest version License PHPStan PHPCodeSniffer CodeQL

Scrutinizer Code Quality Build Status Code Climate Issue Count

Fan chart

This module provides an SVG ancestor fan chart for the webtrees genealogy application.

210 Degree chart with opened contextmenu 210 Degree chart with color gradients and hidden empty segments

Installation

Requires webtrees 2.1.

Using Composer

To install using composer, just run the following command from the command line at the root directory of your webtrees installation.

composer require magicsunday/webtrees-fan-chart:* --update-no-dev

The module will automatically install into the modules_v4 directory of your webtrees installation.

To remove the module run:

composer remove magicsunday/webtrees-fan-chart --update-no-dev

Using Git

If you are using git, you could also clone the current master branch directly into your modules_v4 directory by calling:

git clone https://github.com/magicsunday/webtrees-fan-chart.git modules_v4/webtrees-fan-chart

Manual installation

To manually install the module, perform the following steps:

  1. Download the latest release.
  2. Upload the downloaded file to your web server.
  3. Unzip the package into your modules_v4 directory.
  4. Rename the folder to webtrees-fan-chart

Enable module

Go to the control panel (admin section) of your installation and scroll down to the Modules section. Click on Charts (in subsection Genealogy). Enable the Fan chart custom module (optionally disable the original installed fan chart module) and save your settings.

Control panel - Module administration

Usage

At the charts' menu, you will find a new link called Fan chart. Use the provided configuration options to adjust the layout of the charts according to your needs.

Right clicking on an individual opens an tooltip providing more detailed information of the current individual.

Development

To build/update the javascript, run the following commands:

npm install --unsafe-perm --save-dev
npm run prepare

Run tests

composer update
vendor/bin/phpstan analyse -c phpstan.neon
vendor/bin/phpcs src/ --standard=PSR12