\Kendo\Dataviz\UI\ChartLegendItem
A PHP class representing the item setting of ChartLegend.
Methods
area
Sets the configuration of the legend items of type area. By default, all series except line and scatter use this legend type.
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value \Kendo\Dataviz\UI\ChartLegendItemArea|array
Example - using \Kendo\Dataviz\UI\ChartLegendItemArea
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$area = new \Kendo\Dataviz\UI\ChartLegendItemArea();
$background = 'value';
$area->background($background);
$item->area($area);
?>
Example - using array
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$background = 'value';
$item->area(array('background' => $background));
?>
cursor
The cursor style of the legend item.
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value string
Example
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$item->cursor('value');
?>
highlight
The highlight configuration of the legend item.
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value \Kendo\Dataviz\UI\ChartLegendItemHighlight|array
Example - using \Kendo\Dataviz\UI\ChartLegendItemHighlight
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$highlight = new \Kendo\Dataviz\UI\ChartLegendItemHighlight();
$visible = true;
$highlight->visible($visible);
$item->highlight($highlight);
?>
Example - using array
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$visible = true;
$item->highlight(array('visible' => $visible));
?>
line
Sets the configuration of the legend items of type line. This is the default legend item type for all line and scatter series.
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value \Kendo\Dataviz\UI\ChartLegendItemLine|array
Example - using \Kendo\Dataviz\UI\ChartLegendItemLine
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$line = new \Kendo\Dataviz\UI\ChartLegendItemLine();
$color = 'value';
$line->color($color);
$item->line($line);
?>
Example - using array
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$color = 'value';
$item->line(array('color' => $color));
?>
markers
The configuration of the Chart legend item markers.By default, the marker configuration will be the same as the series.markers settings of the displayed series.
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value \Kendo\Dataviz\UI\ChartLegendItemMarkers|array
Example - using \Kendo\Dataviz\UI\ChartLegendItemMarkers
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$markers = new \Kendo\Dataviz\UI\ChartLegendItemMarkers();
$background = 'value';
$markers->background($background);
$item->markers($markers);
?>
Example - using array
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$background = 'value';
$item->markers(array('background' => $background));
?>
type
Sets the type of the legend items. The default value is based on the series type.The supported values are: "line"—the legend items are rendered as a line. This is the default value for line charts. or "area"—the legend items are rendered as a filled rectangle. This is the default value for area charts..
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value string
Example
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$item->type('value');
?>
visual
A function that can be used to create a custom visual for the legend items. The available argument fields are: options—The item options.; createVisual—A function for getting the default visual.; series—The item series. or pointIndex—The index of the point in the series. Available for the Pie, Donut, and Funnel series..
Returns
\Kendo\Dataviz\UI\ChartLegendItem
Parameters
$value \Kendo\JavaScriptFunction
Example
<?php
$item = new \Kendo\Dataviz\UI\ChartLegendItem();
$item->visual(new \Kendo\JavaScriptFunction('function() { }'));
?>