control.Button
Extends ICustomizable, ISelectableControl.
The "Button" control. The standard button layout changes its appearance depending on the size of the map. If the map is wide enough, the "image + text" version of the button is shown. If the map is medium in size, the "text" version of the button is shown. If the map is small, only the icon is shown in the button layout. If a button has no icon, then only text will be displayed in all states, and vice versa.
Constructor | Fields | Events | Methods
Constructor
control.Button([parameters])
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object|String Parameters of a button or string - button contents in HTML format. |
|
— |
Type: Object Button data. |
|
— |
Type: String Button contents in HTML format. |
|
— |
Type: String URL of the button icon. The standard layout of a button is designed for the icon size 16x16 pixels. |
|
— |
Type: String Text of the popup hint that appears when the mouse cursor hovers over the button. |
|
— |
Type: Object Button options. |
|
false |
Type: Boolean Whether the button registers its size in the map margins manager map.margin.Manager. |
|
"right" |
Type: String The side to which you want to align the control. Can take three values: "left", "right" or "none". If set to "left" or "right", the controls are arranged one by one, starting from the left or right edge of the map, respectively. If set to "none", the controls are positioned according to the values of the left, right, bottom and top options, relative to the boundaries of the map. See also the description of the position option. |
|
0 |
Type: Number The priority of the control positioning. The element with highest priority is positioned closer to the map boundary that is specified in the float property. Does not work with float = "none". |
|
— |
Type: ISelectableControlLayout|String Constructor of the control layout which implements the ISelectableControlLayout interface or the layout key in the layout.storage. The layout constructor is passed an object containing the fields:
|
|
90 |
Type: Number|Number[] The maximum width of the button in different states. If a number is specified, it is assumed that the button has the same maximum dimensions in all states. If an array is specified, it will be interpreted as the maximum width of the button in different states, from the lesser to the greater. The number of states is set in the instance of the class control.Manager, which is usually a field of Map.controls, via the "states" option. By default, the controls have three states ['small', 'medium', 'large']. |
|
— |
Type: Object Object describing the position of a control. If the position option is set, the float option value is automatically treated as "none". |
|
'auto' |
Type: Number|String Position relative to the bottom edge of the map. |
|
'auto' |
Type: Number|String Position relative to the left edge of the map. |
|
'auto' |
Type: Number|String Position relative to the right edge of the map. |
|
'auto' |
Type: Number|String Position relative to the top edge of the map. |
|
true |
Type: Boolean Options describing button behavior.
|
|
'auto' |
Type: String Defines the appearance of the standard button layout. Takes the following values:
|
|
true |
Type: Boolean Indicates if the control is displayed. |
|
— |
Type: Object Object describing the state of the button. |
|
true |
Type: Boolean Indicates if the button is active. |
|
false |
Type: Boolean Indicates if the button is pressed. |
Examples:
1.
// Example 1.
// Creating a button and adding it to the map.
var button = new ymaps.control.Button({
data: {
// Setting an icon for the button.
image: 'images/button.jpg',
// Text on the icon.
content: 'Save',
// Text for the popup hint.
title: 'Click to save the route'
},
options: {
// Setting up the button options.
selectOnClick: false,
// The button will have three states - icon, text, and icon + text.
// So we'll define three values for the button width for all states.
maxWidth: [30, 100, 150]
}
});
map.controls.add(button, { float: 'right', floatIndex: 100 });
2.
// Example 2.
// Creating buttons with a custom layout.
var button = new ymaps.control.Button({
data: {
content: 'Red button',
title: 'Press the button'
},
options: {
layout: ymaps.templateLayoutFactory.createClass(
// If the button is not pressed, the 'myButton' CSS style is applied.
// If the button is pressed, the 'myButton' and 'myButtonSelected' CSS styles are applied.
"<div class='myButton {% if state.selected %}myButtonSelected{% endif %}' title='{{ data.title }}'>" +
"{{ data.content }}" +
"</div>"
),
// In order to correctly position all other controls horizontally,
// you should specify the maximum width of the layout.
maxWidth: 150
}
});
map.controls.add(button, { float: 'left', floatIndex: 0 });
// You can define the positioning relative to the edges of the map. In this case,
// the value of the maxWidth option does not affect
// the positioning of controls.
map.controls.add(button, { float: 'none', position: {left: '5px', top: '5px'} });
Fields
Name |
Type |
Description |
Button data. Names of fields that are available via the data.Manager.get method:
|
||
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from IControl. |
||
The event indicating that the button has been pressed. Unlike the click event, it is generated only if the state isEnabled == true. Instance of the Event class. |
||
Button state. Names of fields that are available via the data.Manager.get method:
|
Events
Name |
Description |
Clicking the button. Instance of the Event class. |
|
The control is not selected. Inherited from ISelectableControl. |
|
The control is unavailable. Inherited from ISelectableControl. |
|
The control is available. Inherited from ISelectableControl. |
|
Change to the object options. Inherited from ICustomizable. |
|
The parent object reference changed. Data fields:
Inherited from IChild. |
|
The control is selected. Inherited from ISelectableControl. |
Methods
Name |
Returns |
Description |
deselect() |
Cancels selection of the control (turns it off). Inherited from ISelectableControl. |
|
disable() |
Makes the control unavailable (user actions are not allowed). Inherited from ISelectableControl. |
|
enable() |
Makes the control available (user actions are allowed). Inherited from ISelectableControl. |
|
getMap() |
Returns reference to the map. |
|
IControlParent|null |
Returns link to the parent object, or null if the parent element was not set. Inherited from IControl. |
|
Boolean |
Returns true if the control is available, or false if it is unavailable. Inherited from ISelectableControl. |
|
Boolean |
Returns true if the control is selected, or false if it is not selected. Inherited from ISelectableControl. |
|
select() |
Selects (turns on) the control. Inherited from ISelectableControl. |
|
Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object. Inherited from IControl. |
Fields details
data
{data.Manager} data
Button data. Names of fields that are available via the data.Manager.get method:
- image - Button icon, if available.
- content - Button content in HTML format.
- title - Text of the popup hint that appears when the mouse cursor hovers over the button.
press
press
The event indicating that the button has been pressed. Unlike the click event, it is generated only if the state isEnabled == true. Instance of the Event class.
state
{data.Manager} state
Button state. Names of fields that are available via the data.Manager.get method:
- selected - Indicates whether the button is selected.
- enabled - Indicates whether the button is active.
- size - The size that is currently set for the button.
Example:
var button = new ymaps.control.Button('Edit');
// Setting the button state to "selected" -
// similar to calling button.select();
button.state.set('selected', true);
Events details
click
Clicking the button. Instance of the Event class.
Methods details
getMap
{Map} getMap()
Returns reference to the map.
Mandatory parameter/option.