ILIAS  trunk Revision v5.2.0beta1-34115-g3a2438be29
ILIAS\UI\Component\Chart\ProgressMeter\Standard Interface Reference
+ Inheritance diagram for ILIAS\UI\Component\Chart\ProgressMeter\Standard:
+ Collaboration diagram for ILIAS\UI\Component\Chart\ProgressMeter\Standard:

Public Member Functions

 getComparison ()
 Get comparison value. More...
 
 withMainText (string $text)
 Get clone of Progress Meter with main text It will be displayed above the main value percentage display. More...
 
 getMainText ()
 Get main text value. More...
 
 withRequiredText (string $text)
 Get clone of Progress Meter with required text. More...
 
 getRequiredText ()
 Get required text value. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Chart\ProgressMeter\ProgressMeter
 getMaximum ()
 Get maximum value. More...
 
 getRequired ()
 Get required value. More...
 
 getMainValue ()
 Get main value. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 

Detailed Description

Definition at line 27 of file Standard.php.

Member Function Documentation

◆ getComparison()

ILIAS\UI\Component\Chart\ProgressMeter\Standard::getComparison ( )

Get comparison value.

This value is represented as the second progress meter bar.

Returns
int|float|null

◆ getMainText()

ILIAS\UI\Component\Chart\ProgressMeter\Standard::getMainText ( )

Get main text value.

◆ getRequiredText()

ILIAS\UI\Component\Chart\ProgressMeter\Standard::getRequiredText ( )

Get required text value.

◆ withMainText()

ILIAS\UI\Component\Chart\ProgressMeter\Standard::withMainText ( string  $text)

Get clone of Progress Meter with main text It will be displayed above the main value percentage display.

Example: withMainText('Your Score')

◆ withRequiredText()

ILIAS\UI\Component\Chart\ProgressMeter\Standard::withRequiredText ( string  $text)

Get clone of Progress Meter with required text.

It will be displayed below the required percentage display. Example: withRequiredText("Minimum Required")


The documentation for this interface was generated from the following file: