Objects
The following objects are used with the Map Widget.
circleConfiguration Object
Contains configuration keys for the circle. The configuration keys can be platform specific.
| Key | Type | Platform Availability | Description |
|---|---|---|---|
| lineColor | String | All | Specifies the color of the circle border line in the RBGA hex format. The default line color in RGBA is FF0000FF (red). For example, with 0xFF0000FF and FF0000FF, both formats are valid for red. Note: The RGBA format follows the standard RGBA format and is not the same as the RGBA color code generated by Volt MX Iris IDE for skins. Note: If the lineColor is not specified properly, the default behavior is selected. |
| fillColor | String | All | Specifies the color that the circle area is filled with in the RBGA hex format. The format could be 0xRGBA or RGBA. No fill color is applied by default. For example, with 0xFF0000FF and FF0000FF, both formats are valid for red. Note: The RGBA format follows the standard RGBA format and is not the same as the RGBA color code generated by Volt MX Iris IDE for skins. Note: If the fillColor is not specified properly, the default behavior is selected. |
| lineWidth | Number | All | Specifies the width of the polyline in screen independent pixels. The default line width is 3 dp. |
| lineDashPattern | Array | iOS | An array of numbers specifying the dash pattern to use for the path. |
circleData Object
Contains the location data of a circle.
Members
id
A string that defines a unique identifier for the circle. If a circle already exists with the same identifier string, the existing circle is replaced by the new circle.
centerLocation
An object that specifies the center location for the circle. This member takes the same keys as the locationData of a Map Widget. The center location of the circle is represented by a pin on the map.
radius
A number that specifies the radius of the circle in meters.
navigateandZoom
A Boolean value that indicates whether the Map Widget should navigate to the circle and zoom the map to fit the bounds of the circle. The default value is true.
Zooming a map to the bounds of a circle is not supported in Android. On Android, the Map Widget only navigates to the circle location and applies the current zoomLevel.
showCenterPin
A Boolean value that indicates whether to show the pin image for the circle’s center location. The default is true.
circleConfig
An object that contains configuration keys for a circle. The configuration keys can be platform specific. For more information, see circleConfiguration Object.
polygonData Object
Contains the information necessary to plot a polygon on a map.
Members
id
String. Defines a unique identifier for the polygon. If a polygon already exists with the same identifier string, the existing polygon is replaced by new polygon.
locations
Array. Specifies the list of all the locations as an array. Each location object accepts "lat" and "lon" keys, and other keys are ignored. The first and last location in the list are connected even if they are not same.
navigateandZoom
Boolean value to indicate whether the map should be navigated to the polygon area and zoom the map to fit the bounds of polygon. If the property is not specified, the default value “true” is assumed.
polygonConfig
Specifies an object with predefined configuration keys. The configuration keys can hold platform specific keys as well.
searchCriteria Object
A JSON object with a value defining either the source or the destination for the map.
Syntax
searchCriteria = {source: {lat:latitude, lon:longitude, address:address} };
searchCriteria = {destination: {lat:latitude, lon:longitude, address:address } };
Parameters
latitude
Specifying the latitude of the source or destination.
longitude
Specifying the longitude of the source or destination.
address
Optional. A string specifying the address of the source or destination.
Remarks
If the searchCriteria object defines a source, the name of the name/value pair is "source." If it defines a destination, the name of the name/value pair is "destination."
A searchCriteria object (a JSON object) is a single name/value pair specifying either the source or the destination. The name of this name/value pair is either "source" or "destination," respectively. In both cases, the value consists of the same two (optionally three) name/value pairs, as shown in the Parameters section.