\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

A PHP class representing the errorBars setting of ChartSeriesItem.

Methods

color

The color of the error bars. Accepts a valid CSS color string, including hex and rgb.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value string

Example

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->color('value');
?>

endCaps

If set to false, the error bars caps will not be displayed. By default the caps are visible.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value boolean

Example

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->endCaps(true);
?>

line

The error bars line options.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value \Kendo\Dataviz\UI\ChartSeriesItemErrorBarsLine |array

Example - using \Kendo\Dataviz\UI\ChartSeriesItemErrorBarsLine

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$line = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBarsLine();
$dashType = 'value';
$line->dashType($dashType);
$errorBars->line($line);
?>

Example - using array

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$dashType = 'value';
$errorBars->line(array('dashType' => $dashType));
?>

value

The error bars value.The following value types are supported: "stderr" - the standard error of the series values will be used to calculate the point low and high value; "stddev(n)" - the standard deviation of the series values will be used to calculate the point low and high value. A number can be specified between the parentheses, that will be multiplied by the calculated standard deviation.; "percentage(n)" - a percentage of the point value; A number that will be subtracted/added to the point value; An array that holds the low and high difference from the point value or A function that returns the errorBars point value.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value string |float |array |\Kendo\JavaScriptFunction

Example - using string

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->value('value');
?>

Example - using float

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->value(1);
?>

Example - using array

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->value(array());
?>

Example - using \Kendo\JavaScriptFunction

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->value(new \Kendo\JavaScriptFunction('function() { }'));
?>

visual

A function that can be used to create a custom visual for the error bars. The available argument fields are: rect - the kendo.geometry.Rect that defines where the visual should be rendered.; options - the error bar options.; createVisual - a function that can be used to get the default visual.; low - the error bar low value.; high - the error bar high value. or sender - the chart instance..

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->visual(new \Kendo\JavaScriptFunction('function() { }'));
?>

xValue

The xAxis error bars value. See the series.errorBars.value option for a list of the supported value types.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value string |float |array |\Kendo\JavaScriptFunction

Example - using string

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->xValue('value');
?>

Example - using float

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->xValue(1);
?>

Example - using array

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->xValue(array());
?>

Example - using \Kendo\JavaScriptFunction

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->xValue(new \Kendo\JavaScriptFunction('function() { }'));
?>

yValue

The yAxis error bars value. See the series.errorBars.value option for a list of the supported value types.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemErrorBars

Parameters

$value string |float |array |\Kendo\JavaScriptFunction

Example - using string

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->yValue('value');
?>

Example - using float

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->yValue(1);
?>

Example - using array

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->yValue(array());
?>

Example - using \Kendo\JavaScriptFunction

<?php
$errorBars = new \Kendo\Dataviz\UI\ChartSeriesItemErrorBars();
$errorBars->yValue(new \Kendo\JavaScriptFunction('function() { }'));
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy