# loopback-data-visualizer

> Loopback data model visualizer

Latest version **2.0.0** (published 2019-12-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install loopback-data-visualizer
pnpm add loopback-data-visualizer
yarn add loopback-data-visualizer
bun add loopback-data-visualizer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-12-11 |
| First published | 2019-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | shupac |

## Links

- npm: https://www.npmjs.com/package/loopback-data-visualizer
- Repository: https://github.com/strongloop/loopback-data-visualizer
- Homepage: https://github.com/strongloop/loopback-data-visualizer#readme
- Issues: https://github.com/strongloop/loopback-data-visualizer/issues
- npm.io page: https://npm.io/package/loopback-data-visualizer

## Dependencies (2)

- [loopback](https://npm.io/package/loopback.md) ^3.15.0
- [loopback-datasource-juggler](https://npm.io/package/loopback-datasource-juggler.md) ^4.17.0

## Recent versions

- 2.0.0 (latest) — 2019-12-11

## README

# Loopback Data Model Visualizer

The Loopback Data Model visualizer generates DOT or SVG diagrams from model definitions using
[graphviz](http://www.graphviz.org/). 

## To render models to graphviz diagrams such as DOT or SVG.

```js
var schemaSvg = viz.render('Models', models, options);

fs.writeFile(path.join(__dirname, 'loopback-models.svg'), schemaSvg, function (err) {
  if (err) {
    throw err;
  }
  console.log('loopback-models.svg is saved to ' + __dirname);
});

var clsGraph = viz.renderGraph('Models', models, options);

fs.writeFile(path.join(__dirname, 'loopback-models.dot'), clsGraph, function (err) {
  if (err) {
    throw err;
  }
  console.log('loopback-models.dot is saved to ' + __dirname);
});
```

To run samples:

`node example/app`

You will find the following diagrams generated:

* loopback-models.svg (open with browsers such as Chrome)
* loopback-models.dot (open with graphviz)


### Options

#### Filters
* excludingNulls: Excluding null/undefined properties
* format: Diagram format

#### Diagram settings
* ARROW_COLOR
* ARROW_HEAD_MULTIPLIER
* TABLE_FONT_POINTS
* TITLE_BACKGROUND_COLOR
* TITLE_FONT_COLOR
* TITLE_FONT_POINTS
* PROPERTY_BACKGROUND_COLOR
* PROPERTY_ALT_BACKGROUND_COLOR
* PROPERTY_NAME_FONT_COLOR
* PROPERTY_VALUE_FONT_COLOR
* PROTOTYPE_BACKGROUND_COLOR
* PROTOTYPE_FONT_COLOR

## Test
run `npm test`

---
_Source: https://npm.io/package/loopback-data-visualizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._