react-tree-svg
v1.4.0
Published
[![NPM version][npm-image]][npm-url] [![build status][ci-image]][ci-url] [![Test coverage][codecov-image]][codecov-url] [![npm download][download-image]][download-url]
Downloads
1,722
Readme
react-tree-svg
Introduction
This project allows to create a horizontal representation of a tree.
It uses React and can be included in other project as a React component but can also be used to generate a svg.
In order to be able to generate the SVG on the server and on the client we need that each element is rendered synchronously
Installation
$ npm i react-tree-svg
Usage
Taxonomy Tree
const {render} = require('react-tree-svg');
const data = [
{
name: 'string',
rank: 'string',
count: 3,
children: [{...}],
nbTaxonomies: 8,
},
];
const svg = render(data, {
nodeRenderer: 'taxonomy',
rankDepthOptions: {
maxRankDepth: 8,
},
positionOptions: {
spacingHorizontal: 100,
},
});
Molecules Tree
const {render} = require('react-tree-svg');
const data = [
{
reaction: {
Label: 'string',
rxnCode: 'string',
},
reactant: {
molfile: 'string',
idCode: 'string',
mf: 'string',
monoisotopicMass: 121.0697,
},
products: {
molfile: 'string',
idCode: 'string',
mf: 'string',
children: [{...}],
monoisotopicMass: 105.065,
},
},
];
const svg = render(data, {
nodeRenderer: 'molecule',
nodeRendererOptions: {
masses: [105.0697, 58.065, 194.1173, 163.0752, 133.0647, 135.0439],
precision: 50,
},
positionOptions: {
spacingHorizontal: 150,
},
});
Reaction Trees
const {render} = require('react-tree-svg');
const dataTrees= [
{
reaction: {
Label: Ionization,
rxnCode: "eM`BN`~b@!eM``fN`~c@#Q[ Q[#!R@AM?DquRo@ !R@AM?Dqtzo@"
},
reactant: {
molfile: "",
idCode: "dg~D@MBdie]v\\kahHBjh@@",
mf: "C11H15NO2",
em: 193.11027900000002,
mz: 193.11027900000002,
charge: 0
},
products: [
{
molfile: "",
idCode: "dg~DBMBmeJYW]gJxZB@jj@@",
mf: "C11H16NO2(+)",
em: 194.11810400000002,
mz: 194.11810400000002,
charge: 1,
children: [...],
}
]
}
];
const svgTrees = TreeSVG.render(dataTrees, {
nodeRenderer: 'trees',
nodeRendererOptions: {
masses: [
58.065, 105.0697, 133.0647, 135.0439, 163.0752, 194.1173, 530.15,
],
precision: 50,
numberFormat: '0.0000',
},
positionOptions: {
spacingHorizontal: 150,
},
});