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

Screening widget

The Screening widget allows you to define an area of interest and analyze specified layers for potential impacts. The area of interest can be defined through a place name search, by drawing on the map, by uploading a shapefile, or by entering a traverse with coordinate and distance pairs. Analysis results can be inspected in the widget and, optionally, shared via a printed report, CSV file download, or feature download.

For an example of how to use this widget, see the Environmental Analysis solution.

Configure the Screening widget

This widget can be set to open automatically when an app starts. Hover over the widget and click the Do not open this widget when the app starts button Do not open this widget when the app starts to change the setting to Open this widget automatically when the app starts. (For widgets that you need to add to the app first, you can turn on this option after configuring the widget.)

Steps:
  1. Hover over the widget and click the Configure this widget button Configure this widget to open the configuration window.
    NoteNote:

    If you need to add the widget to the app first, click a widget placeholder on the Widget tab. In the Choose Widget window that opens, select the widget and click OK.

  2. Optionally click Change widget icon and replace the icon with an image of your own.

    A file explorer window appears, allowing you to select a local image file to use as the widget icon.

  3. Click Add Layers.
    Each added layer specifies a feature layer in the map to be analyzed by the widget. The Screening widget supports the following layer types:
    • Feature services
    • Map services
    NoteNote:

    Map services are supported when they are not nested in the table of contents. Nested layers are not supported.

  4. On the Analysis tab, optionally add a label for each layer.
  5. Click the edit button Edit under Actions to select the fields for the analysis results. You can disable grouping features by field when attributes have the same values and set a sort field for the report.
    NoteNote:

    To automatically populate its field list, the layer must have pop-ups enabled in the web map.

  6. In the Analysis Layers table, under Actions, optionally change the order of layers or delete a layer.
  7. In the Area of Interest Tools section, choose and label the tools that will be available to define the area of interest.
  8. In the Drawing Tools section, optionally disable one or more drawing tools: Point, Polyline, Extent, Circle, and Polygon.

    The draw mode toolbar will also include Select By Rectangle, with which users can select features from a particular layer by drawing a rectangle. You can disable this tool in the Choose selectable layers setting by unchecking the Layer Name box.

    Drawing tools enabled with green box around Layer Name check box

  9. Optionally enable Allow users to upload shapefiles to include in the analysis.

    With this option, you can add an additional layer for analysis in the widget.

  10. Optionally enable Do not analyze or report results for layers that are not visible.

    With this option, layers that are not visible due to scale visibility settings or because they are turned off, will not be analyzed when the Report button is clicked. When layers are not analyzed because of layer visibility, they also are not included in printed reports.

  11. Specify the default unit for Area.
  12. Specify the default unit for Length.
  13. Specify a value for Maximum number of features to analyze.

    This parameter limits the maximum number of features returned from the configured layers and used for analysis.

  14. Specify the Search tolerance value in feet or meters depending on the default analysis results units.

    The search tolerance is used to select features when the area of interest is a point or line shape.

  15. On the Download tab, in the Download Settings section, choose one of the following options:
    • Feature layers—Choose the layers you want downloaded. This option supports CSV file download and, when the layer is a feature service with sync enabled, file geodatabase and shapefile downloads.
    • Extract Data Task—All layers are enabled for CSV file download, and feature data can be downloaded as file geodatabases or shapefiles with the Extract Data Task geoprocessing tool.
    • Disable download—No data download is enabled.

    NoteNote:
    ArcGIS Data Store versions 10.6 and earlier are not supported for download with the Screening widget.

  16. In the Report Settings section, do any or all of the following:
    • Update Print service URL to use an alternate print service with the Export Web Map task enabled.
    • When using an alternate print service with custom layout templates, optionally click Add custom layout to enable the templates to be used for the report.

      A new entry will be added to the Layouts table. Populate Width, Height, and Page Units for the selected layout. These values will be used to define the report page size.

      NoteNote:
      When publishing additional services for printing with ArcGIS Enterprise, ensure that the Execution Mode of the service under the Parameters section is set to Synchronous.

    • Change Default layout.
    • Use the Logo option to change the logo by clicking the image.

      A file explorer window appears, allowing you to select a local image file to use as the logo.

    • Change the default Report title text.
    • Optionally customize how the following values appear in reports. For example, if you have a large dataset for which many features have no data, you can choose to show them as empty cells in the table so the report is easier to review.
      • No data value
      • Not applicable value
    • Change the Report column title color option. This color will be displayed as the background for column titles in the printed report.
    • Optionally disable Display Summary to exclude the table from the report.
    • Optionally hide rows in the printed report by checking one or both of the following settings:
      • Hide rows with 0 value for all analysis fields
      • Hide rows with no data value (null or empty) for all analysis fields
      NoteNote:

      Rows are only hidden in the printed report. If all the fields for a particular feature have 0 or null values, the row will not be hidden in the widget panel at runtime.

    • Provide text in the Footnote text box that will be displayed as a footnote on the printed report.
  17. On the General tab, update the panel labels used in the widget for Area of interest and Report.
  18. Update the default buffer settings for the widget.
  19. Change the symbology used to depict the buffer in the map.
  20. Change the symbology used to depict the point, line, or polygon areas of interest in the map.
  21. Click the Search Source Settings tab. To configure these settings, see Configure the Search widget, which follows the same configuration steps as the Screening widget.

