Class: SC.ProgressView


Extends SC.Control, SC.View.

Displays a progress bar. You can display both a defined and an indeterminate progressbar. The progress bar itself is designed to be styled using CSS classes with the following structure:

<div class="sc-progress-view"><div class="inner"></div></div>

The outer can form the boundary of the bar while the inner will be adjusted to fit the percentage of the progress.

Creating a ProgressView accepts a number of properties, for example:

progressView: SC.ProgressView.design({
  value: 50,
  minimum: 0,
  maximum: 100,
  isIndeterminate: NO,
  isEnabled: YES
})

Defined in: progress.js

Since:
SproutCore 1.0

Field Summary

Instance Methods

Field Detail

ariaRole String
The WAI-ARIA role for progress view.
Default value:
'progressbar'
classNames Array
Default value:
['sc-progress-view']
See:
SC.View#classNames
contentIsIndeterminateKey String

Optionally specify the key used to extract the isIndeterminate value from the content object. If this is set to null then the isIndeterminate value will not be derived from the content object.

Default value:
null
contentMaximumKey String

Optionally specify the key used to extract the maximum progress value from the content object. If this is set to null then the maximum value will not be derived from the content object.

Default value:
null
contentMinimumKey String

Optionally specify the key used to extract the minimum progress value from the content object. If this is set to null then the minimum value will not be derived from the content object.

Default value:
null
displayProperties Array
Default value:
['displayValue', 'ariaValue', 'minimum', 'maximum', 'isIndeterminate', 'isRunning', 'isVisibleInWindow']
See:
SC.View#displayProperties
displayValue Number
isIndeterminate Boolean

Set to true if the item in progress is indeterminate. This may be overridden by the actual value.

Default value:
NO
isRunning Boolean

Set to YES when the process is currently running. This will cause the progress bar to animate, especially if it is indeterminate.

Default value:
NO
maximum Number
The maximum value of the progress bar.
Default value:
1.0
minimum Number
The minimum value of the progress.
Default value:
0
renderDelegateName String
Default value:
'progressRenderDelegate'
value Number

Bind this to the current value of the progress bar. Note that by default an empty value will disable the progress bar and a multiple value will make it indeterminate.

Default value:
0.50

Instance Method Detail

ariaValue()

The WAI-ARIA value for the progress view. This value will be passed to any rendering code as-is, not converted into percentages, etc. It is computed based on the original value property.

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Oct 27 2013 19:58:51 GMT-0600 (CST)