Class: ProgressBar

.bar~ ProgressBar

new ProgressBar(configopt)

Base progress bar implementation.

Parameters:
Name Type Attributes Default Description
config Object <optional>
 {}

init parameters (all inherited from the parent)

Properties
Name Type Attributes Default Description
value number <optional>
 0

initial value
max number <optional>
 100

max progress value
min number <optional>
 0

min progress value
Source:
Example
var ProgressBar = require('stb/ui/progress.bar'),
    progressBar = new ProgressBar({
        min: -100,
        max:  200,
        events: {
            done: function () {
                debug.log('ProgressBar: done');
            },
            change: function ( data ) {
                debug.log('ProgressBar: change to ' + data.curr + ' from ' + data.prev);
            }
        }
    });

Extends

  • Component

Members

max :number

Max progress value.

Type:
  • number
Source:

min :number

Min progress value.

Type:
  • number
Source:

step :number

Value of the one percent step

Type:
  • number
Source:

value :number

Initial progress position.

Type:
  • number
Source:

Methods

init(config)

Init or re-init current max or/and min or/and value.

Parameters:
Name Type Description
config Object

init parameters (subset of constructor config params)
Source:

set(value) → {boolean}

Set position of the given value. Does nothing in case when progress is end and passed value is more than max value.

Parameters:
Name Type Description
value number

new value to set
Source:
Fires:
Returns:

operation result

Type
boolean