Class “ProgressBar”

Object > NativeObject > Widget > ProgressBar

A widget representing a numeric value as a horizontal bar with a growing indicator.

ProgressBar on Android
Android
ProgressBar on iOS
iOS
Constructor public
Singleton No
Namespace tabris
Direct subclasses None
JSX support Element: <ProgressBar/>
Parent element: <Composite/> and any widget extending Composite
Child elements: None
Text content: Not supported

Example

import {ProgressBar, contentView} from 'tabris';

new ProgressBar({
  left: 16, right: 16,
  selection: 50
}).appendTo(contentView);

See also:

JSX Creating a simple ProgressBar

Constructor

new ProgressBar(properties?)

Parameter Type Optional Description
properties Properties<ProgressBar> Yes Sets all key-value pairs in the properties object as widget properties.

Properties

maximum

The value that represents a progress of 100%.

Type number
Default 100
Settable Yes
Change events Yes

minimum

The value that represents a progress of 0%.

Type number
Default 0
Settable Yes
Change events Yes

selection

The actual progress to be displayed.

Type number
Default 0
Settable Yes
Change events Yes

state

Android

This property affects the color of the progress indicator. Not supported on iOS.

Type 'normal' | 'paused' | 'error'
Default 'normal'
Settable Yes
Change events Yes

tintColor

The color used to display the current progress.

Type ColorValue
Settable Yes
Change events Yes

Change Events

minimumChanged

Fired when the minimum property has changed.

Parameter Type Description
value number The new value of minimum.

maximumChanged

Fired when the maximum property has changed.

Parameter Type Description
value number The new value of maximum.

tintColorChanged

Fired when the tintColor property has changed.

Parameter Type Description
value ColorValue The new value of tintColor.

selectionChanged

Fired when the selection property has changed.

Parameter Type Description
value number The new value of selection.

stateChanged

Fired when the state property has changed.

Parameter Type Description
value string The new value of state.