bbbfly. MapModeBar class control

new bbbfly.MapModeBar (def, ref, parent)

Parameters

Name Type Description
def bbbfly.MapModeBar.Definition optional Descendant definition
ref object optional Reference owner
parent object | string optional Parent DIV element or it's ID

Properties

Name Type Default Description
ControlType string bbbfly.map.control.modebar.control_type
Modes object null { modeType: [mode,mode, ...], ... }
DefaultModes object null { modeType: mode, ... }
FrameDef object Mode type frame definition
ButtonDef object Mode button definition

Extends

In Packages

Interfaces

Methods

inherited AddChildControl (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited CreateControl (def){object|null}

Parameters:
Name Type Description
def ngControl.Definition optional Child control definition
See:
Returns:
Type Description
object | null Created control

inherited CreateListener (){object|null}

Returns:
Type Description
object | null

inherited DisposeControls ()

See:

inherited GetAlt (){string|null}

See:
Returns:
Type Description
string | null

abstract GetButtonIcon (mapMode){image}

Parameters:
Name Type Description
mapMode object
type string Map mode type id
mode string Map mode id
Returns:
Type Description
image

inherited GetClassName (suffix){string}

Parameters:
Name Type Description
suffix string optional Control part class name
Returns:
Type Description
string Control class name

inherited GetControlsHolder (){object}

Returns:
Type Description
object self

inherited GetListener (){bbbflt.Map.listener|null}

Returns:
Type Description
bbbflt.Map.listener | null
Get map control by MapID
Returns:
Type Description
bbbfly.MapBox | null

inherited GetState (){bbbfly.Renderer.state}

Returns:
Type Description
bbbfly.Renderer.state Control state

inherited LinkToMap (map){boolean}

Parameters:
Name Type Description
map bbbfly.MapBox
See:
Returns:
Type Description
boolean If control was linked

inherited RemoveChildControl (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited SetAlt (alt, update)

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

inherited SetEnabled (enabled, update){boolean}

Parameters:
Name Type Default Description
enabled boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

inherited SetInvalid (invalid, update){boolean}

Parameters:
Name Type Default Description
invalid boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

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

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:
Returns:
Type Description
boolean False if change was denied

inherited SetReadOnly (readonly, update){boolean}

Parameters:
Name Type Default Description
readonly boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

inherited SetSelected (selected, update){boolean}

Parameters:
Name Type Default Description
selected boolean true optional Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean False if change was denied

ShowMode (modeType, mode)

Parameters:
Name Type Description
modeType string Map mode type name
mode string Map mode name

inherited UnlinkFromMap (map){boolean}

Parameters:
Name Type Description
map bbbfly.MapBox
See:
Returns:
Type Description
boolean If control was unlinked

Events

See:

inherited OnChildControlAdded (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited OnChildControlRemoved (ctrl)

Parameters:
Name Type Description
ctrl ngControl optional Child control reference
See:

inherited OnEnabledChanged ()

See:

inherited OnInvalidChanged ()

See:
Parameters:
Name Type Description
map bbbfly.MapBox Linked map
See:

inherited OnLinkToMap (map){boolean}

Parameters:
Name Type Description
map bbbfly.MapBox Map to be linked
See:
Returns:
Type Description
boolean Return false to deny linking

inherited OnOverflowChanged ()

See:

inherited OnReadOnlyChanged ()

See:

inherited OnSelectedChanged ()

See:

inherited OnSetAlt (alt, update){boolean}

Parameters:
Name Type Default Description
alt boolean Value to set
update boolean true optional If update control
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetEnabled (enabled){boolean}

Parameters:
Name Type Description
enabled boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetInvalid (invalid){boolean}

Parameters:
Name Type Description
invalid boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetOverflow (overflowX, overflowY){boolean}

Parameters:
Name Type Description
overflowX bbbfly.Renderer.overflow optional Horizontal value to set
overflowY bbbfly.Renderer.overflow optional Vertical value to set
See:
Returns:
Type Description
boolean Return false to deny values change

inherited OnSetReadOnly (readonly){boolean}

Parameters:
Name Type Description
readonly boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnSetSelected (selected){boolean}

Parameters:
Name Type Description
selected boolean Value to set
See:
Returns:
Type Description
boolean Return false to deny value change

inherited OnUnlinkedFromMap (map)

Parameters:
Name Type Description
map bbbfly.MapBox Linked map
See:

inherited OnUnlinkFromMap (map){boolean}

Parameters:
Name Type Description
map bbbfly.MapBox Map to be linked
See:
Returns:
Type Description
boolean Return false to deny linking