\Kendo\Dataviz\UI\ChartSubtitle

A PHP class representing the subtitle setting of Chart.

Methods

align

The alignment of the subtitle. "center" - the text is aligned to the middle.; "left" - the text is aligned to the left. or "right" - the text is aligned to the right.. By default, the subtitle has the same alignment as the title.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value string

Example

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

background

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

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value string

Example

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

border

The border of the subtitle.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

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

Example - using \Kendo\Dataviz\UI\ChartSubtitleBorder

<?php
$subtitle = new \Kendo\Dataviz\UI\ChartSubtitle();
$border = new \Kendo\Dataviz\UI\ChartSubtitleBorder();
$color = 'value';
$border->color($color);
$subtitle->border($border);
?>

Example - using array

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

color

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

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value string

Example

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

font

The font of the title.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value string

Example

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

margin

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

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

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

Example - using float

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

Example - using \Kendo\Dataviz\UI\ChartSubtitleMargin

<?php
$subtitle = new \Kendo\Dataviz\UI\ChartSubtitle();
$margin = new \Kendo\Dataviz\UI\ChartSubtitleMargin();
$bottom = 1;
$margin->bottom($bottom);
$subtitle->margin($margin);
?>

Example - using array

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

padding

The padding of the subtitle. A numeric value will set all margins.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

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

Example - using float

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

Example - using \Kendo\Dataviz\UI\ChartSubtitlePadding

<?php
$subtitle = new \Kendo\Dataviz\UI\ChartSubtitle();
$padding = new \Kendo\Dataviz\UI\ChartSubtitlePadding();
$bottom = 1;
$padding->bottom($bottom);
$subtitle->padding($padding);
?>

Example - using array

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

position

The position of the subtitle. "bottom" - the title is positioned on the bottom. or "top" - the title is positioned on the top.. By default, the subtitle is placed in the same position as the title.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value string

Example

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

text

The text of the chart subtitle. You can also set the text directly for a title with default options.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value string

Example

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

visible

If set to true the chart will display the subtitle. By default the subtitle will be displayed.

Returns

\Kendo\Dataviz\UI\ChartSubtitle

Parameters

$value boolean

Example

<?php
$subtitle = new \Kendo\Dataviz\UI\ChartSubtitle();
$subtitle->visible(true);
?>
In this article
Not finding the help you need?