\Kendo\Dataviz\UI\ChartSeriesItemHighlight

A PHP class representing the highlight setting of ChartSeriesItem.

Methods

border

The border of the highlighted chart series. The color is computed automatically from the base point color.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemHighlight

Parameters

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

Example - using \Kendo\Dataviz\UI\ChartSeriesItemHighlightBorder

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$border = new \Kendo\Dataviz\UI\ChartSeriesItemHighlightBorder();
$color = 'value';
$border->color($color);
$highlight->border($border);
?>

Example - using array

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$color = 'value';
$highlight->border(array('color' => $color));
?>

color

The highlight color. Accepts a valid CSS color string, including hex and rgb.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemHighlight

Parameters

$value string

Example

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

line

The line of the highlighted chart series. The color is computed automatically from the base point color.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemHighlight

Parameters

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

Example - using \Kendo\Dataviz\UI\ChartSeriesItemHighlightLine

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$line = new \Kendo\Dataviz\UI\ChartSeriesItemHighlightLine();
$color = 'value';
$line->color($color);
$highlight->line($line);
?>

Example - using array

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$color = 'value';
$highlight->line(array('color' => $color));
?>

opacity

The opacity of the highlighted points.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemHighlight

Parameters

$value float

Example

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$highlight->opacity(1);
?>

toggle

A function that can be used to handle toggling the points highlight. The available argument fields are: preventDefault - a function that can be used to prevent showing the default highlight overlay.; show - a boolean value indicating whether the highlight should be shown.; visual - the visual element that should be highlighted.; category - the point category.; dataItem - the point dataItem.; value - the point value. or series - the point series..

Returns

\Kendo\Dataviz\UI\ChartSeriesItemHighlight

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$highlight->toggle(new \Kendo\JavaScriptFunction('function() { }'));
?>

visible

If set to true the chart will highlight the series when the user hovers it with the mouse. By default chart series highlighting is enabled.

Returns

\Kendo\Dataviz\UI\ChartSeriesItemHighlight

Parameters

$value boolean

Example

<?php
$highlight = new \Kendo\Dataviz\UI\ChartSeriesItemHighlight();
$highlight->visible(true);
?>

visual

A function that can be used to set custom visual for the point highlight.The available argument fields are: createVisual - a function that can be used to get the default highlight visual.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; visual - the visual element that should be highlighted.; options - the point options.; category - the point category.; dataItem - the point dataItem.; value - the point value.; sender - the chart instance.; series - the point series.; stackValue - the cumulative point value on the stack. Available only for stackable series.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; 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\ChartSeriesItemHighlight

Parameters

$value \Kendo\JavaScriptFunction

Example

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