Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

control.RulerControl

Extends control.Button.

The "Ruler" control. The key of the control in the storage. control.storage — "rulerControl".

Constructor | Fields | Events | Methods

Constructor

control.RulerControl([parameters])

Parameters:

ParameterDefault valueDescription
parameters

Type: Object

Control parameters.

parameters.data

Type: Object

Object describing the data of a control.

parameters.options

Type: Object

Control options.

parameters.options.adjustMapMargin false

Type: Boolean

Whether the control registers its size in the map margins manager map.margin.Manager.

parameters.options.position

Type: Object

Object describing the position of a control. If the position option is set, the float option value is automatically treated as "none".

parameters.options.position.bottom 30

Type: Number|String

Position relative to the bottom edge of the map.

parameters.options.position.left 'auto'

Type: Number|String

Position relative to the left edge of the map.

parameters.options.position.right 10

Type: Number|String

Position relative to the right edge of the map.

parameters.options.position.top 'auto'

Type: Number|String

Position relative to the top edge of the map.

parameters.options.scaleLine true

Type: Boolean

Flags if the ruler control should be displayed to the right of the ruler button.

parameters.options.visible true

Type: Boolean

Indicates if the control is displayed.

parameters.state

Type: Object

Object describing the state of a control.

Fields

NameTypeDescription
datadata.Manager

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.

Inherited from control.Button.

eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Inherited from IControl.

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.

Inherited from control.Button.

statedata.Manager

Button state. Names of fields that are available via the data.Manager.get method:

  • selected - Flag for whether the button is selected.
  • enabled - Flag for whether the button is active.
  • size - The size that is currently set for the button.

Inherited from control.Button.

Events

NameDescription
click

Clicking the button. Instance of the Event class.

Inherited from control.Button.

deselect

The control is not selected.

Inherited from ISelectableControl.

disable

The control is unavailable.

Inherited from ISelectableControl.

enable

The control is available.

Inherited from ISelectableControl.

optionschange

Change to the object options.

Inherited from ICustomizable.

parentchange

The parent object reference changed.

Data fields:

  • oldParent - Old parent.
  • newParent - New parent.

Inherited from IChild.

select

The control is selected.

Inherited from ISelectableControl.

Methods

NameReturnsDescription
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()

Map

Returns reference to the map.

Inherited from control.Button.

getParent()

IControlParent|null

Returns link to the parent object, or null if the parent element was not set.

Inherited from IControl.

isEnabled()

Boolean

Returns true if the control is available, or false if it is unavailable.

Inherited from ISelectableControl.

isSelected()

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.

setParent(parent)

IChildOnMap

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.