\Kendo\Dataviz\UI\ChartTooltip
A PHP class representing the tooltip setting of Chart.
Methods
autoHide
Specifies if the tooltip will be hidden when the mouse leaves the target element. If set to false, a Close button will be shown within tooltip.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value boolean
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->autoHide(true);
?>
background
The background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value string
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->background('value');
?>
border
The border configuration options.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value \Kendo\Dataviz\UI\ChartTooltipBorder|array
Example - using \Kendo\Dataviz\UI\ChartTooltipBorder
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$border = new \Kendo\Dataviz\UI\ChartTooltipBorder();
$color = 'value';
$border->color($color);
$tooltip->border($border);
?>
Example - using array
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$color = 'value';
$tooltip->border(array('color' => $color));
?>
color
The text color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value string
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->color('value');
?>
font
The tooltip font.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value string
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->font('value');
?>
format
The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, funnel, pyramid, line and pie{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Bullet{0} - value{1} - target value; Scatter and scatterLine{0} - x value{1} - y value; Candlestick and OHLC{0} - open value{1} - high value{2} - low value{3} - close value{4} - category name or RangeArea, rangeBar, rangeColumn{0} - from value{1} - to value.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value string
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->format('value');
?>
opacity
The opacity of the tooltip.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value float
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->opacity(1);
?>
padding
The padding of the tooltip. A numeric value will set all paddings.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value float|\Kendo\Dataviz\UI\ChartTooltipPadding|array
Example - using float
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->padding(1);
?>
Example - using \Kendo\Dataviz\UI\ChartTooltipPadding
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$padding = new \Kendo\Dataviz\UI\ChartTooltipPadding();
$bottom = 1;
$padding->bottom($bottom);
$tooltip->padding($padding);
?>
Example - using array
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$bottom = 1;
$tooltip->padding(array('bottom' => $bottom));
?>
shared
If set to true the chart will display a single tooltip for every category.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value boolean
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->shared(true);
?>
sharedTemplate
The template which renders the shared tooltip.The fields which can be used in the template are: points - the category points or category - the category name.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->sharedTemplate('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->sharedTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>
template
The template which renders the tooltip.The fields which can be used in the template are: category - the category name; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series; value - the point value (either a number or an object); runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->template('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->template(new \Kendo\JavaScriptFunction('function() { }'));
?>
visible
If set to true the chart will display the series tooltip. By default the series tooltip is not displayed.
Returns
\Kendo\Dataviz\UI\ChartTooltip
Parameters
$value boolean
Example
<?php
$tooltip = new \Kendo\Dataviz\UI\ChartTooltip();
$tooltip->visible(true);
?>