Interface: ProgressItem

Oracle® JavaScript Extension Toolkit (JET)
10.1.0

F37996-01

Since:
  • 4.0.0
Module:
  • ojprogresslist

QuickNav

Fields

Description

This interface defines the API for oj.ProgressItem. It can be implemented in order to the track progress and status of an arbitrary task (e.g. a file being uploaded)


Usage

Typescript Import Format
//To use this interface, import as below.
import {ProgressItem} from "ojs/ojprogresslist";

For additional information visit:


This interface defines the API for oj.ProgressItem. It can be implemented in order to the track progress and status of an arbitrary task (e.g. a file being uploaded)
Deprecated:
Since Description
8.0.0 <oj-progress-list> has been deprecated, please use <oj-list-view> instead.

Fields

(static) EventType :string

ProgressItem event types
Properties:
Name Type Default Description
ABORT string abort Triggered when an upload has been aborted.
ERROR string error Triggered when an upload failed.
LOAD string load Triggered when an upload succeeded.
LOADEND string loadend Triggered when an upload completed (success or failure).
LOADSTART string loadstart Triggered when the progress start
PROGRESS string progress Triggered for upload progress events.
TIMEOUT string timeout Triggered when timeout has passed before upload completed

(static) Status :string

ProgressItem status
Properties:
Name Type Default Description
ABORTED string aborted upload aborted
ERRORED string errored upload failed
LOADED string loaded upload is completed
LOADSTARTED string loadstarted upload is in progress
QUEUED string queued initial state before any progress events
TIMEDOUT string timedout upload timeout

Methods

addEventListener(eventType, listener) : {void}

Attach an event handler
Parameters:
Name Type Description
eventType oj.ProgressItem.EventType eventType
listener EventListener The event listener to add.
Returns:
Type
void

removeEventListener(eventType, listener) : {void}

Detach an event handler
Parameters:
Name Type Description
eventType oj.ProgressItem.EventType eventType
listener EventListener The event listener to remove.
Returns:
Type
void