Element: <oj-progress-bar>

Oracle® JavaScript Extension Toolkit (JET)
9.1.0

F30737-01

Signature:

class ojProgressBar

Note: This component is not supported in the following themes: Alta

QuickNav

Attributes

JET Custom Elements

JET components are implemented as custom HTML elements. In addition to the component attributes documented in this page, JET components also support standard HTML global attributes like id and aria-label.

The JET data binding syntax can be used to define both component and global attributes through the use of dynamically evaluated expressions. All attributes (component and global) support attribute-level binding by prefixing the attribute name with ":" (e.g. :id="[...]"). When using attribute-level binding, all expression values are treated as strings. Additionally, component attributes support property-level binding by using the attribute name directly with no ":" prefix. When using property-level binding, the expressions should evaluate to the types documented by the corresponding attributes. Property-level binding is strongly recommended over attribute-level binding for component attributes.

A detailed description of working with custom HTML elements can be found in: JET Custom Element Usage.


Version:
  • 9.1.0
Since:
  • 9.0.0
Module:
  • ojprogress-bar

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To typecheck the element APIs, import as below.
import {ProgressBarElement} from "ojs/ojprogress-bar";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojprogress-bar";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.


JET Progress Bar

The JET Progress Bar element allows a user to display progress of an operation in a rectangular horizontal meter. If a developer does not wish to display the exact value, a value of '-1' can be passed in to display an indeterminate value.
<oj-progress-bar value='{{progressValue}}'></oj-progress-bar>

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.

Styling Classes

.oj-progress-bar-embedded
Optional class that can be set on a oj-progress bar element to style an embedded progress bar within a web application or dialog.
Example
<div class='oj-web-applayout-page'>
  <header class='oj-web-applayout-header'>
  </header>
  <oj-progress-bar class='oj-progress-bar-embedded' value='{{loadingValue}}'>
  </oj-progress-bar>
</div>

Attributes

max :number

The maximum allowed value. The element's max attribute is used if it is provided, otherwise the default value of 100 is used.
Default Value:
  • 100
Names
Item Name
Property max
Property change event maxChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-max-changed

value :number

The value of the Progress Bar. The element's value attribute is used if it is provided, otherwise the default value of 0 is used. For indeterminate Progress, set value to -1. Any other negative value will default to 0.
Default Value:
  • 0
Names
Item Name
Property value
Property change event valueChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-value-changed

Methods

getProperty(property) : {any}

Retrieves a value for a property or a single subproperty for complex properties.
Parameters:
Name Type Description
property string The property name to get. Supports dot notation for subproperty access.
Returns:
Type
any

setProperties(properties) : {void}

Performs a batch set of properties.
Parameters:
Name Type Description
properties Object An object containing the property and value pairs to set.
Returns:
Type
void

setProperty(property, value) : {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.
Parameters:
Name Type Description
property string The property name to set. Supports dot notation for subproperty access.
value any The new value to set the property to.
Returns:
Type
void