Class: ProgressBar

caph.stripe.ui.component. ProgressBar

new ProgressBar(option)

[DONE] A class which provides ProgressBar UI component.

Parameters:
Name Type Description
option Object

An object which initializes this component.
Refer to the details in caph.ui.base.Component constructor.

Properties
Name Type Argument Default Description
progress Number <optional>
0 ~ 1
  • init value of progressbar state
increment Number <optional>
0 ~ 1
  • value of increment whenever update state
Example
var ProgressBar = caph.require('stripe.ui.component.ProgressBar'),
progressbar_option1 = {
          size      : [500, 10]
          progress  : 0,
          increment : 0.1,
          position  : [100, 100, 0],
     };

progressbar.setCurrentProgress(0.5);
var _currentProgress  =  progressbar.getCurrentProgress();
var _currentIncrement =  progressbar.getIncrement();

progressbar.setCurrentProgress(_currentProgress  + _currentIncrement * 5);

Extends

  • caph.ui.base.component.ProgressBar

Methods

setOption(option)

Sets option for ProgressBar component.

Parameters:
Name Type Description
option Object

An object which initializes this component.
Refer to the details in caph.ui.base.Component constructor.

Properties
Name Type Argument Default Description
progress Number <optional>
0 ~ 1
  • init value of progressbar state
increment Number <optional>
0 ~ 1
  • value of increment whenever update state
Since:
  • 2.0.0
Example
var ProgressBar = caph.require('stripe.ui.component.ProgressBar'),
progressbar_option1 = {
          size      : [500, 10]
          progress  : 0,
          increment : 0.1,
          position  : [100, 100, 0],
     };

var progressbar = new ProgressBar();
progressbar.setOption(progressbar_option1)