Element: <oj-c-progress-bar>

CORE PACK

Oracle® JavaScript Extension Toolkit (JET)
17.0.0
F92240-01

Since:
  • 13.0.0
Module:
  • progress-bar

Note: This component supersedes the following component: <oj-progress-bar>. Migration info available at preceding link.

QuickNav

Attributes

Methods

Other Topics


JET Progress Bar

The oj-c-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-c-progress-bar value='{{progressValue}}'></oj-c-progress-bar>

Accessibility

If this element is being used to describe the loading process of a particular region of a page, then the aria-describedby attribute of the region must point to the id of the oj-c-progress-bar and aria-busy = "true" must be added to the region until the loading is complete.


Usage

Signature:

interface CProgressBarElement

Typescript Import Format
//To typecheck the element APIs, import as below.
import { CProgressBarElement } from "oj-c/progress-bar";

//For the transpiled javascript to load the element's module, import as below
import "oj-c/progress-bar";

For additional information visit:

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.


Attributes

edge :"none"|"top"

Whether the progress bar is positioned at the top edge of a container or not. If set to 'top', the curved borders will be removed.
Supported Values:
Value Description
none Not attached progress bar (default, if unspecified)
top Progress Bar at Top Edge of container
Default Value:
  • "none"
Names
Item Name
Property edge
Property change event edgeChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-edge-changed

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 the value of a property or a subproperty.
Parameters:
Name Type Description
property 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 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 corresponding event.
Parameters:
Name Type Description
property The property name to set. Supports dot notation for subproperty access.
value The new value to set the property to.
Returns:
Type
void