Skip To Content
ArcGIS Developer
Dashboard

Bookmark widget

(Added at v1.0)

The Bookmark widget stores a collection of map view extents (that is, spatial bookmarks) displayed in the app. It also allows you to create and add your spatial bookmarks through configuration or at run time after the app starts. In addition, if there are any existing bookmarks defined in the map, you can use them in the app optionally.

Note:

You can edit bookmarks added separately after an app starts. However, you can't remove preconfigured bookmarks in the app.

Configure the Bookmark 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.)

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

    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 the Change widget icon button if you want to replace the default icon for this widget.

    A File Explorer window appears, allowing you to browse to a local image file to use as the widget icon.

  3. The bookmarks are displayed in the cards view by default. Check the List option if you want to display them in the list view.

    If both the Cards view and List view options are checked, the cards view will be set as the default. If you want to set the list view as the default, hover over the left side of the list view and the Make as default button appears. If you click the Make as default button, you can set the list view as the default.

    Allow to add bookmarks in the widget allows you to control whether end users can add bookmarks separately when the app starts.

    Save layer visibility allows end users to save the visibility setting of the operational layers when a bookmark is created.

  4. Display bookmarks from the web map allows you to include bookmarks from the map. You can review the bookmarks from the map, if there are any, when the option is checked.
  5. When Display custom bookmarks is checked, do the following:
    1. Click Create to add your bookmarks.
    2. Zoom in to or search your desired place using the map in the window.
    3. Provide a bookmark name in the text box.
    4. Click the thumbnail icon.

      A File Explorer window appears, allowing you to browse to a local image file to use as the bookmark icon.

    5. Optionally, check the Save layer visibility box to set the visibility of layers for your bookmark.

      When the Save layer visibility box is checked, the list of operational layers appears. You can turn on or off the visibility of each layer by checking or unchecking the box to the left of the layer name.

    6. Click OK.
    7. Repeat the previous steps to add more bookmarks.
    8. Hover over the bookmark to remove, edit, or reorder it.
  6. Click OK to close the configuration window.

Use the Bookmark widget

  1. Click the widget to display predefined bookmarks.
  2. Click one of the bookmark thumbnails to set the map extent to the bookmark area.
  3. Switch between the cards view and list view, if available.
  4. Add more bookmarks by zooming to your desired location and clicking the Add button.
    Note:

    If the Save layer visibility box is checked at the configuration window, the newly added bookmark will save not only the current map extent but also the layer visibility setting. If a bookmark is saved with the layer visibility setting, a small icon Layer visibility appears in the lower left corner of the thumbnail icon to differentiate it from the bookmarks without layer visibility settings.

    Notice that the newly added bookmark displays separately from predefined bookmarks.

    Note:

    The newly added bookmarks are saved in your web browser's cache. They will be removed after you clear your browser cache.

  5. Hover over the new bookmark, click the blue text to give it a name, and click the edit button Edit to upload a thumbnail locally.
  6. Repeat steps 4 and 5 to add more bookmarks.
  7. Hover over a new bookmark to remove or reorder it.

    Caution:
    The edit, remove, and reorder operations are not available for the predefined bookmarks.

  8. Click the close button in the window to close the widget.