Skip to content

Latest commit

 

History

History
239 lines (182 loc) · 5.92 KB

README.md

File metadata and controls

239 lines (182 loc) · 5.92 KB
Raw

Keen.Dataviz API

Chart types

Powered by C3.js:

Types like "bar" and "line" support axis rotation. To make this easier to achieve, an additional series of types have been exposed, which automatically handle this configuration:

  • horizontal-area
  • horizontal-area-spline
  • horizontal-area-step
  • horizontal-bar
  • horizontal-line
  • horizontal-spline
  • horizontal-step

Custom (built by us):

  • metric
  • bar-range
const chart = new KeenDataviz({
    container: '#some_container',
    type: 'bar-range',
    results: [result1Maximum, result2Minimum]
  })
  • horizontal-bar-range
  • area-range
  • area-range-step
  • area-range-spline

If previousResults is set, the metric will show the difference between the current result and the previous one.

const chart = new KeenDataviz({
    container: '#some_container',
    type: 'metric',
    results,
    previousResults // optional
  })
  • metric combo

This type combines metric and area-spline type of charts

const chart = new KeenDataviz({
    container: '#some_container',
    type: 'metric-combo',
    metricResults: { // data required for metrics
      previous,
      current,
    },
    results // data required for area-spline
  })

  • message

  • funnel

  • horizontal-funnel

Default configuration values:

  funnel: {
    lines: true, // separate each step with a line
    resultValues: true, // show or hide results
    percents: {
      show: false, // show and hide percents
      countingMethod: 'absolute', // 'absolute' - use the value of the first step to calculate the percentage change
                                  // 'relative' - use the value of the previous step to calculate the percentage change
      decimals: 0, // the number of decimal digits visible
    }
    hover: true, // show or hide hover effect
    marginBetweenSteps: false, // show or hide spaces between elements
    minimalSize: false, // minimal size of the last step in pixels
  }

3D funnels have similar options, with a small change:

  • funnel-3d
  funnel: {
    marginBetweenSteps: false, // N/A
    effect3d: 'both-sides' // 'both-sides' - showing shades on both sides
                           // 'left' - showing shades on left side
                           // 'right' - showing shades on right side
  }
  • horizontal-funnel-3d
  funnel: {
    marginBetweenSteps: false, // N/A
    effect3d: 'both-sides' // 'both-sides' - showing shades on top and bottom
                           // 'top' - showing shades on top
                           // 'right' - showing shades on bottom
  }
  • heatmap
const chart = new KeenDataviz({
    container: '.chart-heatmap',
    title: 'Heatmap chart',
    type: 'heatmap',
    heatmap: {
      showSlider: true, // turn on range slider below chart
      simpleTooltip: false // if set to false tooltip displays x, y and value, in other case only value is visible
    },
  })
  • choropleth

Default configuration values:

  choropleth: {
      map: 'world', // 'world' - world map divided by countries
                    // 'us - United States map divided by states
      borders: {
        show: true, // show or hide borders
        size: 0.5, // set size of borders
        color: '#000' // change color of borders
      },
      showSlider: false // show slider to filter data
    }
  }

Prototype methods

.call(function)

Call arbitrary functions within the prototype/instance context.

chart
  .call(function(){
    const total = this.data().slice(1).length;
    this.title('Total Results: ' + total);
  })

.data()

This method accepts two forms of input data.

  • Object: Raw data, either from a query API response or a manually constructed object
  • Keen.Dataset instance

Important: objects passed into .data() will be inspected to infer which type of response is being handled, and to parse accordingly. This is where the library determines a default type (listed above) to use, if no type value has been set.

// Object
chart.data({ result: 621 });

// Dataset instance
const ds = new Keen.Dataset();
ds.set(['Value', 'Result'], 621);
chart.data(ds);

// Return current Dataset.data() output
chart.data();

// Check out what 'type' we have set:
chart.type(); // 'metric' for this example

.destroy()

Destroy a visualization and remove all rendered DOM elements.

chart.destroy();

.library(string)

Specify the library for a visualization. Default value is default.

chart.library('my-custom-library');

.message(string)

Display a message for a visualization. Previously .error()).

chart.message('Oops, an error occured!');

.exportImage({quality, bgcolor})

Download chart as PNG/JPEG image

// method by default generates PNG image
chart.exportImage();

// if quality provided then JPEG is generated
// quality - a number between 0 to 1 indicating image quality (quality = 0 generates PNG image)
// bgcolor - a string value for background color, any valid CSS color value (defaults to '#fff')
chart.exportImage({ quality: 1, bgcolor: 'blue' });

.exportData(string)

Export data to a file

// method by default generates a JSON file
chart.exportData();

// supported formats : 'json', 'csv'
chart.exportData('csv');