\Kendo\UI\CircularProgressBar
A PHP wrapper for Kendo UI CircularProgressBar.
Inherits from \Kendo\UI\Widget.
Usage
To use CircularProgressBar in a PHP page instantiate a new instance, configure it via the available
configuration methods and output it by echo-ing the result of the render method.
Using Kendo CircularProgressBar
<?php
// Create a new instance of CircularProgressBar and specify its id
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
// Configure it
$circularProgressBar->ariaRole(true)
// Output it
echo $circularProgressBar->render();
?>
Methods
ariaRole
If set to true the Circular ProgressBar will have its role attribute set to progressbar. It will also render its aria-valuemin, aria-valuemax, and aria-valuenow attributes.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value boolean
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->ariaRole(true);
?>
centerTemplate
The template that will be displayed in the center of the progress bar. Template variables: * value - the value * color - the matching color for the value
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->centerTemplate('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->centerTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>
color
The color of the value pointer. Accepts a valid CSS color string, including hex and rgb.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value string
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->color('value');
?>
addColor
Adds one or more CircularProgressBarColor to the CircularProgressBar.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value[, $value2, ...] \Kendo\UI\CircularProgressBarColor|array
Example - using \Kendo\UI\CircularProgressBarColor
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$color = new \Kendo\UI\CircularProgressBarColor();
$color = 'value';
$color->color($color);
$circularProgressBar->addColor($color);
?>
Example - using array
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$color = 'value';
$circularProgressBar->addColor(array('color' => $color));
?>
Example - adding more than one CircularProgressBarColor
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$first = new \Kendo\UI\CircularProgressBarColor();
$second = new \Kendo\UI\CircularProgressBarColor();
$circularProgressBar->addColor($first, $second);
?>
indeterminate
A value indicating whether endloess loading is enabled
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value boolean
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->indeterminate(true);
?>
label
The label that would be used as a aria-label for the Circular ProgressBar element. Will be applied only if ariaRole is set to true.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value string
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->label('value');
?>
labelId
The ID of the element that will be used as a label of the Circular ProgressBar. Will be used as a value of the aria-labelledby attribute. Will be applied only if ariaRole is set to true.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value string
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->labelId('value');
?>
opacity
The opacity of the value pointer.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value float
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->opacity(1);
?>
pointerWidth
A value indicating how wide will the pointer be
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value float
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->pointerWidth(1);
?>
theme
The circularProgressBar theme. With versions prior to R1 2023 this can be either the respective LESS theme from the list below or "sass". When set to "sass" the circularProgressBar will read the variables from the Sass-based themes.Note: Since Q2 2024 release, the default value for the theme property is "sass" instead of "default". It is recommended to use "sass" with version Q2 2024 or later.The supported values are: "sass"; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value string
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->theme('value');
?>
transitions
A value indicating if transition animations should be played.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value boolean
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->transitions(true);
?>
value
The component value.
Returns
\Kendo\UI\CircularProgressBar
Parameters
$value float
Example
<?php
$circularProgressBar = new \Kendo\UI\CircularProgressBar('CircularProgressBar');
$circularProgressBar->value(1);
?>