The Map widget illustrates the geographical location of a data variable. It can display predefined locations.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
DisabledThe widget cannot be used.
HiddenHides the widget from the user.
Icon AttributeWhich Attribute to use for determining what icon to render for a record.
Icon FunctionA function for determining what icon to use for representing a record.
MaximizeSet this widget to be maximized (take up all available space).
Popup HTML-templateA template used for generating the tooltip for a record.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.

Style

Name Desciption
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
MarkerClick Triggered when the marker holding the data is clicked on the map.
event Object containing the record (event.record) in the map that was clicked.

Function

addMarker ( enable: Boolean )

Adds a marker to the map.

Parameters
Name Type Description
enable Boolean Specifies whether to enable or disable editing.

refresh ( )

Refreshes the map.

setView ( position: Object , zoom: Float )

Sets the center - location of the Map.

Parameters
Name Type Description
position Object Coordinates to set as the new center of the map.
zoom Float Zoom-level

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget.

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style.

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.