\Kendo\Dataviz\UI\StockChartSeriesItemLegendItem

A PHP class representing the legendItem setting of StockChartSeriesItem.

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

Parameters

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

Example - using \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemArea

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$area = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemArea();
$background = 'value';
$area->background($background);
$legendItem->area($area);
?>

Example - using array

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$background = 'value';
$legendItem->area(array('background' => $background));
?>

cursor

The cursor style of the legend item.

Returns

\Kendo\Dataviz\UI\StockChartSeriesItemLegendItem

Parameters

$value string

Example

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$legendItem->cursor('value');
?>

highlight

The highlight configuration of the legend item.

Returns

\Kendo\Dataviz\UI\StockChartSeriesItemLegendItem

Parameters

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

Example - using \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemHighlight

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

Example - using array

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$visible = true;
$legendItem->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\StockChartSeriesItemLegendItem

Parameters

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

Example - using \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemLine

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$line = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemLine();
$color = 'value';
$line->color($color);
$legendItem->line($line);
?>

Example - using array

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$color = 'value';
$legendItem->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\StockChartSeriesItemLegendItem

Parameters

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

Example - using \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemMarkers

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$markers = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItemMarkers();
$background = 'value';
$markers->background($background);
$legendItem->markers($markers);
?>

Example - using array

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$background = 'value';
$legendItem->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\StockChartSeriesItemLegendItem

Parameters

$value string

Example

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

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$legendItem = new \Kendo\Dataviz\UI\StockChartSeriesItemLegendItem();
$legendItem->visual(new \Kendo\JavaScriptFunction('function() { }'));
?>
In this article
Not finding the help you need?