# mmviz

> MassMutual Visualization Library

Latest version **3.14.4** (published 2024-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install mmviz
pnpm add mmviz
yarn add mmviz
bun add mmviz
```

## 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 | 3.14.4 |
| Published | 2024-04-15 |
| First published | 2016-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Bessey |
| Maintainers | mmbessey, boyooncc, xyz8983, kanastasakis26 |
| Keywords | visualization |

## Links

- npm: https://www.npmjs.com/package/mmviz
- Repository: https://github.com/massmutual/mmviz-web
- Homepage: https://github.com/massmutual/mmviz-web/blob/master/README.md
- Issues: https://github.com/massmutual/mmviz-web/issues
- npm.io page: https://npm.io/package/mmviz

## Dependencies (2)

- [d3](https://npm.io/package/d3.md) 4.10.0
- [d3-format](https://npm.io/package/d3-format.md) ^1.3.2

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 3.14.4 (latest) — 2024-04-15
- 3.14.2 — 2024-04-08
- 3.14.1 — 2024-04-08
- 3.14.0 — 2023-10-03
- 3.13.8 — 2023-07-25
- 3.13.7 — 2023-03-10
- 3.13.5 — 2023-02-17
- 3.13.4 — 2023-02-10
- 3.13.3 — 2023-02-03
- 3.13.2 — 2023-01-27
- 3.13.1 — 2023-01-20
- 3.13.0 — 2023-01-19
- 3.12.0 — 2022-11-09
- 3.11.2 — 2022-10-20
- 3.11.1 — 2022-09-05
- … 138 more at https://npm.io/package/mmviz/versions

## README

# mmviz-web

Library for visualizing data on the web.

## Technologies

* JavaScript (TypeScript 2.0)
* CSS (SASS)
* d3.js (4.x)
* SVG
* canvas
* webpack
* npm
* jest
* typedoc

## Setup and Build

```bash
# Clone the repository
git clone https://github.com/massmutual/mmviz-web.git

# Navigate into the root folder
cd mmviz-web/

# Install the dependencies
npm install
```

**Make** is used to run frequent tasks. Install it, if you need to. Below are tasks run by **Make**.
```bash
# Generate documentation
make docs

# Run tests and generate a coverage report
make test

# Build TS for dev
make scripts

# Build TS for prod
make scripts-dist

# Build Sass 
make styles

# Publish to NPM
make publish
```

### Examples
The following GitHub project includes several examples of mmviz-web :

(https://github.com/massmutual/mmviz-web-examples)


## Architecture

### Builder Factory
Factory to produce common Chart Builders

### Data Operator
Performs data operations such as cleaning, sorting, filtering, aggregating and other general data operations.

### Builders
Constructs charts from modular Layouts and Components. Allows method chaining to add on chart features. One can add on axises as well as add layers of different chart types.

### Layouts
Maps data from value to visual space and produces a layout view model.

### Components
Takes in the view model produced by a Layout and draws the visualization. Components can be implemented in different technologies such as SVG, canvas or webgl. This makes the library view agnostic.

### Dispatcher
Is a Singleton object that implements the observer pattern in order to facilitate communication between visual elements and enables flexible interactivity. For instance an "on click" event would be broadcasted out through a dispatcher channel to any elements listening for an "on click" event. By using the observer pattern via an event Dispatcher, it decouples each element to operate independently.

### Templates
Uses Mustache templates to construct html views such as chart/legend layout and the "on hover" details dialog.

## Architecture Diagram

![alt text](https://github.com/massmutual/mmviz-web/blob/master/files/mmviz-web.png "Architecture Diagram")

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