bbbfly. MapBox class control

Extends

• bbbfly.Map

In Packages

• mapbox

Interfaces

• Definition

Members

static control enum integer

Possible values for bbbfly.Mapbox.MapControls

Name	Type	Default	Description
none	integer	0
copyrights	integer	1
layers	integer	2
drawBar	integer	4
modeBar	integer	8
sideBar	integer	16
zoomSlider	integer	32
drawMarker	integer	64
drawGeometry	integer	128

Methods

inherited AddChildControl (ctrl)

base/panel.js, line 1399

Parameters:

Name	Type	Description
ctrl	ngControl	optional Child control reference

See:

• RemoveChildControl()
• OnChildControlAdded
• OnChildControlRemoved

inherited AddLayer (def){boolean}

map/map.js, line 1166

Add new map layer.

Parameters:

Name	Type	Description
def	bbbfly.Map.Layer

See:

• GetLayers()
• GetLayer()
• AddLayers()
• RemoveLayers()
• RemoveLayer()
• OnLayersChanged

Returns:

Type	Description
boolean	- If layer was added

inherited AddLayers (defs){boolean}

map/map.js, line 1148

Add new map layers.

Parameters:

Name	Type	Description
defs	Array.<bbbfly.Map.Layer>

See:

• GetLayers()
• GetLayer()
• AddLayer()
• RemoveLayers()
• RemoveLayer()
• OnLayersChanged

Returns:

Type	Description
boolean	- If all layers were added

inherited CreateControl (def){object|null}

base/panel.js, line 1424

Parameters:

Name	Type	Description
def	ngControl.Definition	optional Child control definition

See:

• AddChildControl()
• RemoveChildControl()
• DisposeControls()

Returns:

Type	Description
object | null	Created control

inherited CreateLayer (def){bbbfly.Map.layer}

map/map.js, line 1097

Create Leaflet layer wrapper.

Parameters:

Name	Type	Description
def	bbbfly.Map.Layer

See:

• GetLayers()
• GetLayer()
• AddLayers()
• AddLayer()
• RemoveLayers()
• RemoveLayer()

Returns:

Type	Description
bbbfly.Map.layer

inherited CreateMap (){object}

map/map.js, line 789

Create Leaflet map.

See:

• GetMap()
• DoCreateMap()
• DestroyMap()

Returns:

Type	Description
object	Leaflet Map

inherited DestroyMap (){boolean}

map/map.js, line 821

Destroy Leaflet map.

See:

• GetMap()
• CreateMap()
• DoCreateMap()

Returns:

Type	Description
boolean	If map was destroyed

inherited DisposeControls ()

base/panel.js, line 1437

See:

• AddChildControl()
• RemoveChildControl()
• CreateControl()

inherited DoCreateMap (options){object}

map/map.js, line 804

Do reate Leaflet map from its options.

Parameters:

Name	Type	Description
options	object	Leaflet Map options

See:

• GetMap()
• CreateMap()
• DestroyMap()

Returns:

Type	Description
object	Leaflet Map

inherited DoGetLayerName (layer){string|null}

map/map.js, line 1257

Get layer name for current language.

Parameters:

Name	Type	Description
layer	bbbfly.Map.layer

Returns:

Type	Description
string | null

inherited EnableAnimation (enable){boolean}

map/map.js, line 972

Enable or disable map animation.

Parameters:

Name	Type	Description
enable	boolean

Returns:

Type	Description
boolean	If state has changed

inherited FitBounds (bounds, padding){boolean}

map/map.js, line 877

Pan and zoom map to fit certain bounds with padding.

Parameters:

Name	Type	Description
bounds	mapBounds	Bounds to fit
padding	padding	Padding between map edge and bounds

See:

• SetMaxBounds()
• FitCoords()

Returns:

Type	Description
boolean	If fit was successful

inherited FitCoords (coords, padding){boolean}

map/map.js, line 895

Pan and zoom map to fit certain bounds with padding.

Parameters:

Name	Type	Description
coords	mapPoint	Coordinates to fit
padding	padding	Padding between map edge and coords

See:

• FitBounds()

Returns:

Type	Description
boolean	If fit was successful

FitDrawing (id){boolean}

map/map_box.js, line 465

Pan to see drawing

Parameters:

Name	Type	Description
id	string

See:

• FitDrawings()

