ControlManager interface

A manager for the map control's controls. Exposed through the controls property of the atlas.Map class. Cannot be instantiated by the user.

Methods

add(Control | Control[], ControlOptions)

Add a control(s) to the map.

getControls()

Gets an array of all controls on the map

remove(Control | Control[])

Remove a control(s) from the map.

Method Details

add(Control | Control[], ControlOptions)

Add a control(s) to the map.

function add(control: Control | Control[], options?: ControlOptions)

Parameters

control

Control | Control[]

The control to add.

options
ControlOptions

The options for the added control.

getControls()

Gets an array of all controls on the map

function getControls(): Control[]

Returns

remove(Control | Control[])

Remove a control(s) from the map.

function remove(control: Control | Control[])

Parameters

control

Control | Control[]

The control to remove.