Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.1 KB

README.md

File metadata and controls

67 lines (45 loc) · 2.1 KB

StArE.js (Client version)

npm npm Build Status NPM

Description

StArE.js is an open source project intended to facilitate developers the creation of alternative visualizations of search engine results page (SERP). StArE.js provides a modular and extensible processing pipeline capable of (1) transforming SERP, (2) extracting features from individual search results, and (3) visualizing SERP in multiple ways.

For StArE.js-server docs click here

Installation

npm i @stare.js/stare.js-client

How to use

This package consist of only one function that will render the chart that you desire based on JSON documents of StArE.js. The following code is an example of how to render a bar chart for an array of documents of StArE.js

import stare from '@stare.js/stare.js-server';

const stareChart = stare('d3', 'bar');

stareChart('#my-chart', stareDocuments = [], chartOptions = {});

Essencially, to render a chart you need 4 steps:

  • Import stare.js-client.
  • Import you desired library for visualization (currently supported d3.js, three.js).
  • Use the imported stare function to get the renderer function (ex: d3 -> bar renderer).
  • Use the function following the params defined in the next section.

Supported Charts

For the supported options for each chart checkout the docs

D3.js

  • bar
  • bubble
  • network
  • stackedBar
  • tiles
  • tiles2
  • tiles3

Three.js

  • grid

Contributors

License

MIT