UIParam Number

Number UI Parameter

Number parameter allows to save and return numeric values.

this.parameters = function () {
		
    var numberUIParameter = { 
        name: "myNumberParam",
	type: "Number", 
	displayName: "Number Parameter",
	description: "Input any numeric value here.", 
	defaultValue: 34
    };

    return [numberUIParameter];
}
    
this.environments = function (parameters, info) {
    var numberParameterValue = parameters.myNumberParam; // Numeric value
    DocumentModel.log(numberParameterValue);
};

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)

Number, set the type as "Number"

displayName

Interface display name.

description

Interface detail text

defaultValue

Input any Numeric value as a default value.

Numeric values in JSON notation do not use "" { defaultValue: 34 }