Returns:

Type	Description
boolean	If fit was successful

FitDrawings (){boolean}

map/map_box.js, line 478

Pan and zoom to see all drawings

See:

• FitDrawing()

Returns:

Type	Description
boolean	If fit was successful

inherited GetAlt (){string|null}

base/panel.js, line 1386

See:

• SetAlt()
• OnSetAlt
• OnAltChanged

Returns:

Type	Description
string | null

inherited GetAttributions (){bbbfly.Map.attribution}

map/map.js, line 1269

Get all layers attributions.

See:

• OnLayersChanged

Returns:

Type	Description
bbbfly.Map.attribution

inherited GetBoundsPadding (padding){padding}

map/map.js, line 863

Get map bounds padding.

Parameters:

Name	Type	Description
padding	padding	optional Bounds padding

See:

• SetBoundsPadding()
• FitBounds()

Returns:

Type	Description
padding	Bounds padding

inherited GetCenter (){mapPoint|null}

map/map.js, line 1084

Get map position.

See:

• SetView()
• SetCenter()

Returns:

Type	Description
mapPoint | null	Center point

inherited GetClassName (suffix){string}

base/panel.js, line 1287

Parameters:

Name	Type	Description
suffix	string	optional Control part class name

Returns:

Type	Description
string	Control class name

inherited GetControlsHolder (){object}

base/panel.js, line 1612

See:

• GetFramePanel()
• GetControlsPanel()

Returns:

Type	Description
object	ControlsPanel control or self

inherited GetControlsPanel (){object|null}

base/panel.js, line 1601

See:

• GetFramePanel()
• GetControlsHolder()

Returns:

Type	Description
object | null	ControlsPanel control

inherited GetFrame (){bbbfly.Renderer.frame}

base/panel.js, line 1574

Returns:

Type	Description
bbbfly.Renderer.frame	Frame definition

inherited GetFrameDims (){object}

base/panel.js, line 1582

Returns:

Type	Description
object	Frame dimensions

inherited GetFramePanel (){object|null}

base/panel.js, line 1590

See:

• GetControlsPanel()
• GetControlsHolder()

Returns:

Type	Description
object | null	FramePanel control

inherited GetLayer (id){bbbfly.Map.layer}

map/map.js, line 1131

Get map layer.

Parameters:

Name	Type	Description
id	string

See:

• GetLayers()
• AddLayers()
• AddLayer()
• RemoveLayers()
• RemoveLayer()

Returns:

Type	Description
bbbfly.Map.layer

inherited GetLayerName (id){string|null}

map/map.js, line 1246

Get layer name for current language.

Parameters:

Name	Type	Description
id	string

Returns:

Type	Description
string | null

inherited GetLayers (){Array.<bbbfly.Map.layer>}

map/map.js, line 1115

Get map layers.

See:

• GetLayer()
• AddLayers()
• AddLayer()
• RemoveLayers()
• RemoveLayer()

Returns:

Type	Description
Array.<bbbfly.Map.layer>

inherited GetMap (){object}

map/map.js, line 774

Get Leaflet map.

See:

• CreateMap()
• DoCreateMap()
• DestroyMap()

Returns:

Type	Description
object	Leaflet Map

GetMapControls (type){Array.<bbbfly.MapControl>}

map/map_box.js, line 435

Get passed type linked map controls.

Parameters:

Name	Type	Default	Description
type	string	undeUnlinkMapControlfined	optional

See:

• LinkMapControl()
• UnlinkMapControl()
• SetMapControlsVisible()

Returns:

Type	Description
Array.<bbbfly.MapControl>

inherited GetMapLayerName (mapLayer){string|null}

map/map.js, line 1235

Get map layer name for current language.

Parameters:

Name	Type	Description
mapLayer	L.Layer

Returns:

Type	Description
string | null

inherited GetMaxZoom (){number|null}

map/map.js, line 958

Get map maximal zoom level.

See:

• SetMaxZoom()
• SetMinZoom()
• GetMinZoom()

Returns:

Type	Description
number | null	zoom - Zoom level

inherited GetMinZoom (){number|null}

map/map.js, line 928

Get map minimal zoom level.

See:

• SetMinZoom()
• SetMaxZoom()
• GetMaxZoom()

Returns:

Type	Description
number | null	zoom - Zoom level

