1. Get started

  2.  Welcome
  3.  Get started
  4.  Run as a Windows service
  5.  Build your first app
  6.  Requirements
  7.  Accessibility support
  8.  Development overview
  9.  About release versions
  10.  What's new
  11.  Frequently asked questions
  12. Working with apps

  13.  Home page
  14.  Create or import an app
  15.  Edit and launch an app
  16.  Choose a theme
  17.  Select a map or scene
  18.  Add widgets
  19.  Widgets overview
  20.  Configure app attributes
  21.  Preview apps on smaller screens
  22.  Export as a template
  23.  Edit or preview template
  24.  Use URL parameters
  25.  Upgrade apps
  26. Configure 2D widgets

  27.  About widget
  28.  Add Data widget
  29.  Analysis widget
  30.  Attribute Table widget
  31.  Batch Attribute Editor widget
  32.  Basemap Gallery widget
  33.  Bookmark widget
  34.  Business Analyst widget
  35.  Chart widget
  36.  Controller widget
  37.  Coordinate widget
  38.  Coordinate Conversion widget
  39.  Cost Analysis widget
  40.  Data Aggregation widget
  41.  Directions widget
  42.  Distance and Direction widget
  43.  District Lookup widget
  44.  Draw widget
  45.  Edit widget
  46.  Emergency Response Guide widget
  47.  Extent Navigate widget
  48.  Filter widget
  49.  Full Screen widget
  50.  Geocoder widget
  51.  GeoLookup widget
  52.  Geoprocessing widget
  53.  Grid Overlay widget
  54.  Gridded Reference Graphic widget
  55.  Group Filter widget
  56.  Image Measurement widget
  57.  Home Button widget
  58.  Incident Analysis widget
  59.  Infographic widget
  60.  Info Summary widget
  61.  Layer List widget
  62.  Legend widget
  63.  Measurement widget
  64.  My Location widget
  65.  Near Me widget
  66.  Network Trace widget
  67.  Oblique Viewer widget
  68.  Overview Map widget
  69.  Parcel Drafter widget
  70.  Print widget
  71.  Public Notification widget
  72.  Query widget
  73.  Related Table Charts widget
  74.  Report Feature widget
  75.  Reviewer Dashboard widget
  76.  Scalebar widget
  77.  Screening widget
  78.  Search widget
  79.  Select widget
  80.  Share widget
  81.  Situation Awareness widget
  82.  Smart Editor widget
  83.  Splash widget
  84.  Stream widget
  85.  Suitability Modeler widget
  86.  Summary widget
  87.  Swipe widget
  88.  Threat Analysis widget
  89.  Time Slider widget
  90.  Visibility widget
  91.  Zoom Slider widget
  92. Configure 3D widgets

  93.  3DFx widget
  94.  About widget
  95.  Basemap Gallery widget
  96.  Compass widget
  97.  Coordinate widget
  98.  Daylight widget
  99.  Full Screen widget
  100.  Home Button widget
  101.  Layer List widget
  102.  Legend widget
  103.  Measurement widget
  104.  My Location widget
  105.  Navigate widget
  106.  Search widget
  107.  Share widget
  108.  Slides widget
  109.  Splash widget
  110.  Zoom Slider widget
  111. Widget development

  112.  Get started
  113.  Naming conventions
  114.  In-panel and off-panel widgets
  115.  Deploy your widget
  116.  Required files
  117.  Widget manifest
  118.  Extend BaseWidget
  119.  Required properties
  120.  Define the template
  121.  Configure the Demo widget
  122.  Add i18n support
  123.  Make widgets user-friendly
  124.  Build your first app
  125.  Communication to app container
  126.  Widget properties
  127.  Make widgets responsive
  128.  Communication between widgets
  129.  Dojo dijit
  130.  Make widgets configurable in builder
  131.  Make widgets backward compatible
  132.  Create a controller widget
  133.  Widget life cycle
  134.  Add help for your widget
  135.  Create a feature action in your widget
  136.  Provide and consume data sources in widgets
  137.  Best practices for unit testing
  138. Theme development

  139.  Theme elements
  140.  Create a theme
  141. 3D development

  142.  3D development guide
  143. Sample code

  144.  Create a custom in-panel widget
  145.  Create a ListView widget
  146.  Create a custom widget using the Report dijit
  147.  Create a new theme
  148.  Create a new style for a theme
  149.  Create a new default layout
  150.  Create a nondefault layout
  151.  Create a new panel
  152.  Create a new layout widget
  153.  Create a controller widget
  154.  Create a feature action in your widget
  155.  Send a layer to the Attribute Table widget
  156.  Open multiple widgets simultaneously
  157.  Use other libraries
  158.  Change the URL of ArcGIS API for JavaScript
  159. Deployment

  160.  Deploy your app
  161.  Use proxy
  162.  Web-tier authentication
  163.  Custom widget and theme deployment
  164.  Upgrade custom widgets and themes
  165. Framework reference

  166.  CSS framework
  167.  FeatureActionManager class
  168.  FilterManager class
  169.  LayerInfo class
  170.  LayerInfos class
  171.  LayerNode class
  172.  LayerStructure class
  173.  PanelManager class
  174.  SelectionManager class
  175.  Utils class
  176.  WidgetManager class
  177. dijit

  178.  FeaturelayerChooserFromMap class
  179.  FeaturelayerServiceBrowser class
  180.  FeatureSetChooserForSingleLayer class
  181.  Filter class
  182.  ImageChooser class
  183.  ItemSelector class
  184.  LayerChooserFromMap class
  185.  RendererChooser class
  186.  Report class
  187.  SnapShot class
  188.  SymbolChooser class
  189. JSON reference

  190.  App configuration
  191.  Map configuration
  192.  Widget configuration
  193.  Widget pool configuration
  194.  Widget on-screen configuration
  195.  Panel configuration
  196.  Group configuration
  197.  DataSource configuration
  198.  About
  199.  Analysis
  200.  Attribute Table
  201.  Basemap Gallery
  202.  Bookmark
  203.  Chart
  204.  Coordinate
  205.  Directions
  206.  Draw
  207.  Edit
  208.  Full Screen
  209.  Geocoder
  210.  Geoprocessing
  211.  Controller
  212.  Home Button
  213.  Image Measurement
  214.  Infographic
  215.  Layer List
  216.  Legend
  217.  Loading Page
  218.  Measurement
  219.  My Location
  220.  Near Me
  221.  Oblique Viewer
  222.  Overview Map
  223.  Print
  224.  Query
  225.  Report Feature
  226.  Reviewer Dashboard
  227.  Scalebar
  228.  Search
  229.  Share
  230.  Splash
  231.  Stream
  232.  Swipe
  233.  Time Slider
  234.  Zoom Slider
  235. What's new archive

  236.  What's new in version 2.23
  237.  What's new in version 2.22
  238.  What's new in version 2.21
  239.  What's new in version 2.20
  240.  What's new in version 2.19
  241.  What's new in version 2.18
  242.  What's new in version 2.17
  243.  What's new in version 2.16
  244.  What's new in version 2.15
  245.  What's new in version 2.14
  246.  What's new in version 2.13
  247.  What's new in version 2.12
  248.  What's new in version 2.11
  249.  What's new in version 2.10
  250.  What's new in version 2.9
  251.  What's new in version 2.8
  252.  What's new in version 2.7
  253.  What's new in version 2.6
  254.  What's new in version 2.5
  255.  What's new in version 2.4
  256.  What's new in version 2.3
  257.  What's new in version 2.2
  258.  What's new in version 2.1
  259.  What's new in version 2.0
  260.  What's new in version 1.3
  261.  What's new in version 1.2
  262.  What's new in version 1.1

