Component Settings

You can change the settings for any component in a Geocortex Web (GXW) app. The settings for components are accessible from the Components panel, which appears when you create or open an app.

In Web Designer, you can use Pinpoint Search (CTRL+F) to easily find any component. The following section lists each component by its type, since component titles can be changed arbitrarily. To determine the type of a component, hover the mouse cursor over the component's icon in the Components panel.

About Shared Configuration

Some components are linked with one or more other components, as indicated by Shared Configuration near the top of the panel of the component. Changing settings (other than layout settings) of such components affects the configuration of components with which they are linked. To see which components a component is linked with, click Shared Configuration. If the linked component belongs to a different layout, the layout is also displayed.

You can unlink a component's configuration from other components so that you can edit the configuration of those other components separately.

To unlink a component's configuration from other components:

  1. In the Components panel, click the component with shared configuration that you want to unlink.

  2. Click Shared Configuration.

    Any other components linked to this component are displayed. If the linked component belongs to a different layout, the layout is also displayed.

  3. Click Unlink.

    The configuration of this component is now unlinked from other components. You can now edit the configuration of those other components separately.

Address Settings

You can change the following address settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Basemap Picker Settings

You can change the following basemap picker settings: 

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 must 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.

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: 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, beside the current command, click .

      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-premise Workflow installations that are not installed in the default installation folder.

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.

      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, in the Reference Layers section, 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 up or down to the position you want.

      3. Click Done.

      To delete a reference layer:

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

      2. Click the Delete icon .

      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 following base layer settings:

        • 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 up or down to the position you want.

      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.

    • 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, beside the current command, click .

      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-premise Workflow installations that are not installed in the default installation folder.

To edit a basemap:

  1. In the Components panel, select Basemap Picker.

  2. In the Basemap Picker panel, click the name of the basemap.

  3. Change the basemap settings you want.

To reorder a basemap:

  1. In the Components panel, select Basemap Picker.

  2. In the Basemap Picker panel, click Edit Items.

  3. Drag the basemap up or down to the position you want.

  4. Click Done.

To delete a basemap:

  1. In the Components panel, select Basemap Picker.

  2. In the Basemap Picker panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Bookmarks Settings

You can change the following bookmarks settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Button Settings

You can change the following button settings:

Main Settings

Behavior

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Chart Settings

You can configure charts to display data from layer fields when the user performs an identify, search or workflow operation.

Charts only appear when the user performs an identify, search or workflow operation on visible layers, as a set of results (Geocortex Features) is required to display charts.

To add a chart:

  1. While editing your app in Designer, in the Components panel, click + Add Component.

    If the + Add Component button is not visible, you are likely viewing your app's Services; click Components to view the components of your layout.

    The Toolbox panel appears.

  2. In the Toolbox panel, click the Other tab.

  3. In the Toolbox panel, drag beside the Chart component to where you want to place it in the Components panel.

    When adding this component for the first time, there may be a slight delay before it appears in the layout while the component loads.

    The Chart component is added to your layout.

Main Settings

Chart Settings

Events

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Columns Settings

The Columns component is a layout component that can contain other components, each of which are displayed horizontally. For more information, see Columns.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Compass Settings

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Dialog Settings

The Dialog component is a layout component that can contain other components, each of which are displayed in a dialog window. For more information, see Dialog.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Expand Settings

The Expand component is a layout component that can contain other components, each of which are displayed vertically once the Expand component is clicked. For more information, see Expand.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Geolocate Settings

The Geolocate component allows the user to locate their position on the map. You can configure the following settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

I Want To Menu Settings

You can change any item in the I Want To menu, add custom items to the menu or delete those you do not want.

You can change the following I Want To menu settings:

Main Settings

Menu Items

Within each menu item, you can change the following:

To add a menu item:

  1. In the Components panel, select I want to....

  2. In the Menu panel, click +Add Menu Item.

    You can add a divider to the menu, which helps to organize related menu items. To add a menu divider, click beside +Add Menu Item and click Add Divider.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following:

    • Title: Type a title for this menu item as it will appear in the I Want To menu. For example, Switch to Results Table.

    • Description: Type an explanation of what this menu item will do when you click it. For example, Switches to viewing search results in a table.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command switches from the Results List to the Results Table.

      Copy
      [
        {
          "name": "ui.deactivate",
          "arguments": "results-list"
        },
        {
          "name": "ui.activate",
          "arguments": "results-table"
        }
      ]
    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

    • Visible To: Determines 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.

    • Hidden From: Determines which users and groups are explicitly forbidden to access this component.

      This setting overrides the Visible To setting.

