Survey123WebForm

constructor

Create a Survey123Webform instance.

For example:

1
2
3
4
5
var webform = new Survey123WebForm({
   clientId: "ABC1234567890",
   container: "formDiv",
   itemId: "129132bbedcb490488a162aa996b12323"
}

options

copyFeature

clone a feature from the related feature service of a survey the globalId of feature is required

getContainer

Get Container.

getForm

Get survey form. Only available after onFormLoaded().

getItemId

Get item id.

getOptions

Get options.

getQuestions

Get questions in JSON format.

setCredential

Set credential.

setGeometry

Dynamically set geometry on Map question. Only works if there is Map question in the survey. Supported formats are either GeoJSON, Esri Geometry Object, or XLSForm Geotrace/Geoshape format.

setGeopoint

Dynamically set coordinates on Geopoint question. Only works if there is Geopoint question in the survey.

setItemId

Set item id. IFrame will be reloaded.

setMode

Sets the mode of the web form. Valid values are

• edit, which sets the survey to edit an existing entry rather than create one, and
• view, which opens an existing entry in read-only mode, and
• copy, which will create a new web form that is populated with the contents from an existing entry.

When setting the mode, the globalId parameter (version ≥ 3.9) or objectId(version ≤ 3.9) parameter must also be provided.

For example:

1
2
3
4
webform.setMode({
       mode: 'view',
       globalId: '<globalId>'
    })

setOnFormFailed

Set OnFormResized event.

setOnFormLoaded

Set OnFormLoaded event.

setOnFormResized

Set OnFormResized event.

setOnFormSubmitter

Set OnFormSubmitter event.

setOnQuestionValueChanged

Set OnQuestionValueChanged event.

setQuestionValue

Dynamically set value on each question.

setStyle

Set CSS style.

setTheme

Set form theme.