Komodo IDE SDK

Class: Progress

ko/progress~ Progress

Progress()

Properties:
Name Type Description
$element module:ko/dom~QueryObject

The ko/dom instance for the parent element
element Element

The main DOM element for the parent element

Methods

<static> close(force)

Close the progress bar, this removes the element

Parameters:
Name Type Description
force boolean

If force is false then an on("close") callback can interrupt this process

<static> message(value)

Set the given message under the progress bar

Parameters:
Name Type Description
value string

<static> off(type, callback)

Remove callback listener

Parameters:
Name Type Default Description
type string message|close

Event type
callback function

The Callback function that was used to add the listener

<static> on(type, callback)

Add callback listener

Parameters:
Name Type Default Description
type string message|close

Event type
callback function

Callback function

<static> percentage(value)

Set the percentage to the given value

This can only be used on determined progress bars

Parameters:
Name Type Description
value integer