Create or import an app

With the developer edition of ArcGIS Web AppBuilder, you can create a 2D or 3D app from scratch, import an existing app directly from ArcGIS Online or ArcGIS Enterprise, or import the downloaded ZIP file from your computer. You can also use a template to create a 2D app.

Create an app

Steps:
  1. On the home page, click Create New. To create a 2D app, choose the Default (2D) option to create the app from scratch, or use one of the templates to create the app. The former opens the builder environment, and the latter opens the template-based configuration environment. To create a 3D app, choose the Default (3D) option.
  2. Provide the app name, description, and thumbnail and click OK.
    • With the Default (2D) or Default (3D) option, the builder opens. Creating an app in the builder environment involves the following workflow:
      1. Choose the look and feel of the app.
      2. Specify the web map or web scene authored by your portal, which usually contains a basemap and operational layers.
      3. Configure the widgets.
      4. Brand the app.
      5. Preview the app on devices if you build the 2D app.
        NoteNote:
        The 3D app does not support devices.
      6. Save the app.
      7. Launch the app.
    • With the template option, the template-based configuration environment opens. Configure the parameters as needed, and preview and save the app. If the template does not meet your criteria, click the Saved drop-down arrow and click Advanced Configuration to open the builder environment. You can always come back to the template-based configuration by clicking the Saved drop-down arrow and clicking Template Based Configuration.

Import an existing app

You can build a 2D or 3D app on top of an existing app by importing it from your ArcGIS Online organization or Web AppBuilder account.

Steps:
  1. On the home page, click Import and choose Import from my account to open the Import App window.

    The Import App window displays the available apps created by Web AppBuilder integrated into your portal.

    NoteNote:

    The imported app must be from the same portal as the developer edition installation of Web AppBuilder where you logged in.

  2. Choose an app and click OK.
    • If the imported app was created in an earlier version of Web AppBuilder, it upgrades automatically during import. When successful, you'll see the app listed on the home page. Otherwise, a failure message appears and asks you to check the log file, which is appbuilder.log in the \server\logs directory of the Web AppBuilder installation.

      Failure message
      NoteNote:

      You cannot import an app that has a later version than the installed developer edition. For example, If you type the wabVersion variable in debug mode with a Web AppBuilder online edition app, you may find the value is 1.3. You will be unable to import it to developer edition version 1.1. In general, developer edition 1.0 is equal to Web AppBuilder online edition 1.1. Starting with developer edition 2.0, the developer and online editions of Web AppBuilder share the same version number. For example, developer edition 2.0 is equal to online edition 2.0.

    • If the imported app shares the same version of the developer edition, it's automatically imported and added to the app list.
  3. If an app with the same name already exists, a suffix is automatically added to the imported app name.

Import a downloaded app

You can build a 2D or 3D app on top of an existing app by importing it from your computer. The existing app must be a ZIP file created and downloaded from Web AppBuilder.

Steps:
  1. On the home page, click Import and choose Import from my computer.
  2. Browse to the ZIP file directory, which is downloaded from Web AppBuilder.
  3. Choose the file and click Open.
    • If the imported app was created by an earlier version of Web AppBuilder, it upgrades automatically during import. When successful, you'll see the app listed on the home page. Otherwise, a failure message appears and asks you to check the log file, which is appbuilder.log in the \server\logs directory of the Web AppBuilder installation.

    • If the imported app shares the same version as the developer edition, it is automatically imported and added to the app list.
    • If the imported app includes custom widgets, the importing process will bring these custom widgets along the app automatically without checking them. You need to make sure these custom widgets are compiled with the version of ArcGIS API for JavaScript and version of Web AppBuilder to which you import the app. See the version comparison chart.
  4. If an app with the same name already exists, a suffix is automatically added to the imported app name.