Code Monkey home page Code Monkey logo

loopback-model-visualizer's Introduction

Loopback Data Model Visualizer

The Loopback Data Model visualizer generates DOT or SVG diagrams from model definitions using graphviz.

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

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

loopback-model-visualizer's People

Contributors

rmg avatar raymondfeng avatar cgole avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.