Skip to main content

PROGRESS signal

Emits PROGRESS signal.

component image

In-ports​

trigger <any> — triggers PROGRESS signal (hidden if config port is enabled).

config <any> (dynamic) — accepts a JSON object with configuration properties that can be set at runtime. The output signal is emitted on every config event.

Out-ports​

output <Signal> — emits PROGRESS signal event.

Overview​

The PROGRESS signal transmits progress parameters that determine how widgets display progress indicators when a progress bar is enabled. Widgets that support progress bars will react to the PROGRESS signal. However, only widgets with a visible progress bar will display the progress.

The progress state is defined by the PROGRESS signal configuration and can be set either through the Settings dialog or programmatically via the config port.

Progress bars can be displayed in three different modes: Continuous, Incremental, and Incremental Continuous. Each mode is activated, progressed, and completed by a distinct combination of Value, Total, and Status properties.

Settings​

Enable realtime config port​

If this setting is enabled, the component can be configured through the config port. This port accepts a configuration object as input and allows you to set dynamic properties at runtime. Note that using this port does not cause the component to reinitialize, but it may cause some previous state of the component to be lost.

Display Mode​

Progress bars can appear in three modes: Continuous, Incremental, and Incremental Continuous.

  • Continuous Mode: No specific value or total provided. The progress bar shows an indefinite animation to indicate ongoing activity.
  • Incremental Mode: Provides both value and total where the progress bar displays precise completion status.
  • Incremental Continuous Mode: Assigning value as a number, but leaving total as null, allows the bar to move toward completion slowly but never reach the end. Completion only occurs with an explicit "completed" status value.

Value (value)​

Current progress value should be between 0 and Total attribute.

Type: Number|Null
Required: No
Default:

Total (total)​

Define the total value for the progress. The total is defaulted to 100 if value is defined.

Type: Number|Null
Required: No
Default: 100

Status (status)​

Controls the status of the progress.

Type: String
Required: No
Default: started

  • Started (started) — progress is started.
  • Aborted (aborted) — progress bar is aborted on current value.
  • Completed (completed) — sets progress bar final value and completes.

Examples​

Continuous Progress​

This example illustrates a continuous mode where neither value nor total is provided. The progress bar will show an ongoing activity animation without any specific progress indication.

{ }

Incremental Progress​

In this example, both value and total are defined. The progress bar displays the current progress as a specific percentage of completion. Changes to value will update the display.

// 50% progress
{
  "value": 512,
  "total": 1024
}
// 50% progress
{
  "value": 50
}
{
  "status": "completed"
}

Incremental Continuous Progress​

These configurations demonstrate incremental continuous mode. The progress bar appears to be moving incrementally but will remain incomplete until explicitly completed by a status of "completed".

{
  "total": null
}