Showing Component Progress

There are two VDL components specifically provided for representing progress.

VDL Spinner The VDL Spinner component is a very simple VDL extension that signals an action is happening. It is available to drag and drop onto a VDL View and is constantly animating to show that the scenario is executing, in the same way that the default execution overlay shows the same spinner.

It is advised that this component, or a parent container component, has its visibility controlled with a vdl-if expression, so that the s[inner only shows during execution:

<vdl-container vdl-if="=scenario.executionStatus.status !== 'NO_JOB_STATUS'">
		           <vdl-spinner></vdl-spinner>
         </vdl- container> 

VDL Progress Bar The VDL Progress Bar component is used to display quantified progress for a scenario.

It is advised that this component, or a parent container component, has its visibility controlled with a vdl-if expression, so that the s[inner only shows during execution:

<vdl-container vdl-if="=scenario.executionStatus.status !== 'NO_JOB_STATUS'">
		           <vdl-spinner></vdl-spinner>
         </vdl- container> 

The Progress Bar shows a value of 50(%). The value can either be provided using the entity attribute,

<vdl-progress-bar entity="PROGESS_ENTITY_NAME">
</vdl-progress-bar> 

which must be a model scalar entity annotated as providing progress updates. The value should be between 0 and 100 and is displayed as a percentage by default. Alternatively the progress value can be supplied using a VDL expression:

<vdl-progress-bar value="=scenario.entities.PROGRESS_SCALAR.value50">
</vdl-progress-bar> 

It is also possible to provide a custom label to replace the default percentage value:

<vdl-progress-bar value="=50" label="Optimization in progress">
</vdl-progress-bar> 

The label and value attribute can be dynamic.

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.