Skip to content
This repository has been archived by the owner on Nov 22, 2024. It is now read-only.

Latest commit

 

History

History
42 lines (30 loc) · 3 KB

README.md

File metadata and controls

42 lines (30 loc) · 3 KB
Raw

Fractal.js

Build Status npm version

This repository is used to add improvements and features developed at The Hyve and contribute them to the original Fractal.js repository.

About

This is the front-end component of the Fractalis project. It is responsible for the communication with the back-end and the visualisation of analysis results. See https://fractalis.lcsb.uni.lu/

Demo

Please have a look at this playlist to see a demo of the visual aspects of Fractalis: Playlist.

Installation

  • Install npm
  • Run npm install within the project to install all dependencies.
  • Run npm run-script devserver, which will run a local web server to serve the project to you.
  • Open the shown URL and navigate to the test charts in 'test/charts' to play around or do your own development.
  • Please note that the test charts might not always be up-to-date. They are really just playground for developers and work-in-progress charts.

I don't use webpack or similar tools. How can I include Fractalis in my project?

https://unpkg.com/fractalis/lib/fractal.js

Usage

Please refer to the main.js file. It is the only file directly exposed to your code. Basically you initialize a FractalisJS instance by calling the init method and subsequently use the available methods listed in this file to control front and back-end.

Add new analytics

This paragraph only describes how to add a visualisation/chart to the web library. For statistical analyses please refer to the Fractalis repository.

Adding any new chart, custom or not, requires an understanding of Vue.js. The framework is well documented and might seem familiar to those who have worked with other MVC frameworks before.

In order for Fractalis to recognise a chart one has to put a Vue component into this folder. However, to benefit from several existing helper components, it is somewhat crucial to understand how they interact and what they do. For this purpose I recommend beginning with a minimal Vue component and including other components (such as DataBox, Chart, ControlPanel), and observing the effect they have on your view. Once you feel familiar with them, it should be fairly straight forward to write your own visualisation. Feel free to ask questions if you need help with a particular problem.

More documentation will be added if there is a notable interest from the community for it.

Citation

Manuscript is in preparation.