easyvis.io

This site uses Just the Docs, a documentation theme for Jekyll.

Search

Progress

Show a static or dynamic progress on your visualization device

Table of contents

  1. Structure
  2. Validation
  3. Restrictions

Structure

With the progress visualization app you display a static or dynamic (growing or shrinking) progress bar. The startingSide parameter defines the initial side from which the progress bar is shown. The parameter progressStart defines at how much percentage of the screen the progress starts (e.g. 0.2 means that already 20% of the screen are shown with the progress bar). With color you can define the color of the progress bar and with the bgColor parameter you decide the color of the rest of the screen. If you want to have a dynamic progress bar, you have to define a time (in seconds) that defines in which time interval the progress bar is either growing (to 100%) or shrinking (to 0%). Whether the progress bar is growing or shrinking can be defined with the progressDirection parameter.

A growing red progress bar (bottom to top) which starts at 0% and grows in 20s to 100%, the background color is blue:

{
  "type": "PROGRESS",
  "config": {
    "startingSide": "bottom",
    "progressDirection": "grow",
    "progressStart": "0.0",
    "time": "20",
    "color": "Red",
    "bgColor": "Blue"
  }
}

A static blue progress bar which covers 20% of the screen starting from the right side:

{
  "type": "PROGRESS",
  "config": {
    "startingSide": "right",
    "progressStart": "0.2",
    "color": "Blue"
  }
}

Validation

Config parameter Description Required Allowed Values Default
startingSide Side of the screen the progress bar starts from   left, right, bottom, top bottom
progressStart Percentage of screen which is covered with the progress bar initially   0.0 <= progressStart <= 1.0 0.0
time Time (in seconds) the progress bar grows/shrinks to 100%/0%. If not defined, the progress bar is static and does not move   time >= 0 not defined
progressDirection Direction in which the progress bar moves if it is dynamic   grow, shrink grow
color Color of the progress bar   Color Handling White
bgColor Color of the rest of the screen (not the progress bar)   Color Handling Black

Restrictions

The progress visualization app does not yet work with a hdmi device output.