Hide Table of Contents
esri/dijit/util
esri/process
esri/workers
Code Assist Plugins

Note: This page has been deprecated and may be removed in a future release.

The ArcGIS JavaScript API Code Assist Plug-in provides you a better programming experience with less typos and mistakes. By simply enabling the plug-in with the instruction below, you can easily get a list of suggested class and property names while coding, and useful tooltips when entering argument values for a function.

The Code Assist Plug-in features:

  • Auto-completion of source code
  • Summary of classes, constructors, properties, methods and globals
  • Parameter hints for constructors and methods

The code assist was created based on the Visual Studio JavaScript XML Intellisense syntax. Currently supported IDEs are:

  • Visual Studio - 2010, 2012
  • Aptana - 2

Note: these plug-ins do not yet support code that loads JS API modules using AMD due to the nature of how modules are aliased once loaded.

Visual Studio 2010 and 2012 Installation Instructions

To enable the Code Assist Plug-in in Visual Studio, simply follow the steps below:

  1. Download the zipped plug-in document from the Downloads list at the bottom of this page. Find a download link according to the IDE and the JavaScript API version you are using.
  2. Extract the .zip file you downloaded. You will get a jsapi_vsdoc_<version>.js file. This is the code assist document. Place this file in your coding project.
  3. When working in an HTML file, add a <script> tag that references to the code assist document.
          <script type="text/javascript" src="path_to_the_code_assist_document"></script>
        
  4. If working in a JavaScript file, add a reference directive to the code assist document:
          /// <reference path="path_to_the_code_assist_document" />
        
  5. Start type in class names in your IDE. Autocomplete and tooltips will be provided while you are coding.
For more information about JavaScript Intellisense, refer to Microsoft's JavaScript Intellisense MSDN article.

Note: Since Intellisense does not support multiple constructors in Visual Studio 2010 and earlier, the VS2010 version of the code assist plug-in only prompts one constructor even though there are actually more than one (such as the case of esri.geometry.Point). If possible, use Visual Studio 2012 to optimize your coding experience.

Aptana 2 Installation Instructions

  1. Download the zipped plug-in document from the Downloads list at the bottom of this page. Find a download link according to the IDE and the JavaScript API version you are using.
  2. Extract the .zip file you downloaded. You will get a jsapi_vsdoc_<version>.js file. This is the code assist document.
  3. Drag the code assist document into your Aptana project.

Downloads