To edit a menu item:

  1. In the Components panel, select I want to....

  2. In the Menu panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select I want to....

  2. In the Menu panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select I want to....

  2. In the Menu panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Image Settings

The Image component allows you to add an image, either by specifying an image URL or uploading an image.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Inline Settings

The Inline component allows you to add Geocortex Inline views to your app. For more information about Inline, see the Geocortex Inline documentation.

If the expected Inline views do not appear in Designer after you have finished configuring the Inline component, save the app and refresh the page.

Main Settings

Inline Views

This section contains a list of the Inline views added to your app.

To add an Inline view:

  1. In the Components panel, select Inline.

  2. In the Inline panel, click +Add Inline Views.

    A windows appears that lets you select Inline views to add.

  3. Select the Inline views you want to add, and click Select.

    The Inline views are added to your app.

  4. Save the app.

  5. Refresh the page.

To edit an Inline view:

  1. In the Components panel, select Inline.

  2. In the Inline panel, click the name of the Inline view.

  3. To change the Inline view, click Select.

    A windows appears that lets you select a different Inline view.

  4. Select the Inline view you want, and click Select.

    The Inline view is replaced.

  5. Save the app.

  6. Refresh the page.

To reorder an Inline view:

  1. In the Components panel, select Inline.

  2. In the Inline panel, click Edit Items.

  3. Drag the Inline view up or down to the position you want.

  4. Click Done.

  5. Save the app.

  6. Refresh the page.

To delete an Inline view:

  1. In the Components panel, select Inline.

  2. In the Inline panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

  5. Save the app.

  6. Refresh the page.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

KPI Card Settings

You can configure Key Performance Indicator (KPI) cards to display data from layer fields when the user performs an identify, search or workflow operation. KPI cards are divided vertically in three parts: top, middle and bottom, each of which can be configured separately.

KPI cards only appear when the user performs an identify, search or workflow operation on visible layers, as a set of results (Geocortex Features) is required to display KPI cards.

To add a KPI card:

  1. While editing your app in Designer, in the Components panel, click + Add Component.

    If the + Add Component button is not visible, you are likely viewing your app's Services; click Components to view the components of your layout.

    The Toolbox panel appears.

  2. In the Toolbox panel, click the Other tab.

  3. In the Toolbox panel, drag beside the KPI Card component to where you want to place it in the Components panel.

    When adding this component for the first time, there may be a slight delay before it appears in the layout while the component loads.

    The KPI card component is added to your layout.

Value

Advanced Mode

The advanced mode allows you to edit the code for the Arcade script that generates the value for the KPI card.

When you enter Advanced Mode, you will lose access to Designer's UI to easily configure the KPI card settings.

Reference

The settings used to calculate a reference token, which can be used in the Text settings, and the Expression setting used to create conditional formatting.

If you use an Arcade expression that divides by the reference token when its value is zero, the result will be Infinity. You can use the IIf operator to account for this possibility.

Background Color

Top

These settings apply to the top part of the KPI card when no conditions are created or true.

Middle

These settings apply to the middle part of the KPI card when no conditions are created or true.

Bottom

These settings apply to the bottom part of the KPI card when no conditions are created or true.

Conditional Formatting

You can add conditions to apply formatting under certain circumstances. For example, you could change the colors of the various parts of the KPI card depending on the size of the value.

Geocortex Web applies conditional formatting based on the first condition that is true. If no conditions are true, the default formatting above is applied.

