Ego Form

Purpose

A paginated form that assigns values to ego.

Behaviors

The specified form can be used to assigns form values to the ego in the current network. Any validation errors must be resolved before the interface can advance. Changes to the form are saved upon navigating to the next or previous stage.

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 should specify entity ego.	This parameter tells Network Canvas which form should be shown for ego.
introductionPanel Required	Object specifying the introductory information before the form is shown.	Used to provide instruction for the upcoming form.
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": "ego-form-1",
      "type": "EgoForm",
      "label": "Ego Form",
      "form": "egoForm1",
      "introductionPanel": {
        "title": "Introduction to the ego form",
        "text": "There are multiple ways to describe **you**."
      }
},