Per alter Form

Purpose

A paginated form that assigns values on a per-alter basis.

Behaviors

The specified form can be used to assigns form values to each applicable alter in the current network. A node and the form are shown one at a time until all nodes have been viewed. Any validation errors must be resolved before the node can advance. Changes to the form are saved upon navigating to the next or previous node.

General Interface API

See General Interface API.

Interface Specific API

In addition to all properties specified in the general interface API, this interface has the following parameters:

Property	Possible Values	Purpose
form Required	A string matching a key in the protocol's forms object. The form specifies node type.	This parameter tells Network Canvas which form should be shown for each applicable node in the network.
introductionPanel Required	Object specifying the introductory information before the form is shown.	Used to provide instruction for the upcoming forms.
introductionPanel.title Required	A string of text	This string is displayed as large text at the top of the interface content.
introductionPanel.text Required	A string of text	This string contains the main body of text and can include markdown.

Example usage

{
      "id": "alter-form-1",
      "type": "AlterForm",
      "label": "Alter Form",
      "form": "myAlterFormID",
      "introductionPanel": {
          "title": "Introduction to the alter form",
          "text": "This is some **markdown** that \n* explains this interface and \n* is *marked down*. \n\nBelow this might be as much additional text as the researcher desires. The container that this content is in should dynamically expand to accommodate that."
      }
},