To add a condition:

  1. In the Components panel, select KPI Card.

  2. In the KPI Card panel, click +Add Condition.

    A window appears that lets you create a condition.

  3. In the Expression box, type a conditional Arcade expression. Do not enclose the Arcade expression within curly braces. For example, value + reference > 0.

  4. Set the conditional formatting you want to apply when this condition's Expression is the first to be true:

    Background Color

    • Use App Colors: Whether to use the colors configured in the Branding Settings.

    • Custom Background Color: Specify a background color for the KPI card. This option only appears when Use App Colors is disabled.

      To select a color, click the color picker to select a color from the palette, using the sliders to adjust the hue and opacity, or the predefined color swatches at the bottom.

      Alternatively, there are two ways in which you can manually specify a color:

      • Hex (Hexadecimal): Type a hexadecimal value for the color. The first pair of characters represent the amount of red, the second pair the amount of green, and the third pair the amount of blue. Each character must be between 0 and F. You cannot specify the opacity in the hexadecimal value, however, you can use the opacity slider or the Alpha value in the RGBA value. For more information, see Web colors.

      • RGBA (Red, Green, Blue, Alpha): Type an RGBA value for the color, which consists of four numbers. The first three numbers represent the amount of red, green and blue, respectively, and each value must be an integer between 0 and 255. The final number represents the color's opacity and must be an integer between 0 (fully transparent) and 100 (fully opaque).

    Top

    These settings apply to the top part of the KPI card when this condition's Expression is the first to be true.

    • Text: The text to display at the top of the KPI card.

      You can use Arcade expressions within curly braces {}, including the value and reference tokens. For example, Value * Reference is: {value * reference}. For more information, see ArcGIS Arcade.

    • Icon: The icon to display at the top of the KPI card. To select an icon, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Size: The size of the text and icon at the top of the KPI card.

    • Use App Colors: Whether to use the colors configured in the Branding Settings.

    • Custom Color: The color of the text and icon at the top of the KPI card.This option only appears when Use App Colors is disabled.

    • Inherit Formatting: Whether to use the formatting settings configured in the Region Settings for numbers produced by an Arcade expression.

    • Number Format: The format of any numbers produced by an Arcade expression. This option only appears when Inherit Formatting is disabled.

    • Decimal Places: The number of decimal places for numbers produced by an Arcade expression. This option only appears when Inherit Formatting is disabled.

    Middle

    These settings apply to the middle part of the KPI card when this condition's Expression is the first to be true.

    • Text: The text to display in the middle of the KPI card.

      You can use Arcade expressions within curly braces {}, including the value and reference tokens. For example, Value * Reference is: {value * reference}. For more information, see ArcGIS Arcade.

    • Icon: The icon to display in the middle of the KPI card. To select an icon, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Size: The size of the text and icon in the middle of the KPI card.

    • Use App Colors: Whether to use the colors configured in the Branding Settings.

    • Custom Color: The color of the text and icon in the middle of the KPI card.This option only appears when Use App Colors is disabled.

    • Inherit Formatting: Whether to use the formatting settings configured in the Region Settings for numbers produced by an Arcade expression.

    • Number Format: The format of any numbers produced by an Arcade expression. This option only appears when Inherit Formatting is disabled.

    • Decimal Places: The number of decimal places for numbers produced by an Arcade expression. This option only appears when Inherit Formatting is disabled.

    Bottom

    These settings apply to the bottom part of the KPI card when this condition's Expression is the first to be true.

    • Text: The text to display at the bottom of the KPI card.

      You can use Arcade expressions within curly braces {}, including the value and reference tokens. For example, Value * Reference is: {value * reference}. For more information, see ArcGIS Arcade.

    • Icon: The icon to display at the bottom of the KPI card. To select an icon, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Size: The size of the text and icon at the bottom of the KPI card.

    • Use App Colors: Whether to use the colors configured in the Branding Settings.

    • Custom Color: The color of the text and icon at the bottom of the KPI card.This option only appears when Use App Colors is disabled.

    • Inherit Formatting: Whether to use the formatting settings configured in the Region Settings for numbers produced by an Arcade expression.

    • Number Format: The format of any numbers produced by an Arcade expression. This option only appears when Inherit Formatting is disabled.

    • Decimal Places: The number of decimal places for numbers produced by an Arcade expression. This option only appears when Inherit Formatting is disabled.

  5. Click Submit.

To edit a condition:

  1. In the Components panel, select KPI Card.

  2. In the KPI Card panel, click the name of the menu item.

  3. Change the condition settings you want.

To reorder a menu item:

  1. In the Components panel, select KPI Card.

  2. In the KPI Card panel, click Edit Items.

  3. Drag the condition up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select KPI Card.

  2. In the KPI Card panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Layer List Settings

Main Settings

Layer Extensions

Select the layer list settings for each layer:

Layer Actions

Layer Actions: Configure the menu items in the menu beside each layer in the layer list.

Menu items have the following settings:

To add a menu item:

  1. In the Components panel, select Layers.

  2. In the Layer List panel, click +Add Menu Item.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following:

    • Title: Type a title for this menu item as it will appear in the layer menu. For example, Zoom to Extent then Visible Scale.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Zooms to the extent of the layer and then to the visible scale of the layer.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command zooms to the extent of the layer and then zooms to its visible scale.

      Copy
      [
        "map.zoom-to-layer-extent",
        "map.zoom-to-layer-visible-scale"
      ]

      The above example demonstrates how to pass the current context - the layer - as an argument into the map.zoom-to-layer-extent operation. The returned value of map.zoom-to-layer-extent, which is the same layer, is then automatically passed into the next command, map.zoom-to-layer-visible-scale. If you want to instead ignore the current context and supply your own argument to a command, see the example provided in Toolbar Settings.

    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

To edit a menu item:

  1. In the Components panel, select Layers.

  2. In the Layer List panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Layers.

  2. In the Layer List panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Layers.

  2. In the Layer List panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Layer Presets Settings

A layer preset allows a user to change the visibility settings of many layers at once. For example, you could configure a layer preset that only displays layers related to vegetation. Layer presets are located at the bottom of the layer list.

Main Settings

Layer Presets

Layer presets have the following settings:

To add a layer preset:

  1. In the Components panel, select Layer Presets.

  2. In the Layer Presets panel, click +Add Layer Preset.

  3. In the New Layer Preset panel, set the following: 

    • Layer Extensions: Select the layer preset settings for each layer:

      • Disable/Enable Visible : Click the icon to toggle whether this layer is visible on the map when this layer preset is selected.

    • Basemap: Select a basemap for this layer preset. You can either use a standard Esri basemap, a custom basemap configured in Basemap Picker Settings, or no basemap (None Selected).

    • Title: Change the name of the layer preset as it will appear in the layer list.

    • Icon: To select an icon to represent this layer preset, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

To edit a layer preset:

  1. In the Components panel, select Layer Presets.

  2. In the Layer Presets panel, click the name of the layer preset.

  3. Change the layer preset settings you want.

To reorder a layer preset:

  1. In the Components panel, select Layer Presets.

  2. In the Layer Presets panel, click Edit Items.

  3. Drag the layer preset up or down to the position you want.

  4. Click Done.

To delete a layer preset:

  1. In the Components panel, select Layer Presets.

  2. In the Layer Presets panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Legend Settings

The Legend component displays the map legend for each layer. You can configure the following settings:

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

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Map Settings

A group of settings related to the map, its layers, context menu and start up event: 

Main Settings

Map Settings

Layer Extensions

Add or remove layers for this map. You can also set the following on each layer:

Events

Layer Comparison

You can configure the map with a Layer Comparison tool, where an adjustable slider splits the map into two sides: the first side contains leading layers and the second side contains trailing layers. You can configure which layers appear on either side. Layers that are not added to either side appear on both sides of the map.

Context Menu

You can change any item in the context menu, which appears when the user right-clicks or long-presses the map. Add custom items to the menu or delete those you do not want.

Within each menu item, you can change the following:

To add a menu item:

  1. In the Components panel, select Map.

  2. In the Map panel, click +Add Menu Item.

    You can add a divider to the menu, which helps to organize related menu items. To add a menu divider, click beside +Add Menu Item and click Add Divider.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following: 

    • Title: Type a title for this menu item as it will appear in the context menu when the user right-clicks or long-presses the map. For example, Run My Workflow.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Runs my custom workflow.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, to create a menu item that runs a workflow, in the Command box, start typing Run Workflow and select the command when it appears. From the list of workflows that appears, select the workflow you want to run. The command becomes a custom command and code similar to the following appears in the code box:

      Copy
      {
      "id": "1a2b3c4d-5e6f-1a2b-3c4d-5e6lucina14e",
      "inputs": {},
      "portalItem": "https://mycompany.maps.arcgis.com/sharing/rest/content/items/1c8eevee4b154mewsix894bff619a4d7",
      "commandArgumentInput": "myGeometryParameter"
      }

      The above example uses the commandArgumentInput property to specify which workflow input should receive the current context as its value, that is, the geometry of the selected point. By default, the commandArgumentInput property is set to context.

      You can also use the inputs property to supply values to workflow inputs. The inputs property is a key-value object, where the keys are the names of workflow inputs.

      The commandArgumentInput property overrides the inputs property.

      For more information, see Use the Menu Context as a Workflow Input.

    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

    • Visible To: Determines 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.

    • Hidden From: Determines which users and groups are explicitly forbidden to access this component.

      This setting overrides the Visible To setting.

To edit a menu item:

  1. In the Components panel, select Map.

  2. In the Map panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Map.

  2. In the Map panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Map.

  2. In the Map panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Constraints

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Map 3D Toggle Settings

The Map 3D Toggle component allows the user to toggle between the 2D web map and 3D web scene. You can configure the following settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Map Coordinates Settings

The Map Coordinates component displays the coordinates of the last position the cursor was over the map. You can configure the following settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Panel Settings

The Panel component is a layout component that can contain other subcomponents, each of which are displayed successively. When the user clicks the Back button , the panel displays the previous subcomponent. For more information, see Panel.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Printing Settings

You can adjust the print settings available when the user prints the map, including the print template settings, spatial reference grids and resolutions the user can select. The user is also presented with any input parameters the print template may have.

Main Settings

Print Templates

Add print templates for the user to select. Print templates are created with Geocortex Printing. Each print template has the following settings:

To add a print template:

  1. In the Components panel, select Printing.

  2. In the Print panel, click +Add Print Templates.

  3. Select one or more print templates. You can search for a print template by name or portal item ID. You can search print templates you own or print templates shared with you.

  4. Click Select.

To edit a print template:

  1. In the Components panel, select Printing.

  2. In the Print panel, click the title of the print template.

  3. Change the print template settings you want.

To reorder a print template:

  1. In the Components panel, select Printing.

  2. In the Print panel, click Edit Items.

  3. Drag the print template up or down to the position you want.

  4. Click Done.

To delete a print template:

  1. In the Components panel, select Printing.

  2. In the Print panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Spatial Reference Grids

Add spatial reference grids for the user to select that will appear when the map is printed. Each spatial reference grid has the following settings:

For a list of Well-Known IDS (WKIDs) and Well-Known Texts (WKTs), see Esri's Geographic Coordinate Systems or Projected Coordinate Systems.

To add a spatial reference grid:

  1. In the Components panel, select Printing.

  2. Click +Add Grid.

  3. In the Name box, type a display name for the spatial reference grid.

  4. Do one of the following:

    • In the WKID box, type the Well-Known ID of the spatial reference to use for the grid.

    • In the Well-Known Text box, type the Well-Known Text of the spatial reference to use for the grid.

    The WKID setting overrides the Well-Known Text setting.

To edit a spatial reference grid:

  1. In the Components panel, select Printing.

  2. In the Print panel, click beside the spatial reference grid you want to edit.

  3. Change the spatial reference grid settings you want.

To reorder a spatial reference grid:

  1. In the Components panel, select Printing.

  2. In the Print panel, click Edit Items.

  3. Drag the spatial reference grid up or down to the position you want.

  4. Click Done.

To delete a spatial reference grid:

  1. In the Components panel, select Printing.

  2. In the Print panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Resolutions

Add resolutions for the user to select in which to print the map. Each resolution has the following setting:

To add a resolution:

  1. In the Components panel, select Printing.

  2. In the Resolution panel, click +Add Resolution.

  3. In the DPI box, type a number representing the Dots Per Inch (DPI) resolution.

  4. Click Select.

To edit a resolution:

  1. In the Components panel, select Printing.

  2. In the Resolution panel, click beside the resolution you want to edit.

  3. Change the resolution settings you want.

To reorder a resolution:

  1. In the Components panel, select Printing.

  2. In the Resolution panel, click Edit Items.

  3. Drag the resolution up or down to the position you want.

  4. Click Done.

To delete a resolution:

  1. In the Components panel, select Printing.

  2. In the Resolution panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Result Details Settings

The Result Details settings contain a list of feature action menu items that are common to the Results List and Results Table settings. Adding, editing or removing a menu item in one place affects the others.

Main Settings

Feature Actions

Feature actions set at this level are available for all features, unlike setting feature actions on a particular layer within Map Settings.

Menu items have the following settings:

To add a menu item:

  1. In the Components panel, select Result Details.

  2. In the Result Details panel, click +Add Menu Item.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following: 

    • Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels. For example, Zoom to and Pulse Features.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Zooms to features and temporarily highlights them.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command zooms to features in the results and temporarily highlights them.

      Copy
      [
        "map.zoom-to-features",
        "highlights.pulse"
      ]

      The above example demonstrates how to pass the current context - the features in the results - as an argument into the map.zoom-to-features operation. The returned value of map.zoom-to-features, which is the same set of features, is then automatically passed into the next command, highlights.pulse. If you want to instead ignore the current context and supply your own argument to a command, see the example provided in Toolbar Settings.

    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

    • Visible To: Determines 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.

    • Hidden From: Determines which users and groups are explicitly forbidden to access this component.

      This setting overrides the Visible To setting.

To edit a menu item:

  1. In the Components panel, select Result Details.

  2. In the Result Details panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Result Details.

  2. In the Result Details panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Result Details.

  2. In the Result Details panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Events

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Result Summary Settings

The Result Summary component displays a map tip with a brief summary of information about the feature or features at a certain location. By default, the Result Summary appears when the user hovers the mouse cursor over one or more features on the map.

Main Settings

Feature Actions

Feature actions set at this level are available for all features, unlike setting feature actions on a particular layer within Map Settings.

Menu items have the following settings:

To add a menu item:

  1. In the Components panel, select Result Summary.

  2. In the Result Summary panel, click +Add Menu Item.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following: 

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command zooms to features in the results and temporarily highlights them.

      Copy
      [
        "map.zoom-to-features",
        "highlights.pulse"
      ]

      The above example demonstrates how to pass the current context - the features in the results - as an argument into the map.zoom-to-features operation. The returned value of map.zoom-to-features, which is the same set of features, is then automatically passed into the next command, highlights.pulse. If you want to instead ignore the current context and supply your own argument to a command, see the example provided in Toolbar Settings.

    • Title: Type a title for this menu item as it will appear in the Result Summary component. For example, Zoom to and Pulse Features.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Zooms to features and temporarily highlights them.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

To edit a menu item:

  1. In the Components panel, select Result Summary.

  2. In the Result Summary panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Result Summary.

  2. In the Result Summary panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Result Summary.

  2. In the Result Summary panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Events

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Results List Settings

The Results List settings contain a list of feature action menu items that are common to the Result Details and Results Table settings. Adding, editing or removing a menu item in one place affects the others.

Main Settings

Feature Actions

Feature actions set at this level are available for all features, unlike setting feature actions on a particular layer within Map Settings.

Menu items have the following settings:

To add a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click +Add Menu Item.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following: 

    • Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels. For example, Zoom to and Pulse Features.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Zooms to features and temporarily highlights them.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command zooms to features in the results and temporarily highlights them.

      Copy
      [
        "map.zoom-to-features",
        "highlights.pulse"
      ]

      The above example demonstrates how to pass the current context - the features in the results - as an argument into the map.zoom-to-features operation. The returned value of map.zoom-to-features, which is the same set of features, is then automatically passed into the next command, highlights.pulse. If you want to instead ignore the current context and supply your own argument to a command, see the example provided in Toolbar Settings.

    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

    • Visible To: Determines 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.

    • Hidden From: Determines which users and groups are explicitly forbidden to access this component.

      This setting overrides the Visible To setting.

To edit a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Events

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Results Table Settings

The Results Table settings contain a list of feature action menu items that are common to the Result Details and Results List settings. Adding, editing or removing a menu item in one place affects the others.

Main Settings

Feature Actions

Feature actions set at this level are available for all features, unlike setting feature actions on a particular layer within Map Settings.

Menu items have the following settings:

To add a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click +Add Menu Item.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following: 

    • Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels. For example, Zoom to and Pulse Features.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Zooms to features and temporarily highlights them.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command zooms to features in the results and temporarily highlights them.

      Copy
      [
        "map.zoom-to-features",
        "highlights.pulse"
      ]

      The above example demonstrates how to pass the current context - the features in the results - as an argument into the map.zoom-to-features operation. The returned value of map.zoom-to-features, which is the same set of features, is then automatically passed into the next command, highlights.pulse. If you want to instead ignore the current context and supply your own argument to a command, see the example provided in Toolbar Settings.

    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

    • Visible To: Determines 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.

    • Hidden From: Determines which users and groups are explicitly forbidden to access this component.

      This setting overrides the Visible To setting.

To edit a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Results.

  2. In the Results panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Events

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Rows Settings

The Rows component is a layout component that can contain other components, each of which are displayed vertically. For more information, see Rows.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Scale Bar Settings

