Documentation

Module

ui_interactions

UI Interections Functions definitions

View Source ui_interactions.js, line 1

Methods

# inner animateLinesOfSight(geojson_asset_points, geojson_anchors, geojson_antennas, geojson_lines_of_sight)

Animate Lines Of Sight function
Parameters:
Name Type Description
geojson_asset_points FeatureCollection Asset Points FeatureCollection data
geojson_anchors FeatureCollection Anchors FeatureCollection data
geojson_antennas FeatureCollection Antennas FeatureCollection data
geojson_lines_of_sight FeatureCollection Lines of Sight FeatureCollection data

View Source ui_interactions.js, line 881

# inner animatePulsingDotPoints(pulsing_dots_layers_sources)

Animate Pulsing Dot Points function
Parameters:
Name Type Description
pulsing_dots_layers_sources Array Pulsing Dots sources Array

View Source ui_interactions.js, line 996

# inner animateWallIntersectionPoints(wall_intersections_points, geojson_lines_of_sight, geojson_walls)

Animate Wall Intersection Points function
Parameters:
Name Type Description
wall_intersections_points FeatureCollection Lines-of-Sight Walls Intersection Points Array
geojson_lines_of_sight FeatureCollection Lines-of-Sight FeatureCollection
geojson_walls FeatureCollection Map Features Walls FeatureCollection data

View Source ui_interactions.js, line 949

# inner autoScrollDown(htmlElement, string)

Auto scroll down element (Console debug content)
Parameters:
Name Type Description
htmlElement HTMLElement HTML Element (Console debug)
string string Text to print on console

View Source ui_interactions.js, line 450

# inner catchAntennaDirectionsIntersections(lines_of_sight, geojson_antennas_directions) → {boolean}

