Template
Command Description
INSERT DESCRIPTION
Parameters
| Name | Description | Type |
|---|---|---|
name |
description | type |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
AddBookmark
Command Description
Bookmarks the current extent with the given name.
Parameters
| Name | Description | Type |
|---|---|---|
name |
The name of the bookmark to add. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.0 or later
Alert
Command Description
Displays an alert dialog.
Parameters
| Name | Description | Type |
|---|---|---|
message |
The body of the alert. | String |
title |
The title of the alert dialog box. | String |
callback |
An optional callback to fire when the alert is dismissed. | ? |
Supported in...
- Hyperlink
- Geocortex Viewer for HTML5 1.0 or later
AttachFileToFeature
Command Description
Checks for HTML5 FileReader / Cordova support before invoking a dialog that allows users to attach files to a feature.
Parameters
| Name | Description | Type |
|---|---|---|
feature |
The Geocortex feature to attach the file to. | ? |
Supported in...
- Hyperlink
- Geocortex Viewer for HTML5 1.3 or later
ChangeEditLogEntry
Command Description
Changes an existing edit log entry using an updated version of the feature edit that it represents.
Parameters
| Name | Description | Type |
|---|---|---|
arg |
An object with the following members: mapService, feature, oldEditLogEntry, successCallback, errorCallback. |
Object |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.2 or later
ClearCharts
Command Description
Removes the highlights from the charting highlight layer.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink:
<a href="command:ClearCharts">Clear Chart Highlight</a> - Geocortex Viewer for HTML5 2.3 or later
ClearFeatureInformation
Command Description
Clear the information stored within RelatedFeaturesView and RelatedFeaturesViewModel (for example, which features are currently open).
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.3 or later
ClearSelection
Command Description
Clears the open identify results/selection.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
CloseFeatureSetCollection
Command Description
Closes the feature set collection with the given ID.
Parameters
| Name | Description | Type |
|---|---|---|
fscId |
The ID of the feature set collection to close. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
Confirm
Command Description
Displays a confirmation message
Parameters
| Name | Description | Type |
|---|---|---|
message |
The body of the confirmation. | String |
title |
The title of the confirmation dialog box. | String |
callback |
An optional callback to fire with the result of the confirm (True or False). |
? |
Supported in...
- Hyperlink
- Geocortex Viewer for HTML5 1.0 or later
CreateAttachment
Command Description
Creates a feature attachment.
Parameters
| Name | Description | Type |
|---|---|---|
args |
An object with the following members: mapService, layer, feature, featureUrl, filename, contentType, payload, successCallback, errorCallback |
Object |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
CreateFeature
Command Description
Creates a new feature. If the application is offline, the feature will be created in the edit log to be synced at a late date.
Parameters
| Name | Description | Type |
|---|---|---|
arg |
An object with the following members: mapService, feature, successCallback, errorCallback. |
Object |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
CreateRelatedRecord
Command Description
Creates a related table record.
Parameters
| Name | Description | Type |
|---|---|---|
arg |
An object with the following members: mapService, layer, feature, relatedFeature, relationshipOrigin, relationshipDestination, successCallback, errorCallback. |
Object |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
DeleteFeature
Command Description
Deletes a feature. If the application is offline, a deletion is added to the edit log, unless the feature is new and unsynchronized, in which case the creation edit and any subsequent update entries are deleted.
Parameters
| Name | Description | Type |
|---|---|---|
arg |
An object with the following members: mapService, feature, successCallback, errorCallback. |
Object |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
DeleteFromEditLog
Command Description
Removes the given entry from the edit log, then saves the edit log.
Parameters
| Name | Description | Type |
|---|---|---|
editLogEntry |
The edit log entry to remove. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
DeleteRelatedRecord
Command Description
Deletes a related table record.
Parameters
| Name | Description | Type |
|---|---|---|
arg |
An object with the following members: mapService, layer, feature, relatedFeature, relationshipOrigin, relationshipDestination, successCallback, errorCallback. |
Object |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
DisplayChartById
Command Description
Opens the specified chart in the Charting View.
Parameters
| Name | Description | Type |
|---|---|---|
chartId |
The chart ID. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.3 or later
FSMCollectionSetCommand
FSMCollectionSetCommandCommand Description
Set the preferred command to open the FeatureSetCollection for the given source name.
Parameters
| Name | Description | Type |
|---|---|---|
sourceName |
The source name whose command you want to change. | String |
commandName |
The command to run for the source name. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.2 until deprecated in 2.4
HideFeatureTemplatePicker
Command Description
Hides the feature template picker used to created new features.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.3 or later
OpenFeatureSetCollection
Command Description
Opens the feature set collection with the given ID.
Parameters
| Name | Description | Type |
|---|---|---|
fscId |
The ID of the feature set collection to open. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
Prompt
Command Description
Displays a prompt dialog.
Parameters
| Name | Description | Type |
|---|---|---|
title |
The title of the prompt dialog box. | String |
description |
The text description to show in the prompt. | String |
defaultText |
The default text that will appear in the input text box. | String |
callback |
An optional callback to fire if the window was closed without clicking OK or Cancel. | ? |
Supported in...
- Hyperlink
- Geocortex Viewer for HTML5 1.0 or later
RemoveBookmark
Command Description
Removes the bookmark with the specified name.
Parameters
| Name | Description | Type |
|---|---|---|
name |
The name of the bookmark to remove. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.0 or later
RemoveChartById
Command Description
Removes the specified chart from the Charting View.
Parameters
| Name | Description | Type |
|---|---|---|
chartId |
The chart ID. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.3 or later
RemoveCollection
RemoveCollectionCommand Description
Removes a specified feature set collection from the feature set manager.
Parameters
| Name | Description | Type |
|---|---|---|
fsc |
The feature set collection to remove. | geocortex.essentialsHtmlViewer.mapping.infrastructure.featureSetCollection |
Supported in...
- Hyperlink
- Geocortex Viewer for HTML5 1.0 until deprecated in 1.2
RemoveCollectionById
RemoveCollectionByIdCommand Description
Removes a specified feature set collection from the feature set manager.
Parameters
| Name | Description | Type |
|---|---|---|
id |
The ID of the feature set collection to remove. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.0 until deprecated in 1.2
RemoveFeatureSetCollection
Command Description
Removes a specified feature set collection from the feature set manager.
Parameters
| Name | Description | Type |
|---|---|---|
fsc |
The feature set collection to remove. | geocortex.essentialsHtmlViewer.mapping.infrastructure.featureSetCollection |
Supported in...
- Hyperlink
- Geocortex Viewer for HTML5 1.2 or later
RemoveFeatureSetCollectionById
Command Description
Removes a specified feature set collection from the feature set manager.
Parameters
| Name | Description | Type |
|---|---|---|
fscId |
The ID of the feature set collection to remove. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.2 or later
ScreenReaderNarrate
Command Description
If a user has screen reader software enabled, then the provided string is immediately spoken to them.
Parameters
| Name | Description | Type |
|---|---|---|
inputText |
A string that will be spoken to the user. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
SelectBaseMap
Command Description
Selects the specified base map or base map group and makes it visible. All other base maps are faded out.
Parameters
| Name | Description | Type |
|---|---|---|
basemapName |
The name of the base map or base map group to switch to. To specify a base map, use the map service's short display name if it has one; otherwise use the map service's display name. For a base map group, use the group's name. | String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.0 or later
SetCollectionOfInterest
Command Description
Sets the feature set collection of interest that will be used to generate data for charts.
Parameters
| Name | Description | Type |
|---|---|---|
fscId |
The ID of the FeatureSetCollection for which to display charts. |
? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.3 or later
SetEditLog
Command Description
Sets the edit log, passing it into a callback. If an error occurs, the error is passed into the callback.
Parameters
| Name | Description | Type |
|---|---|---|
editLog |
An array of edit logs to set. | ? |
errorCallback |
A callback to execute when an error occurs. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
SetFeatureDetailsMode
Command Description
Creates and displays the Feature Details dialog for the feature in the specified view mode. If the feature is not specified, details for the last feature will be displayed.
Parameters
| Name | Description | Type |
|---|---|---|
args |
A string specifying the view mode, or a configuration object with two properties: viewMode and feature. If the feature is not specified, details for the last feature will be displayed. The feature is an instance of geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature. |
String |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
ShowAddBookmark
Command Description
Displays a dialog box to create a bookmark for the current map extent. The bookmark is added to the Bookmarked Locations menu. This command only works when the Bookmark's Module's bookmarksEnabled and showBookmarksButton properties are set to True.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
ShowAccessibilityView
Command Description
Activates the accessibility view.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink:
<a href="command:ShowAccessibilityView">Show Accessibility View</a> - Geocortex Viewer for HTML5 2.5 or later
ShowBookmarks
Command Description
Displays the Bookmarked Locations menu. This command only works when the bookmarksEnabled property is set to True.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink:
<a href="command:ShowBookmarks">Show Bookmarks</a> - Geocortex Viewer for HTML5 2.0 or later
ShowChartingView
Command Description
Activates the Charting View.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink:
<a href="command:ShowChartingView">Show Charts</a> - Geocortex Viewer for HTML5 2.3 or later
ShowExportMapDialog
Command Description
Displays a dialog to save a map image.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink:
<a href="command:ShowExportMapDialog">Export Map Image</a> - Geocortex Viewer for HTML5 2.4 or later
ShowFeatureDetails
Command Description
Creates and displays the feature details for the specified feature or feature set collection.
Note: In order to use this command in a workflow, you must use the ID of the feature set collection as the parameter.
Parameters
| Name | Description | Type |
|---|---|---|
arg |
The feature, or the ID of the feature set collection in context. | geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.1 or later
ShowFeatureDetailsCompact
Command Description
Creates and displays the Feature Details dialog for the feature in Compact View mode. If the feature is not specified, details for the last feature will be displayed.
Parameters
| Name | Description | Type |
|---|---|---|
feature |
A feature for which to show the feature details. | geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
ShowFeatureDetailsExpanded
Command Description
Creates and displays the Feature Details for the feature in Expanded View mode. If the feature is not specified, details for the last feature will be displayed.
Parameters
| Name | Description | Type |
|---|---|---|
feature |
A feature for which to show the feature details. | geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later
ShowFeatureParentDetails
Command Description
Shows the previously opened feature when browsing related features in the features details view.
Parameters
None
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.3 or later
ShowFeatureTemplatePicker
Command Description
Shows the feature template picker used to create new features. If a feature layer is supplied, shows the templates for the feature layer.
Parameters
| Name | Description | Type |
|---|---|---|
layer |
A feature layer for which to display templates. (Optional) | String |
relatedFeature |
An Esri feature with the information needed to create a related feature. | ? |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 1.2 or later
ShowResultList
Command Description
Displays the list of features in the given FeatureSetCollection as a list.
Note: In order to use this command in a workflow, you must use the ID of the FeatureSetCollection as the parameter.
Parameters
| Name | Description | Type |
|---|---|---|
fsc |
The FeatureSetCollection to show results for or the ID of the FeatureSetCollection. |
geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Geocortex Viewer for HTML5 1.1 or later
StartEditingNewRelatedRecord
Command Description
Used to start the process for creating a new related record/feature. Is is activated by clicking Create A New Related Record in the related feature details view.
Parameters
| Name | Description | Type |
|---|---|---|
item |
A RelatedLayerEntry object with the following properties: id, text, relatedFeature, essentialsRelatedFeature (optional), feature (optional), editable, and relationship. |
RelatedLayerEntry |
isNew |
A boolean value indicating whether the record is new or not. | Boolean |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.3 or later
Template
Command Description
INSERT DESCRIPTION
Parameters
| Name | Description | Type |
|---|---|---|
name |
description | type |
Supported in...
- Geocortex Workflow Designer: Run External Command
- Hyperlink
- Geocortex Viewer for HTML5 2.4 or later