Basemap Picker Settings

The Basemap Picker settings include the following:

Main Settings

Additional Basemaps

You can configure two kinds of basemaps for the user to select:

Basemap layers are typically drawn at the bottom of other layers, although a custom basemap may contain reference layers, which are drawn on top of all other layers.

All basemaps, reference layers and base layers should ideally use exactly the same spatial reference as the web map specified in the Map Settings.

If both a 2D web map and 3D web scene are configured in the Map component, the 2D web map must also use exactly the same spatial reference as the 3D web scene.

Esri Basemap

To add an Esri basemap:

  1. In the Components panel, select Basemap Picker.

  2. In the Basemap Picker panel, click +Add Esri Basemap.

    The Esri Basemap window appears.

  3. In the Esri Basemap window, from the Basemap menu, select a standard Esri basemap.

  4. Click Submit.

    The Esri basemap appears in the list of Additional Basemaps.

  5. If you click the title of the Esri basemap, you can set the following:

    • Title: The title of the basemap as it will appear in the basemap picker.

    • Basemap: The standard Esri basemap to use as the basemap.

    • Show in Legend: To display a legend for this basemap in the Legend component, enable this setting.

      The legend is not supported for some layer types, as mentioned under Known Limitations in the Esri API Reference.

    • Basemap Clicked: Specifies the command to run when the basemap is clicked or tapped.

Basemap Clicked

The command to run when the basemap is clicked or tapped. A command is an action the app should perform.

Some commands have additional settings you can configure.

To change the command:

  1. In the Components panel, select Basemap Picker.

  2. Click the basemap for which you want to change the command.

  3. If necessary, in the right panel, click to expand the Events section.

  4. Under Basemap Clicked, click the box that contains the current command followed by .

  5. Select a command and click Submit.

To delete the command:

  1. In the Components panel, select Basemap Picker.

  2. Click the basemap from which you want to delete the command.

  3. If necessary, in the right panel, click to expand the Events section.

  4. Under Basemap Clicked, beside the current command, click .

To add a command:

  1. In the Components panel, select Basemap Picker.

  2. Click the basemap to which you want to add the command.

  3. If necessary, in the right panel, click to expand the Events section.

  4. Under Basemap Clicked, click Select Command.

    A window appears that lets you select a command, workflow or report.

  5. Click one of the following tabs as appropriate:

    • Commands: Select the command you want to run, and click Select.

    • Workflows: Select the workflow you want to run, and click Select. Alternatively, to create a new workflow, click Create a new Workflow. After adding the workflow, you can set its Title and Icon.

    • Reports: Select the report you want to run, and click Select.

To turn your command into a custom command, click . A code box appears in which you can manually edit the JSON code for the command. Turning your command into a custom command is a one-way operation. While editing the custom command in the code box, press CTRL+Space to access code suggestions. You can specify a sequence of multiple commands.

To convert commands into a workflow, first click to customize the commands, and then click . Converting commands into a workflow cannot be reversed. This option is not available for on-premises Workflow installations that are not installed in the default installation folder.

Custom Basemap

To add a custom basemap:

  1. In the Components panel, select Basemap Picker.

  2. In the Basemap Picker panel, click beside +Add Esri Basemap and click Add Custom Basemap.

  3. In the Custom Basemap window, set the following:

    • Title: The title of the basemap as it will appear in the basemap picker.

    • Thumbnail Image URL: The URL for an image you want to use as the thumbnail in the basemap picker.

  4. Click Submit.

    The Custom Basemap panel appears.

  5. In the Custom Basemap panel, set the following:

    • Title: The title of the basemap as it will appear in the basemap picker.

    • Thumbnail Image URL: The URL for an image you want to use as the thumbnail in the basemap picker.

    • Reference Layers: These layers are drawn on top of all other layers. They are typically text label layers such as street names.

    • Base Layers: These layers are drawn at the bottom of the other layers.

    • Basemap Clicked: The command to run when the basemap is clicked or tapped. A command is an action the app should perform.

Reference Layers

These layers are drawn on top of all other layers. They are typically text label layers such as street names.

To add a reference layer:

  1. In the Custom Basemap panel, click +Add Layer.

  2. Select the reference layers you want to add as part of the custom basemap. You can search for a reference layer to use by name or portal item ID. You can search reference layers you own, reference layers shared with you, or public reference layers.

  3. Click Select.

