Skip to content

DocumentModel

SmartJSONEditor edited this page Apr 12, 2018 · 32 revisions

DocumentModel Class

DocumentModel class represents a global application context accessed as "DocumentModel" global variable in script context. DocumentModel let you use Swift JSON Editor application internal helper functions to

  • Retrieve Project Nodes
  • Use helper functions for encoding, logging, timestamp etc.

Logging Functions

Function Parameters Returns Description
log(Object) Javascript/String/Number String description Use to print log information about provided objects, prints to console.
error(String) String String description Will popup actively console window immediately and display error message. Use for critical errors as user will be notified immediatelly.

Value Transformer Parameter Handling

| Function | Parameters | Returns | Description | | getUserParameterValue(parameterName) | String UI Parameter name | user set parameter value of value transformer as String, Number, Array, Object | Use to retrive user set value for Value Transformer parameter | | setUserParameterValue(parameterName, value) | String, Any | sets value for user parameter | Use to modify or store additional values within Value Transformer |

Value Transformers Helper functions

Function Parameters Returns Description
randomValueDatabase(key) String String Use to get random value from database. Possible keys are: maleNames,femaleNames,surname,country,countryCode,USState,USStateCode,currencyName,currencyCode,color,loremIpsum
base64Encode(string) String String Encode string using Base64 algorithm
unixTimestamp() None Double Returns the definition of swift Date() timestamp from 1970
dateTimeString(format,double) String,Double String use to convert timestamp double value with DateFormatter format

Examples

this.transform = function (inputValue, jsonValue, arrayIndex, parameters, info) {
    var value = DocumentModel.randomValueDatabase("country");
    DocumentModel.log(value);
    return value
}

Clone this wiki locally