ArcGIS API 3.x for JavaScript was retired on July 1, 2024.

Fifteen years ago, Esri released the first version of the ArcGIS API for JavaScript, which developers have been using to build powerful web mapping applications throughout dozens of industries, across the globe. The API’s original code base was not only used by the developer community, but also powered the web mapping experience in ArcGIS Online, ArcGIS Enterprise, and web mapping applications available with ArcGIS. In 2016, we introduced a more powerful, performant, and modern 2D/3D API with a completely new code base – version 4.x (now called ArcGIS Maps SDK for JavaScript or simply, JavaScript Maps SDK). Initially, the development team split their efforts between continuing to enhance 3.x, meanwhile progressing JavaScript Maps SDK with redesigned, modernized capabilities. Over time, we drastically reduced our focus on 3.x and eventually all new innovation was introduced in JavaScript Maps SDK, with only minor updates and critical bug fixes released with version 3.x. Over the last few years, we have been encouraging developers to build all new apps using the JavaScript Maps SDK and consider migrating 3.x-based apps.

FAQ

What happens when ArcGIS API 3.x for JavaScript is retired?

Once version 3.x is retired, there will be no further bug fixes or enhancements to the API and hence no further 3.x API deployments to js.arcgis.com. In addition, technical support will no longer be available. Please refer to the Product Lifecycle Support Policy.

What are the risks of using ArcGIS API 3.x for JavaScript after retirement?

After retirement, the 3.x API will remain hosted on our CDN for a multi-year grace period so that apps that have already been deployed which have a dependency on the API will not break. However, browser updates may introduce new issues to apps running on the 3.x API, resulting in performance issues, feature malfunction, or even crashing applications. After retirement, there will be no further bug fixes, patches, and enhancement to the API, and technical support will also no longer be available, per the Product Lifecycle Support Policy.

Therefore, even though your apps may still work after the retirement, we strongly encourage developers to migrate to the version 4.x –  ArcGIS Maps SDK for JavaScript – to mitigate risks and enjoy the outstanding performance and all the new features of a modern JavaScript mapping library.

What action should I take to mitigate the impact of this product retirement? 

Custom web apps should be migrated and, in most cases, rewritten to use the JavaScript Maps SDK as soon as possible. This way, apps will benefit from superior performance, capabilities, and other aspects that are based on modern browser technology. Also, because it is our active code base, we will address issues found in the API and introduced by browser updates.

Esri highly encourages that apps created using Esri’s configurable apps and builders that are based on 3.x should be migrated to options that are based on the ArcGIS Maps SDK for JavaScript, if possible. For example, when possible, apps built on ArcGIS Web AppBuilder and ArcGIS Configurable Apps can move to ArcGIS Experience Builder and/or ArcGIS Instant Apps.

When will ArcGIS Web AppBuilder retire?

There are three editions of ArcGIS Web AppBuilder.

• Web AppBuilder Developer edition retires in July 2024, in alignment with the 3.x API.
• Web AppBuilder in ArcGIS Online will retire in Q1 2026.
• Web AppBuilder in ArcGIS Enterprise is considered deprecated as of this announcement. Web AppBuilder will continue to be a part of Enterprise until the first half of 2025, at which point it will be retired and no longer released in new versions of Enterprise. Existing versions of Enterprise will continue to be supported in accordance with the ArcGIS Enterprise product lifecycle. 

Please review this blog for more information on Web AppBuilder retirement.

When will Map Viewer Classic and ArcGIS Configurable Apps retire?

Map Viewer Classic, and ArcGIS Configurable Apps product life cycles are being managed separately. There are no changes to the product lifecycle stages for these components at this time.

What’s happening with JavaScript API 3.x in ArcGIS Enterprise?

With the upcoming release of ArcGIS Enterprise 12.0, version 3.x of ArcGIS API for JavaScript will no longer be included for applications to reference within ArcGIS Enterprise. Custom applications that reference version 3.x of the ArcGIS API for JavaScript which was shipped with previous ArcGIS Enterprise versions will be impacted and will stop functioning after upgrading to ArcGIS Enterprise 12.0 or later. Given that version 3.x of ArcGIS API for JavaScript officially retired on July 1, 2024, we strongly recommend developers to migrate their applications to ArcGIS Maps SDK for JavaScript. Please review this blog for more information on building with ArcGIS Enterprise 12.0.

Migrating to ArcGIS Maps SDK for JavaScript

Explore JavaScript Maps SDK

The JavaScript Maps SDK is powered by WebGL and vastly out-performs the legacy 3.x API. Its portfolio of capabilities is unparalleled with any other web mapping API available, including the 3.x API. To explore some of the capabilities that are only in the JavaScript Maps SDK, see this JavaScript Maps SDK tour or visit the documentation website.

Migration resources

JavaScript Maps SDK represents a significant departure in both architecture and coding practices from version 3.x of ArcGIS API for JavaScript. Transitioning to the new SDK typically necessitates a complete rewrite of existing applications, posing a considerable challenge for customers who have not yet migrated. However, the introduction of JavaScript Maps SDK web components library enables developers to build complex GIS functionalities with fewer lines of code, speeding up app creation. To support a seamless transition to the ArcGIS Maps SDK for JavaScript, we recommend that customers use the following resources:

• Tutorials: These step-by-step exercises are designed to introduce the fundamentals of the ArcGIS JavaScript Maps SDK, aiding new customers in their initial setup and use.
• Fundamental Guides: These documents provide a thorough understanding of the core concepts within the JavaScript Maps SDK. They include programming patterns, tutorials for typical workflows, and sample projects covering maps, visualization, query, and geocoding.
• Migration Guide Functionality Matrix: This resource aligns modules, properties, events, and capabilities between both versions. It includes direct links to the relevant sections of the API reference, offering a detailed comparison of low-level functionalities.
• Developer Tooling: This includes enhanced tools to better integrate and utilize the JavaScript Maps SDK, highlighting the use of ES modules and AMD.
• Samples: By exploring these samples, customers can gain a deeper insight into the capabilities of JavaScript Maps SDK.

Esri is fully committed to building standards-based web components that extend the core API of the ArcGIS Maps SDK for JavaScript into reusable custom HTML elements, such as <arcgis-map></arcgis-map>. Today, the recommended approach for building web apps using the SDK is to use components. To develop with components, we recommend starting with following resources:

• Esri Developer & Technology Sessions – Web Components: We strongly recommend using components for building web applications. This three-part series covers the essentials of building web apps with JavaScript Maps SDK components, providing foundational knowledge for both new and migrating developers.
• Components Overview: This component section gives developers a detailed overview on getting started and building applications with components.

Stay connected

We are very interested in hearing about your triumphs and trials as you begin using the JavaScript Maps SDK and are also happy to support your migration in any way that we can. Please reach out to us on Esri Community!

The 2024 Esri Developer Summit is on March 7-10^th and is the best opportunity of the year to learn about building apps with the ArcGIS Maps SDK for JavaScript – including best practices, tips and tricks, how to take advantage of latest SDK capabilities, and our roadmap. You’ll also have the opportunity to discuss your projects and interests 1:1 with the product teams.

Updated in February 2024