fybdp-d3-kg/README.md

Knowledge Graph using React and D3.js

<p align="center">
   <a href="https://npm.fybdp.com/-/web/detail/@local/d3-kg">
    d3-kg </a> Data graph visualization library for React based on D3js
  <br /><br />  
</p>

---

d3-kg is a modular chart component library that leverages
React natively for rendering the components while using D3js under the
hood for calculations. The library provides an easy way to get started
creating charts without sacrificing customization ability.

## Quick Links

- Checkout the [demos](https://npm.fybdp.com/-/web/detail/@local/d3-kg)
- Learn more in the [docs](https://gitlab.fybdp.com/fuxi/d3-kg) 
- Learn about updates from the [changelog](CHANGELOG.md)

## Features

Chart types include:

- Bar Chart
  - Single Series Vertical / Horizontal
  - Multi Series Vertical / Horizontal
  - Stacked Vertical / Horizontal
  - Stacked Normalized Vertical / Horizontal
  - Stacked Diverging Vertical / Horizontal
  - Marimekko
  - Radial
  - Sparkline
  - Waterfall
- Line Chart
  - Single Series
  - Multi Series
  - Stacked
  - Stacked Normalized
  - Radial
  - Sparklines
- Area Chart
  - Single Series
  - Multi Series
  - Stacked
  - Stacked Normalized
  - Radial
  - Sparklines
- Bubble Chart
  - Linear
  - Radial
- Scatter Chart
  - Linear
  - Radial
- Pie Chart
  - Standard
  - Exploded
- Donut Chart
- Sankey chart
- Hive Plot
- Gauge
  - Radial
  - Linear
- Map Chart
- Heatmap
  - Standard
  - Year Calendar
  - Month Calendar

Additional features:

- Legend
  - Discrete
  - Sequential
- Axis
  - Linear
  - Radial
  - Advanced Label Positioning
- Gestures
  - Pinch
  - Pan
  - Zoom
  - Move
- Tooltip
  - Single Value
  - Grouped Values
- Line/Area Series Symbols
- Animations Enter/Update/Exit
- Brush
- Patterns
- Gradients
- Grid Lines
- Mark Lines
- BigInt Support
- Auto Sizing
- Range Lines
- SSR

## Install

To use d3-kg in your project, install it via npm/yarn:

```
npm i d3-kg --save
```

then import a chart type into your JSX element:

```jsx
import { BarChart } from "d3-kg";

const data = [
  { key: 'IDS', data: 14 },
  { key: 'Malware', data: 5 },
  { key: 'DLP', data: 18 }
];

const App = () => <BarChart width={350} height={250} data={data} />;
```

Checkout this [demo live](#) or
visit the [demos page](#) to learn more!

## Development

If you want to run d3-kg locally, its super easy!
- Set npm registry
- `npm set registry https://npm.fybdp.com` 

- Clone the repository
- `npm install`
- `npm run start`
- Browser opens to Storybook page

to publish the repo to git you can run:
- `git clone git@gitlab.fybdp.com:fuxi/d3-kg.git`
- `npm login` to login npm
- `npm version patch` to bump the version
- `npm publish` to bump the version
- `git push --follow-tags`

## thanks
- D3
- react
- Reaviz
- https://github.com/d3/d3/wiki/Plugins
- http://www.coppelia.io/2014/07/an-a-to-z-of-extra-features-for-the-d3-force-layout/
- https://bl.ocks.org/AndreaSimeone/3dce7e69ef27c871b9ce851379f6f7d8
- https://algs4.cs.princeton.edu/42digraph/
- https://blog.csdn.net/NoTwice/article/details/48275335
- https://blog.csdn.net/wry2008wry/article/details/80812562
- https://www.jb51.net/article/154227.htm