Class arel.Object

Class Detail

Method Detail

• {string} getIcon()
  Get Object icon path for the image as being displayed in the MapView (location-based Scenes only).

  Returns:

  {string} path where to retrieve the map icon from
• {string} getID()
  Get Object ID.

  Returns:

  {string} ID of the Object
• {arel.LLA} getLocation()
  Get Object Location information (location-based Scenes only).

  Returns:

  {arel.LLA} coordination of the Object as latitude, longitude, altitude
• {int} getMaxDistance()
  Get the maximum distance to the Object to display it (location-based Scenes only).

  Returns:

  {int} maxdistance Value in m
• {int} getMinAccuracy()
  Get the minimum accuracy of the sensors to display the Object (location-based Scenes only).

  Returns:

  {int} Value in m (will be 1 for displaying an Object only if a LLA Marker is scanned)
• {int} getMinDistance()
  Get the maximum distance to the Object to display it (location-based Scenes only).

  Returns:

  {int} mindistance Value in m
• {String} getParameter(key)
  Get a certain parameter for the object

  Parameters:

  {String} key

  the value belonging to the key

  Returns:

  {String} value
• {Object} getParameters()
  Get all parameters for the object

  Returns:

  {Object} object with KEY => VALUE
• {arel.Popup} getPopup()
  Get Object Popup information.

  Returns:

  {arel.Popup} information for the Object information box
• {string} getState()
  Get the state of the model (arel.Config.OBJECT_STATE_LOADING | arel.config.OBJECT_STATE_READY)

  Returns:

  {string} state the model is in - loading or ready
• {string} getThumbnail()
  Get Object thumbnail path for the image as being displayed in the ListView (location-based Scenes only).

  Returns:

  {string} path where to retrieve the list thumb from
• getTitle(Title)
  Get Object Title.

  Parameters:

  {string} Title

  of the Object
• {object} getVisibility()
  use this method to determine whether an object is visible or not in liveview/maplist/radar

  Returns:

  {object} object which fields are liveview, maplist and radar and each contains a bolean which specifies if it is visible or not
• isRendered(_callback, caller)
  Check if this Object is currently in the view of the user. Only if the Object is rendered, it can be considered to be in the current field of view.

  Parameters:

  {function} _callback

  a callback function receiving the value as Boolean value

  {Object} caller

  the object this shall be referenced to in the callback function -> optional
• setIcon(iconPath)
  Set Object icon path for the image as being displayed in the MapView (location-based Scenes only).

  Parameters:

  {string} iconPath

  path where to retrieve the map icon from
• setID(objectID)
  Set Object ID.

  Parameters:

  {string} objectID

  alphanummeric string defining the Object ID.
• setLocation(location)
  Set Object Location information (location-based Scenes only).

  Parameters:

  {arel.LLA} location

  coordination of the Object as latitude, longitude, altitude
• setMaxDistance(maxdistance)
  Set the maximum distance to the Object to display it (location-based Scenes only).

  Parameters:

  {int} maxdistance

  Value in m
• setMinAccuracy(minaccuracy)
  Set the minimum accuracy of the sensors to display the Object (location-based Scenes only).

  Parameters:

  {int} minaccuracy

  Value in m (set 1 for displaying an Object only if a LLA Marker is scanned)
• setMinDistance(_mindistance)
  Set the maximum distance to the Object to display it (location-based Scenes only).

  Parameters:

  {int} _mindistance

  mindistance Value in m
• {Boolean | String} setParameter(key, value, override)
  Use this method to set a specific parameter for an object

  Parameters:

  {String} key

  the value belonging to the key

  {String} value

  to be set

  {Boolean} override

  true if overriding a parameter is allowed, false otherwise. default: false

  Returns:

  {Boolean | String} returns false, if the parameter already exists and override is set to false
• setParameters(_parameters)
  Use this method to set parameters for an object

  Parameters:

  {Object} _parameters

  parameters of an object e.g. {"test" : 1, "url": "www.junaio.com"}
• setPopup(popup)
  Set Object Popup information.

  Parameters:

  {arel.Popup} popup

  information for the Object information box
• setThumbnail(thumbnailPath)
  Set Object thumbnail path for the image as being displayed in the ListView (location-based Scenes only).

  Parameters:

  {string} thumbnailPath

  path where to retrieve the list thumb from
• setTitle(title)
  Set Object Title.

  Parameters:

  {string} title

  Title of the Object
• setVisibility(_liveview, _maplist, _radar)
  Set the visibility for an Object for MapView, ListView, LiveView and Radar. For GLUE, only LiveView is supported.

  Parameters:

  {boolean} _liveview

  set true if the Object should be shown in Live View, false if hidden, undefined is unchanged

  {boolean} _maplist

  set true if the Object should be shown on the Map and in the List, false if hidden, undefined is unchanged

  {boolean} _radar

  set true if the Object should be shown on the radar, false if hidden, undefined is unchanged