Use the Screening widget

Steps:
  1. Click the Screening widget button to open it.

    The widget displays on the right.

    Screening widget button

  2. Define an area of interest with one of the provided tools.
    • Placename—Search for a location in the map, and optionally apply a buffer.
    • Draw—Draw a point, line, or polygon on the map or select a feature from the map, and optionally apply a buffer. Use the Choose selectable layer list to define the layers that are selectable in the map.

      Draw tab

    • Shapefile—Upload a zipped shapefile, and optionally apply a buffer.
    • Coordinates—Identify a starting point for a traverse by searching the map, specifying a coordinate pair, or drawing a point on the map. Specify bearing and distance pairs to define the traverse.

      Specify coordinates

  3. Define a buffer.
  4. Click Start Over to remove the defined area of interest and create a new one.
  5. Click Report to analyze the configured layers within the area of interest.

    Analysis results are presented in the panel. Layers with data intersecting the area of interest report a total feature count, and results are presented by grouping unique attribute combinations with the following information:

    • Area of overlap when the area of interest is a polygon
    • Length of overlap when the area of interest is a polygon

    The areas and lengths are calculated by performing a clip analysis on the intersecting geometries in the coordinate system of the web map. If the underlying map or feature service has a spatial reference other than that of the web map, the transformation of the data is handled by the service. If the web map is using the Web Mercator coordinate system, all geometry operations are performed using geodesic lengths and areas; otherwise, planar lengths and areas are used.

Explore the results

Steps:
  1. Expand the result details by clicking a layer. The layer details expand as shown in the following screen capture:

    Results of a layer

  2. Click the settings button to choose the fields that are presented with the results and change the sort order and sort field.
    NoteNote:

    When all fields are disabled, the layer will be hidden in the printed report.

    Select the fields to be presented with the results

  3. Optionally add an additional layer for analysis by clicking the Upload button.

    A file explorer window appears, allowing you to select a local zipped shapefile.

  4. Optionally change the units of the analysis results by clicking the Choose units for analysis button.

    A window appears, allowing you to choose the length and area units for analysis results.

  5. Optionally refresh the analysis results for the current area of interest by clicking the Refresh report button.
  6. Download feature information in CSV file, file geodatabase, or shapefile format by clicking the Download button and choosing a format.

    The downloaded report includes all the fields.

  7. Print a report of the analysis results by clicking the Print button and choosing a page size and orientation.

    A new window appears where you can change the report title or comments.