\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
A PHP class representing the tool setting of DiagramShapeDefaultsEditableTools.
Methods
attributes
Specifies the HTML attributes of a button.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value ``
addButton
Adds one or more DiagramShapeDefaultsEditableToolButton to the DiagramShapeDefaultsEditableTool.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value[, $value2, ...] \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolButton|array
Example - using \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolButton
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$button = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolButton();
$enable = true;
$button->enable($enable);
$tool->addButton($button);
?>
Example - using array
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$enable = true;
$tool->addButton(array('enable' => $enable));
?>
Example - adding more than one DiagramShapeDefaultsEditableToolButton
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$first = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolButton();
$second = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolButton();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value \Kendo\JavaScriptFunction
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->click(new \Kendo\JavaScriptFunction('function() { }'));
?>
enable
Specifies whether the control is initially enabled or disabled. Default value is "true".
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value boolean
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->enable(true);
?>
group
Assigns the button to a group. Applicable only for buttons with togglable set to true.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->icon('value');
?>
id
Specifies the ID of the button.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->id('value');
?>
imageUrl
If set, the ToolBar will render an image with the specified URL in the button.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->imageUrl('value');
?>
addMenuButton
Adds one or more DiagramShapeDefaultsEditableToolMenuButton to the DiagramShapeDefaultsEditableTool.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value[, $value2, ...] \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolMenuButton|array
Example - using \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolMenuButton
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$menuButton = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolMenuButton();
$enable = true;
$menuButton->enable($enable);
$tool->addMenuButton($menuButton);
?>
Example - using array
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$enable = true;
$tool->addMenuButton(array('enable' => $enable));
?>
Example - adding more than one DiagramShapeDefaultsEditableToolMenuButton
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$first = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolMenuButton();
$second = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableToolMenuButton();
$tool->addMenuButton($first, $second);
?>
name
The name of the tool. The built-in tools are edit, delete, rotateClockwise, and rotateAnticlockwise.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->overflowTemplate('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->overflowTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>
primary
Specifies whether the button is primary. Primary buttons receive different styling.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value boolean
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value boolean
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->selected(true);
?>
showIcon
Specifies where the button icon will be displayed. Possible values are "toolbar", "overflow" or "both" (default).
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->showIcon('value');
?>
showText
Specifies where the text will be displayed. Possible values are "toolbar", "overflow" or "both" (default).
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->spriteCssClass('value');
?>
step
The step of the rotateClockwise and rotateAnticlockwise tools. It determines the angle at which a selected shape will be rotated when one of the tools is clicked.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value float
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->step(1);
?>
template
Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->template('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->template(new \Kendo\JavaScriptFunction('function() { }'));
?>
text
Sets the text of the button.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->text('value');
?>
togglable
Specifies if the button is togglable, e.g. has a selected and unselected state.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value boolean
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$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\DiagramShapeDefaultsEditableTool
Parameters
$value \Kendo\JavaScriptFunction
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->toggle(new \Kendo\JavaScriptFunction('function() { }'));
?>
type
Specifies the command type. Supported types are "button", "splitButton", "buttonGroup", "separator".
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->type('value');
?>
url
Specifies the url to navigate to.
Returns
\Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool
Parameters
$value string
Example
<?php
$tool = new \Kendo\Dataviz\UI\DiagramShapeDefaultsEditableTool();
$tool->url('value');
?>