Git Product home page Git Product logo

maturity-radar's Introduction

maturity-radar

Overview

A simple JS library for embedding a maturity radar, given axis definitions and target/actual values. It allows you to embed a clear and intuitive maturity radar anywhere you can embed HTML and JavaScript. The display includes colourization based on maturity level (on a traffic light gradient) and hover functionality to provide tooltip access to metrics and maturity levels.

The maturity radar in use looks like this (this is the demo file provided in the repo as /dist/index.html, which is also useful if you want to modify the code for your own use (NPM and WebPack is the short answer to the first question you'll ask).

Maturity Radar

Usage

You can use the the library directly from the githack CDN by referencing the following URI:

https://rawcdn.githack.com/kolektiv/maturity-radar/master/dist/radar.js

To use the maturity radar, create an empty page element in which to embed the radar, and include the library:

<div id="demo"></div>
<script src="https://rawcdn.githack.com/kolektiv/maturity-radar/master/dist/radar.js"></script>

Now, simply define your data in a script element. The radar.show function takes a selector for the element to use as a container, and an object containing a desired pixel size, and the metrics to display, like so.

<script>
radar.show('#demo', {
  size: 700,
  metrics: [
    {
      name: "Metric 1",
      range: [
        "Value 0",
        "Value 1",
        "Value 2",
        "Value 3"
      ],
      target: 2,
      actual: 1
    },
    ...
  ]
});
</script>

Each metric requires a name, a range (a simple ordered array of maturity values, from 0 onwards), a target maturity level, and an actual maturity level. The library is quite adaptive. It should cope reasonably well with metrics with different cardinalities, maturity measures with different numbers of metrics.

Acknowledgements

maturity-radar contains a tree-shaken version of various d3 libraries (it is built using d3).

The maturity radar is a simplified and specialised version of the radar chart work done by Nadieh Bremer (https://bl.ocks.org/nbremer). It has been rebuilt to be less generic and more opinionated, focused solely on providing a simple and embeddable way to display maturity levels.

maturity-radar's People

Contributors

kolektiv 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.