Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 3.64 KB

README.md

File metadata and controls

70 lines (51 loc) · 3.64 KB
Raw

JavaScript Functions for Survey123

With newer releases of Survey123 you are allowed to extend the function of a question by including a JavaScript file in the extension for the survey. This provided the survey the ability to leverage additional logic to calculate the value of a question. This function came with some limitations on how much JavaScript could be included in the question. This library allows the user to bring in WebPacked JS functions and additional libraries to extend that even further.

Getting Started

Clone this repository to any location on your machine. Once downloaded run npm install in the directory to install the needed node modules. The JavaScript functions for Survey123 will get installed in the Extensions directory for the Survey.
---ADD IMAGE HERE---

Developing with the Extensions

Most mode modules can be included in the WebPack for the Javascript libraries. Simply develop the functions in JavaScript as you would any other JS functions.

Run npm build to create the packed version of your extension that can be included in the Extensions directory of your Survey.

This library contains the JavaScript functions used by Survey123 in addtion to polyfills needed to support more advanced functions. This are included in the survey123\lib.js library.

The functions you create will all be in the index.js file. Each function here can be linked to a question including the ability to output console.log statements to a console question.

Including the Extension in your Survey

Once you have developed you library and are ready to include in your Survey. Make sure to include in the extension directory. You can create a symbolic link from the webpack out file into the Surveys extension directory.

To call the function from within the survey you call use a calculation on a field to get data.
pulldata("@javascript", "<Name of the Extension file>.js", "<Name of the Extension file>.<name of the function>",<parameters comma seperated list>)

pulldata("@javascript", "MyLibrary.js", "MyLibrary.reprojectPoint",${x}, ${y}) MyLibrary.js is the resulting javascript file stored in the extensions directory MyLibrary.reprojectPoint this will call the reprojectPoint function inside the index.js file ${x}, ${y} these are parameters that are passed into the function

export function reprojectPoint(x, y) {
  try{
    if(isNaN(x) || isNaN(y)){
      return "Please provide numbers for x or y"
    }

    if(!isFinite(x) || !isFinite(y))
    {
      return "Please provide finite numbers for x or y"
    }

    //https://spatialreference.org/ref/epsg/indian-1960-utm-zone-48n/proj4/
    var projectTo = "+proj=utm +zone=48 +a=6377276.345 +b=6356075.41314024 +units=m +no_defs";
    return proj4(projectTo,[x,y]);
  }catch{
    return ""
  }
}

Samples

Please visit the Wiki page for Sample on how to use the functions inside Survey123

License

Copyright © 2017-2021 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.