Popup UI Parameter

Popup parameter allows to save and return any Javascript Object values.

this.parameters = function () {

    var defaultValue = [
        { displayName: "Value1", value:0 },
        { displayName: "Value2", value:"Hello" },
        { displayName: "Value3", value: {name:"Test", id:12} },
        { displayName: "Value4", value: [0,1,2,3,4] }
    ]
	
    var popupUIParameter = { 
        name: "myPopupParam",
	type: "Popup", 
	displayName: "Popup Parameter",
	description: "Select from pre defined values", 
	defaultValue: defaultValue
    };

    return [popupUIParameter];
}
    
this.environments = function (parameters, info) {
    // Popup parameter returns selected item value. If not user selected yet, returns item[0] by default.
    var popupParameterValue = parameters.myPopupParam; // String, Number, Array or Object value
    DocumentModel.log(popupParameterValue);
};

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)

Popup, set the type as "Popup"

displayName

Interface display name.

description

Interface detail text

defaultValue

Array of objects with defined structure: [ { displayName: "DisplayName", value: "Any Javascript Object Value" } ...]