GetMode (modeType){string|null}

map/map_box.js, line 505

Get map mode

Parameters:

Name	Type	Description
modeType	string

See:

• SetMode()
• GetModes()
• OnModeChanged

Returns:

Type	Description
string | null

GetModes (){Array.<string>}

map/map_box.js, line 519

Get all map modes

See:

• SetMode()
• GetMode()
• OnModeChanged

Returns:

Type	Description
Array.<string>

inherited GetState (){bbbfly.Renderer.state}

base/panel.js, line 1279

Returns:

Type	Description
bbbfly.Renderer.state	Control state

inherited GetZoom (){number|null}

map/map.js, line 1021

Get map zoom level.

See:

• SetView()
• SetZoom()
• ZoomIn()
• ZoomOut()

Returns:

Type	Description
number | null	zoom - Zoom level

LinkMapControl (type, ctrl){boolean}

map/map_box.js, line 403

Link map control to map.

Parameters:

Name	Type	Description
type	string
ctrl	bbbfly.MapControl

See:

• UnlinkMapControl()
• GetMapControls()
• SetMapControlsVisible()

Returns:

Type	Description
boolean	If control was linked

inherited RemoveChildControl (ctrl)

base/panel.js, line 1411

Parameters:

Name	Type	Description
ctrl	ngControl	optional Child control reference

See:

• AddChildControl()
• OnChildControlAdded
• OnChildControlRemoved

inherited RemoveLayer (id){boolean}

map/map.js, line 1202

Remove map layer.

Parameters:

Name	Type	Description
id	string

See:

• GetLayers()
• GetLayer()
• AddLayers()
• AddLayer()
• RemoveLayers()
• OnLayersChanged

Returns:

Type	Description
boolean	- If layer was removed

inherited RemoveLayers (ids){boolean}

map/map.js, line 1184

Remove map layers.

Parameters:

Name	Type	Description
ids	Array.<string>	optional All layers will be removed if no ID is passed

See:

• GetLayers()
• GetLayer()
• AddLayers()
• AddLayer()
• RemoveLayer()
• OnLayersChanged

Returns:

Type	Description
boolean	- If all layers were removed

inherited SetAlt (alt, update)

base/panel.js, line 1373

Parameters:

Name	Type	Default	Description
alt	string | null		Value to set
update	boolean	true	optional If update control

See:

• GetAlt()
• OnSetAlt
• OnAltChanged

inherited SetBoundsPadding (padding){boolean}

map/map.js, line 849

Set map bounds padding.

Parameters:

Name	Type	Description
padding	padding | px	Bounds padding

See:

• GetBoundsPadding()
• FitBounds()

Returns:

Type	Description
boolean	If padding was set

inherited SetCenter (coords){boolean}

map/map.js, line 1070

Set map position.

Parameters:

Name	Type	Description
coords	mapPoint	Center point

See:

• SetView()
• GetCenter()

Returns:

Type	Description
boolean	If center was set

SetDrawControlDrawing (drawing){boolean}

map/map_box.js, line 533

Set draw control geometry type

Parameters:

Name	Type	Description
drawing	bbbfly.MapDrawingItem

Returns:

Type	Description
boolean

inherited SetEnabled (enabled, update){boolean}

base/panel.js, line 1305

Parameters:

Name	Type	Default	Description
enabled	boolean	true	optional Value to set
update	boolean	true	optional If update control

See:

• OnSetEnabled
• OnEnabledChanged

Returns:

Type	Description
boolean	False if change was denied

inherited SetInvalid (invalid, update){boolean}

base/panel.js, line 1318

Parameters:

Name	Type	Default	Description
invalid	boolean	true	optional Value to set
update	boolean	true	optional If update control

See:

• OnSetInvalid
• OnInvalidChanged

Returns:

Type	Description
boolean	False if change was denied

inherited SetLayerVisible (id, visible){boolean}

map/map.js, line 1220

Shows or hides map layer.

Parameters:

Name	Type	Description
id	string
visible	boolean

See:

• GetLayer()
• OnLayersChanged

Returns:

Type	Description
boolean	- If layer visibility was set

SetMapControlsVisible (type, visible){boolean}

map/map_box.js, line 449

Set visibility of passed type map controls.

Parameters:

Name	Type	Default	Description
type	string
visible	boolean	true	optional

See:

• LinkMapControl()
• UnlinkMapControl()
• GetMapControls()

Returns:

Type	Description
boolean	If map control visibility was set.

inherited SetMaxBounds (bounds){boolean}

map/map.js, line 836

Set maximal map bounds.

Parameters:

Name	Type	Description
bounds	mapBounds | array	Maximal bounds

See:

• FitBounds()

Returns:

Type	Description
boolean	If bounds were set

inherited SetMaxZoom (zoom){boolean}

map/map.js, line 942

Set maximal map zoom level.

Parameters:

Name	Type	Description
zoom	number	Zoom level

See:

• GetMaxZoom()
• GetMinZoom()
• SetMinZoom()

Returns:

Type	Description
boolean	If zoom was set

inherited SetMinZoom (zoom){boolean}

map/map.js, line 912

Set minimal map zoom level.

Parameters:

Name	Type	Description
zoom	number	Zoom level

See:

• GetMinZoom()
• GetMaxZoom()
• SetMaxZoom()

Returns:

Type	Description
boolean	If zoom was set

SetMode (modeType, mode){string|null}

map/map_box.js, line 490

Set map mode

Parameters:

Name	Type	Description
modeType	string
mode	string | null

See:

• GetMode()
• GetModes()
• OnModeChanged

Returns:

Type	Description
string | null

inherited SetOverflow (overflowX, overflowY, update){boolean}

base/panel.js, line 1358

Parameters:

Name	Type	Default	Description
overflowX	bbbfly.Renderer.overflow	hidden	optional Horizontal value to set
overflowY	bbbfly.Renderer.overflow	hidden	optional Vertical value to set
update	boolean	true	optional If update control

See:

• OnSetOverflow
• OnOverflowChanged

Returns:

Type	Description
boolean	False if change was denied

inherited SetReadOnly (readonly, update){boolean}

base/panel.js, line 1331

Parameters:

Name	Type	Default	Description
readonly	boolean	true	optional Value to set
update	boolean	true	optional If update control

See:

• OnSetReadOnly
• OnReadOnlyChanged

Returns:

Type	Description
boolean	False if change was denied

inherited SetSelected (selected, update){boolean}

base/panel.js, line 1344

Parameters:

Name	Type	Default	Description
selected	boolean	true	optional Value to set
update	boolean	true	optional If update control

See:

• OnSetSelected
• OnSelectedChanged

Returns:

Type	Description
boolean	False if change was denied

inherited SetView (coords, zoom){boolean}

map/map.js, line 984

Set map position and zoom level.

Parameters:

Name	Type	Description
coords	mapPoint	Center point
zoom	number	Zoom level

See:

• SetZoom()
• GetZoom()
• ZoomIn()
• ZoomOut()
• SetCenter()
• GetCenter()
• OnZoomChanged

Returns:

Type	Description
boolean	If view was set

inherited SetZoom (zoom){boolean}

map/map.js, line 1004

Set map zoom level.

Parameters:

Name	Type	Description
zoom	number	Zoom level

See:

• SetView()
• GetZoom()
• ZoomIn()
• ZoomOut()
• OnZoomChanged

Returns:

Type	Description
boolean	If zoom was set

StopDrawControlActions ()

map/map_box.js, line 543

Stop all draw control actions

inherited TrackChildControls ()

base/panel.js, line 1491

inherited TrackControl (ctrl, track)

base/panel.js, line 1482

Parameters:

Name	Type	Default	Description
ctrl	ngControl		optional Tracked control reference
track	boolean	true	optional Pass false to cancel tracking

UnlinkMapControl (type, ctrl){boolean}

map/map_box.js, line 419

Unlink map control from map.

Parameters:

Name	Type	Description
type	string
ctrl	bbbfly.MapControl

See:

• LinkMapControl()
• GetMapControls()
• SetMapControlsVisible()

Returns:

Type	Description
boolean	If control was unlinked

inherited ZoomIn (zoomBy){boolean}

map/map.js, line 1036

Zoom map in.

Parameters:

Name	Type	Description
zoomBy	number	Number of zoom levels

See:

• SetView()
• SetZoom()
• GetZoom()
• ZoomOut()
• OnZoomChanged

Returns:

Type	Description
boolean	If map was zoomed

inherited ZoomOut (zoomBy){boolean}

map/map.js, line 1053

