Note: 

  • All code samples below refer to the skuid object.

  • In the v2 API, this object is not directly accessible when working within a browser console—or when referring to another Nintex Apps page runtime.

  • If you are experiencing issues, use the skuid.runtime API to target the appropriate page context.

skuid.formula

Classes

skuid.formula.Formula(formulaName, formulaFunction, options)

This is used for constructing formula objects. Once a formula object has been constructed, its formula can be used within any formula field in the App Page Designer.

new skuid.formula.FormulaFunction(/**/);

The formula function can then be used declaratively within any formula field in the Page Designer by prepending the namespace option value (followed by two underscores ) to the localName option value like so:

Arguments:
  • formulaName ( string ) -- The name of the formula
  • formulaFunction ( function ) -- The function that is executed by the formula.
  • options ( object ) --

    A JavaScript object with the following properties:

    • namespace ( string ) - A namespace prefix, placed before the formulaName to ensure that two formulas with the same name do not overwrite one another. Defaults to c.

      Note:  When being called from the App Page Designer, the namespace is always followed by two underscores.

    • numArgs ( number ) - The number of arguments expected by your formula function. Defaults to 1.
    • returnType ( string ) - The type of value your function is expected to return; valid options are "boolean", "number", "string", or "date"

Formulas can be declaratively accessed in the App Page Designer by prepending the namespace (followed by two underscores ) to the formulaName like so:

nameSpace__formulaName(arg1, ... argN)

For example, to use this custom formula:

Copy 
skuid.formula.Formula (
  'APPEND_TEXT',
  function (fieldName, appendString) {
    return fieldName + ' ' + appendString;
  },{
    namespace: 'textManipulation',
    numArgs : 2,
    returnType : 'string'
  }
);

Enter textManipulation__APPEND_TEXT('text1', 'text2') in a formula field within the Page Designer.

If the namespace option were not specified, then c__APPEND_TEXT('text1', 'text2') would be used instead.