react-tree-svg
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

react-tree-svg

[![NPM version][npm-image]][npm-url] [![build status][ci-image]][ci-url] [![Test coverage][codecov-image]][codecov-url] [![npm download][download-image]][download-url]

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,
          },
        });
        ```
## License

[MIT](./LICENSE)

[npm-image]: https://img.shields.io/npm/v/react-tree-svg.svg
[npm-url]: https://www.npmjs.com/package/react-tree-svg
[ci-image]: https://github.com/cheminfo/react-tree-svg/workflows/Node.js%20CI/badge.svg?branch=main
[ci-url]: https://github.com/cheminfo/react-tree-svg/actions?query=workflow%3A%22Node.js+CI%22
[codecov-image]: https://img.shields.io/codecov/c/github/cheminfo/react-tree-svg.svg
[codecov-url]: https://codecov.io/gh/cheminfo/react-tree-svg
[download-image]: https://img.shields.io/npm/dm/react-tree-svg.svg
[download-url]: https://www.npmjs.com/package/react-tree-svg

Readme

Keywords

none

Package Sidebar

Install

npm i react-tree-svg

Weekly Downloads

547

Version

1.0.0

License

none

Unpacked Size

889 kB

Total Files

224

Last publish

Collaborators

  • cheminfo-bot