Catch the Antennas Direction Intersections in Lines Of Sight ((UNCALLED - done in calculate at backend module)
Parameters:
Name Type Description
lines_of_sight FeatureCollection Lines of Sight FeatureCollection data
geojson_antennas_directions FeatureCollection Antennas Directions FeatureCollection data

View Source ui_interactions.js, line 1010

Result value of Asset Points with Antennas Directions
boolean

# inner catchLinesOfSight(geojson_objs, geojson_antennas) → {Array}

Catch the Lines Of Sight FeatureCollection
Parameters:
Name Type Description
geojson_objs FeatureCollection Points (Asset Points or Anchors) FeatureCollection data
geojson_antennas FeatureCollection Antennas FeatureCollection

View Source ui_interactions.js, line 817

Lines Of Sight Array data
Array

# inner catchWallIntersections(lines_of_sight, walls) → {Array}

Catch the Wall Intersections in Lines Of Sight
Parameters:
Name Type Description
lines_of_sight FeatureCollection Lines of Sight FeatureCollection data
walls FeatureCollection Map Features Walls FeatureCollection data

View Source ui_interactions.js, line 893

Lines-of-Sight Walls Intersection Points Array
Array

# inner checkAllCheckboxOptions(checkboxes)

Check All Checkbox Options
Parameters:
Name Type Description
checkboxes Array Checkboxes HMTL input type Array

View Source ui_interactions.js, line 484

# inner createAntennaDirection(index, geojson_antennas_directions) → {FeatureCollection}

Create Antenna Direction with provided a rotation angle
Parameters:
Name Type Description
index number Antenna feature index
geojson_antennas_directions * Antennas Directions FeatureCollection

View Source ui_interactions.js, line 780

Antennas Directions FeatureCollection
FeatureCollection

# inner createAssetPointLobesDirection(index, geojson_assetpoints_directions) → {FeatureCollection}

Create Asset Point Lobes Direction with provided a rotation angles
Parameters:
Name Type Description
index number Asset point feature index
geojson_assetpoints_directions FeatureCollection Asset Point Directions FeatureCollection

View Source ui_interactions.js, line 734

Asset Points Directions FeatureCollection
FeatureCollection

# inner generateAnimatedImage(basecolor)

Generate an Animated Image with rgb basecolor
Parameters:
Name Type Description
basecolor string RGB color values

View Source ui_interactions.js, line 371

Animated Pulsing Dot

# inner printOnConsoleDebugger(string)

Print string on console debugger innerHTML element and call autoScrollDown()
Parameters:
Name Type Description
string string Text to print on console

View Source ui_interactions.js, line 465

# inner setPulsingDotsLayersToNone(layers_pulsing_dots_IDs_to_disable) → {Array}

Set visibility of 'pulsing-dots' layers to none
Parameters:
Name Type Description
layers_pulsing_dots_IDs_to_disable Array Pulsing Dots Layer Ids Array to disable

View Source ui_interactions.js, line 595

Pulsing Dots Layer Ids Array with non-visible elements
Array

# inner setPulsingDotsLayersToVisible(layers_pulsing_dots_IDs_to_enable) → {Array}

Set visibility of 'pulsing-dots' layers to visible
Parameters:
Name Type Description
layers_pulsing_dots_IDs_to_enable Array Pulsing Dots Layer Ids Array to enable

View Source ui_interactions.js, line 579

Pulsing Dots Layer Ids Array with visible elements
Array

# inner toggleDrag(source_obj, geojson_obj, currentFeatureId, draggability)

Toggle Drag option inside popup
Parameters:
Name Type Description
source_obj string Source of FeatureCollection
geojson_obj FeatureCollection FeatureCollection data object
currentFeatureId number Index of FeatureCollection data object
draggability boolean Value of draggability option

View Source ui_interactions.js, line 271

# inner toggleLinesOfSight(source_obj, geojson_obj, currentFeatureId, show_lines)

Toggle Lines-of-Sight option inside popup
Parameters:
Name Type Description
source_obj string Source of FeatureCollection
geojson_obj FeatureCollection FeatureCollection data object
currentFeatureId number Index of FeatureCollection data object
show_lines boolean Value of show lines option

View Source ui_interactions.js, line 339

# inner togglePredictions(source_obj, geojson_obj, currentFeatureId, show_predictions)

Toggle Predictions option inside popup
Parameters:
Name Type Description
source_obj string Source of FeatureCollection
geojson_obj FeatureCollection FeatureCollection data object
currentFeatureId number Index of FeatureCollection data object
show_predictions boolean Value of show predictions option

View Source ui_interactions.js, line 305

# inner uncheckAllCheckboxOptions(checkboxes)

Uncheck All Checkbox Options
Parameters:
Name Type Description
checkboxes Array Checkboxes HMTL input type Array

View Source ui_interactions.js, line 494

# inner updateAnimationColorButtonsOnStart()

Update 'Start Animation' and 'Stop Animation' button colors on start

View Source ui_interactions.js, line 541

# inner updateAnimationColorButtonsOnStop()

Update 'Start Animation' and 'Stop Animation' button colors on stop

View Source ui_interactions.js, line 549

# inner updateAntennaConfigs(source_obj, geojson_antennas, geojson_antennas_directions, currentFeatureId)

Update Antenna Configs option inside popup
Parameters:
Name Type Description
source_obj string Source of FeatureCollection
geojson_antennas FeatureCollection Antennas FeatureCollection
geojson_antennas_directions FeatureCollection Antennas Directions FeatureCollection
currentFeatureId number Antenna feature index

View Source ui_interactions.js, line 682

# inner updateAssetPointConfigs(source_obj, geojson_assetpoints, geojson_assetpoints_directions, prev_large_lobe_angle_direction, prev_small_lobe_angle_direction, animation_item, currentFeatureId)

Update Asset Point Configs option inside popup
Parameters:
Name Type Description
source_obj string Source of FeatureCollection
geojson_assetpoints FeatureCollection Asset Points FeatureCollection
geojson_assetpoints_directions FeatureCollection Asset Points Directions FeatureCollection
prev_large_lobe_angle_direction number Previous value of large lobe angle direction of Asset Point
prev_small_lobe_angle_direction number Previous value of small lobe angle direction of Asset Point
animation_item number Asset Point Animation item index
currentFeatureId number Asset Point feature index

View Source ui_interactions.js, line 616

# inner updateConnectionButtonsColors()

Update connect and disconnect button colors on connect successfully

View Source ui_interactions.js, line 557

# inner updateContainerInnerHtml(container, message)

Attach a message to a container innerHTML
Parameters:
Name Type Description
container HTMLElement HTML element container
message string Text to print on container

View Source ui_interactions.js, line 476

# inner updateDisconnectionButtonsColors()

Update connect and disconnect button colors on disconnect successfully

View Source ui_interactions.js, line 567

# inner updateLinesOfSightCoordinates(geojson_asset_points, geojson_anchors, geojson_antennas, geojson_lines_of_sight) → {Array}

Update Lines Of Sight Coordinates
Parameters:
Name Type Description
geojson_asset_points FeatureCollection Asset Points FeatureCollection data
geojson_anchors FeatureCollection Anchors FeatureCollection data
geojson_antennas FeatureCollection Antennas FeatureCollection data
geojson_lines_of_sight FeatureCollection Lines of Sight FeatureCollection data

View Source ui_interactions.js, line 845

Lines Of Sight Array data
Array

# inner updateMqttParameters(mqtt_hostname, mqtt_port, reconnect_timeout, clientUsername, clientPassword, ssl_flag, messageToSend, mqttTopicToReceivePredictions, mqttTopicToReceiveCalculations, geojson_asset_points, geojson_antennas, geojson_anchors, geojson_precison_decimal_places, pulsing_dots_layers_IDs, pulsing_dots_layers_sources, selectedMapIndex, received_uuid) → {string}

Update Mqtt Variables and call MQTTConnect() function
Parameters:
Name Type Description
mqtt_hostname string MQTT hostname connection
mqtt_port string MQTT port connection
reconnect_timeout number MQTT reconnect Time Out value
clientUsername string MQTT client username connection
clientPassword string MQTT client password connection
ssl_flag boolean MQTT connection SSL flag
messageToSend string MQTT message to send to the broker
mqttTopicToReceivePredictions string MQTT Topic To Receive Predictions
mqttTopicToReceiveCalculations string MQTT Topic To Receive Calculations
geojson_asset_points FeatureCollection Asset Points FeatureCollection
geojson_antennas FeatureCollection Antennas FeatureCollection
geojson_anchors FeatureCollection Anchors FeatureCollection
geojson_precison_decimal_places number Vaule of precison decimal places
pulsing_dots_layers_IDs Array Pulsing Dots IDs Array
pulsing_dots_layers_sources Array Pulsing Dots sources Array
selectedMapIndex number index of selected Map
received_uuid string MQTT received session UUID

View Source ui_interactions.js, line 26

Connection string value and backend read rate value;
string

# inner updatePulsingDotPointsCoordinates(geojson_pulsing_dots_points, length_source, index_source) → {FeatureCollection}

Update Pulsing Dot Point Coordinates
Parameters:
Name Type Description
geojson_pulsing_dots_points FeatureCollection Pulsing Dot Points FeatureCollection
length_source number FeatureCollection size
index_source number Pulsing Dot Points FeatureCollection index

View Source ui_interactions.js, line 962

Pulsing Dot Points FeatureCollection Updated
FeatureCollection

# async inner updateRssiParametersColorButton()

Update Rssi Parameters button color

View Source ui_interactions.js, line 503

# inner updateRssiPathLossModelParameters(connectedFlag, geojson_asset_points, geojson_antennas, geojson_anchors, geojson_precison_decimal_places, backend_read_rate, selectedMapIndex, mqttTopicToPublish, messageToSend) → {JSON}

Update RSSI Path-Loss Model parameters
Parameters:
Name Type Description
connectedFlag boolean MQTT connection state flag
geojson_asset_points FeatureCollection Asset Points FeatureCollection
geojson_antennas FeatureCollection Antennas FeatureCollection
geojson_anchors FeatureCollection Anchors FeatureCollection
geojson_precison_decimal_places number Vaule of precison decimal places
backend_read_rate number Value of Backend read rate
selectedMapIndex number Index of selected Map
mqttTopicToPublish string MQTT Topic To Publish Messages
messageToSend string MQTT message to send to broker

View Source ui_interactions.js, line 212

RSSI parameters as JSON object
JSON

# inner updateSelectedColorButtonStartConnection()

Update Start Connection button color on selected ML agents

View Source ui_interactions.js, line 527

# inner updateSelectedColorButtonSubmitAgents()

Update button color on select ML agents

View Source ui_interactions.js, line 513

# inner updateSelectedMlAgents(connectedFlag, geojson_asset_points, geojson_antennas, geojson_anchors, geojson_precison_decimal_places, backend_read_rate, selectedMapIndex, mqttTopicToPublish, messageToSend) → {Array}

Update Selected ML Agent from Container
Parameters:
Name Type Description
connectedFlag boolean MQTT connection state flag
geojson_asset_points FeatureCollection Asset Points FeatureCollection
geojson_antennas FeatureCollection Antennas FeatureCollection
geojson_anchors FeatureCollection Anchors FeatureCollection
geojson_precison_decimal_places number Vaule of precison decimal places
backend_read_rate number Value of Backend read rate
selectedMapIndex number Index of selected Map
mqttTopicToPublish string MQTT Topic To Publish Messages
messageToSend string MQTT message to send to broker

View Source ui_interactions.js, line 128

Selected ML Agent Algorithm
Array

# inner updateUnselectedColorButtonStartConnection()

Update Start Connection button color on deselect ML agents

View Source ui_interactions.js, line 534

# inner updateUnselectedColorButtonSubmitAgents()

Update button color on unselect ML agents

View Source ui_interactions.js, line 520

# inner updateWallIntersectionPointsCoordinates(wall_intersections_points, geojson_lines_of_sight, geojson_walls) → {Array}

Update Wall Intersection Points Coordinates
Parameters:
Name Type Description
wall_intersections_points FeatureCollection Lines-of-Sight Walls Intersection Points Array
geojson_lines_of_sight FeatureCollection Lines-of-Sight FeatureCollection
geojson_walls FeatureCollection Map Features Walls FeatureCollection data

View Source ui_interactions.js, line 915

Lines-of-Sight Walls Intersection Points Array
Array