Documentation

Kitchen Sink documentation of style: 'Delos' of skin: 'ILIAS'

Fixed Size

Description

Purpose: The Fixed Size Progress Meter ensures that the element is rendered exactly as set regardless of the screen size.
Composition: See composition description for Standard Progress Meter.

Rules

Composition

See composition rules for Standard Progress Meter.

Example 1: Base

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\FixedSize;
 
/**
 * Example for rendering a fixed size Progress Meter with minimum configuration
 */
function base()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Genarating and rendering the responsive progressmeter
    $progressmeter = $f->chart()->progressMeter()->fixedSize(100, 75);
 
    // render
    return $renderer->render($progressmeter);
}

Example 2: Maximum configuration

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\FixedSize;
 
/**
 * Example for rendering a fixed size Progress Meter with maximum configuration
 */
function maximum_configuration()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Genarating and rendering the responsive progressmeter
    $progressmeter = $f->chart()->progressMeter()->fixedSize(100, 75, 80, 50, 350);
 
    // add score text
    $progressmeter = $progressmeter->withMainText('Your Score');
 
    // add required text
    $progressmeter = $progressmeter->withRequiredText('Required Score');
 
    // render
    return $renderer->render($progressmeter);
}

Example 3: Only comparison value

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\FixedSize;
 
/**
 * Example for rendering a fixed size Progress Meter with an diagnostic score only
 */
function only_comparison_value()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Genarating and rendering the responsive progressmeter
    $progressmeter = $f->chart()->progressMeter()->fixedSize(100, 0, 75, 50);
 
    // render
    return $renderer->render($progressmeter);
}

Example 4: User reached required

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Chart\ProgressMeter\FixedSize;
 
/**
 * Example for rendering a fixed size Progress Meter when a specific score was reached
 */
function user_reached_required()
{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Genarating and rendering the responsive progressmeter
    $progressmeter = $f->chart()->progressMeter()->fixedSize(100, 80, 75);
 
    // render
    return $renderer->render($progressmeter);
}

Relations

Parents

UIComponent
Chart
Progress Meter