\Kendo\Dataviz\UI\ChartSeriesItemTooltip

A PHP class representing the tooltip setting of ChartSeriesItem.

Methods

background

The background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemTooltip

Parameters

$value string

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$tooltip->background('value');
?>

border

The border configuration options.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemTooltip

Parameters

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

Example - using \Kendo\Dataviz\UI\ChartSeriesItemTooltipBorder

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$border = new \Kendo\Dataviz\UI\ChartSeriesItemTooltipBorder();
$color = 'value';
$border->color($color);
$tooltip->border($border);
?>

Example - using array

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$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\ChartSeriesItemTooltip

Parameters

$value string

Example

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

font

The tooltip font.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemTooltip

Parameters

$value string

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$tooltip->font('value');
?>

format

The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, line, pie, radarArea, radarColumn and radarLine{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Scatter, scatterLine{0} - x value{1} - y value; PolarArea, polarLine and polarScatter{0} - x value (degrees){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\ChartSeriesItemTooltip

Parameters

$value string

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$tooltip->format('value');
?>

padding

The padding of the tooltip. A numeric value will set all paddings.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemTooltip

Parameters

$value float |\Kendo\Dataviz\UI\ChartSeriesItemTooltipPadding |array

Example - using float

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$tooltip->padding(1);
?>

Example - using \Kendo\Dataviz\UI\ChartSeriesItemTooltipPadding

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$padding = new \Kendo\Dataviz\UI\ChartSeriesItemTooltipPadding();
$bottom = 1;
$padding->bottom($bottom);
$tooltip->padding($padding);
?>

Example - using array

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$bottom = 1;
$tooltip->padding(array('bottom' => $bottom));
?>

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\ChartSeriesItemTooltip

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$tooltip->template('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$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\ChartSeriesItemTooltip

Parameters

$value boolean

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\ChartSeriesItemTooltip();
$tooltip->visible(true);
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy