The Script Editor

The script editor is available in the "Fill-in Form" tab of Template Builder.

It can be used docked or undocked from the Template Builder. While undocked, you can adjust the size of the window for a smoother experience.

There is a search option to search within the script code, and you can access it by clicking the icon within the script editor.

The script editor also provides error messages depending on the problem. It will show compile or run time errors.

Compile Error

Runtime Error

When trying to catch a runtime error, it is recommend that you name a function with a string value. By naming a function, this name is used in the error message to indicate where the error came from.

In the following example, if you catch an error, the string used under "user defined name" is shown in the error message:

In this case, you can just add the string value in your function error report so it shows in the error message:

Initialization

There are two global events that can be used to initialize the Fill-in Form:

• onCreate: Called when template is opened in Viz Pilot Edge.

  Note: This event is not triggered when creating a new data-element from an existing one.

  Example:

  vizrt.onCreate = () => {

  // For example set startup values, initialize fields visibility, etc.

  Initialize()

  }

• onLoad: Called when an existing data-element is loaded in Viz Pilot Edge. The normal steps are to initiate/refresh data each time you open a data-element.

  Note: This event can potentially modify the data-element when opening, which means it must be saved before being draggable/sendable to a NRCS.

  Example:

  vizrt.onLoad = () => {

  // For example reset or refresh values, etc.

  ResetForm()

  }

Field Access

When using the scripting tool in the template, the individual fields must be accessed through the global name space vizrt.fields (for example, vizrt.fields.$singleline.value).

The script executes when a graphic element is opened or created with the scripted template in Viz Pilot Edge.

In Template Builder, the script is also re-loaded and restarted when there are changes made to it.

By typing vizrt.fields, the editor's autocomplete will show you the available fields to choose from.

You can read and write field values, as well as react to value changes from outside the script.

You can also access the properties error, hidden, readOnly, and tip of the vizrt fields.

• onChanged: A property on fields that you can set as a function, and if you do so, this function is called whenever the value of the fields changes, and gets the new value as an argument . If this is not set, it is null.
  

  Note: Changes done to field values by the template script will not trigger the onChanged function to be called.

• readOnly: Read and write boolean access, to whether the field should be editable in the form or not. If false , the field and its input elements are editable in the UI. If true , they are read-only and greyed out in the UI, but are accessible, saved and loaded as part of the payload.

• hidden: Read and write boolean access, to whether the field should be editable in the form or not. If false , the field and its input elements are present and visible in the UI. If true , they are hidden from the UI but are accessible, saved and loaded as part of the payload.

• error: Read and write string access, to an error to display for this field. It overrides other error messages associated with the field when non-empty (e.g. errors due to input length or regex constraints specified in the field definition).

• tip: Read and write string access, to a tip to use for this field. It overrides the tip specified in the field definition when non-empty.

Typescript lets you access fields using known names (for example, vizrt.fields["$field_2"]), but does not allow expressing the field names using variables (for example, vizrt.fields["$field_" + num]), as it is unable to determine whether the field name is valid and what type the field is. To overcome this, the type checking associated with vizrt.fields can be locally ignored by using the any type. You may do so inline using for example (vizrt.fields as any)["$field_" + num], or storing it as a new variable, as shown in the example below.