@steelbreeze/landscape

landscape

Landscape map visualisation of data.

This library produces visualisations of data that conform to the Archimate Landscape Map Viewpoint.

The tool takes as an input a cube of data generated by @steelbreeze/pivot along with the axes used to create it. It generates the layout, first creating duplicate rows or columns where there is more than one value in a cell and then merging adjacent cells on the x and/or y axes.

The final render operation is left to the user, using the tools and techniques of your choice. The returned data structure is a jagged array with values for cols and rows denoting how many column and rows the cell spans.

These visualisations are an invaluable communication tool offering insight into the health of a portfolio.

If you like @steelbreeze/landscape, please star it.

Installation

NPM

To install from npm:

npm install @steelbreeze/landscape

Web

For web via a CDN:

import * as pivot from 'https://cdn.skypack.dev/@steelbreeze/landscape@3.2?min';

Dependencies

@steelbreeze/landscape is dependant on @steelbreeze/pivot, also installable via npm or skypack. The @steelbreeze/landscape API requires cubes and dimensions generated by @steelbreeze/pivot.

Example

This simple example is taken from the steelbreeze.net homepage:

// create pre-defined dimensions
const axes = {
	x: pivot.dimension(["Rates", "FX", "MM", "Credit", "Equities"], "Product"),
	y: pivot.dimension(["Market gateway", "Order execution", "Order management", "Confirmations"], "Capability")
};

// pivot the data using the product and capability dimensions as the x and y axes respectively
const cube = pivot.cube(data, axes);

// create a table of data from the pivot cube and dimensions
const table = landscape.table(cube, axes, key, true);

// merge cells on both axes where possible
landscape.merge(table, true, true);

// render the table in the target element
document.getElementById('tablan').replaceWith(render.table(table, 'tablan', 'landscape'));

...

// create text and style to be used when rendering the table
function key(record) {
	return { text: record.Name, style: record.Status };
}

Note that while the key function must comply with the Key interface, specifing values for text and style, other properties can be added and these will be available at the time of rendering. When merging adjacent cells, in the merge function, only text and style are compared.

Usage

The full API documentation can be found here.

License

MIT License

Copyright (c) 2020-21 David Mesquita-Morris.