Skip to content

UIParam Map

SmartJSONEditor edited this page Aug 30, 2017 · 4 revisions

Map UI Parameter

Map parameter returns and object of location coordinate.

this.parameters = function () {
	
    var mapDefaultValues = {
        latitude: 8.0,
        longitude: 11.0,
        latitudeDelta: 0.0,
        longitudeDelta: 0.0,
        mapType: 0 // 0 = map, 1 = satellite, 2 = hybrid
    }
	
    var mapUIParameter = { 
        name: "myMapParam",
	type: "Map", 
	displayName: "Map Parameter",
	description: "Navigate to select center coordinate", 
	defaultValue: mapDefaultValues
    };

    return [mapUIParameter];
}
    
this.environments = function (parameters, info) {

    // Returns { latitude: 0.0, longitude: 0.0, latitudeDelta: 0.0, longitudeDelta: 0.0, mapType: 0 } object
    var latitude = parameters.myMapParam.latitude;
    var longitude = parameters.myMapParam.longitude;
    var latitudeDelta = parameters.myMapParam.latitudeDelta;
    var longitudeDelta = parameters.myMapParam.longitudeDelta;
    var mapType = parameters.myMapParam.mapType;
};

All UI parameters are Javascript Objects.

name (*Required)

Name property identifies the parameter name and also returns the value in functions that receives the parameters input. Access the value using the parameters.name property.

type (*Required)

Map, set the type as "Map"

displayName

Interface display name.

description

Interface detail text

defaultValue

Javascript Object with pre defined values.

Clone this wiki locally