You can configure the settings that control the style and units of measurement used to display the Scale Bar. The scale bar is a line that indicates the size of features and distances on a map. You can represent the scale bar in different units of measurement, as a simple line, or a ruler broken into increments of the units.

Select from the following options:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Scale Input Settings

The Scale Input component allows the user to select the scale at which to display the map. You can configure the following settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Search Settings

Set the following options for searches in your app:

Main Settings

Events

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Search New Extent Settings

Set the following options for Search This Area button in your app, which appears when you pan the map after obtaining search results:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Tabs Settings

The Tabs component is a layout component that can contain other components, each of which are displayed within tabs. For more information, see Tabs.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Text Settings

Controls the content of the Home panel.

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Toolbar Settings

You can change any item on the Toolbar menu, add custom items to the menu or delete those you do not want.

Main Settings

Menu Items

Under each menu item, you can change the following:

To add a menu item:

  1. In the Components panel, select Toolbar.

  2. In the Menu panel, click +Add Menu Item.

    You can add a divider to the menu, which helps to organize related menu items. To add a menu divider, click beside +Add Menu Item and click Add Divider.

    You can add a submenu to the menu, which helps to further organize related menu items. To add a submenu, click beside +Add Menu Item and click Add Submenu. The process of adding menu items to a submenu is the same except you cannot add a submenu to a submenu.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following: 

    • Title: Type a title for this menu item as it will appear in the toolbar. For example, Switch to Results Table.

    • Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank. For example, Switches to viewing search results in a table.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command switches from the Results List to the Results Table.

      Copy
      [
        {
          "name": "ui.deactivate",
          "arguments": "results-list"
        },
        {
          "name": "ui.activate",
          "arguments": "results-table"
        }
      ]
    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

To edit a menu item:

  1. In the Components panel, select Toolbar.

  2. In the Menu panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select Toolbar.

  2. In the Menu panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select Toolbar.

  2. In the Menu panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

User Settings

The User component allows the user to sign in and out of the app. The User component can contain other components.

Main Settings

Menu Items

You can change any item in the User component menu, add custom items to the menu or delete those you do not want. Within each menu item, you can change the following:

To add a menu item:

  1. In the Components panel, select User.

  2. In the Menu panel, click +Add Menu Item.

    You can add a divider to the menu, which helps to organize related menu items. To add a menu divider, click beside +Add Menu Item and click Add Divider.

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

  3. 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.

  4. Click the new menu item to edit it.

  5. In the Menu Item panel, set the following:

    • Title: Type a title for this menu item as it will appear in the User component menu. For example, Switch to Results Table.

    • Description: Type an explanation of what this menu item will do when you click it. For example, Switches to viewing search results in a table.

    • Icon: To select an icon to represent this menu item, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

    • Command: The command to run when a user clicks the menu item. A command is an action the app should perform.

      To select the command you want, click . The list of available commands depends on the context of the component.

      Some commands have additional settings you can configure.

      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-premise Workflow installations that are not installed in the default installation folder.

      For example, the following custom command switches from the Results List to the Results Table.

      Copy
      [
        {
          "name": "ui.deactivate",
          "arguments": "results-list"
        },
        {
          "name": "ui.activate",
          "arguments": "results-table"
        }
      ]
    • Hide when Disabled: Whether to hide the menu item when the command cannot be executed.

    • Can be Toggled: Whether the menu item can be toggled between two states. If the menu item can be toggled, you can specify the behavior of the menu item for both states as well as whether the menu item is toggled by default.

To edit a menu item:

  1. In the Components panel, select User.

  2. In the Menu panel, click the name of the menu item.

  3. Change the menu item settings you want.

To reorder a menu item:

  1. In the Components panel, select User.

  2. In the Menu panel, click Edit Items.

  3. Drag the menu item up or down to the position you want.

  4. Click Done.

To delete a menu item:

  1. In the Components panel, select User.

  2. In the Menu panel, click Edit Items.

  3. Click the Delete icon .

  4. Click Done.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

User Preferences Settings

This component offers end users the following app display options:

In Designer, you can configure the following User Preferences component settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Workflow Settings

The Workflow component hosts a workflow form. You can configure the following settings:

Main Settings

Default Workflow

The workflow to host.

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout

Zoom Settings

The Zoom component allows the user to zoom in and out of the map by pressing buttons. You can configure the following settings:

Main Settings

Visibility Filters

These settings allow you to control which users and groups can or cannot access this component.

Layout