Zoom map out.

Parameters:

Name	Type	Description
zoomBy	number	Number of zoom levels

See:

• SetView()
• SetZoom()
• GetZoom()
• ZoomIn()
• OnZoomChanged

Returns:

Type	Description
boolean	If map was zoomed

Events

inherited IsTrackedControlChanged (ctrl, options)

base/panel.js, line 1497

Parameters:

Name	Type	Description
ctrl	ngControl	optional Tracked control reference
options	object	optional Per tracker options

inherited OnAltChanged ()

base/panel.js, line 1220

See:

• SetAlt()
• OnSetAlt

inherited OnChildControlAdded (ctrl)

base/panel.js, line 1230

Parameters:

Name	Type	Description
ctrl	ngControl	optional Child control reference

See:

• AddChildControl()
• RemoveChildControl()
• OnChildControlRemoved

inherited OnChildControlRemoved (ctrl)

base/panel.js, line 1242

Parameters:

Name	Type	Description
ctrl	ngControl	optional Child control reference

See:

• AddChildControl()
• RemoveChildControl()
• OnChildControlAdded

inherited OnEnabledChanged ()

base/panel.js, line 1111

See:

• SetEnabled()
• OnSetEnabled

inherited OnInvalidChanged ()

base/panel.js, line 1132

See:

• SetInvalid()
• OnSetInvalid

inherited OnLayersChanged ()

map/map.js, line 756

See:

• AddLayer()
• AddLayer()
• RemoveLayer()
• RemoveLayers()

OnModeChanged (modeType, mode)

map/map_box.js, line 381

Parameters:

Name	Type	Description
modeType	string
mode	string | null

See:

• SetMode()
• GetMode()
• GetModes()

inherited OnOverflowChanged ()

base/panel.js, line 1197

See:

• SetOverflow()
• OnSetOverflow

inherited OnReadOnlyChanged ()

base/panel.js, line 1153

See:

• SetReadOnly()
• OnSetReadOnly

inherited OnSelectedChanged ()

base/panel.js, line 1174

See:

• SetSelected()
• OnSetSelected

inherited OnSetAlt (alt, update){boolean}

base/panel.js, line 1207

Parameters:

Name	Type	Default	Description
alt	boolean		Value to set
update	boolean	true	optional If update control

See:

• SetAlt()
• OnAltChanged

Returns:

Type	Description
boolean	Return false to deny value change

inherited OnSetEnabled (enabled){boolean}

base/panel.js, line 1099

Parameters:

Name	Type	Description
enabled	boolean	Value to set

See:

• SetEnabled()
• OnEnabledChanged

Returns:

Type	Description
boolean	Return false to deny value change

inherited OnSetInvalid (invalid){boolean}

base/panel.js, line 1120

Parameters:

Name	Type	Description
invalid	boolean	Value to set

See:

• SetInvalid()
• OnInvalidChanged

Returns:

Type	Description
boolean	Return false to deny value change

inherited OnSetOverflow (overflowX, overflowY){boolean}

base/panel.js, line 1184

Parameters:

Name	Type	Description
overflowX	bbbfly.Renderer.overflow	optional Horizontal value to set
overflowY	bbbfly.Renderer.overflow	optional Vertical value to set

See:

• SetOverflow()
• OnOverflowChanged

Returns:

Type	Description
boolean	Return false to deny values change

inherited OnSetReadOnly (readonly){boolean}

base/panel.js, line 1141

Parameters:

Name	Type	Description
readonly	boolean	Value to set

See:

• SetReadOnly()
• OnReadOnlyChanged

Returns:

Type	Description
boolean	Return false to deny value change

inherited OnSetSelected (selected){boolean}

base/panel.js, line 1162

Parameters:

Name	Type	Description
selected	boolean	Value to set

See:

• SetSelected()
• OnSelectedChanged

Returns:

Type	Description
boolean	Return false to deny value change

inherited OnTrackedControlChanged (ctrl)

base/panel.js, line 1472

Parameters:

Name	Type	Description
ctrl	ngControl	optional Tracked control reference

inherited OnZoomChanged (zoom)

map/map.js, line 742

Parameters:

Name	Type	Description
zoom	number	Actual zoom level

See:

• SetView()
• SetZoom()
• GetZoom()
• ZoomIn()
• ZoomOut()