\Kendo\Dataviz\UI\SankeyTooltip

A PHP class representing the tooltip setting of Sankey.

Methods

appendTo

The element to which the tooltip will be appended.

Returns

\Kendo\Dataviz\UI\SankeyTooltip

Parameters

$value string

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->appendTo('value');
?>

delay

The delay in milliseconds before the tooltip is displayed.

Returns

\Kendo\Dataviz\UI\SankeyTooltip

Parameters

$value float

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->delay(1);
?>

followPointer

If set to true, the tooltip will follow the mouse pointer.

Returns

\Kendo\Dataviz\UI\SankeyTooltip

Parameters

$value boolean

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->followPointer(true);
?>

linkTemplate

The template which renders the tooltip content for the links.

Returns

\Kendo\Dataviz\UI\SankeyTooltip

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->linkTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->linkTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

nodeTemplate

The template which renders the tooltip content for the nodes.

Returns

\Kendo\Dataviz\UI\SankeyTooltip

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->nodeTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->nodeTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

offset

The distance between the tooltip and the mouse pointer in pixels.

Returns

\Kendo\Dataviz\UI\SankeyTooltip

Parameters

$value float

Example

<?php
$tooltip = new \Kendo\Dataviz\UI\SankeyTooltip();
$tooltip->offset(1);
?>