Skip To ContentArcGIS for DevelopersSign In Dashboard

Which version of the ArcGIS API for JavaScript should I use now? 3.32 or 4.15?

See the Choose a version topic for more information.

I have an app built with the 3.x version of the ArcGIS API for JavaScript and I want to take advantage of some of the features in version 4. What is the best process to migrate to 4.x?

There have been significant changes to the object model in order to enable higher productivity and effectiveness. Due to these major changes in the API, the cleanest approach is to re-write apps from scratch when building with the 4.x API. For more information, see Migrating from 3.x to 4.15.

Does current version of 4.x have all of the features of 3.x?

No, not yet. We are working hard to build a full-featured API that will not only meet but exceed 3.x capabilities. See Choose a version for more information, or review the 4.15 API reference.

When will the ArcGIS API 4.x for JavaScript have full editing support?

The 4.x API supports the ability to edit feature data using the Editor widget as of version 4.11. Additional editing and drawing support will be released in a phased approach. This includes more sophisticated sketching capabilities, attachment editing, and editing related records. Full editing support is planned for 2020.

How do I know what is comparable from 3.x to 4.x?

See the 3x to 4x functionality matrix topic for more information.

Can I use the ArcGIS API for JavaScript with other JavaScript frameworks (e.g., React, Angular)?

Yes, there are a variety of github projects, libraries and samples that offer examples for integrating the ArcGIS API for JavaScript with popular third-party frameworks such as React, Angular, Vue and Ember. You can read more about it in the Using Frameworks topic.

If you are using a framework that works well with the Webpack module bundler, the ArcGIS Webpack Plugin is now available. This will be of interest for developers who want to bring the ArcGIS API for JavaScript modules into their build process.

How do I access features from my feature layer with mouse clicks?

Use either the MapView.hitTest or SceneView.hitTest methods to search for graphics that intersect the specified screen coordinates. See the Access features with click events for a sample on how this works.

What is the planned release schedule for future 4.x releases?

We release four times a year. Version 4.16 is planned for summer 2020, and version 4.17 is planned for fall 2020.

How are breaking changes managed with the ArcGIS API for JavaScript?

Before upgrading to a newer version of the API we recommend thoroughly reviewing the breaking changes section of all release notes that apply since your last update. Here are our general guidelines for introducing breaking changes:

  • Major breaking changes are phased in over three or more releases. An example of this was the switch to WebGL-only rendering. The first release offers the functionality as opt-in. In the second release the functionality is on by default with an opt-out option. Then after the third release the functionality is removed.
  • Minor breaking changes, such as a property that was renamed, is phased in over two or more releases. The first release provides a console message and documentation update. After two or more releases the functionality is removed.

While we follow these guidelines as much as possible, there are infrequent circumstances when we will introduce changes without prior notice. For example, breaking changes related to browser security updates. Another example could be changes required in order to introduce a new feature: in this scenario we will weigh delaying the release of the feature against the downside of introducing a breaking change without notice.

What does the beta tag mean for capabilities specific to ArcGIS API for JavaScript?

Production releases of the ArcGIS API for JavaScript sometimes have one or more capabilities that are released with a beta label. If you try out a feature in beta and it meets your app's requirements, you can use it in your app. Here is what the beta label means:

  • We are interested in gathering feedback with respect to ease of use of the API and whether the functionality adequately meets developer use-cases.
  • In some cases, aspects of the capability haven't been implemented yet, for example it might not support all layer types yet. In those cases, limitations will be noted in the API reference.
  • Beta functionality is tested but still provisional. API, behavior and end-user experience might change based on feedback or an improved design.
  • Configuration for some beta capabilities may not be saved to web maps and web scenes.
  • If you later decide to upgrade your application to a new API version, there might be code changes required in order for the capability to continue to work properly (due to # 3 above).
  • Esri's standard policies for beta software can be found at https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-translations/english.pdf.

What is the best way to come up to speed on building 3D web apps?

See the Getting Started with 3D in the ArcGIS API for JavaScript Developer Summit talk that discusses some things to take into consideration when working with 3D scenes.

Does 3D run on the browser on my phone?

Yes. Performance has been enhanced in the ArcGIS API for JavaScript to enable 3D scenes in the browser on your phone without a plugin. All your end users need is a URL to your app and they can interact with your data in 3D. Check out this blog for an interesting example of 3D web mapping on mobile devices. See Hardware requirements for 3D for more information on supported devices.

I have an app built on 3.x. What is the roadmap for 3.x and how long will technical support be available?

Version 4.x is our primary focus for development. We will continue to release version 3.x with very minor updates until Q3 2020 at the earliest. 3.x technical support will be available until August 1, 2022. The 3.x versions of the API will be hosted on Esri's CDN for the foreseeable future, therefore apps that are built on 3.x versions of the API will continue to work beyond the support period. See the Product Life Cycle document for more information regarding 3.x releases and the support plan going forward.

Which versions of ArcGIS Enterprise does 4.x work with?

The ArcGIS API for JavaScript 4.x works with supported versions of ArcGIS Enterprise - see Product Life Cycle document. Note that for example, ArcGIS 10.2.2 was retired on July 1, 2019. Non-supported versions might still work to different degrees, but are not being tested (or supported) with the API.

Am I allowed to modify the ArcGIS API for JavaScript?

No. The code for the ArcGIS API for JavaScript cannot be modified.

Content