Skip to main content

Map objects

SitePoint​

This object describes a geocoded site

  • id : site Id
  • longitude : longitude in decimal degrees
  • latitude : latitude in decimal degrees
Example of SitePoint
{
    "id": "25AB0A30-F7B2-446A-898A-51D81EC8DC2C",
    "longitude": -0.561684354178071,
    "latitude": 47.4624963439028
}

WebviewPOI​

This object describes a POI on the map

  • id : POI Id
  • pos : ARPos
  • icon : name or URL to a drawable file (PNG, JPG, etc.)
  • isSelectable : is set to true, the POI can be selected on the map (default=false)
  • isDragAndDropable : is set to true, the POI can be dragged on the map (default=false)
  • hasRollover : is set to true, the map will display a message when the mouse is over it (default=false)
  • displayOptions : ARDisplayOptions for normal display
  • currentEntityDisplayOptions : ARDisplayOptions when the POI is the current one
  • selectedDisplayOptions : ARDisplayOptions when the POI is selected
  • label : label displayed under the icon
  • tooltip : ARTooltip Tooltip to display when the mouse is over
  • vectorLayer : not documented
Example of WebviewPOI
Example of a POI with displayOptions
{
    "id": "77C43D9D-9F76-4562-8AA2-2AB64C804393",
    "pos": {
        "lonLat": [
            -0.56167604902276,
            47.462473288384
        ]
    },
    "icon": "pin_yellow_syd.png",
    "isSelectable": false,
    "isDragAndDropable": false,
    "hasRollover": false,
    "displayOptions": {
        "width": 18,
        "height": 24,
        "anchor": [
            0,
            1
        ]
    },
    "label": "10 Rue Fulton 49000 Angers"
}

Possible values for icons​

Some icons can be directly used without URL :

SizeAnchorImageName
18x24[0,1]pin_blue_sydpin_blue_syd.png
pin_green_sydpin_green_syd.png
pin_grey_sydpin_grey_syd.png
pin_orange_sydpin_orange_syd.png
pin_red_sydpin_red_syd.png
pin_yellow_sydpin_yellow_syd.png
24x24[0.5,0.5]bullet_ball_bluebullet_ball_blue.png
bullet_ball_greenbullet_ball_green.png
bullet_ball_greybullet_ball_grey.png
bullet_ball_yellowbullet_ball_yellow.png
bullet_square_bluebullet_square_blue.png
bullet_square_greenbullet_square_green.png
bullet_square_greybullet_square_grey.png
bullet_square_yellowbullet_square_yellow.png
26x32[0.5,1]flag_checkered_sydflag_checkered_syd.png
48x48[0.5,0.5]map_pointermap_pointer.png

ARPos​

This object descibe a longitude and a latitude (decimal degrees)

Example of Pos
{
    "lonLat": [
        -0.561684354178071,
        47.4624963439028
    ]
}

ARCoordinates​

List of 2 numbers :

  • the 1st one is the longitude
  • the 2nd one is the latitude
Example of Coordinates
[
    -0.561684354178071,
    47.4624963439028
]

ARBaseEntityRef​

This abstract object describes an entity.

It must have a field entityType and can represent :

ItineraryEntityRef​

This object describes a route

  • entityType : ITINERARY
  • routeId : route Id
Example of Itinerary Ref
{
    "entityType": "ITINERARY",
    "routeId": "000ZYX1DH01"
}

ActivityEntityRef​

This object describes an activity on a route

  • entityType : ACTIVITY
  • routeId : route Id
  • index : position on the array of activities on the route (starting at 1)
Example of Activity Ref
{
    "entityType": "ACTIVITY",
    "routeId": "000ZYX1DH01",
    "index": 12
}

OperationEntityRef​

This object describes an operation

  • entityType : OPERATION
  • orderId : operation Id
  • idxSplit : split index (if exists)
Example of Operation Ref
{
    "entityType": "OPERATION",
    "orderId": "OPERATION_06",
    "idxSplit": 0
}

SiteEntityRef​

This object describes a site

  • entityType : SITE
  • id : site Id
Example of Site Ref
{
    "entityType": "SITE",
    "id": "MOULINS"
}

Tools objects​

ARDisplayOptions​

This object describes how the object will be displayed

  • img : not documented
  • color : ARFeatureColor overrided color of the initial object
  • width : with in pixel
  • height : height in pixel
  • offsetX : offset in pixel for X (longitude) display
  • offsetY : offset in pixel for Y (latitude) display
  • anchor : ARAnchor
Example of Display Options
{
	"color": [
		0,
		125,
		255,
		0.7
	],
    "width": 18,
    "height": 24,
    "anchor": [
        0,
        1
    ]
}

ARFeatureColor​

list of 4 numbers (RGB + opacity)

  • value for Red color (0 to 255)
  • value for Green color (0 to 255)
  • value for Blue color (0 to 255)
  • opacity : from 0 (transparent) to 1 (opaque)
Example of Feature Color
[
    0,
    125,
    255,
    0.7
]

ARAnchor​

list of 2 numbers (alignment on longitude and latitude)

  • value for X (longitude) alignment : from 0 (left) to 1 (right); 0.5 = center
  • value for Y (latitude) alignment : from 0 (top) to 1 (bottom); 0.5 = center
Example of Anchor: Left + Bottom
[
    0,
    1
]

ARTooltip​

Object for displaying a tooltip on the map when the mouse is over

  • title : Tooltip title
  • body : Body content

These strings can contain HTML code