API

rbmViz

library namespace

Scatter Plot

• function: rbmViz.default.scatterPlot

Parameters

1. {(Node|string)} _element_ canvasnode or a unique [HTMLid`](https://www.w3schools.com/html/html_id.asp)
2. {Array} \_data\_ results for a single KRI; see KRI results data specification
3. {Object} \_config\_ KRI metadata and chart configuration; see KRI metadata specification
4. {Array} bounds threshold bounds for a single KRI; see KRI bounds data specification

Configuration

Configuration of the scatter plot is generally data-driven by meta_workflow.

• x
  • the name of the variable to be plotted on the x-axis
  • default: 'denominator'
• xLabel
  • a short description of the x-axis variable
  • default: meta_workflow[ config.x ]
• y
  • the name of the variable to be plotted on the y-axis
  • default: 'numerator'
• yLabel
  • a short description of the y-axis variable
  • default: meta_workflow[ config.y ]
• color
  • the name of the variable by which to color the points
  • default: 'flag'
• colors
  • an array of hex values
  • default: ['#52C41A', '#FADB14', '#FF4D4F']

Bar Chart

• function: rbmViz.default.barChart

Parameters

1. {(Node|string)} _element_ canvasnode or a unique [HTMLid`](https://www.w3schools.com/html/html_id.asp)
2. {Array} \_data\_ results for a single KRI; see KRI results data specification
3. {Object} \_config\_ KRI metadata and chart configuration; see KRI metadata specification

Configuration

Configuration of the bar chart is generally data-driven by meta_workflow.

• x
  • the name of the variable to be plotted on the x-axis
  • default: 'groupid'
• xLabel
  • a short description of the x-axis variable
  • default: meta_workflow[ config.x ]
• y
  • the name of the variable to be plotted on the y-axis
  • default: 'score'
• yLabel
  • a short description of the y-axis variable
  • default: meta_workflow[ config.y ]
• color
  • the name of the variable by which to color the points
  • default: 'flag'
• colorLabel
  • a short description of the color variable
  • default: ''
• n
  • the name of the variable that captures the number of participants in each group
  • default: 'n'
• nLabel
  • a short description of the n variable
  • default: meta_workflow[ config.n ]
• num
  • the variable name of the numerator in the KRI calculation
  • default: 'numerator'
• numeratorLabel
  • a short description of the numerator variable
  • default: meta_workflow[ config.num ]
• denom
  • the variable name of the denominator in the KRI calculation
  • default: 'denominator'
• denominatorLabel
  • a short description of the denominator variable
  • default: meta_workflow[ config.denom ]
• threshold
  • an array of thresholds
  • default: [ { threshold: -10, flag: -2 }, { threshold: -5, flag: -1 }, { threshold: 5, flag: 1 }, { threshold: 10, flag: 2 }, ];

Time Series (in development)

• function: rbmViz.default.timeSeries

Sparkline (in development)

• function: rbmViz.default.sparkline