progress Event (WebImageConverterJS)

In This Topic

Occurs when information about image file converting is updated.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance; // Type: WebImageConverterJS
instance.progress = function(event) { }

progress = function (
   eventObject that contains information about event. Object has the following properties:
  target (object): An object that raised the event.
 type (string): Event name.
 data (object): An object that contains data, which were specified when subscribing to the event.
 originalEvent (object): Original event if event was received from DOM-element.
 
 : object
   eventsArgsObject that contains event arguments. Object has the following properties:
  description (string): The image file converting status. Possible values: "Encoding", "Finished" or "Aborted".
 errorMessage (string): Error message.
 progress (number): The progress, in percents, of synchronous file converting.
 currentImageIndex (number): A zero-based index, which defines image that is being converting now.
 convertedImageCount (number): The total number of converted images.
 resultFilesIds (object): An array of identifiers of the converted files.
 
 : object
) { };

Parameters

event

Object that contains information about event. Object has the following properties:

target (object): An object that raised the event.
type (string): Event name.
data (object): An object that contains data, which were specified when subscribing to the event.
originalEvent (object): Original event if event was received from DOM-element.

eventArgs

Object that contains event arguments. Object has the following properties:

description (string): The image file converting status. Possible values: "Encoding", "Finished" or "Aborted".
errorMessage (string): Error message.
progress (number): The progress, in percents, of synchronous file converting.
currentImageIndex (number): A zero-based index, which defines image that is being converting now.
convertedImageCount (number): The total number of converted images.
resultFilesIds (object): An array of identifiers of the converted files.

Browser Compatibility

56+

45+

Reference

WebImageConverterJS Class
WebImageConverterJS Members

Send Feedback