Skip to content
This repository has been archived by the owner on Jul 18, 2022. It is now read-only.

Development

Jump to bottom
Benjamin Bach edited this page Aug 2, 2021 · 18 revisions

General Information

  • The Vistorian and its modules are written in Typescript (TS) using Node.js.
  • The tsconfig.json specifies the transpilation process from TS to JS.
  • Then, it uses rollup (rollup.config.js) to bungle the src files into a single js file per package. E.g., vistorian-core.js for the vistorian-core package/git repo. See below for a full list of packages/repositories.
  • package.json specifies routines
    • build: tsc --pretty false && rollup -c
    • node dependencies for a package.
    • If you want to use the npm-packages for development, make sure the package.json is showing the respective version numbers for each vistorian dependency. If you are using your local copy that you may use for development, link those dependencies to file:../<vistorian-package-here>.
  • packages are published on https://www.npmjs.com under their same name.

To learn more about the specific development with each package, check the individual repositories and their Read-me.

Development Scenarios

a) Fix Issues

Each repository has a list of open issues. Create issues if you find them. If you fix an issue in any of the repositories, create a branch/cloned repo and submit a push request to the respective repo's main branch. We will test and create the respective npm patch if successful.

b) Create a new visualization

The aim of Vistorian is to provide a range of out-of-the-shelf visualizations for networks with the following characteristics:

  • different link types
  • multiple links between nodes
  • link weights
  • link direction
  • temporal information on links (weight / presence)
  • geographical positions attached to nodes that can change over time.

You can create your own visualization by including vistorian-core. If you want to share your visualization with other applications and developers writing visualizations with Vistorian, contact us.

Find more information of how to create bespoke visualizations.

c) Build your own application

You can include the core functionality (vistorian-core) and its visualization packages). All you need is to

  • load the vistorian-core node module
  • load the visualization modules you need
  • import your data
  • call a visualization.

Repositories

  • vistorian-core: core functionality for loading and storing networks, querying the graph, etc.
  • vistorian-web: a fully implemented web-application using all Vistorian packages.
  • vistorian-nodelink: an interactive node-link diagram implementation with time-slider and interactive filtering
  • vistoeian-matrix: a interactive adjacency matrix with different matrix ordering mechanisms, timeslider, and filtering mechanisms
  • vistorian-dynamicego: a time-arc visualization to show links over time.
  • vistorian-map: a geographic map visualization with overlaid links and nodes. Nodes can change positions over time.
  • vistorian-bookmarkbrowser: a menu widget that

More Development resources:

Clone this wiki locally