To edit a reference layer:

  1. In the Custom Basemap panel, go to the Reference Layers section and click the name of the reference layer.

  2. Change any of the following reference layer settings:

    • Layer: Click Select to select a different reference layer

    • Transparency: The transparency of the reference layer represented as a percentage between 0 (fully opaque) and 100 (fully transparent).

    • Maximum Scale: The maximum visible scale of the reference layer.

    • Minimum Scale: The minimum visible scale of the reference layer.

    • Show in Legend: To display a legend for this base layer in the Legend component, enable this setting.

      The legend is not supported for some layer types, as mentioned under Known Limitations in the Esri API Reference.

  3. Click the back button.

To reorder a reference layer:

  1. In the Custom Basemap panel, in the Reference Layers section, click Edit Items.

  2. Drag the reference layer to the desired position.

  3. Click Done.

Base Layers

These layers are drawn at the bottom of the other layers.

To add a base layer:

  1. In the Custom Basemap panel, click +Add Layer.

  2. Select the base layers you want to add as part of the custom basemap. You can search for a base layer to use by name or portal item ID. You can search base layers you own, base layers shared with you or public base layers.

  3. Click Select.

To edit a base layer:

  1. In the Custom Basemap panel, in the Base Layers section, click the name of the base layer.

  2. Change any of the base layer settings described in the table below.

    Setting

    Description

    Layer

    Click Select to select a different base layer.

    Transparency

    The transparency of the base layer represented as a percentage between 0 (fully opaque) and 100 (fully transparent).

    Maximum Scale

    The maximum visible scale of the base layer.

    Minimum Scale

    The minimum visible scale of the base layer.

    Identify

    Turn identifying on or off for this base layer.

    Search Turn search on or off for this base layer.
    Zoom Scale Set the scale to which the map should zoom for results in this base layer. When zooming to results from multiple layers, the highest Zoom Scale is used. If both Zoom Scale and Zoom Factor are set, the higher of the two scale values is used.
    Zoom Factor Set the Zoom Factor that is applied to the geometry of non-point results to calculate the scale at which to zoom. When zooming to non-point results from multiple layers, the highest Zoom Factor is used. The default is 1.5. If both Zoom Scale and Zoom Factor are set, the higher of the two scale values is used.
    Inherit Formatting

    Turn inherited formatting options on or off.

    Turn off Inherit Formatting to activate options to set custom formatting for this base layer.

    Show in Legend

    To display a legend for this base layer in the Legend component, enable this setting.

    The legend is not supported for some layer types, as mentioned under Known Limitations in the Esri API Reference.

  3. Click the Back button.

To reorder a base layer:

  1. In the Custom Basemap panel, in the Base Layers section, click Edit Items.

  2. Drag the base layer to the desired position.

  3. Click Done.

To delete a base layer:

  1. In the Custom Basemap panel, in the Base Layers section, click Edit Items.

  2. Click the Delete icon.

  3. Click Done.

Visibility Filters

The following settings allow you to control which users and groups can or cannot access this component:

Visible To

The Visible To settings determine which users and groups can access this component. If no users or groups are specified, all users can access this component by default.

The Hidden From setting overrides this setting.

To add a user:

  1. In the menu on the right, select Users.

  2. In the menu on the left, select the name of the user you want to add.

    To quickly find a user, click the menu on the left and start typing the name of the user.

To add a group:

  1. In the menu on the right, select Groups.

  2. In the menu on the left, select the name of the group you want to add.

    To quickly find a group, click the menu on the left and start typing the name of the group.

    There are three special groups that are always available even if no Esri groups have been configured:

    • All Users: Any user regardless of whether they are signed in or not.

    • Anonymous Users: Users who are not signed in.

    • Authenticated Users: Users who are signed in.

To remove a user or group:

  1. Click the X beside the name of the user or group.

Hidden From

The Hidden From setting determines which users and groups are explicitly forbidden to access this component.

This setting overrides the Visible To setting.

To add a user:

  1. In the menu on the right, select Users.

  2. In the menu on the left, select the name of the user you want to add.

    To quickly find a user, click the menu on the left and start typing the name of the user.

To add a group:

  1. In the menu on the right, select Groups.

  2. In the menu on the left, select the name of the group you want to add.

    To quickly find a group, click the menu on the left and start typing the name of the group.

    There are three special groups that are always available even if no Esri groups have been configured:

    • All Users: Any user regardless of whether they are signed in or not.

    • Anonymous Users: Users who are not signed in.

    • Authenticated Users: Users who are signed in.

To remove a user or group:

  1. Click the X beside the name of the user or group.

Layout

The Layout settings you can configure include the following: