Element: <oj-progress-circle>

Oracle® JavaScript Extension Toolkit (JET)
10.0.0

F32683-01

Since:
  • 9.0.0
Module:
  • ojprogress-circle

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

QuickNav

Attributes


JET Progress Circle

The JET Progress Circle element allows a user to display progress of an operation with a circular 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-circle value='{{progressValue}}'></oj-progress-circle>


Usage

Signature:

interface ProgressCircleElement

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

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

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

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

size :"sm"|"md"|"lg"

Specifies the size of the progress circle.
Supported Values:
Value Description
sm small progress circle
md medium progress circle (default, if unspecified)
lg large progress circle
Default Value:
  • "md"
Names
Item Name
Property size
Property change event sizeChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-size-changed

value :number

The value of the Progress Circle. 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