Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

IControl

Extends IChildOnMap.

Control.

Constructor | Fields | Events | Methods

Constructor

IControl([options])

Interface for a control.

Parameters:

ParameterDefault valueDescription
options

Type: Object

Control options.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Events

NameDescription
parentchange

The parent object reference changed.

Data fields:

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

Inherited from IChild.

Methods

NameReturnsDescription
getParent()

IControlParent|null

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

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.

Fields details

options

{IOptionManager} options

Options manager.

Methods details

getParent

{IControlParent|null} getParent()

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

setParent

{IChildOnMap} setParent(parent)

Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object.

Returns self-reference.

Parameters:

ParameterDefault valueDescription
parent*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IControlParent|null

Parent object.

* Mandatory parameter/option.