Class: ProgressComponent

ProgressComponent(dataObjectopt, optionsopt)

ProgressComponent tracks change of a process and displays a progress bar

Constructor

new ProgressComponent(dataObjectopt, optionsopt)

Parameters:
Name Type Attributes Default Description
dataObject DataObject <optional>
null
options Object <optional>
null
Properties
Name Type Attributes Default Description
initialValue number <optional>
0
dataField string <optional>
null a DataModel field to track with this progress readout
Source:
To Do:
  • make it watch a field on the dataObject with a filter function that maps to 'starting'|'complete'|'failed'|[0,1]
Example

Watch a DataModel's field

const progressComponent = new ProgressComponent(myDataModel, {
	dataField: 'completion'
})

Members

value

value - float from 0 to 1
Source:

value

value - float from 0 to 1
Source: