\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

A PHP class representing the label setting of ChartXAxisItemPlotBand.

Methods

align

The position of the plotband label.The supported values are: "left" - the plotband label is positioned on the left; "right" - the plotband label is positioned on the right or "center" - the plotband label is positioned in the center.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value string

Example

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$label->align('value');
?>

background

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

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value string

Example

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

border

The border of the label.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

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

Example - using \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabelBorder

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$border = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabelBorder();
$color = 'value';
$border->color($color);
$label->border($border);
?>

Example - using array

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

color

The text color of the label. Accepts a valid CSS color string, including hex and rgb.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value string

Example

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

font

The font style of the label.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value string

Example

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

margin

The margin of the label. A numeric value will set all margins.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

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

Example - using float

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$label->margin(1);
?>

Example - using \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabelMargin

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$margin = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabelMargin();
$bottom = 1;
$margin->bottom($bottom);
$label->margin($margin);
?>

Example - using array

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$bottom = 1;
$label->margin(array('bottom' => $bottom));
?>

padding

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

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

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

Example - using float

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

Example - using \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabelPadding

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$padding = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabelPadding();
$bottom = 1;
$padding->bottom($bottom);
$label->padding($padding);
?>

Example - using array

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

position

The position of the label.The supported values are: "top" - the axis label is positioned on the top; "bottom" - the axis label is positioned on the bottom or "center" - the axis label is positioned in the center.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value string

Example

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$label->position('value');
?>

rotation

The rotation angle of the label. By default the label is not rotated.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value float

Example

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$label->rotation(1);
?>

text

The text of the label.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value string

Example

<?php
$label = new \Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel();
$label->text('value');
?>

visible

If set to false the chart will not display the label.

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value boolean

Example

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

visual

A function that can be used to create a custom visual for the label. The available argument fields are: text - the label text.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; sender - the chart instance (may be undefined).; options - the label options. or createVisual - a function that can be used to get the default visual..

Returns

\Kendo\Dataviz\UI\ChartXAxisItemPlotBandLabel

Parameters

$value \Kendo\JavaScriptFunction

Example

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