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.
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:
In the Components panel, click the component with shared configuration that you want to unlink.
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.
Click Unlink.
The configuration of this component is now unlinked from other components. You can now edit the configuration of those other components separately.
You can change the following address settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
You can change the following basemap picker settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
You can configure two kinds of basemaps for the user to select:
Esri Basemap: These are the well-known standard Esri basemaps.
Custom Basemap: Create your own basemap with whichever layers you want.
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:
In the Components panel, select Basemap Picker.
In the Basemap Picker panel, click +Add Esri Basemap.
The Esri Basemap window appears.
In the Esri Basemap window, from the Basemap menu, select a standard Esri basemap.
Click Submit.
The Esri Basemap panel appears.
In the Custom Basemap panel, 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.
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.
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.
To add a custom basemap:
In the Components panel, select Basemap Picker.
In the Basemap Picker panel, click beside +Add Esri Basemap and click Add Custom Basemap.
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.
Click Submit.
The Custom Basemap panel appears.
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.
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.
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:
In the Custom Basemap panel, click +Add Layer.
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.
Click Select.
To edit a reference layer:
In the Custom Basemap panel, in the Reference Layers section, click the name of the reference layer.
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.
Click the back button .
To reorder a reference layer:
In the Custom Basemap panel, in the Reference Layers section, click Edit Items.
Drag the reference layer up or down to the position you want.
Click Done.
To delete a reference layer:
In the Basemap Picker panel, in the Reference Layers section, click Edit Items.
Click the Delete icon .
Click Done.
Base Layers: These layers are drawn at the bottom of the other layers.
To add a base layer:
In the Custom Basemap panel, click +Add Layer.
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.
Click Select.
To edit a base layer:
In the Custom Basemap panel, in the Base Layers section, click the name of the base layer.
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.
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.
Click the back button .
To reorder a base layer:
In the Custom Basemap panel, in the Base Layers section, click Edit Items.
Drag the base layer up or down to the position you want.
Click Done.
To delete a base layer:
In the Basemap Picker panel, in the Base Layers section, click Edit Items.
Click the Delete icon .
Click Done.
To edit a basemap:
In the Components panel, select Basemap Picker.
In the Basemap Picker panel, click the name of the basemap.
Change the basemap settings you want.
To reorder a basemap:
In the Components panel, select Basemap Picker.
In the Basemap Picker panel, click Edit Items.
Drag the basemap up or down to the position you want.
Click Done.
To delete a basemap:
In the Components panel, select Basemap Picker.
In the Basemap Picker panel, click Edit Items.
Click the Delete icon .
Click Done.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
You can change the following bookmarks settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
You can change the following button settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, 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 button. 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.
[ { "name": "ui.deactivate", "arguments": "results-list" }, { "name": "ui.activate", "arguments": "results-table" } ]
Hide when Disabled: Whether to hide the button when the command cannot be executed.
Can be Toggled: Whether the button can be toggled between two states. If the button can be toggled, you can specify the behavior of the button for both states as well as whether the button is toggled by default.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
Show Title: Whether or not to display the title of the component.
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:
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.
In the Toolbox panel, click the Other tab.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Chart Type: Select the type of chart you want to display:
Bar: Displays values as proportional rectangular bars.
Pie: Displays values as proportional slices of a circle.
Line: Displays values in a graph, each connected with a line.
Scatter Plot: Displays values in a graph, similar to a line chart but values are not connected with a line.
Orientation: Select the way to orient the graph. This option is not available for pie charts.
Vertical: Display the graph vertically.
Horizontal: Display the graph horizontally.
Setting the Orientation to Horizontal swaps the positions of the Axis Labels.
Source: Select the layer or workflow from which to source the data for the chart.
If the app contains more than one map, layers appear with a (Map Title) suffix. For example, MyLayer (MyMap1), MyLayer (MyMap2).
Workflows are indicated with a (Workflow) suffix. If you select a workflow, you must be aware of the field names and types of the workflow's output.
If the workflow executes the charts.display
command with results from a layer on your map, set the chart's Source to that layer instead of the workflow.
Series Type: Select the series type which determines how the chart presents the data:
Single-Field Groups: Displays the data grouped by a single field. For example, display the average height of buildings depending on their actual use.
Group By
Field: The layer field to use as the X values (when Orientation is set to Vertical).
Is Date Field: Specifies whether this field is a date field. This option only appears when Source is set to a workflow and Series Type is set to Single-Field Groups.
Date Unit: Specifies the part of the date to display. This option only appears when Field is a date field and Series Type is set to Single-Field Groups.
The Hour option ignores all other aspects of the timestamp, including day, minutes and seconds. Therefore, when displaying data for 10, all of the following would match: 10:00, 10:30, 10:59.
Axis Label: Specify a label for the X axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.
Group Values
Statistic: The function to apply to the Y values (when Orientation is set to Vertical):
Average: Returns the average of the Y values.
Sum: Returns the total of the Y values added together.
Maximum: Returns the highest Y value.
Minimum: Returns the lowest Y value.
Count: Returns the total number of Y values.
Field: The layer field to use as the Y values (when Orientation is set to Vertical).
Axis Label: Specify a label for the Y axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.
Multi-Field Groups: Displays the data grouped by multiple fields. For example, display the average rainfall for January, February, March, and so on. When this option is selected, the fields must be numerical.
Groups
Fields: The layer fields to use as the X values (when Orientation is set to Vertical).
To add a field:
In the Components panel, select Chart.
In the Charts panel, click +Add Field.
The Field window appears.
In the menu, select a Field.
Click Submit.
The field appears in the list of fields.
To edit a field:
In the Components panel, select Chart.
In the Chart panel, click the name of the field.
Change the field settings you want.
To reorder a field:
In the Components panel, select Chart.
In the Chart panel, click Edit Items.
Drag the field up or down to the position you want.
Click Done.
To delete a field:
In the Components panel, select Chart.
In the Chart panel, click Edit Items.
Click the Delete icon .
Click Done.
Statistic: The function to apply to the Y values (when Orientation is set to Vertical):
Average: Returns the average of the Y values.
Sum: Returns the total of the Y values added together.
Maximum: Returns the highest Y value.
Minimum: Returns the lowest Y value.
X Axis Label: Specify a label for the X axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.
Y Axis Label: Specify a label for the Y axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.
XY Plot: Plots the data as a series of X and Y values. For example, display the flow rate of fire hydrants depending on their installation date.
This option only appears when the Chart Type is either Line or Scatter Plot. This option requires that both fields are either numbers or dates.
X Value
Field: The layer field to use as the X values (when Orientation is set to Vertical).
Axis Label: Specify a label for the X axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.
Y Value
Field: The layer field to use as the Y values (when Orientation is set to Vertical).
Axis Label: Specify a label for the Y axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.
Advanced Mode
The advanced mode allows you to edit the code for both the Arcade script that generates the chart, as well as the Chart Definition JSON of the High Charts template that configures the appearance of the chart.
When you enter Advanced Mode, you will lose access to Designer's UI to easily configure most chart settings.
Arcade Script: To edit the raw Arcade Script used to transform results into chart data, click the Open Editor button. For more information, see ArcGIS Arcade.
If changes are made to the script such that it no longer matches a Designer chart template, you will not be able to exit advanced mode.
Chart Definition: To edit the raw High Charts template JSON used to configure the appearance of the chart, click the Open Editor button. For more information, see Highcharts JS API Reference.
If changes are made to the JSON configuration such that it no longer matches a Designer chart template, you will not be able to exit advanced mode. This includes specifying an unsupported chart type
or adding more than one object in the series
property.
Series Point Hover: The command to execute when the user hovers the cursor over a series point on the chart.
Series Point Hover End: The command to execute when the user moves the cursor away from a series point on the chart.
Series Point Click: The command to execute when the user clicks a series point on the chart.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
The Columns component is a layout component that can contain other components, each of which are displayed horizontally. For more information, see Columns.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Horizontal Alignment: Sets the horizontal position of any fixed-width components within. Has no visible effect on any component within whose width automatically grows to the size of the parent.
Vertical Alignment: Sets the vertical position of any fixed-height components within. Has no visible effect on any component within whose height automatically grows to the size of the parent.
Width: Specifies the width of the component. If Fixed Size is not selected, the width is an approximate percentage of the width of the parent component. If Fixed Size is selected, the width is in pixels and will not change when other component sizes are changed.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Resizable: Whether the user can resize the parts of the component.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Horizontal Alignment: Sets the horizontal position of any fixed-width components within. Has no visible effect on any component within whose width automatically grows to the size of the parent.
Vertical Alignment: Sets the vertical position of any fixed-height components within. Has no visible effect on any component within whose height automatically grows to the size of the parent.
Height: Specifies the height of the component. If Fixed Size is not selected, the height is an approximate percentage of the height of the parent component. If Fixed Size is selected, the height is in pixels and will not change when other component sizes are changed.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
Show Title: Whether or not to display the title of the component.
Show Icon: Whether to display the icon of the component.
The Geolocate component allows the user to locate their position on the map. You can configure the following settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Within each menu item, you can change the following:
Title: Type a title for this menu item.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select I want to....
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.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ { "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:
In the Components panel, select I want to....
In the Menu panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select I want to....
In the Menu panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select I want to....
In the Menu panel, click Edit Items.
Click the Delete icon .
Click Done.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
The Image component allows you to add an image, either by specifying an image URL or uploading an image.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Image Source: The image file to display.
The image file types supported are: GIF, JPG, JPEG, PNG, SVG and SVGZ.
Do one of the following:
Type the URL of the image you want to use.
Click Select File, select the image file you want to use, and click Open.
The Select File button only appears if the app has been saved at least once.
Alternative text: The alternative text to display if the image cannot be displayed.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
This section contains a list of the Inline views added to your app.
To add an Inline view:
In the Components panel, select Inline.
In the Inline panel, click +Add Inline Views.
A windows appears that lets you select Inline views to add.
Select the Inline views you want to add, and click Select.
The Inline views are added to your app.
Save the app.
Refresh the page.
To edit an Inline view:
In the Components panel, select Inline.
In the Inline panel, click the name of the Inline view.
To change the Inline view, click Select.
A windows appears that lets you select a different Inline view.
Select the Inline view you want, and click Select.
The Inline view is replaced.
Save the app.
Refresh the page.
To reorder an Inline view:
In the Components panel, select Inline.
In the Inline panel, click Edit Items.
Drag the Inline view up or down to the position you want.
Click Done.
Save the app.
Refresh the page.
To delete an Inline view:
In the Components panel, select Inline.
In the Inline panel, click Edit Items.
Click the Delete icon .
Click Done.
Save the app.
Refresh the page.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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:
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.
In the Toolbox panel, click the Other tab.
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.
Source: Select the layer or workflow from which to source the data for the KPI card.
If the app contains more than one map, layers appear with a (Map Title) suffix. For example, MyLayer (MyMap1), MyLayer (MyMap2).
Workflows are indicated with a (Workflow) suffix. If you select a workflow, you must be aware of the field names and types of the workflow's output.
If the workflow executes the kpi.display
command with results from a layer on your map, set the KPI card's Source to that layer instead of the workflow.
Statistic: The function to apply to the field values of selected features that determines the value to display in the KPI card.
Average: Returns the average of the field values.
Count: Returns the total number of field values.
Maximum: Returns the highest field value.
Minimum: Returns the lowest field value.
Sum: Returns the total of the field values added together.
Standard Deviation: Returns the standard deviation of the field values.
Field: The layer field to use as the values for the Statistic function.
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.
Value Expression: To edit the raw Arcade Script used to transform the results into the value for the KPI card, click Open Editor. For more information, see ArcGIS Arcade.
If changes are made to the script such that it no longer matches a Designer value expression template, you will not be able to exit advanced mode.
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.
Reference Type: There are a number of ways the reference
token can be calculated:
None: No reference
token is required.
Previous Value: Use the previous value of the value
token.
When Previous Value is selected, the value of the reference
token is only updated by the kpi.display
command, that is, when the KPI card is displayed; it is not affected by filtering, adding or removing results with the kpi.add-features
and kpi.remove-features
commands.
Fixed: Assign a static number to the reference
token.
Reference: The fixed number to assign the reference
token.
Statistic: Apply a function to the field values of selected features as the value for the reference
token.
Statistic: The function to apply to the field values of selected features that determines the value for the reference
token.
Average: Returns the average of the field values.
Count: Returns the total number of field values.
Maximum: Returns the highest field value.
Minimum: Returns the lowest field value.
Sum: Returns the total of the field values added together.
Standard Deviation: Returns the standard deviation of the field values.
Field: The layer field to use as the values for the Statistic function.
Advanced Mode
The advanced mode allows you to edit the code for the Arcade script that generates the value for the reference
token.
When you enter Advanced Mode, you will lose access to Designer's UI to easily configure the KPI card settings.
Value Expression: To edit the raw Arcade Script used to transform the results into the value for the reference
token, click Open Editor. For more information, see ArcGIS Arcade.
If changes are made to the script such that it no longer matches a Designer value expression template, you will not be able to exit advanced mode.
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).
These settings apply to the top part of the KPI card when no conditions are created or 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.
These settings apply to the middle part of the KPI card when no conditions are created or 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.
These settings apply to the bottom part of the KPI card when no conditions are created or 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.
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:
In the Components panel, select KPI Card.
In the KPI Card panel, click +Add Condition.
A window appears that lets you create a condition.
In the Expression box, type a conditional Arcade expression. Do not enclose the Arcade expression within curly braces. For example, value + reference > 0.
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.
Click Submit.
To edit a condition:
In the Components panel, select KPI Card.
In the KPI Card panel, click the name of the menu item.
Change the condition settings you want.
To reorder a menu item:
In the Components panel, select KPI Card.
In the KPI Card panel, click Edit Items.
Drag the condition up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select KPI Card.
In the KPI Card panel, click Edit Items.
Click the Delete icon .
Click Done.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Select the layer list settings for each layer:
Disable/Enable Included
: Click the icon to toggle whether this layer is included in the layer list.
This setting does not affect the layer's visibility on the map.
Open the layer : Click the arrow to open this layer's settings:
Included
: Toggles whether this layer is included in the layer list.
This setting does not affect the layer's visibility on the map.
Layer Actions: Configure the menu items in the menu beside each layer in the layer list.
Menu items have the following settings:
Title: Type a title for this menu item as it will appear in the layer menu.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select Layers.
In the Layer List panel, click +Add Menu Item.
A window appears that lets you select a command, workflow or report.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ "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:
In the Components panel, select Layers.
In the Layer List panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Layers.
In the Layer List panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Layers.
In the Layer List panel, click Edit Items.
Click the Delete icon .
Click Done.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Layer presets have the following settings:
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.
Open the layer : Click the arrow to open this layer's settings:
Visible
: Toggles 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 add a layer preset:
In the Components panel, select Layer Presets.
In the Layer Presets panel, click +Add Layer Preset.
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:
In the Components panel, select Layer Presets.
In the Layer Presets panel, click the name of the layer preset.
Change the layer preset settings you want.
To reorder a layer preset:
In the Components panel, select Layer Presets.
In the Layer Presets panel, click Edit Items.
Drag the layer preset up or down to the position you want.
Click Done.
To delete a layer preset:
In the Components panel, select Layer Presets.
In the Layer Presets panel, click Edit Items.
Click the Delete icon .
Click Done.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
A group of settings related to the map, its layers, context menu and start up event:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Web Map: Click Select, select a web map to use and click Select. You can search for a web map by name or portal item ID. You can search web maps you own, web maps shared with you or public web maps.
For a list of supported web maps , see 2D Web Map Support.
All basemaps, reference layers and base layers must use exactly the same spatial reference as the web map.
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 remove the web map, click Remove.
Use Esri Field Formatting: Whether to use the field formatting configured in the Esri portal or the formatting defined within Web Designer.
In the Esri portal, the field formatting settings are found within the layer's pop-up configuration.
In Web Designer, formatting settings are found within both the Region and Map component settings. Formatting settings in the Region service affect the entire app. Within the Map component, formatting can apply to an entire layer or an individual field.
Web Scene: Click Select, select a web scene to use and click Select. You can search for a web scene by name or portal item ID. You can search web scenes you own, web maps shared with you or public web scenes.
For a list of supported web scenes, see 3D Web Scene Support.
To remove the web scene, click Remove.
Default View: Determines whether to display the 2D web map or 3D web scene when the app starts.
This option is only available when you have configured both a web map and a web scene.
Configure Layers for: Switches between the 2D web map or 3D web scene for both the app preview and configuration settings.
This option is only available when you have configured both a web map and a web scene.
Add or remove layers for this map. You can also set the following on each layer:
Disable/Enable Identify : Click the icon to toggle the identify function for this layer.
Disable/Enable Search : Click the icon to toggle search for this layer.
Open the layer : Click the arrow to open the settings for this layer view its field extensions. Layers have the following settings:
Feature Actions
Feature actions set at this level only appear for features of this particular layer. To add a feature action for all features, see the Result Details, Results List, Results Table or Result Summary settings.
Menu items have the following settings:
Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select Map, and select the desired layer.
In the layer panel, click +Add Menu Item.
A window appears that lets you select a command, workflow or report.
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.
Reports: Select the report you want to run, and click Select. Alternatively, to create a new Report, click Create a new Report.
Click the new menu item to edit it.
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.
[ "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.
To edit a menu item:
In the Components panel, select Map, and select the desired layer.
In the layer panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Map, and select the desired layer.
In the layer panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Map, and select the desired layer.
In the layer panel, click Edit Items.
Click the Delete icon .
Click Done.
Field Extensions
Disable Search : Click the icon to disable search for this field extension
Open the Field Extension : Click the arrow to open the settings for this field. Fields have the following settings:
Searchable
: Click the icon to turn off searching of this field extension.
Task Settings
Identify
: Turn identifying on or off for this layer.
Search
: Turn search on or off for this layer.
Zoom Settings
Zoom Scale: Set the scale to which the map should zoom for results in this 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.
Display Settings
Icon: An image file to display as the layer icon. This icon appears in the layer list, result summary and results list.
The image file types supported are: JPG, JPEG, PNG and SVG.
Do one of the following:
Type the URL of the image you want to use.
Click Select File, select the image file you want to use, and click Open.
The Select File button only appears if the app has been saved at least once.
Formatting
Inherit Formatting : Turn inherited formatting options on or off.
Turn off Inherit Formatting to activate options to set custom formatting for this layer.
Date Format: Select the format of the date to use for this layer. The default is Date Time Short.
Number Format: Select the number format to use for numbers displayed by this layer. For more information on number formats, see Standard Numeric Format Strings. The default is Fixed Point. Select one of the following formats:
Number: A localized representation of a number with a decimal separator, group separator and optional negative sign. For example, in the en-us
locale: 12,345.67 or -42.
Fixed Point: A localized representation of a number with a decimal separator and optional negative sign. For example, in the en-us
locale: 12345.67 or -42.
Currency: A localized representation of a monetary amount in a specific currency. For example, in the en-us
locale: $123.45 for USD or £123.45 for GBP.
Accounting: A localized representation of a monetary amount in a specific currency except negative values are displayed in brackets. For example, in the en-us
locale, -$543.21 would be represented as: ($543.21) for USD.
Percent: A localized representation of a percentage. For example, in the en-us
locale, 0.99 would be represented as: 99%.
Custom: Use one or more numeric specifiers to define how to format numeric data. For more information, see Microsoft's Custom Numeric Format Strings.
Currency: Select the currency you want to use for this layer. The default is USD.
Fractional Digits: Type in the number of digits to appear after the decimal point in fractions. If you do not set a number, the default applied to currency units depends on the currency.
For a number format, the default applied is 4.
Failure Behavior
Layer Failure Action: Specify what Geocortex Web should do when this layer fails to load:
Halt Map Load: Stop loading the map and display an error.
Warn End User: Continue loading the map but warn the end user this layer failed to load.
Silent Failure: Continue loading the map and do not warn the user this layer failed to load.
Map Clicked: The command to run when the map is clicked or tapped. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Clicked, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Clicked, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Clicked, beside the current command, click .
Map Hovering: The command to run when the user begins to hover the mouse cursor over a location on the map. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Hovering, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Hovering, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Hovering, beside the current command, click .
Map Hovered: The command to run when the user finishes hovering the mouse cursor over a location on the map, that is, when the mouse cursor is no longer hovering over the location. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Hovered, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Hovered, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Hovered, beside the current command, click .
Map Initialized: The command to run the first time the map finishes loading. A command is an action the app should perform. The command runs again if the page is refreshed but not when switching between a 2D web map and a 3D web scene, or vice versa.
Some commands have additional settings you can configure.
The Map Initialized command runs after any commands are run via the Application Initializing and Application Initialized events configured in App settings and any Launch Link Workflow is run. To view the order in which initialization events occur, see Order of Initialization Events.
To add a command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Initialized, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Initialized, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Initialized, beside the current command, click .
Map Viewpoint Changed: The command to run when the map viewpoint changes, for example, when the user pans or zooms the map. A command is an action the app should perform.
Some commands have additional settings you can configure.
Any command for Map Viewpoint Changed should be considered carefully for performance reasons.
To add a command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Viewpoint Changed, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Viewpoint Changed, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Map.
If necessary, in the Map panel, click to expand the Events section.
Under Map Viewpoint Changed, beside the current command, click .
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:
Title: Type a title for this menu item. as it will appear in the context menu.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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.
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 add a menu item:
In the Components panel, select Map.
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.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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:
{ "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.
To edit a menu item:
In the Components panel, select Map.
In the Map panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Map.
In the Map panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Map.
In the Map panel, click Edit Items.
Click the Delete icon .
Click Done.
Maximum Scale: Set the maximum scale to which the map can be zoomed in.
Minimum Scale: Set the minimum scale to which the map can be zoomed out.
Rotation Enabled: Turn the ability to rotate the map on or off. When on, the map can be rotated using gestures on a touchscreen. The default is on.
Snap to Zoom: Turn the Snap to Zoom feature on or off. When on, and you zoom in or out, the map snaps to the closest incremental scale setting. The default is off.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
The Map Coordinates component displays the coordinates of the last position the cursor was over the map. You can configure the following settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Show Coordinate Formats: Allow the user to select the coordinate format to display.
Coordinate Format: The default coordinate format to display. The options are:
XY: The XY coordinate format.
Lat/Long DD: The Latitude/Longitude coordinate format in decimal degrees (°).
Lat/Long DDM: The Latitude/Longitude coordinate format in decimal degrees (°) minutes (').
Lat/Long DMS: The Latitude/Longitude coordinate format in decimal degrees (°) minutes (') seconds (").
MGRS: The Military Grid Reference System (MGRS) coordinate format.
USNG: The United States National Grid (USNG) coordinate format.
XY Decimal Places: The number of decimal places to display for the XY coordinate format.
Lat/Long Decimal Places: The number of decimal places to display for the Lat/Long coordinate formats.
MGRS Precision: The precision level to display for the Military Grid Reference System (MGRS) coordinate format.
USNG Precision: The precision level to display for the United States National Grid (USNG) coordinate format.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Horizontal Alignment: Sets the horizontal position of any fixed-width components within. Has no visible effect on any component within whose width automatically grows to the size of the parent.
Vertical Alignment: Sets the vertical position of any fixed-height components within. Has no visible effect on any component within whose height automatically grows to the size of the parent.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Show Close Button: Whether to display the close button to close the component.
Show Back Button: Whether to display the back button to navigate backwards.
Show Maximize Button: Whether to display the maximize button to maximize the component.
Show Minimize Button: Whether to display the minimize button to minimize the component.
Initial State: Specifies the initial state of the component. Select either: Default, Minimized or Maximized.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Add print templates for the user to select. Print templates are created with Geocortex Printing. Each print template has the following settings:
Title: The title to display for the print template.
Template: The URL of the print template.
To add a print template:
In the Components panel, select Printing.
In the Print panel, click +Add Print Templates.
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.
Click Select.
To edit a print template:
In the Components panel, select Printing.
In the Print panel, click the title of the print template.
Change the print template settings you want.
To reorder a print template:
In the Components panel, select Printing.
In the Print panel, click Edit Items.
Drag the print template up or down to the position you want.
Click Done.
To delete a print template:
In the Components panel, select Printing.
In the Print panel, click Edit Items.
Click the Delete icon .
Click Done.
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:
Name: The display name of the spatial reference grid.
WKID: The Well-Known ID (WKID) that identifies the spatial reference to use for the grid.
Well-Known Text: The Well-Known Text (WKT) that identifies the spatial reference to use for the grid.
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:
In the Components panel, select Printing.
Click +Add Grid.
In the Name box, type a display name for the spatial reference grid.
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:
In the Components panel, select Printing.
In the Print panel, click the title of the spatial reference grid.
Change the spatial reference grid settings you want.
To reorder a spatial reference grid:
In the Components panel, select Printing.
In the Print panel, click Edit Items.
Drag the spatial reference grid up or down to the position you want.
Click Done.
To delete a spatial reference grid:
In the Components panel, select Printing.
In the Print panel, click Edit Items.
Click the Delete icon .
Click Done.
Add resolutions for the user to select in which to print the map. Each resolution has the following setting:
To add a resolution:
In the Components panel, select Printing.
In the Resolution panel, click +Add Resolution.
In the DPI box, type a number representing the Dots Per Inch (DPI) resolution.
Click Select.
To edit a resolution:
In the Components panel, select Printing.
In the Resolution panel, click the title of the resolution.
Change the resolution settings you want.
To reorder a resolution:
In the Components panel, select Printing.
In the Resolution panel, click Edit Items.
Drag the resolution up or down to the position you want.
Click Done.
To delete a resolution:
In the Components panel, select Printing.
In the Resolution panel, click Edit Items.
Click the Delete icon .
Click Done.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
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:
Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select Result Details.
In the Result Details panel, click +Add Menu Item.
A window appears that lets you select a command, workflow or report.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ "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.
To edit a menu item:
In the Components panel, select Result Details.
In the Result Details panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Result Details.
In the Result Details panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Result Details.
In the Result Details panel, click Edit Items.
Click the Delete icon .
Click Done.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Result Added: The command to run when a result is added to the Result Details panel, for example, from a search or identify operation. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Added, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Details.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Result Removed: The command to run when a result is removed from the Result Details panel, for example, when the user clicks Remove Result(s). A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Removed, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Related Record Clicked: The command to run when the user clicks a related record.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Related Record Clicked, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Related Record Clicked, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Details.
If necessary, in the Results panel, click to expand the Events section.
Under Related Record Clicked, beside the current command, click .
Result Shown: The command to run when a result in the Result Details panel becomes the actively displayed result. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Shown, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Result Hidden: The command to run when a result in the Result Details panel no longer becomes the actively displayed result because the user views the previous or next result. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Hidden, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Details.
If necessary, in the Result Details panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
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:
Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
Hide when Disabled: Whether to hide the menu item when the command cannot be executed.
To add a menu item:
In the Components panel, select Result Summary.
In the Result Summary panel, click +Add Menu Item.
A window appears that lets you select a command, workflow or report.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ "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:
In the Components panel, select Result Summary.
In the Result Summary panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Result Summary.
In the Result Summary panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Result Summary.
In the Result Summary panel, click Edit Items.
Click the Delete icon .
Click Done.
Result Added: The command to run when a result is added to the Result Summary. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Added, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Result Removed: The command to run when a result is removed from the Result Summary. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Removed, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Result Clicked: The command to run when the user clicks a result in the Result Summary. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Clicked, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Clicked, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Clicked, beside the current command, click .
Result Shown: The command to run when a previously hidden result in the Results List panel is displayed, for example, when the filters are removed. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Shown, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Result Hidden: The command to run when a result is hidden from the Result Summary, for example, when a filter is applied. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Hidden, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Result Summary.
If necessary, in the Result Summary panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
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:
Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select Results.
In the Results panel, click +Add Menu Item.
A window appears that lets you select a command, workflow or report.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ "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.
To edit a menu item:
In the Components panel, select Results.
In the Results panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Results.
In the Results panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Results.
In the Results panel, click Edit Items.
Click the Delete icon .
Click Done.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Result Clicked: The command to run when the user clicks a result in the Results List. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Clicked, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Clicked, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Clicked, beside the current command, click .
Result Added: The command to run when a result is added to the Results List, for example, from a search or identify operation. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Result Removed: The command to run when a result is removed from the Results List. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Removed, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Result Shown: The command to run when a previously hidden result in the Results List panel is displayed, for example, when the filters are removed. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Shown, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Result Hidden: The command to run when a result is hidden from the Results List, for example, when a filter is applied. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hidden, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Result Hovering: The command to run when the user begins to hover the mouse cursor over a result in the Results List. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovering, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovering, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovering, beside the current command, click .
Result Hovered: The command to run when the user finishes hovering the mouse cursor over a result in the Results List, that is, when the mouse cursor is no longer hovering over the result. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovered, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovered, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovered, beside the current command, click .
Result Selected: The command to run when the user selects a result in the Results List. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Selected, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Selected, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Selected, beside the current command, click .
Result Deselected: The command to run when the user deselects a result in the Results List. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Deselected, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Deselected, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Deselected, beside the current command, click .
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
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.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
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:
Title: Type a title for this menu item as it will appear in the Result Details, Results List and Results Table panels.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select Results.
In the Results panel, click +Add Menu Item.
A window appears that lets you select a command, workflow or report.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ "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.
To edit a menu item:
In the Components panel, select Results.
In the Results panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Results.
In the Results panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Results.
In the Results panel, click Edit Items.
Click the Delete icon .
Click Done.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Result Clicked: The command to run when the user clicks a result in the Results Table. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Clicked, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Clicked, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Clicked, beside the current command, click .
Result Added: The command to run when a result is added to the Results Table, for example, from a search or identify operation. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Added, beside the current command, click .
Result Removed: The command to run when a result is removed from the Results Table. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Removed, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Removed, beside the current command, click .
Result Shown: The command to run when a previously hidden result in the Results Table panel is displayed, for example, when the filters are removed. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Shown, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Shown, beside the current command, click .
Result Hidden: The command to run when a result is hidden from the Results Table, for example, when a filter is applied. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hidden, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hidden, beside the current command, click .
Result Hovering: The command to run when the user begins to hover the mouse cursor over a result in the Results Table. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovering, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovering, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovering, beside the current command, click .
Result Hovered: The command to run when the user finishes hovering the mouse cursor over a result in the Results Table, that is, when the mouse cursor is no longer hovering over the result. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovered, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovered, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Hovered, beside the current command, click .
Result Selected: The command to run when the user selects a result in the Results Table. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Selected, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Selected, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Selected, beside the current command, click .
Result Deselected: The command to run when the user deselects a result in the Results Table. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Deselected, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Deselected, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Results.
If necessary, in the Results panel, click to expand the Events section.
Under Result Deselected, beside the current command, click .
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
The Rows component is a layout component that can contain other components, each of which are displayed vertically. For more information, see Rows.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Horizontal Alignment: Sets the horizontal position of any fixed-width components within. Has no visible effect on any component within whose width automatically grows to the size of the parent.
Vertical Alignment: Sets the vertical position of any fixed-height components within. Has no visible effect on any component within whose height automatically grows to the size of the parent.
Height: Specifies the height of the component. If Fixed Size is not selected, the height is an approximate percentage of the height of the parent component. If Fixed Size is selected, the height is in pixels and will not change when other component sizes are changed.
/
: Click to toggle whether the Width or Height of the component is unlocked
or locked
. When a size is locked, it will not change when other component sizes are changed. This setting only appears when there are three or more components whose sizes are not fixed.
Fixed Size: Whether the Width or Height of the component is a percentage relative to the size of the parent component or a fixed size in pixels. If Fixed Size is selected, the size will not change when other component sizes are changed.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Resizable: Whether the user can resize the parts of the component.
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:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Style: Select the style of the line to display the scale bar. You can select either Line or a Ruler. The default is Line.
Line scale bar (left); Ruler scale bar (right)
Show Dual Units: Whether to display both Metric and Imperial units. This setting is only available when the scale bar's Style is set to Line.
Line scale bar with dual units
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
The Scale Input component allows the user to select the scale at which to display the map. You can configure the following settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
Set the following options for searches in your app:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Maximum Results: Type in the maximum number of search results to display on a single page. The default is set to 50.
Maximum Search Suggestions: Type in the maximum number of search suggestions to offer a user. The default is 6.
Geocoder Enabled: Whether to use the geocoder as part of the search results. The default is true.
Search Cleared: The command to run when the user clears the search box. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Search.
If necessary, in the Search panel, click to expand the Events section.
Under Search Cleared, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Search.
If necessary, in the Search panel, click to expand the Events section.
Under Search Cleared, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Search.
If necessary, in the Search panel, click to expand the Events section.
Under Search Cleared, beside the current command, click .
Search: The command to run when the user performs a search. A command is an action the app should perform.
Some commands have additional settings you can configure.
To add a command:
In the Components panel, select Search.
If necessary, in the Search panel, click to expand the Events section.
Under Search, click +Add Command.
A window appears that lets you select a command, workflow or report.
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.
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 change the command:
In the Components panel, select Search.
If necessary, in the Search panel, click to expand the Events section.
Under Search, beside the current command, click .
Select a command and click Submit.
To delete the command:
In the Components panel, select Search.
If necessary, in the Search panel, click to expand the Events section.
Under Search, beside the current command, click .
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.
Set the following options for Search This Area button in your app, which appears when you pan the map after obtaining search results:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
The Tabs component is a layout component that can contain other components, each of which are displayed within tabs. For more information, see Tabs.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Horizontal Alignment: Sets the horizontal position of any fixed-width components within. Has no visible effect on any component within whose width automatically grows to the size of the parent.
Vertical Alignment: Sets the vertical position of any fixed-height components within. Has no visible effect on any component within whose height automatically grows to the size of the parent.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Controls the content of the Home panel.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Text: Type the content you want to appear. You can include rich content, as this setting supports the original Markdown syntax.
You can include an image by typing something similar to the following: 
Horizontal Alignment: Sets the horizontal position of any fixed-width components within. Has no visible effect on any component within whose width automatically grows to the size of the parent.
Vertical Alignment: Sets the vertical position of any fixed-height components within. Has no visible effect on any component within whose height automatically grows to the size of the parent.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
You can change any item on the Toolbar menu, add custom items to the menu or delete those you do not want.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Under each menu item, you can change the following:
Title: Type a title for this menu item.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select Toolbar.
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.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ { "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:
In the Components panel, select Toolbar.
In the Menu panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select Toolbar.
In the Menu panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select Toolbar.
In the Menu panel, click Edit Items.
Click the Delete icon .
Click Done.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Orientation: Whether the component is oriented horizontally or vertically.
The User component allows the user to sign in and out of the app. The User component can contain other components.
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
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:
Title: Type a title for this menu item.
Description: Type a description of what this menu item does. If you don't want a description of the menu item, leave it blank.
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.
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 add a menu item:
In the Components panel, select User.
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.
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.
Reports: Select the report you want to run, and click Select.
Click the new menu item to edit it.
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.
[ { "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:
In the Components panel, select User.
In the Menu panel, click the name of the menu item.
Change the menu item settings you want.
To reorder a menu item:
In the Components panel, select User.
In the Menu panel, click Edit Items.
Drag the menu item up or down to the position you want.
Click Done.
To delete a menu item:
In the Components panel, select User.
In the Menu panel, click Edit Items.
Click the Delete icon .
Click Done.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
This component offers end users the following app display options:
Compact View: Reduces the padding of user interface elements when enabled, allowing more information to be displayed before needing to scroll, which may better suit desktop displays.
Measurement System: Sets the measurement units of the app to be one of the following:
Browser Locale: Uses the web browser's locale settings to automatically set the units of measurement.
Metric: Sets the app to use metric units of measurement.
US Customary: Sets the app to use imperial units of measurement.
This setting overrides the Measurement System setting configured in Region Settings.
Theme: Apply an overall background color scheme. From the drop-down list, select either Light or Dark, which are the themes included by default.
This setting overrides the Color Theme setting configured in Branding Settings.
In Designer, you can configure the following User Preferences component settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
The Workflow component hosts a workflow form. You can configure the following settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
The workflow to host.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
The Zoom component allows the user to zoom in and out of the map by pressing buttons. You can configure the following settings:
Title: Type a title to display for the component. This title is used both in GXW and Designer.
Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.
Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.
This setting only appears when the component is within the Map component.
Margin (px): The margin space around the component in pixels.
Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show
command.
Button Style: The style of the button. Choose either Rounded or Square.
Map: The Map component this component affects. This setting cannot be modified if this component is either a subcomponent of a Map component or there is only a single Map component in the app.