\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

A PHP class representing the tool setting of DiagramConnectionDefaultsEditableTools.

Methods

attributes

Specifies the HTML attributes of a button.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value ``

addButton

Adds one or more DiagramConnectionDefaultsEditableToolButton to the DiagramConnectionDefaultsEditableTool.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value[, $value2, ...] \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolButton |array

Example - using \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolButton

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$button = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolButton();
$enable = true;
$button->enable($enable);
$tool->addButton($button);
?>

Example - using array

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$enable = true;
$tool->addButton(array('enable' => $enable));
?>

Example - adding more than one DiagramConnectionDefaultsEditableToolButton

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$first  = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolButton();
$second = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolButton();
$tool->addButton($first, $second);
?>

click

Specifies the click event handler of the button. Applicable only for commands of type button and splitButton.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->click(new \Kendo\JavaScriptFunction('function() { }'));
?>

enable

Specifies whether the control is initially enabled or disabled. Default value is "true".

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value boolean

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->enable(true);
?>

group

Assigns the button to a group. Applicable only for buttons with togglable set to true.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->group('value');
?>

icon

Sets icon for the item. The icon should be one of the existing in the Kendo UI theme sprite.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->icon('value');
?>

id

Specifies the ID of the button.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->id('value');
?>

imageUrl

If set, the ToolBar will render an image with the specified URL in the button.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->imageUrl('value');
?>

addMenuButton

Adds one or more DiagramConnectionDefaultsEditableToolMenuButton to the DiagramConnectionDefaultsEditableTool.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value[, $value2, ...] \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolMenuButton |array

Example - using \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolMenuButton

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$menuButton = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolMenuButton();
$enable = true;
$menuButton->enable($enable);
$tool->addMenuButton($menuButton);
?>

Example - using array

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$enable = true;
$tool->addMenuButton(array('enable' => $enable));
?>

Example - adding more than one DiagramConnectionDefaultsEditableToolMenuButton

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$first  = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolMenuButton();
$second = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableToolMenuButton();
$tool->addMenuButton($first, $second);
?>

name

The name of the tool. The built-in tools are "edit" and "delete".

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->name('value');
?>

overflow

Specifies how the button behaves when the ToolBar is resized. Possible values are "always", "never" or "auto" (default).

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->overflow('value');
?>

overflowTemplate

Specifies what element will be added in the command overflow popup. Applicable only for items that have a template.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->overflowTemplate('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->overflowTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

primary

Specifies whether the button is primary. Primary buttons receive different styling.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value boolean

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->primary(true);
?>

selected

Specifies if the toggle button is initially selected. Applicable only for buttons with togglable set to true.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value boolean

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->selected(true);
?>

showIcon

Specifies where the button icon will be displayed. Possible values are "toolbar", "overflow" or "both" (default).

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->showIcon('value');
?>

showText

Specifies where the text will be displayed. Possible values are "toolbar", "overflow" or "both" (default).

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->showText('value');
?>

spriteCssClass

Defines a CSS class (or multiple classes separated by spaces) which will be used for button icon.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->spriteCssClass('value');
?>

template

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string |\Kendo\JavaScriptFunction

Example - using string

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->template('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->template(new \Kendo\JavaScriptFunction('function() { }'));
?>

text

Sets the text of the button.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

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

togglable

Specifies if the button is togglable, e.g. has a selected and unselected state.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value boolean

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->togglable(true);
?>

toggle

Specifies the toggle event handler of the button. Applicable only for commands of type button and togglable set to true.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->toggle(new \Kendo\JavaScriptFunction('function() { }'));
?>

type

Specifies the command type. Supported types are "button", "splitButton", "buttonGroup", "separator".

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->type('value');
?>

url

Specifies the url to navigate to.

Returns

\Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool

Parameters

$value string

Example

<?php
$tool = new \Kendo\Dataviz\UI\DiagramConnectionDefaultsEditableTool();
$tool->url('value');
?>