Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Callable

  • __call(commandName: "ActivateBuffering"): TypedCommand<function>
  • __call(commandName: "ActivateBufferingAndDisplayOptions"): TypedCommand<function>
  • __call(commandName: "ActivateContainersForWorkflow"): TypedCommand<function>
  • __call(commandName: "ActivateContextMenu"): TypedCommand<function>
  • __call(commandName: "ActivateEventCopyView"): TypedCommand<function>
  • __call(commandName: "ActivateEditCollaborationEventMessageView"): TypedCommand<function>
  • __call(commandName: "ActivateEditCollaborationFeatureMessageView"): TypedCommand<function>
  • __call(commandName: "ActivateHomePanel"): TypedCommand<function>
  • __call(commandName: "ActivatePlotCoordinatesView"): TypedCommand<function>
  • __call(commandName: "ActivateSelectLayersForIdentify"): TypedCommand<function>
  • __call(commandName: "ApplyFilterControlQuery"): TypedCommand<function>
  • __call(commandName: "ApplyEdits"): TypedCommand<function>
  • __call(commandName: "DeactivateSelectLayersForIdentify"): TypedCommand<function>
  • __call(commandName: "ActivateSelectLayersForSnapping"): TypedCommand<function>
  • __call(commandName: "DeactivateSelectLayersForSnapping"): TypedCommand<function>
  • __call(commandName: "ActivateSnapping"): TypedCommand<function>
  • __call(commandName: "DeactivateSnapping"): TypedCommand<function>
  • __call(commandName: "ActivateTransientElements"): TypedCommand<function>
  • __call(commandName: "AddBookmark"): TypedCommand<function>
  • __call(commandName: "AddClusterLayer"): TypedCommand<function>
  • __call(commandName: "AddCollaborationFeatures"): TypedCommand<function>
  • __call(commandName: "AddFeatureToStarredSelection"): TypedCommand<function>
  • __call(commandName: "AddFeatureSetToStarredSelection"): TypedCommand<function>
  • __call(commandName: "AddFeatureToResults"): TypedCommand<function>
  • __call(commandName: "AddFeatureToResultsAtIndex"): TypedCommand<function>
  • __call(commandName: "AddHeatMap"): TypedCommand<function>
  • __call(commandName: "AddMarker"): TypedCommand<function>
  • __call(commandName: "AddMarkup"): TypedCommand<function>
  • __call(commandName: "AddMarkupFeature"): TypedCommand<function>
  • __call(commandName: "AddMarkupGeometry"): TypedCommand<function>
  • __call(commandName: "AddPushpin"): TypedCommand<function>
  • __call(commandName: "AddPushpins"): TypedCommand<function>
  • __call(commandName: "AddResultsStatus"): TypedCommand<function>
  • __call(commandName: "AutoJoinCollaborationRoom"): TypedCommand<function>
  • __call(commandName: "AddQueryStatus"): TypedCommand<function>
  • __call(commandName: "AddFilterStatus"): TypedCommand<function>
  • __call(commandName: "RemoveQueryStatus"): TypedCommand<function>
  • __call(commandName: "RemoveFilterStatus"): TypedCommand<function>
  • __call(commandName: "AddStatus"): TypedCommand<function>
  • __call(commandName: "AddTextMarkup"): TypedCommand<function>
  • __call(commandName: "AddTemporaryMarkupGeometry"): TypedCommand<function>
  • __call(commandName: "RippleClick"): TypedCommand<function>
  • __call(commandName: "ToggleRippleClick"): TypedCommand<function>
  • __call(commandName: "DisableRippleClick"): TypedCommand<function>
  • __call(commandName: "EnableRippleClick"): TypedCommand<function>
  • __call(commandName: "Alert"): TypedCommand<function>
  • __call(commandName: "AttachFileToFeature"): TypedCommand<function>
  • __call(commandName: "BroadcastCurrentViewpoint"): TypedCommand<function>
  • __call(commandName: "BufferGeometry"): TypedCommand<function>
  • __call(commandName: "CancelEditCoordinate"): TypedCommand<function>
  • __call(commandName: "CancelSearch"): TypedCommand<function>
  • __call(commandName: "ChangeMarkupStyle"): TypedCommand<function>
  • __call(commandName: "ClearActiveTool"): TypedCommand<function>
  • __call(commandName: "ClearChartHighlights"): TypedCommand<function>
  • __call(commandName: "ClearCharts"): TypedCommand<function>
  • __call(commandName: "ClearCollaborationDrawings"): TypedCommand<function>
  • __call(commandName: "ClearCollaborationFeatures"): TypedCommand<function>
  • __call(commandName: "ClearDefaultHighlights"): TypedCommand<function>
  • __call(commandName: "ClearFeatureInformation"): TypedCommand<function>
  • __call(commandName: "ClearHighlights"): TypedCommand<function>
  • __call(commandName: "ClearMarkup"): TypedCommand<function>
  • __call(commandName: "ClearMarkupQuiet"): TypedCommand<function>
  • __call(commandName: "ClearCustomGraphics"): TypedCommand<function>
  • __call(commandName: "ClearSearch"): TypedCommand<function>
  • __call(commandName: "ClearSelection"): TypedCommand<function>
  • __call(commandName: "ClearStarredSelection"): TypedCommand<function>
  • __call(commandName: "ClearStorageForApplication"): TypedCommand<function>
  • __call(commandName: "ClearStorageForDomain"): TypedCommand<function>
  • __call(commandName: "ClearTemporaryMarkup"): TypedCommand<function>
  • __call(commandName: "ClearTrustedUrls"): TypedCommand<function>
  • __call(commandName: "CloseBottomRegion"): TypedCommand<function>
  • __call(commandName: "CloseDataFrame"): TypedCommand<function>
  • __call(commandName: "CloseFeatureSetCollection"): TypedCommand<function>
  • __call(commandName: "CloseResultsFrame"): TypedCommand<function>
  • __call(commandName: "CloseOverviewMap"): TypedCommand<function>
  • __call(commandName: "CollaborationDraw"): TypedCommand<function>
  • __call(commandName: "CollaborationDrawText"): TypedCommand<function>
  • __call(commandName: "Confirm"): TypedCommand<function>
  • __call(commandName: "ConsoleDir"): TypedCommand<function>
  • __call(commandName: "CopyCollaborationEvent"): TypedCommand<function>
  • __call(commandName: "CreateAttachment"): TypedCommand<function>
  • __call(commandName: "CreateCollaborationEvent"): TypedCommand<function>
  • __call(commandName: "CreateCollaborationRoom"): TypedCommand<function>
  • __call(commandName: "CreateFeature"): TypedCommand<function>
  • __call(commandName: "CreateGraphicsInMemory"): TypedCommand<function>
  • __call(commandName: "CreateHighlightLayer"): TypedCommand<function>
  • __call(commandName: "CreateMarkupStyleView"): TypedCommand<function>
  • __call(commandName: "CreateSelection"): TypedCommand<function>
  • __call(commandName: "CreateOrEditFeatureFromBarcodeScan"): TypedCommand<function>
  • __call(commandName: "CreateRelatedRecord"): TypedCommand<function>
  • __call(commandName: "CutFeatureInteractive"): TypedCommand<function>
  • __call(commandName: "CutGraphicsInMemory"): TypedCommand<function>
  • __call(commandName: "DeactivateBuffering"): TypedCommand<function>
  • __call(commandName: "DeactivateBufferingAndDismissOptions"): TypedCommand<function>
  • __call(commandName: "DeactivateContainersForWorkflow"): TypedCommand<function>
  • __call(commandName: "DeactivateContextMenu"): TypedCommand<function>
  • __call(commandName: "DeleteAttachments"): TypedCommand<function>
  • __call(commandName: "DeleteAllCoordinates"): TypedCommand<function>
  • __call(commandName: "DeleteCoordinates"): TypedCommand<function>
  • __call(commandName: "EditCoordinate"): TypedCommand<function>
  • __call(commandName: "DeleteFeature"): TypedCommand<function>
  • __call(commandName: "DeleteGraphicsInMemory"): TypedCommand<function>
  • __call(commandName: "DeleteFromEditLog"): TypedCommand<function>
  • __call(commandName: "DeleteMarkup"): TypedCommand<function>
  • __call(commandName: "DeleteMeasurement"): TypedCommand<function>
  • __call(commandName: "DeleteProject"): TypedCommand<function>
  • __call(commandName: "DeleteSelection"): TypedCommand<function>
  • __call(commandName: "DeleteRelatedRecord"): TypedCommand<function>
  • __call(commandName: "DisableMapClick"): TypedCommand<function>
  • __call(commandName: "DisableMapKeyboardNavigation"): TypedCommand<function>
  • __call(commandName: "DisableMapTips"): TypedCommand<function>
  • __call(commandName: "DisablePushpins"): TypedCommand<function>
  • __call(commandName: "DisplayBufferOptions"): TypedCommand<function>
  • __call(commandName: "DisplayChartById"): TypedCommand<function>
  • __call(commandName: "DisplayDockedExternalComponentById"): TypedCommand<function>
  • __call(commandName: "DisplayNotification"): TypedCommand<function>
  • __call(commandName: "DisplayUndockedExternalComponentById"): TypedCommand<function>
  • __call(commandName: "DisplayWorkflowContainerContent"): TypedCommand<function>
  • __call(commandName: "EditCollaborationEvent"): TypedCommand<function>
  • __call(commandName: "EditCollaborationMarkupMessage"): TypedCommand<function>
  • __call(commandName: "ShowEditCollaborationMessageView"): TypedCommand<function>
  • __call(commandName: "ShowEditCollaborationGraphicMessageView"): TypedCommand<function>
  • __call(commandName: "EditCollaborationRoom"): TypedCommand<function>
  • __call(commandName: "EditMarkup"): TypedCommand<function>
  • __call(commandName: "EnableAllLayersForIdentify"): TypedCommand<function>
  • __call(commandName: "EraseMarkupEvent"): TypedCommand<function>
  • __call(commandName: "DisableAllLayersForIdentify"): TypedCommand<function>
  • __call(commandName: "EnableLayerForIdentify"): TypedCommand<function>
  • __call(commandName: "DisableLayerForIdentify"): TypedCommand<function>
  • __call(commandName: "EnableMapClick"): TypedCommand<function>
  • __call(commandName: "EnableMapKeyboardNavigation"): TypedCommand<function>
  • __call(commandName: "EnableMapTips"): TypedCommand<function>
  • __call(commandName: "EnablePushpins"): TypedCommand<function>
  • __call(commandName: "EnableSearchRefinement"): TypedCommand<function>
  • __call(commandName: "ExplodeGraphicsInMemory"): TypedCommand<function>
  • __call(commandName: "ExportResultsTo"): TypedCommand<function>
  • __call(commandName: "ExportMarkupLayer"): TypedCommand<function>
  • __call(commandName: "ExportGraphicsLayer"): TypedCommand<function>
  • __call(commandName: "FocusMap"): TypedCommand<function>
  • __call(commandName: "FocusSearch"): TypedCommand<function>
  • __call(commandName: "FindAllSelectionMetadata"): TypedCommand<function>
  • __call(commandName: "FindMetadataForSelection"): TypedCommand<function>
  • __call(commandName: "FindSelection"): TypedCommand<function>
  • __call(commandName: "FocusOnFirstInputInView"): TypedCommand<function>
  • __call(commandName: "FSMCollectionSetCommand"): TypedCommand<function>
  • __call(commandName: "Geolocate"): TypedCommand<function>
  • __call(commandName: "GeolocateFollow"): TypedCommand<function>
  • __call(commandName: "GeolocateStop"): TypedCommand<function>
  • __call(commandName: "GeolocateTrack"): TypedCommand<function>
  • __call(commandName: "GeolocateShowBuffer"): TypedCommand<function>
  • __call(commandName: "GeolocateHideBuffer"): TypedCommand<function>
  • __call(commandName: "GetCollaborationEvent"): TypedCommand<function>
  • __call(commandName: "GetCollaborationRooms"): TypedCommand<function>
  • __call(commandName: "GetEditLog"): TypedCommand<function>
  • __call(commandName: "GetFeatureDetailsProviders"): TypedCommand<function>
  • __call(commandName: "GetRelatedFeatures"): TypedCommand<function>
  • __call(commandName: "GlobalSearch"): TypedCommand<function>
  • __call(commandName: "HandleGenerateSharingLink"): TypedCommand<function>
  • __call(commandName: "HideFeatureAttributeEditor"): TypedCommand<function>
  • __call(commandName: "HideFeatureDetails"): TypedCommand<function>
  • __call(commandName: "HideAllMapTips"): TypedCommand<function>
  • __call(commandName: "HideAllCoordinates"): TypedCommand<function>
  • __call(commandName: "HideCoordinates"): TypedCommand<function>
  • __call(commandName: "HideCoordinateActions"): TypedCommand<function>
  • __call(commandName: "HideFeatureLayerModalMessage"): TypedCommand<function>
  • __call(commandName: "HideFeatureTemplatePicker"): TypedCommand<function>
  • __call(commandName: "HideHomePanel"): TypedCommand<function>
  • __call(commandName: "HideLog"): TypedCommand<function>
  • __call(commandName: "HideMapElement"): TypedCommand<function>
  • __call(commandName: "HideMapServiceActions"): TypedCommand<function>
  • __call(commandName: "HideMapTips"): TypedCommand<function>
  • __call(commandName: "HideLayerPropertiesView"): TypedCommand<function>
  • __call(commandName: "HideMarkers"): TypedCommand<function>
  • __call(commandName: "HideMarkupStyleView"): TypedCommand<function>
  • __call(commandName: "HidePushpins"): TypedCommand<function>
  • __call(commandName: "HighlightChartFeatureSet"): TypedCommand<function>
  • __call(commandName: "HighlightCollaborationFeatures"): TypedCommand<function>
  • __call(commandName: "HighlightEsriFeatureSet"): TypedCommand<function>
  • __call(commandName: "HighlightFeature"): TypedCommand<function>
  • __call(commandName: "HighlightFeatures"): TypedCommand<function>
  • __call(commandName: "ClearAndHighlightFeatures"): TypedCommand<function>
  • __call(commandName: "FocusFeature"): TypedCommand<function>
  • __call(commandName: "ClearFeatureFocus"): TypedCommand<function>
  • __call(commandName: "ClearFeatureHighlight"): TypedCommand<function>
  • __call(commandName: "HighlightFeatureDefault"): TypedCommand<function>
  • __call(commandName: "HighlightFeatureSet"): TypedCommand<function>
  • __call(commandName: "Identify"): TypedCommand<function>
  • __call(commandName: "IdentifyBufferedGeometry"): TypedCommand<function>
  • __call(commandName: "IdentifyBufferedFeature"): TypedCommand<function>
  • __call(commandName: "IdentifyBufferedFeatureSet"): TypedCommand<function>
  • __call(commandName: "IdentifyBufferedFeatureSetCollection"): TypedCommand<function>
  • __call(commandName: "InvokeMapTip"): TypedCommand<function>
  • __call(commandName: "InitializeSite"): TypedCommand<function>
  • __call(commandName: "AddMapService"): TypedCommand<function>
  • __call(commandName: "LaunchBarcodeScannerWithCallback"): TypedCommand<function>
  • __call(commandName: "ListenToExternalComponentFrame"): TypedCommand<function>
  • __call(commandName: "LoadCollaborationMarkupGraphics"): TypedCommand<function>
  • __call(commandName: "LoadProject"): TypedCommand<function>
  • __call(commandName: "ListSelections"): TypedCommand<function>
  • __call(commandName: "ListQueries"): TypedCommand<function>
  • __call(commandName: "ListFilters"): TypedCommand<function>
  • __call(commandName: "LogOptimizerEvent"): TypedCommand<function>
  • __call(commandName: "MapResize"): TypedCommand<function>
  • __call(commandName: "MaximizePanel"): TypedCommand<function>
  • __call(commandName: "MeasureArea"): TypedCommand<function>
  • __call(commandName: "MeasureDistance"): TypedCommand<function>
  • __call(commandName: "OpenAfterActionPlayback"): TypedCommand<function>
  • __call(commandName: "OpenCollaboration"): TypedCommand<function>
  • __call(commandName: "OpenEventFeatureImage"): TypedCommand<function>
  • __call(commandName: "OpenDataFrame"): TypedCommand<function>
  • __call(commandName: "OpenAndFocusDataFrame"): TypedCommand<function>
  • __call(commandName: "OpenAndFocusIWantToMenu"): TypedCommand<function>
  • __call(commandName: "OpenBottomRegion"): TypedCommand<function>
  • __call(commandName: "OpenFeatureSetCollection"): TypedCommand<function>
  • __call(commandName: "OpenPortalMyContentWindow"): TypedCommand<function>
  • __call(commandName: "OpenResultsFrame"): TypedCommand<function>
  • __call(commandName: "OpenOverviewMap"): TypedCommand<function>
  • __call(commandName: "PanDown"): TypedCommand<function>
  • __call(commandName: "PanLeft"): TypedCommand<function>
  • __call(commandName: "PanRight"): TypedCommand<function>
  • __call(commandName: "PanToAllFeatures"): TypedCommand<function>
  • __call(commandName: "PanToFeature"): TypedCommand<function>
  • __call(commandName: "PanToFeatureIfOutsideMapExtent"): TypedCommand<function>
  • __call(commandName: "PanToPoint"): TypedCommand<function>
  • __call(commandName: "PanUp"): TypedCommand<function>
  • __call(commandName: "PlotCoordinates"): TypedCommand<function>
  • __call(commandName: "PopulateLabelOptionsView"): TypedCommand<function>
  • __call(commandName: "PrintMap"): TypedCommand<function>
  • __call(commandName: "PushCollaborationRoom"): TypedCommand<function>
  • __call(commandName: "ShowExportMapDialog"): TypedCommand<function>
  • __call(commandName: "ShowLayerCatalog"): TypedCommand<function>
  • __call(commandName: "ActivateTimeSlider"): TypedCommand<function>
  • __call(commandName: "DeactivateTimeSlider"): TypedCommand<function>
  • __call(commandName: "HideTimeSlider"): TypedCommand<function>
  • __call(commandName: "ShowTimeSliderSettings"): TypedCommand<function>
  • __call(commandName: "HideTimeSliderSettings"): TypedCommand<function>
  • __call(commandName: "ToggleTimeSliderActions"): TypedCommand<function>
  • __call(commandName: "StartTimeSliderPlayback"): TypedCommand<function>
  • __call(commandName: "StopTimeSliderPlayback"): TypedCommand<function>
  • __call(commandName: "StepTimeSliderForward"): TypedCommand<function>
  • __call(commandName: "StepTimeSliderBack"): TypedCommand<function>
  • __call(commandName: "SetTimeSliderProfile"): TypedCommand<function>
  • __call(commandName: "AddCatalogLayers"): TypedCommand<function>
  • __call(commandName: "AppendCatalogLayers"): TypedCommand<function>
  • __call(commandName: "ClearLayerCatalogLayers"): TypedCommand<function>
  • __call(commandName: "ClearSavedQueries"): TypedCommand<function>
  • __call(commandName: "ClearSavedFilters"): TypedCommand<function>
  • __call(commandName: "RemoveCollaborationFeatures"): TypedCommand<function>
  • __call(commandName: "RemoveLayerCatalogItem"): TypedCommand<function>
  • __call(commandName: "Project"): TypedCommand<function>
  • __call(commandName: "Prompt"): TypedCommand<function>
  • __call(commandName: "PulseStatus"): TypedCommand<function>
  • __call(commandName: "RecenterMapOnNextMapResize"): TypedCommand<function>
  • __call(commandName: "RefreshOfflineMapsList"): TypedCommand<function>
  • __call(commandName: "Redo"): TypedCommand<function>
  • __call(commandName: "CombineResults"): TypedCommand<function>
  • __call(commandName: "CombineResultsInteractive"): TypedCommand<function>
  • __call(commandName: "ResultsIntersect"): TypedCommand<function>
  • __call(commandName: "ResultsReplace"): TypedCommand<function>
  • __call(commandName: "ResultsSubtract"): TypedCommand<function>
  • __call(commandName: "ResultsUnion"): TypedCommand<function>
  • __call(commandName: "RefreshProjectsList"): TypedCommand<function>
  • __call(commandName: "RegisterChartPointAdapter"): TypedCommand<function>
  • __call(commandName: "RegisterSearchProvider"): TypedCommand<function>
  • __call(commandName: "RegisterSnappingLayer"): TypedCommand<function>
  • __call(commandName: "RegisterSnappingLayers"): TypedCommand<function>
  • __call(commandName: "RemoveNotification"): TypedCommand<function>
  • __call(commandName: "RemoveSnappingLayer"): TypedCommand<function>
  • __call(commandName: "RemoveSnappingLayers"): TypedCommand<function>
  • __call(commandName: "RemoveBookmark"): TypedCommand<function>
  • __call(commandName: "RemoveChartById"): TypedCommand<function>
  • __call(commandName: "RemoveClusterLayer"): TypedCommand<function>
  • __call(commandName: "RemoveFeatureFromStarredSelection"): TypedCommand<function>
  • __call(commandName: "RemoveFeatureSetFromStarredSelection"): TypedCommand<function>
  • __call(commandName: "RemoveFeatureFromResults"): TypedCommand<function>
  • __call(commandName: "RemoveFeatureSetFromResults"): TypedCommand<function>
  • __call(commandName: "RemoveFeatureSetCollection"): TypedCommand<function>
  • __call(commandName: "RemoveFeatureSetCollectionById"): TypedCommand<function>
  • __call(commandName: "RemoveHeatMap"): TypedCommand<function>
  • __call(commandName: "RemoveHighlightLayer"): TypedCommand<function>
  • __call(commandName: "RemoveMarker"): TypedCommand<function>
  • __call(commandName: "RemoveMapService"): TypedCommand<function>
  • __call(commandName: "RemovePushpin"): TypedCommand<function>
  • __call(commandName: "RemovePushpins"): TypedCommand<function>
  • __call(commandName: "RemoveExternalComponentById"): TypedCommand<function>
  • __call(commandName: "RemoveResultsStatus"): TypedCommand<function>
  • __call(commandName: "RemoveStatus"): TypedCommand<function>
  • __call(commandName: "RemoveUserAddedLayer"): TypedCommand<function>
  • __call(commandName: "RemoveVisualization"): TypedCommand<function>
  • __call(commandName: "RemoveSymbolization"): TypedCommand<function>
  • __call(commandName: "ResymbolizeLayer"): TypedCommand<function>
  • __call(commandName: "RenameSelection"): TypedCommand<function>
  • __call(commandName: "RestoreSelection"): TypedCommand<function>
  • __call(commandName: "RestorePanel"): TypedCommand<function>
  • __call(commandName: "ResizeShell"): TypedCommand<function>
  • __call(commandName: "RestoreAllMapTips"): TypedCommand<function>
  • __call(commandName: "ResumeMapTips"): TypedCommand<function>
  • __call(commandName: "RunChartFeatureActions"): TypedCommand<function>
  • __call(commandName: "RunWorkflowById"): TypedCommand<function>
  • __call(commandName: "RunWorkflowWithArguments"): TypedCommand<function>
  • __call(commandName: "RunWorkflowWithGeometry"): TypedCommand<function>
  • __call(commandName: "RunWorkflowByUrl"): TypedCommand<function>
  • __call(commandName: "RunWorkflowByUrlAndInputs"): TypedCommand<function>
  • __call(commandName: "ScreenReaderNarrate"): TypedCommand<function>
  • __call(commandName: "DisableScreenReaderNarrate"): TypedCommand<function>
  • __call(commandName: "EnableScreenReaderNarrate"): TypedCommand<function>
  • __call(commandName: "SelectBaseMap"): TypedCommand<function>
  • __call(commandName: "SetActiveHighlightLayer"): TypedCommand<function>
  • __call(commandName: "SetActiveHighlightLayerDefault"): TypedCommand<function>
  • __call(commandName: "SetActiveTool"): TypedCommand<function>
  • __call(commandName: "SetCollaborationImageLocation"): TypedCommand<function>
  • __call(commandName: "SetCollectionOfInterest"): TypedCommand<function>
  • __call(commandName: "SetEditLog"): TypedCommand<function>
  • __call(commandName: "SetEditorFeatureGeometry"): TypedCommand<function>
  • __call(commandName: "SetHighlightBorderColor"): TypedCommand<function>
  • __call(commandName: "SetHighlightBorderWidth"): TypedCommand<function>
  • __call(commandName: "SetHighlightFillColor"): TypedCommand<function>
  • __call(commandName: "SetIdentifyCombineMode"): TypedCommand<function>
  • __call(commandName: "SetFocusedBorderColor"): TypedCommand<function>
  • __call(commandName: "SetFocusedFillColor"): TypedCommand<function>
  • __call(commandName: "SetMeasurementUnits"): TypedCommand<function>
  • __call(commandName: "SetOfflineMapEditorGeometry"): TypedCommand<function>
  • __call(commandName: "SetTimeExtent"): TypedCommand<function>
  • __call(commandName: "StartEditingNewRelatedRecord"): TypedCommand<function>
  • __call(commandName: "ShareOn"): TypedCommand<function>
  • __call(commandName: "ShowAccessibilityView"): TypedCommand<function>
  • __call(commandName: "ShowAddBookmark"): TypedCommand<function>
  • __call(commandName: "ShowAllCoordinates"): TypedCommand<function>
  • __call(commandName: "ShowCopyDialogForEvent"): TypedCommand<function>
  • __call(commandName: "ShowCoordinates"): TypedCommand<function>
  • __call(commandName: "ShowCoordinateActions"): TypedCommand<function>
  • __call(commandName: "ShowSkipLinks"): TypedCommand<function>
  • __call(commandName: "ShowLabelOptionsView"): TypedCommand<function>
  • __call(commandName: "ShowLayerPropertiesView"): TypedCommand<function>
  • __call(commandName: "ShowSearchOptions"): TypedCommand<function>
  • __call(commandName: "ShowBookmarks"): TypedCommand<function>
  • __call(commandName: "ShowChartingView"): TypedCommand<function>
  • __call(commandName: "ShowExportWebMapDialog"): TypedCommand<function>
  • __call(commandName: "ShowFeatureAttributeEditor"): TypedCommand<function>
  • __call(commandName: "ShowFirstFeatureFromCollection"): TypedCommand<function>
  • __call(commandName: "ShowFeatureDetails"): TypedCommand<function>
  • __call(commandName: "ShowFeatureDetailsCompact"): TypedCommand<function>
  • __call(commandName: "ShowFeatureDetailsExpanded"): TypedCommand<function>
  • __call(commandName: "ShowFeatureDetailsFromMaptip"): TypedCommand<function>
  • __call(commandName: "SetFeatureDetailsMode"): TypedCommand<function>
  • __call(commandName: "ShowFeatureLayerModalMessage"): TypedCommand<function>
  • __call(commandName: "ShowFeatureTemplatePicker"): TypedCommand<function>
  • __call(commandName: "ShowFeatureParentDetails"): TypedCommand<function>
  • __call(commandName: "ShowGeolocateMenu"): TypedCommand<function>
  • __call(commandName: "ShowHomePanel"): TypedCommand<function>
  • __call(commandName: "ShowExternalComponentView"): TypedCommand<function>
  • __call(commandName: "ShowLayerActions"): TypedCommand<function>
  • __call(commandName: "ShowLayerList"): TypedCommand<function>
  • __call(commandName: "ShowMapServiceActions"): TypedCommand<function>
  • __call(commandName: "ShowMapTips"): TypedCommand<function>
  • __call(commandName: "ShowSaveSelectionDialog"): TypedCommand<function>
  • __call(commandName: "ShowSelection"): TypedCommand<function>
  • __call(commandName: "ShowStarredSelection"): TypedCommand<function>
  • __call(commandName: "ShowOfflineMapEditor"): TypedCommand<function>
  • __call(commandName: "ShowShareView"): TypedCommand<function>
  • __call(commandName: "SwitchToLayerView"): TypedCommand<function>
  • __call(commandName: "SwitchToLegendView"): TypedCommand<function>
  • __call(commandName: "ShowLog"): TypedCommand<function>
  • __call(commandName: "ShowMap"): TypedCommand<function>
  • __call(commandName: "ShowMapCallout"): TypedCommand<function>
  • __call(commandName: "ShowMapElement"): TypedCommand<function>
  • __call(commandName: "ShowMapTip"): TypedCommand<function>
  • __call(commandName: "ShowMapTipInCallout"): TypedCommand<function>
  • __call(commandName: "ShowMapTipResults"): TypedCommand<function>
  • __call(commandName: "ShowMapTipResultsInCallout"): TypedCommand<function>
  • __call(commandName: "ShowMarkers"): TypedCommand<function>
  • __call(commandName: "ShowPushpins"): TypedCommand<function>
  • __call(commandName: "StopFeaturePlacementState"): TypedCommand<function>
  • __call(commandName: "ListReports"): TypedCommand<function>
  • __call(commandName: "RunFeatureReport"): TypedCommand<function>
  • __call(commandName: "RunFeaturesReport"): TypedCommand<function>
  • __call(commandName: "RunReport"): TypedCommand<function>
  • __call(commandName: "RunReportByUrl"): TypedCommand<function>
  • __call(commandName: "SaveAsProject"): TypedCommand<function>
  • __call(commandName: "SaveProject"): TypedCommand<function>
  • __call(commandName: "ShowProjectEditor"): TypedCommand<function>
  • __call(commandName: "ShowProjects"): TypedCommand<function>
  • __call(commandName: "ShowResults"): TypedCommand<function>
  • __call(commandName: "ShowResultsList"): TypedCommand<function>
  • __call(commandName: "ShowResultsTable"): TypedCommand<function>
  • __call(commandName: "SwitchToListResultsView"): TypedCommand<function>
  • __call(commandName: "RestoreTableColumnsOrder"): TypedCommand<function>
  • __call(commandName: "RestoreTableColumnsWidth"): TypedCommand<function>
  • __call(commandName: "RestoreTableColumnsVisibility"): TypedCommand<function>
  • __call(commandName: "ActivateResultsTableEditingMode"): TypedCommand<function>
  • __call(commandName: "SwitchToTabularResultsView"): TypedCommand<function>
  • __call(commandName: "ShowShareProject"): TypedCommand<function>
  • __call(commandName: "ShowVisualizationView"): TypedCommand<function>
  • __call(commandName: "SignIn"): TypedCommand<function>
  • __call(commandName: "SignOut"): TypedCommand<function>
  • __call(commandName: "StartEditingAttributesAndGeometryFeature"): TypedCommand<function>
  • __call(commandName: "StartEditingEditLogEntry"): TypedCommand<function>
  • __call(commandName: "StartEditingFeature"): TypedCommand<function>
  • __call(commandName: "StartEditingNewFeature"): TypedCommand<function>
  • __call(commandName: "StartOfflineFeatureSync"): TypedCommand<function>
  • __call(commandName: "StartOfflineDownloadAndShowProgress"): TypedCommand<function>
  • __call(commandName: "StartOfflineSyncAndShowProgress"): TypedCommand<function>
  • __call(commandName: "StepZoomIn"): TypedCommand<function>
  • __call(commandName: "StepZoomOut"): TypedCommand<function>
  • __call(commandName: "StopEditingMarkup"): TypedCommand<function>
  • __call(commandName: "SuspendMapTips"): TypedCommand<function>
  • __call(commandName: "SwitchToLayerTheme"): TypedCommand<function>
  • __call(commandName: "TakeApplicationOffline"): TypedCommand<function>
  • __call(commandName: "TapToDismiss"): TypedCommand<function>
  • __call(commandName: "TakeApplicationOnline"): TypedCommand<function>
  • __call(commandName: "ToggleDataFrame"): TypedCommand<function>
  • __call(commandName: "ToggleDynamicLabels"): TypedCommand<function>
  • __call(commandName: "ToggleLogView"): TypedCommand<function>
  • __call(commandName: "ToggleMouseCoordinates"): TypedCommand<function>
  • __call(commandName: "ToggleResultsFrame"): TypedCommand<function>
  • __call(commandName: "ToggleExternalComponentSyncById"): TypedCommand<function>
  • __call(commandName: "ToggleToolbar"): TypedCommand<function>
  • __call(commandName: "OpenToolbar"): TypedCommand<function>
  • __call(commandName: "CloseToolbar"): TypedCommand<function>
  • __call(commandName: "OpenAndFocusToolbar"): TypedCommand<function>
  • __call(commandName: "HideToolbarButton"): TypedCommand<function>
  • __call(commandName: "ShowToolbarButton"): TypedCommand<function>
  • __call(commandName: "HideToolbarTab"): TypedCommand<function>
  • __call(commandName: "ShowToolbarTab"): TypedCommand<function>
  • __call(commandName: "SetCurrentTab"): TypedCommand<function>
  • __call(commandName: "Undo"): TypedCommand<function>
  • __call(commandName: "UnionFeaturesInteractive"): TypedCommand<function>
  • __call(commandName: "UnionGraphicsInMemory"): TypedCommand<function>
  • __call(commandName: "UpdateAttachment"): TypedCommand<function>
  • __call(commandName: "UpdateFeature"): TypedCommand<function>
  • __call(commandName: "UpdateGraphicsInMemory"): TypedCommand<function>
  • __call(commandName: "UpdateRelatedRecord"): TypedCommand<function>
  • __call(commandName: "UpdateFeatureLayerModalMessage"): TypedCommand<function>
  • __call(commandName: "UpdateMarker"): TypedCommand<function>
  • __call(commandName: "UpdateSelection"): TypedCommand<function>
  • __call(commandName: "UpdateStatus"): TypedCommand<function>
  • __call(commandName: "UploadData"): TypedCommand<function>
  • __call(commandName: "VerifyRoomNameUnique"): TypedCommand<function>
  • __call(commandName: "WebSocketCommand"): TypedCommand<function>
  • __call(commandName: "ZoomOutToExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToAllFeatures"): TypedCommand<function>
  • __call(commandName: "ZoomToEsriFeatureSet"): TypedCommand<function>
  • __call(commandName: "ZoomToExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToFeature"): TypedCommand<function>
  • __call(commandName: "ZoomToFeatureIfOutsideMapExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToFeatures"): TypedCommand<function>
  • __call(commandName: "ZoomToFeatureSetCollection"): TypedCommand<function>
  • __call(commandName: "ZoomToFullExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToInitialExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToPreviousExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToNamedExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToNextExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToOfflineMapExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToLayerExtent"): TypedCommand<function>
  • __call(commandName: "ZoomToLayerVisibleScale"): TypedCommand<function>
  • __call(commandName: "ZoomToScale"): TypedCommand<function>
  • __call(commandName: string): TypedCommand<any>
  • Activates buffering with the current settings for the specified command(s).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateBuffering

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "ActivateBuffering"

    Returns TypedCommand<function>

  • Activates buffering for the specified command and displays the associated Buffer Options dialog.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateBufferingAndDisplayOptions

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "ActivateBufferingAndDisplayOptions"

    Returns TypedCommand<function>

  • Activates any workflow container views associated with a given workflow.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateContainersForWorkflow

    Parameters

    • commandName: "ActivateContainersForWorkflow"

    Returns TypedCommand<function>

  • Activates a context menu view that will be positioned based on the page x & y values specified.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateContextMenu

    Parameters

    • commandName: "ActivateContextMenu"

    Returns TypedCommand<function>

  • Activate the event copy menu.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateEventCopyView

    introduced

    2.8

    Parameters

    • commandName: "ActivateEventCopyView"

    Returns TypedCommand<function>

  • Edit the associated message for a collaboration event using its rest event.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateEditCollaborationEventMessageView

    introduced

    2.9

    Parameters

    • commandName: "ActivateEditCollaborationEventMessageView"

    Returns TypedCommand<function>

  • Edit the associated message for a collaboration event using one of its drawn features.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateEditCollaborationFeatureMessageView

    introduced

    2.9

    Parameters

    • commandName: "ActivateEditCollaborationFeatureMessageView"

    Returns TypedCommand<function>

  • Activates the Home Panel if it is configured to be included.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateHomePanel

    introduced

    1.3

    deprecated

    2.0 Use ShowHomePanel instead.

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ActivateHomePanel"

    Returns TypedCommand<function>

  • Activates the Plot Coordinates View.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivatePlotCoordinatesView

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "ActivatePlotCoordinatesView"

    Returns TypedCommand<function>

  • Activates the Layer Selector for Identify and applies current settings.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateSelectLayersForIdentify

    introduced

    2.5

    gcx-command-category

    Layer Selector

    Parameters

    • commandName: "ActivateSelectLayersForIdentify"

    Returns TypedCommand<function>

  • Applies the current query to the specified Filter Control.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ApplyFilterControlQuery

    introduced

    2.8

    gcx-command-category

    Layer Selector

    Parameters

    • commandName: "ApplyFilterControlQuery"

    Returns TypedCommand<function>

  • Applies edits to features. It can include additions, updates and deletions.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ApplyEdits

    introduced

    2.10

    gcx-command-category

    Editing

    Parameters

    • commandName: "ApplyEdits"

    Returns TypedCommand<function>

  • Deactivates the Layer Selector for Identify and enables all default identifiable layers.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateSelectLayersForIdentify

    introduced

    2.5

    gcx-command-category

    Layer Selector

    Parameters

    • commandName: "DeactivateSelectLayersForIdentify"

    Returns TypedCommand<function>

  • Activates the Layer Selector for Snapping.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateSelectLayersForSnapping

    introduced

    2.5

    gcx-command-category

    Layer Selector

    Parameters

    • commandName: "ActivateSelectLayersForSnapping"

    Returns TypedCommand<function>

  • Deactivates the Layer Selector for Snapping.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateSelectLayersForSnapping

    introduced

    2.5

    gcx-command-category

    Layer Selector

    Parameters

    • commandName: "DeactivateSelectLayersForSnapping"

    Returns TypedCommand<function>

  • Activates Snapping.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateSnapping

    introduced

    2.5

    gcx-command-category

    Snapping

    Parameters

    • commandName: "ActivateSnapping"

    Returns TypedCommand<function>

  • Deactivates Snapping.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateSnapping

    introduced

    2.5

    gcx-command-category

    Snapping

    Parameters

    • commandName: "DeactivateSnapping"

    Returns TypedCommand<function>

  • Activates any transient elements configured against a specific ID in the toolbar module.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateTransientElements

    introduced

    1.3

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ActivateTransientElements"

    Returns TypedCommand<function>

  • Bookmarks the current extent with the given name.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddBookmark

    introduced

    2.0

    gcx-command-category

    Bookmark

    Parameters

    • commandName: "AddBookmark"

    Returns TypedCommand<function>

  • Adds a cluster layer to an existing Geocortex Layer that holds an Esri FeatureLayer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddClusterLayer

    introduced

    2.5

    gcx-command-category

    Visualization

    Parameters

    • commandName: "AddClusterLayer"

    Returns TypedCommand<function>

  • Add a collaboration event's graphics to the collaboration graphics layer as a Feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddCollaborationFeatures

    introduced

    2.8

    Parameters

    • commandName: "AddCollaborationFeatures"

    Returns TypedCommand<function>

  • Add the supplied feature to the 'starred' (default) selected set, if it is not already present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddFeatureToStarredSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "AddFeatureToStarredSelection"

    Returns TypedCommand<function>

  • Adds all features from the supplied FeatureSet to the 'starred' or default selection, if they are not already present..

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddFeatureSetToStarredSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "AddFeatureSetToStarredSelection"

    Returns TypedCommand<function>

  • Adds an individual feature to the current {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} displayed in the results view. Typically, an end-user would click "Add to Results" on a map tip to add the feature to the results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddFeatureToResults

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "AddFeatureToResults"

    Returns TypedCommand<function>

  • Adds an individual feature to the current {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} displayed in the results view at the specified index.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddFeatureToResultsAtIndex

    introduced

    2.10

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "AddFeatureToResultsAtIndex"

    Returns TypedCommand<function>

  • Adds a heat map visualization to a given Geocortex layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddHeatMap

    introduced

    2.5

    gcx-command-category

    Visualization

    Parameters

    • commandName: "AddHeatMap"

    Returns TypedCommand<function>

  • Creates and displays a marker on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddMarker

    introduced

    2.5

    Parameters

    • commandName: "AddMarker"

    Returns TypedCommand<function>

  • Adds the given geometry to the markup layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddMarkup

    introduced

    1.3

    gcx-command-category

    Markup

    Parameters

    • commandName: "AddMarkup"

    Returns TypedCommand<function>

  • Adds the given feature to the markup layer. (Identical to the AddMarkup command.)

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddMarkupFeature

    introduced

    2.8

    gcx-command-category

    Markup

    Parameters

    • commandName: "AddMarkupFeature"

    Returns TypedCommand<function>

  • Adds the given geometry to the markup layer. (Identical to the AddMarkup command.)

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddMarkupGeometry

    introduced

    2.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "AddMarkupGeometry"

    Returns TypedCommand<function>

  • Creates and displays a pushpin for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature} specified. Pushpins must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddPushpin

    introduced

    2.4

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "AddPushpin"

    Returns TypedCommand<function>

  • Creates and displays pushpins for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} specified. Pushpins must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddPushpins

    introduced

    2.3

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "AddPushpins"

    Returns TypedCommand<function>

  • Displays a status indicator that can relay short messages in the results list or table.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddResultsStatus

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "AddResultsStatus"

    Returns TypedCommand<function>

  • Add a collaboration room to the auto join list.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AutoJoinCollaborationRoom

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "AutoJoinCollaborationRoom"

    Returns TypedCommand<function>

  • Displays a status message for the query builder

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddQueryStatus

    introduced

    2.8

    gcx-command-category

    Query

    Parameters

    • commandName: "AddQueryStatus"

    Returns TypedCommand<function>

  • Displays a status message for the filter builder

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddFilterStatus

    introduced

    2.8

    gcx-command-category

    Query

    Parameters

    • commandName: "AddFilterStatus"

    Returns TypedCommand<function>

  • Removes a status message for the query builder

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveQueryStatus

    introduced

    2.8

    gcx-command-category

    Query

    Parameters

    • commandName: "RemoveQueryStatus"

    Returns TypedCommand<function>

  • Removes a status message for the filter builder

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFilterStatus

    introduced

    2.8

    gcx-command-category

    Query

    Parameters

    • commandName: "RemoveFilterStatus"

    Returns TypedCommand<function>

  • Displays a status indicator that can relay tool tips and other types of short messages.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddStatus

    introduced

    1.1

    gcx-workflow-requirements

    In order to use this command in a workflow, you must pass the statusArgs parameter as a string.

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "AddStatus"

    Returns TypedCommand<function>

  • Prompts the user for text to add as markup. When completed, text markup is added at the provided geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddTextMarkup

    introduced

    2.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "AddTextMarkup"

    Returns TypedCommand<function>

  • Adds a temporary markup graphic to the map. The command ClearTemporaryMarkup will clear this piece of markup. Subsequent invocations of AddTemporaryMarkupGeometry will clear the previous piece of temporary markup.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddTemporaryMarkupGeometry

    introduced

    1.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "AddTemporaryMarkupGeometry"

    Returns TypedCommand<function>

  • Activates a visual ripple on the point of the map specified. Used to implement the map Ripple click.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RippleClick

    introduced

    2.8

    gcx-workflow-disabled
    gcx-command-category

    Map Widget

    Parameters

    • commandName: "RippleClick"

    Returns TypedCommand<function>

  • Toggles the ripple effect ( See RippleClick Command ) from a click on the map

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleRippleClick

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ToggleRippleClick"

    Returns TypedCommand<function>

  • Disables the ripple effect ( See RippleClick Command ) from a click on the map

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisableRippleClick

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "DisableRippleClick"

    Returns TypedCommand<function>

  • Disables the ripple effect ( See RippleClick Command ) from a click on the map

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableRippleClick

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "EnableRippleClick"

    Returns TypedCommand<function>

  • Displays an alert.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Alert

    introduced

    1.0

    gcx-workflow-requirements

    In order to use this command in a workflow, you must omit the callback parameter.

    gcx-command-category

    Dialog

    Parameters

    • commandName: "Alert"

    Returns TypedCommand<function>

  • Invokes a dialog that allows users to attach files to a given feature, when the browser environment supports it.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AttachFileToFeature

    introduced

    1.3

    gcx-workflow-disabled
    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "AttachFileToFeature"

    Returns TypedCommand<function>

  • Broadcasts the viewers current viewpoint to the specified external component.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    BroadcastCurrentViewpoint

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "BroadcastCurrentViewpoint"

    Returns TypedCommand<function>

  • Buffers input geometry, adds buffer markup to the map, and fires the callback and event with the buffered geometry. When the source command is specified, buffers using current settings for the command.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    BufferGeometry

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "BufferGeometry"

    Returns TypedCommand<function>

  • Cancels editing of a coordinate if currently active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CancelEditCoordinate

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "CancelEditCoordinate"

    Returns TypedCommand<function>

  • Cancel any in-progress search on all providers.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CancelSearch

    introduced

    1.1

    gcx-command-category

    Search

    Parameters

    • commandName: "CancelSearch"

    Returns TypedCommand<function>

  • Changes the style of markup to match the provided symbol.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ChangeMarkupStyle

    introduced

    2.8

    Parameters

    • commandName: "ChangeMarkupStyle"

    Returns TypedCommand<function>

  • Clears the active tool.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearActiveTool

    introduced

    1.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ClearActiveTool"

    Returns TypedCommand<function>

  • Removes the highlights from the charting highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearChartHighlights

    introduced

    2.3

    Parameters

    • commandName: "ClearChartHighlights"

    Returns TypedCommand<function>

  • Removes all charts from the charting view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearCharts

    introduced

    2.3

    gcx-command-category

    Charting

    Parameters

    • commandName: "ClearCharts"

    Returns TypedCommand<function>

  • Clears all the features from the collaboration markup layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearCollaborationDrawings

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "ClearCollaborationDrawings"

    Returns TypedCommand<function>

  • Clears all the features from the collaboration graphics layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearCollaborationFeatures

    introduced

    2.8

    Parameters

    • commandName: "ClearCollaborationFeatures"

    Returns TypedCommand<function>

  • Clears the highlights from the default highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearDefaultHighlights

    introduced

    1.2

    deprecated

    1.3 Use ClearHighlights with no args instead.

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "ClearDefaultHighlights"

    Returns TypedCommand<function>

  • Clear the information stored within RelatedFeaturesView and RelatedFeaturesViewModel (for example, which features are currently open).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearFeatureInformation

    introduced

    2.3

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ClearFeatureInformation"

    Returns TypedCommand<function>

  • Clears the highlights from the default or supplied highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearHighlights

    introduced

    1.2

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "ClearHighlights"

    Returns TypedCommand<function>

  • Prompts the user for confirmation, and if approved, clears all of the markup from the markup layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearMarkup

    introduced

    1.2

    gcx-command-category

    Markup

    Parameters

    • commandName: "ClearMarkup"

    Returns TypedCommand<function>

  • Clears all of the markup from the markup layer without prompting for confirmation.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearMarkupQuiet

    introduced

    1.2

    gcx-command-category

    Markup

    Parameters

    • commandName: "ClearMarkupQuiet"

    Returns TypedCommand<function>

  • Clears all of the graphics from the custom graphics layer with the given id, or all custom graphics if no id given.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearCustomGraphics

    introduced

    4.13

    gcx-command-category

    Markup

    Parameters

    • commandName: "ClearCustomGraphics"

    Returns TypedCommand<function>

  • Clears any search results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearSearch

    introduced

    1.3

    gcx-command-category

    Search

    Parameters

    • commandName: "ClearSearch"

    Returns TypedCommand<function>

  • Clears the open identify results/selection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearSelection

    introduced

    2.4

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ClearSelection"

    Returns TypedCommand<function>

  • Removes all features from the 'starred' (default) selection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearStarredSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ClearStarredSelection"

    Returns TypedCommand<function>

  • Clears locally stored offline data for the current application.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearStorageForApplication

    introduced

    1.2

    gcx-command-category

    Offline

    Parameters

    • commandName: "ClearStorageForApplication"

    Returns TypedCommand<function>

  • Clears all offline data for the current domain. This includes data for all applications loaded from the current domain.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearStorageForDomain

    introduced

    1.1

    gcx-command-category

    Offline

    Parameters

    • commandName: "ClearStorageForDomain"

    Returns TypedCommand<function>

  • Removes temporary markup created by the command AddTemporaryMarkupGeometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearTemporaryMarkup

    introduced

    1.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "ClearTemporaryMarkup"

    Returns TypedCommand<function>

  • Clears list of trusted URLs which are added by clicking "yes" on potentially untrusted content popup.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearTrustedUrls

    introduced

    2.7

    gcx-command-category

    Content Policy

    Parameters

    • commandName: "ClearTrustedUrls"

    Returns TypedCommand<function>

  • Closes the BottomPanelRegion, if it is present in the current shell.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CloseBottomRegion

    introduced

    1.3

    gcx-command-category

    Region and View

    Parameters

    • commandName: "CloseBottomRegion"

    Returns TypedCommand<function>

  • Closes the data frame, if it is present in the current shell.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CloseDataFrame

    introduced

    1.0

    gcx-command-category

    Region and View

    Parameters

    • commandName: "CloseDataFrame"

    Returns TypedCommand<function>

  • Closes the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CloseFeatureSetCollection

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "CloseFeatureSetCollection"

    Returns TypedCommand<function>

  • Closes the Results Frame, in shells where it is present and active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CloseResultsFrame

    introduced

    1.1

    gcx-command-category

    Region and View

    Parameters

    • commandName: "CloseResultsFrame"

    Returns TypedCommand<function>

  • Closes the Overview Map when it is present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CloseOverviewMap

    introduced

    2.4

    gcx-command-category

    Map Display

    Parameters

    • commandName: "CloseOverviewMap"

    Returns TypedCommand<function>

  • Add a graphic to the collaboration markup layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CollaborationDraw

    introduced

    2.8

    Parameters

    • commandName: "CollaborationDraw"

    Returns TypedCommand<function>

  • Add a text graphic to the collaboration markup layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CollaborationDrawText

    introduced

    2.8.1

    Parameters

    • commandName: "CollaborationDrawText"

    Returns TypedCommand<function>

  • Displays a confirm.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Confirm

    introduced

    1.0

    gcx-workflow-requirements

    In order to use this command in a workflow, you must omit the callback parameter.

    gcx-command-category

    Dialog

    Parameters

    • commandName: "Confirm"

    Returns TypedCommand<function>

  • Displays a representation of the specified parameter object in the browser's debugging console.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ConsoleDir

    introduced

    2.7

    gcx-command-category

    Log

    Parameters

    • commandName: "ConsoleDir"

    Returns TypedCommand<function>

  • Copies a Collaboration Event to a new room.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CopyCollaborationEvent

    introduced

    2.8

    Parameters

    • commandName: "CopyCollaborationEvent"

    Returns TypedCommand<function>

  • Creates a feature attachment.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateAttachment

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "CreateAttachment"

    Returns TypedCommand<function>

  • Creates a Collaboration Event.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateCollaborationEvent

    introduced

    2.8

    Parameters

    • commandName: "CreateCollaborationEvent"

    Returns TypedCommand<function>

  • Creates a Collaboration Room.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateCollaborationRoom

    introduced

    2.8

    Parameters

    • commandName: "CreateCollaborationRoom"

    Returns TypedCommand<function>

  • Creates a new feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateFeature

    introduced

    1.1

    gcx-command-category

    Editing

    Parameters

    • commandName: "CreateFeature"

    Returns TypedCommand<function>

  • Creates new graphics. These edits are only applied to the graphics layer in memory.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateGraphicsInMemory

    introduced

    2.5

    Parameters

    • commandName: "CreateGraphicsInMemory"

    Returns TypedCommand<function>

  • Creates a new highlight layer with the specified name, if one does not already exist.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateHighlightLayer

    introduced

    1.2

    deprecated

    2.8 Recommended to use graphics layers for arbitrary graphics, and not to abuse highlighting.

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "CreateHighlightLayer"

    Returns TypedCommand<function>

  • Activates the markup style picker view. The view will be configured for the current markup type and symbol.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateMarkupStyleView

    introduced

    2.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "CreateMarkupStyleView"

    Returns TypedCommand<function>

  • Creates a new named, saved selection based on the supplied {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "CreateSelection"

    Returns TypedCommand<function>

  • Launch the barcode scanner, and use the result to create a new feature or edit an existing feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateOrEditFeatureFromBarcodeScan

    introduced

    2.5

    gcx-command-category

    Scanning

    Parameters

    • commandName: "CreateOrEditFeatureFromBarcodeScan"

    Returns TypedCommand<function>

  • Creates a related table record.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CreateRelatedRecord

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "CreateRelatedRecord"

    Returns TypedCommand<function>

  • Presents a user interface guiding user to draw cut polyline to cut a feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CutFeatureInteractive

    introduced

    2.10

    Parameters

    • commandName: "CutFeatureInteractive"

    Returns TypedCommand<function>

  • Cut graphics using a polyline, updating the geometry of the original graphic and creating new graphics for each new geometry. Created graphics will copy attribute values from the original graphic, but can be updated in the successCallback. These edits are only applied to the graphics layer in memory.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CutGraphicsInMemory

    introduced

    2.5

    Parameters

    • commandName: "CutGraphicsInMemory"

    Returns TypedCommand<function>

  • Deactivates buffering, if active, for the specified command(s).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateBuffering

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "DeactivateBuffering"

    Returns TypedCommand<function>

  • Deactivates buffering for the specified command and dismisses the associated Buffer Options dialog if it's active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DectivateBufferingAndDisplayOptions

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "DeactivateBufferingAndDismissOptions"

    Returns TypedCommand<function>

  • Deactivates any workflow container views associated with a given workflow.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateContainersForWorkflow

    Parameters

    • commandName: "DeactivateContainersForWorkflow"

    Returns TypedCommand<function>

  • Deactivates the context menu view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateContainersForWorkflow

    introduced

    2.6

    Parameters

    • commandName: "DeactivateContextMenu"

    Returns TypedCommand<function>

  • Deletes feature attachments.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteAttachments

    Parameters

    • commandName: "DeleteAttachments"

    Returns TypedCommand<function>

  • Deletes all plotted Coordinates from the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteAllCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "DeleteAllCoordinates"

    Returns TypedCommand<function>

  • Deletes one or many plotted Coordinates from the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "DeleteCoordinates"

    Returns TypedCommand<function>

  • Edits a plotted Coordinate on the map or creates a new coordinate in edit mode.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EditCoordinate

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "EditCoordinate"

    Returns TypedCommand<function>

  • Deletes a feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteFeature

    introduced

    1.1

    gcx-command-category

    Editing

    Parameters

    • commandName: "DeleteFeature"

    Returns TypedCommand<function>

  • Deletes graphics. These edits are only applied to the graphics layer in memory.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteGraphicsInMemory

    introduced

    2.5

    Parameters

    • commandName: "DeleteGraphicsInMemory"

    Returns TypedCommand<function>

  • Removes the given entry from the edit log, then saves the edit log.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteFromEditLog

    introduced

    1.1

    gcx-command-category

    Editing

    Parameters

    • commandName: "DeleteFromEditLog"

    Returns TypedCommand<function>

  • Deletes markup that intersects the extent of the provided geometry, prompting the user if multiple pieces of markup are selected for deletion.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteMarkup

    introduced

    2.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "DeleteMarkup"

    Returns TypedCommand<function>

  • Deletes measurement markup that intersects the extent of the provided geometry, prompting the user if multiple pieces of measurement markup are selected for deletion.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteMeasurement

    introduced

    2.1

    gcx-command-category

    Measurement

    Parameters

    • commandName: "DeleteMeasurement"

    Returns TypedCommand<function>

  • Deletes a project.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteProject

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "DeleteProject"

    Returns TypedCommand<function>

  • Deletes a named selection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "DeleteSelection"

    Returns TypedCommand<function>

  • Deletes a related table record.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeleteRelatedRecord

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "DeleteRelatedRecord"

    Returns TypedCommand<function>

  • Prevents the commands configured to execute on map click from executing and also prevents the MapClickedEvent from firing.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisableMapClick

    introduced

    2.4

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "DisableMapClick"

    Returns TypedCommand<function>

  • Disables map keyboard navigation if currently enabled.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableMapKeyboardNavigation

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "DisableMapKeyboardNavigation"

    Returns TypedCommand<function>

  • Disables the display of map tips on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisableMapTips

    introduced

    2.3.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "DisableMapTips"

    Returns TypedCommand<function>

  • Disables the display of pushpins on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisablePushpins

    introduced

    2.1

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "DisablePushpins"

    Returns TypedCommand<function>

  • Displays the Buffer Options dialog for the specified target command, and executes a optional delegate function when the user clicks the Continue button.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisplayBufferOptions

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "DisplayBufferOptions"

    Returns TypedCommand<function>

  • Opens the specified chart in the charting view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisplayChartById

    introduced

    2.3

    gcx-command-category

    Charting

    Parameters

    • commandName: "DisplayChartById"

    Returns TypedCommand<function>

  • Opens the specified external component in the external components view. If this component is open in a separate window, it will be closed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisplayDockedExternalComponentById

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "DisplayDockedExternalComponentById"

    Returns TypedCommand<function>

  • Displays a notification view and associated text, icon, and buttons

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisplayNotification

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "DisplayNotification"

    Returns TypedCommand<function>

  • Opens the specified external component in a separate window from the viewer. If this component is open in the viewer, it will be closed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisplayUndockedExternalComponentById

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "DisplayUndockedExternalComponentById"

    Returns TypedCommand<function>

  • Displays a view in a workflow container.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisplayWorkflowContainerContent

    introduced

    1.0

    gcx-workflow-disabled
    gcx-command-category

    Workflow

    Parameters

    • commandName: "DisplayWorkflowContainerContent"

    Returns TypedCommand<function>

  • Modifies an existing Collaboration Event.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EditCollaborationEvent

    introduced

    2.8

    Parameters

    • commandName: "EditCollaborationEvent"

    Returns TypedCommand<function>

  • Edits the message of a given collaboration message.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EditCollaborationMarkupMessage

    introduced

    2.8

    Parameters

    • commandName: "EditCollaborationMarkupMessage"

    Returns TypedCommand<function>

  • Open the edit message view for a Collaboration event.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowEditCollaborationMessageView

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "ShowEditCollaborationMessageView"

    Returns TypedCommand<function>

  • Open the edit message view for a Collaboration feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowEditCollaborationGraphicMessageView

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "ShowEditCollaborationGraphicMessageView"

    Returns TypedCommand<function>

  • Modifies an existing Collaboration Room.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EditCollaborationRoom

    introduced

    2.8

    Parameters

    • commandName: "EditCollaborationRoom"

    Returns TypedCommand<function>

  • Edits markup that intersects the extent of the provided geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EditMarkup

    introduced

    2.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "EditMarkup"

    Returns TypedCommand<function>

  • Enables all identifiable layers such that they participate in Identify operations.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableAllLayersForIdentify

    introduced

    2.5

    gcx-command-category

    Identify

    Parameters

    • commandName: "EnableAllLayersForIdentify"

    Returns TypedCommand<function>

  • Erases the given event after a confirmation dialog.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EraseMarkupEvent

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "EraseMarkupEvent"

    Returns TypedCommand<function>

  • Disables all identifiable layers such that they do not participate in Identify operations.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisableAllLayersForIdentify

    introduced

    2.5

    gcx-command-category

    Identify

    Parameters

    • commandName: "DisableAllLayersForIdentify"

    Returns TypedCommand<function>

  • Enables the specified layer, if it's identifiable, such that it participates in Identify operations.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableLayerForIdentify

    introduced

    2.5

    gcx-command-category

    Identify

    Parameters

    • commandName: "EnableLayerForIdentify"

    Returns TypedCommand<function>

  • Disables the specified layer, if it's in the list of identifiable layers, such that it does not participate in Identify operations.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisableLayerForIdentify

    introduced

    2.5

    gcx-command-category

    Identify

    Parameters

    • commandName: "DisableLayerForIdentify"

    Returns TypedCommand<function>

  • Enables all configured commands to execute on map click and also wires up the MapClickEvent to fire when the map is clicked.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableMapClick

    introduced

    2.4

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "EnableMapClick"

    Returns TypedCommand<function>

  • Enables map keyboard navigation if currently disabled.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableMapKeyboardNavigation

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "EnableMapKeyboardNavigation"

    Returns TypedCommand<function>

  • Enables the display of map tips on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableMapTips

    introduced

    2.3.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "EnableMapTips"

    Returns TypedCommand<function>

  • Enables the display of pushpins on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnablePushpins

    introduced

    2.1

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "EnablePushpins"

    Returns TypedCommand<function>

  • Enables or disables the refinement of a global search from within search hints (if any).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableSearchRefinement

    introduced

    2.0

    gcx-command-category

    Search

    Parameters

    • commandName: "EnableSearchRefinement"

    Returns TypedCommand<function>

  • Separates multi-part graphics into individual graphics. Created graphics will copy attribute values from the original graphic, but can be updated in the successCallback. These edits are only applied to the graphics layer in memory.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ExplodeGraphicsInMemory

    introduced

    2.5

    Parameters

    • commandName: "ExplodeGraphicsInMemory"

    Returns TypedCommand<function>

  • Exports the data from a feature set to an external data format (csv, xlsx, shp).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ExportResultsTo

    introduced

    2.4

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ExportResultsTo"

    Returns TypedCommand<function>

  • Exports the markup layer to a Shapefile.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ExportMarkupLayer

    introduced

    2.6

    gcx-command-category

    Markup

    Parameters

    • commandName: "ExportMarkupLayer"

    Returns TypedCommand<function>

  • Exports graphics layer to the specified format.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ExportGraphicsLayer

    introduced

    2.6

    gcx-command-category

    Export

    Parameters

    • commandName: "ExportGraphicsLayer"

    Returns TypedCommand<function>

  • Focusses map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FocusMap

    introduced

    2.9

    gcx-command-category

    Region and View

    Parameters

    • commandName: "FocusMap"

    Returns TypedCommand<function>

  • Focusses search.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FocusSearch

    introduced

    2.9

    gcx-command-category

    Region and View

    Parameters

    • commandName: "FocusSearch"

    Returns TypedCommand<function>

  • Lists all the available metadata for named selections.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FindAllSelectionMetadata

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "FindAllSelectionMetadata"

    Returns TypedCommand<function>

  • Looks up metadata about a particular named selection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FindMetadataForSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "FindMetadataForSelection"

    Returns TypedCommand<function>

  • Looks up a particular named selection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FindSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "FindSelection"

    Returns TypedCommand<function>

  • Focuses on the first selectable input in the passed view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FocusOnFirstInputInView

    introduced

    2.4

    gcx-command-category

    Region and View

    Parameters

    • commandName: "FocusOnFirstInputInView"

    Returns TypedCommand<function>

  • Set the preferred command to open the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} for the given source name.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FSMCollectionSetCommand

    introduced

    1.2

    deprecated

    2.4 This is now an internal implementation detail. For control over how different sources of features populate the viewer, consult the resultMappings option in the viewer's configuration file(s).

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "FSMCollectionSetCommand"

      The command to run for the source name.

    Returns TypedCommand<function>

  • Zooms to the current location of the device when it becomes available.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Geolocate

    introduced

    1.1

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "Geolocate"

    Returns TypedCommand<function>

  • Enables the following of the device's location when it is available, panning the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GeolocateFollow

    introduced

    2.3

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "GeolocateFollow"

    Returns TypedCommand<function>

  • Stops the tracking and following of the device's location.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GeolocateStop

    introduced

    2.3

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "GeolocateStop"

    Returns TypedCommand<function>

  • Enables the tracking of the device's location when it is available, without panning the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GeolocateTrack

    introduced

    2.3

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "GeolocateTrack"

    Returns TypedCommand<function>

  • Displays a circle around the user's position that indicates the accuracy of the GPS reading.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GeolocateShowBuffer

    introduced

    2.3

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "GeolocateShowBuffer"

    Returns TypedCommand<function>

  • Hides the circle around the user's position that indicates the accuracy of the GPS reading.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GeolocateHideBuffer

    introduced

    2.3

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "GeolocateHideBuffer"

    Returns TypedCommand<function>

  • Retrieves a Collaboration Event.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GetCollaborationEvent

    introduced

    2.8

    Parameters

    • commandName: "GetCollaborationEvent"

    Returns TypedCommand<function>

  • Retrieves the list of available Collaboration rooms.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GetCollaborationRooms

    introduced

    2.8

    Parameters

    • commandName: "GetCollaborationRooms"

    Returns TypedCommand<function>

  • Gets the edit log, passing it into a callback. If an error occurs, the error is passed into the callback.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GetEditLog

    introduced

    1.1

    gcx-command-category

    Editing

    Parameters

    • commandName: "GetEditLog"

    Returns TypedCommand<function>

  • Creates view for all configured feature details providers and embeds them into feature details dialog.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GetFeatureDetailsProviders

    Parameters

    • commandName: "GetFeatureDetailsProviders"

    Returns TypedCommand<function>

  • Gets features related to a MapService based on a specific relationship and object ID.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GetRelatedFeatures

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "GetRelatedFeatures"

    Returns TypedCommand<function>

  • Performs a global search using all active providers.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    GlobalSearch

    introduced

    1.1

    gcx-command-category

    Search

    Parameters

    • commandName: "GlobalSearch"

    Returns TypedCommand<function>

  • Generates a sharing link, passing it into a callback.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HandleGenerateSharingLink

    introduced

    2.4

    gcx-command-category

    Share

    Parameters

    • commandName: "HandleGenerateSharingLink"

    Returns TypedCommand<function>

  • Hides the feature attribute editor used to edit feature attributes.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideFeatureAttributeEditor

    introduced

    1.3

    deprecated

    2.3 This command should never be used as it can lead to a confusing state, since it only hides the editing pane without canceling feature editing.

    gcx-command-category

    Offline

    Parameters

    • commandName: "HideFeatureAttributeEditor"

    Returns TypedCommand<function>

  • Hides the Feature Details dialog.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideFeatureDetails

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "HideFeatureDetails"

    Returns TypedCommand<function>

  • Prevents the display of map tips by setting their visibility to false. Map tips must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideAllMapTips

    introduced

    2.3.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "HideAllMapTips"

    Returns TypedCommand<function>

  • Hides all plotted Coordinates temporarily.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideAllCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "HideAllCoordinates"

    Returns TypedCommand<function>

  • Hides one or many plotted Coordinates temporarily.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "HideCoordinates"

    Returns TypedCommand<function>

  • Hides any coordinate actions view that is currently active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideCoordinateActions

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "HideCoordinateActions"

    Returns TypedCommand<function>

  • Removes a modal message.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideFeatureLayerModalMessage

    Parameters

    • commandName: "HideFeatureLayerModalMessage"

    Returns TypedCommand<function>

  • Hides the feature template picker used to create new features.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideFeatureTemplatePicker

    introduced

    1.3

    gcx-command-category

    Editing

    Parameters

    • commandName: "HideFeatureTemplatePicker"

    Returns TypedCommand<function>

  • Deactivates/hides the Home Panel if it is configured to be included.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideHomePanel

    introduced

    2.7

    gcx-command-category

    Region and View

    Parameters

    • commandName: "HideHomePanel"

    Returns TypedCommand<function>

  • Hides the log view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideLog

    introduced

    2.0

    gcx-command-category

    Log

    Parameters

    • commandName: "HideLog"

    Returns TypedCommand<function>

  • Removes an element previously anchored to the map using the command ShowMapElement.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideMapElement

    introduced

    1.0

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "HideMapElement"

    Returns TypedCommand<function>

  • Closes the map service actions view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideMapServiceActions

    introduced

    2.7

    gcx-workflow-disabled
    gcx-command-category

    Layer List

    Parameters

    • commandName: "HideMapServiceActions"

    Returns TypedCommand<function>

  • Prevents the display of map tips by setting their visibility to false, and suspends displaying map tips. Map tips must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideMapTips

    introduced

    2.3.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "HideMapTips"

    Returns TypedCommand<function>

  • Closes the Layer Properties panel.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideLayerPropertiesView

    introduced

    2.7

    gcx-command-category

    Layer Addition

    Parameters

    • commandName: "HideLayerPropertiesView"

    Returns TypedCommand<function>

  • Prevents the display of markers by setting their visibility to false.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideMarkers

    introduced

    2.5

    Parameters

    • commandName: "HideMarkers"

    Returns TypedCommand<function>

  • Dismisses the Markup Style view if it is open.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideMarkupStyleView

    introduced

    2.8

    gcx-command-category

    Markup

    Parameters

    • commandName: "HideMarkupStyleView"

    Returns TypedCommand<function>

  • Prevents the display of pushpins by setting their visibility to false. Pushpins must be enabled for this command to work. Pushpins must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HidePushpins

    introduced

    2.1

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "HidePushpins"

    Returns TypedCommand<function>

  • Highlights all of the features in the specified feature set in the charting highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightChartFeatureSet

    introduced

    2.3

    gcx-workflow-disabled
    gcx-command-category

    Charting

    Parameters

    • commandName: "HighlightChartFeatureSet"

    Returns TypedCommand<function>

  • Highlights the features of a given collaboration event.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightCollaborationFeatures

    introduced

    2.8

    Parameters

    • commandName: "HighlightCollaborationFeatures"

    Returns TypedCommand<function>

  • Highlights all of the features in the specified Esri feature set in the active highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightEsriFeatureSet

    introduced

    1.2

    deprecated

    2.8 Use 'HighlightFeature' or 'HighlightFeatures'

    gcx-hyperlink-disabled
    gcx-command-category

    Highlighting

    Parameters

    • commandName: "HighlightEsriFeatureSet"

    Returns TypedCommand<function>

  • Highlights the feature (or array of features) in the default (or specified) highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightFeature

    introduced

    1.2

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "HighlightFeature"

    Returns TypedCommand<function>

  • Highlights the feature (or array of features) in the default (or specified) highlight layer. Synonym for HighlightFeature

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightFeatures

    introduced

    1.2

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "HighlightFeatures"

    Returns TypedCommand<function>

  • Clears existing highlights and highlights all specified features on the default (or specified) highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearAndHighlightFeatures

    introduced

    2.8

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "ClearAndHighlightFeatures"

    Returns TypedCommand<function>

  • Focus the specified feature on the active highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    FocusFeature

    introduced

    2.8

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "FocusFeature"

    Returns TypedCommand<function>

  • Clears the focus from a feature if it's currently focused, returning it to the highlighted state.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearFeatureEmphasis

    introduced

    2.8

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "ClearFeatureFocus"

    Returns TypedCommand<function>

  • Clears the feature highlight from a feature. This will also clear the emphasis.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearFeatureEmphasis

    introduced

    2.8

    gcx-workflow-disabled
    gcx-command-category

    Highlighting

    Parameters

    • commandName: "ClearFeatureHighlight"

    Returns TypedCommand<function>

  • Highlights the feature in the default highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightFeatureDefault

    introduced

    1.2

    deprecated

    1.3 Use HighlightFeature instead.

    gcx-workflow-disabled
    gcx-command-category

    Highlighting

    Parameters

    • commandName: "HighlightFeatureDefault"

    Returns TypedCommand<function>

  • Highlights all of the features in the specified FeatureSet in the active highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HighlightFeatureSet

    introduced

    1.2

    deprecated

    2.8 We don't use this, but if it is required please just add FeatureSet to the existing HighlightFeature command signature.

    gcx-workflow-disabled
    gcx-command-category

    Highlighting

    Parameters

    • commandName: "HighlightFeatureSet"

    Returns TypedCommand<function>

  • Executes an identify operation on a geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Identify

    introduced

    1.0

    gcx-command-category

    Identify

    Parameters

    • commandName: "Identify"

    Returns TypedCommand<function>

  • Activates the Buffer Options dialog, buffers input geometry using settings specified by the user, places temporary markup on the map and identifies using the buffered geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    IdentifyBufferedGeometry

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "IdentifyBufferedGeometry"

    Returns TypedCommand<function>

  • Activates the Buffer Options dialog, buffers input feature geometry using settings specified by the user, places temporary markup on the map and identifies using the buffered geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    IdentifyBufferedFeature

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "IdentifyBufferedFeature"

    Returns TypedCommand<function>

  • Activates the Buffer Options dialog, buffers the specified feature set geometry using settings specified by the user, places temporary markup on the map and identifies using the buffered geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    IdentifyBufferedFeatureSet

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "IdentifyBufferedFeatureSet"

    Returns TypedCommand<function>

  • Activates the Buffer Options dialog, buffers the specified feature set collection geometries using settings specified by the user, places temporary markup on the map and identifies using the buffered geometry.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    IdentifyBufferedFeatureSetCollection

    introduced

    2.5

    gcx-command-category

    Buffering

    Parameters

    • commandName: "IdentifyBufferedFeatureSetCollection"

    Returns TypedCommand<function>

  • Executes an Identify operation on the given geometry and sets "MapTip" as the feature source.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    InvokeMapTip

    introduced

    1.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "InvokeMapTip"

    Returns TypedCommand<function>

  • Tells the Geocortex Essentials Site object to begin initialization.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    InitializeSite

    introduced

    1.0

    deprecated

    2.8 The site is no longer initialized via command.

    gcx-command-category

    Start-Up

    Parameters

    • commandName: "InitializeSite"

    Returns TypedCommand<function>

  • Integrate a {@link essentials.MapService} and its sub-components into the viewer and onto the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddMapService

    introduced

    2.6

    gcx-command-category

    Layer List

    Parameters

    • commandName: "AddMapService"

    Returns TypedCommand<function>

  • Lauches a QR scan, then calls the provided callback with the result.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    LaunchBarcodeScannerWithCallback

    introduced

    2.5

    gcx-command-category

    Scanning

    Parameters

    • commandName: "LaunchBarcodeScannerWithCallback"

    Returns TypedCommand<function>

  • Wires up a {@link geocortex.essentialsHtmlViewer.integration.PostMessageTransport} and enables bi-directional communication with the component.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ListenToExternalComponentFrame

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "ListenToExternalComponentFrame"

    Returns TypedCommand<function>

  • Load a collaboration event's graphics to the collaboration graphics layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    LoadCollaborationMarkupGraphics

    introduced

    2.8

    Parameters

    • commandName: "LoadCollaborationMarkupGraphics"

    Returns TypedCommand<function>

  • Loads a project and applies it to the viewer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    LoadProject

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "LoadProject"

    Returns TypedCommand<function>

  • Presents a user interface for managing the list of available named, saved selections.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ListSelections

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ListSelections"

    Returns TypedCommand<function>

  • Presents a user interface for managing the list of available named queries.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ListQueries

    introduced

    2.8

    Parameters

    • commandName: "ListQueries"

    Returns TypedCommand<function>

  • Presents a user interface for managing the list of available named filters.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ListFilters

    introduced

    2.8

    Parameters

    • commandName: "ListFilters"

    Returns TypedCommand<function>

  • Logs an event for Geocortex Optimizer.

    name

    LogOptimizerEvent

    introduced

    2.1

    gcx-command-category

    Optimizer

    Parameters

    • commandName: "LogOptimizerEvent"

    Returns TypedCommand<function>

  • Tells the map control to resize itself. This should be called after altering the map container's dimensions.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    MapResize

    introduced

    1.0

    gcx-command-category

    Map Display

    Parameters

    • commandName: "MapResize"

    Returns TypedCommand<function>

  • Instructs the region hosting a view to maximize itself, if it supports this action. As of version 2.4, only the BottomPanelRegion and its subregions support this action.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    MaximizePanel

    introduced

    2.4

    gcx-command-category

    Region and View

    Parameters

    • commandName: "MaximizePanel"

    Returns TypedCommand<function>

  • Computes the area, perimeter and individual segment lengths for the specified polygon geometry and plots it on the map along with its measurements. Uses the spatial reference, calculation mode and units specified for the measurement module

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    MeasureArea

    introduced

    2.0

    gcx-command-category

    Measurement

    Parameters

    • commandName: "MeasureArea"

    Returns TypedCommand<function>

  • Computes the total and segment distance measurements for the specified Polyline geometry and plots it on the map along with its measurements. Uses the spatial reference, calculation mode and units specified for the measurement module.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    MeasureDistance

    introduced

    2.0

    gcx-command-category

    Measurement

    Parameters

    • commandName: "MeasureDistance"

    Returns TypedCommand<function>

  • Opens the After Action Playback view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenAfterActionPlayback

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "OpenAfterActionPlayback"

    Returns TypedCommand<function>

  • Opens the Collaboration view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenCollaboration

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "OpenCollaboration"

    Returns TypedCommand<function>

  • Opens the image associated with a given ShareImageEvent given its map Feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenEventFeatureImage

    introduced

    2.8.1

    Parameters

    • commandName: "OpenEventFeatureImage"

    Returns TypedCommand<function>

  • Opens the data frame, if it is present in the current shell.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenDataFrame

    introduced

    1.0

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenDataFrame"

    Returns TypedCommand<function>

  • Opens the data frame, if open, focusses it. This command is not available for handheld.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenAndFocusDataFrame

    introduced

    2.9

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenAndFocusDataFrame"

    Returns TypedCommand<function>

  • Opens the IWantToMenu, if open, focusses it.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenAndFocusIWantToMenu

    introduced

    2.9

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenAndFocusIWantToMenu"

    Returns TypedCommand<function>

  • Opens the bottom region, if it is present in the current shell.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenBottomRegion

    introduced

    1.3

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenBottomRegion"

    Returns TypedCommand<function>

  • Opens the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} with the given ID.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenFeatureSetCollection

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "OpenFeatureSetCollection"

    Returns TypedCommand<function>

  • Opens a new browser window to the authenticated users ArcGIS Portal 'My Content' page.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenPortalMyContentWindow

    introduced

    2.6

    gcx-command-category

    Navigation

    Parameters

    • commandName: "OpenPortalMyContentWindow"

    Returns TypedCommand<function>

  • Opens the Results Frame in shells where it is present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenResultsFrame

    introduced

    1.1

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenResultsFrame"

    Returns TypedCommand<function>

  • Opens the Overview Map when it is present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenOverviewMap

    introduced

    2.4

    gcx-command-category

    Map Display

    Parameters

    • commandName: "OpenOverviewMap"

    Returns TypedCommand<function>

  • Pans the map down on the vertical axis.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanDown

    introduced

    1.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanDown"

    Returns TypedCommand<function>

  • Pans the map left on the horizontal axis.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanLeft

    introduced

    1.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanLeft"

    Returns TypedCommand<function>

  • Pans the map right on the vertical axis.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanRight

    introduced

    1.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanRight"

    Returns TypedCommand<function>

  • Pans to the extent of all the specified features.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanToAllFeatures

    introduced

    2.3

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanToAllFeatures"

    Returns TypedCommand<function>

  • Pans to a Geocortex feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanToFeature

    introduced

    1.1

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanToFeature"

    Returns TypedCommand<function>

  • Pans to a Geocortex feature if the feature is outside of the map's extent, otherwise nothing happens.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanToFeatureIfOutsideMapExtent

    introduced

    2.4

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanToFeatureIfOutsideMapExtent"

    Returns TypedCommand<function>

  • Pans to a point on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanToPoint

    introduced

    1.0

    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanToPoint"

    Returns TypedCommand<function>

  • Pans the map up on the vertical axis.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PanUp

    introduced

    1.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "PanUp"

    Returns TypedCommand<function>

  • Plots a coordinate or a number of coordinates on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PlotCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "PlotCoordinates"

    Returns TypedCommand<function>

  • Populates the LabelOptions view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PopulateLabelOptionsView

    introduced

    2.7

    gcx-command-category

    Label Options

    Parameters

    • commandName: "PopulateLabelOptionsView"

    Returns TypedCommand<function>

  • Displays a dialog to create a printable map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PrintMap

    introduced

    1.3

    gcx-command-category

    Print

    Parameters

    • commandName: "PrintMap"

    Returns TypedCommand<function>

  • Push the contents of one collaboration room to another.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PushCollaborationRoom

    introduced

    2.8

    Parameters

    • commandName: "PushCollaborationRoom"

    Returns TypedCommand<function>

  • Displays a dialog to export the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowExportMapDialog

    introduced

    2.4

    gcx-command-category

    Export

    Parameters

    • commandName: "ShowExportMapDialog"

    Returns TypedCommand<function>

  • Shows the layer catalog view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowLayerCatalog

    introduced

    2.7

    gcx-command-category

    Layer Catalog

    Parameters

    • commandName: "ShowLayerCatalog"

    Returns TypedCommand<function>

  • Activates and shows the time slider if time slider profiles have been defined in the site.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateTimeSlider

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "ActivateTimeSlider"

    Returns TypedCommand<function>

  • Deactivates time settings applied to the map and hides the Time Slider.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DeactivateTimeSlider

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "DeactivateTimeSlider"

    Returns TypedCommand<function>

  • Hides the time slider if currently visible but does not deactivate time settings applied to the map..

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideTimeSlider

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "HideTimeSlider"

    Returns TypedCommand<function>

  • Shows the time slider settings view..

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowTimeSliderSettings

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "ShowTimeSliderSettings"

    Returns TypedCommand<function>

  • Hides the time slider settings view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideTimeSliderSettings

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "HideTimeSliderSettings"

    Returns TypedCommand<function>

  • Toggles the time slider actions container visibility.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleTimeSliderActions

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "ToggleTimeSliderActions"

    Returns TypedCommand<function>

  • Starts playback for an open time slider.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartTimeSliderPlayback

    introduced

    2.9

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "StartTimeSliderPlayback"

    Returns TypedCommand<function>

  • Stops playback for an open time slider.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StopTimeSliderPlayback

    introduced

    2.9

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "StopTimeSliderPlayback"

    Returns TypedCommand<function>

  • Steps the time slider forward in an open time slider.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StepTimeSliderForward

    introduced

    2.9

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "StepTimeSliderForward"

    Returns TypedCommand<function>

  • Steps the time slider backward in an open time slider.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StepTimeSliderBack

    introduced

    2.9

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "StepTimeSliderBack"

    Returns TypedCommand<function>

  • Sets a specified time slider profile or updates the existing profile if only a partial profile is specified.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetTimeSliderProfile

    introduced

    2.7

    gcx-command-category

    TimeSlider

    Parameters

    • commandName: "SetTimeSliderProfile"

    Returns TypedCommand<function>

  • Adds catalog layers.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AddCatalogLayers

    introduced

    2.7

    gcx-command-category

    Layer Catalog

    Parameters

    • commandName: "AddCatalogLayers"

    Returns TypedCommand<function>

  • Appends catalog layers.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    AppendCatalogLayers

    introduced

    2.7

    gcx-command-category

    Layer Catalog

    Parameters

    • commandName: "AppendCatalogLayers"

    Returns TypedCommand<function>

  • Clears all catalog layers.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearLayerCatalogLayers

    introduced

    2.7

    gcx-command-category

    Layer Catalog

    Parameters

    • commandName: "ClearLayerCatalogLayers"

    Returns TypedCommand<function>

  • Clear all saved queries

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearSavedQueries

    introduced

    2.8

    gcx-command-category

    Query

    Parameters

    • commandName: "ClearSavedQueries"

    Returns TypedCommand<function>

  • Clear all saved filters

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ClearSavedFilters

    introduced

    2.8

    gcx-command-category

    Query

    Parameters

    • commandName: "ClearSavedFilters"

    Returns TypedCommand<function>

  • Remove a collaboration event's graphics from the collaboration graphics layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveCollaborationFeatures

    introduced

    2.8

    Parameters

    • commandName: "RemoveCollaborationFeatures"

    Returns TypedCommand<function>

  • Removes specific layer catalog item like layer or map service(will not work for map service which has multiple layers like dynamicmapService).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveLayerCatalogItem

    introduced

    2.7

    gcx-command-category

    Layer Catalog

    Parameters

    • commandName: "RemoveLayerCatalogItem"

    Returns TypedCommand<function>

  • Calls a geometry service to project geometries between different coordinate systems.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Project

    introduced

    1.1

    gcx-hyperlink-disabled
    gcx-workflow-disabled
    gcx-command-category

    Projection

    Parameters

    • commandName: "Project"

    Returns TypedCommand<function>

  • Displays a prompt.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Prompt

    introduced

    1.0

    gcx-workflow-recommendations

    Instead of using the Prompt viewer command in workflows, use the Prompt workflow activity that is provided in Workflow Designer.

    gcx-command-category

    Dialog

    Parameters

    • commandName: "Prompt"

    Returns TypedCommand<function>

  • Resets the timer of the status view model.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    PulseStatus

    introduced

    1.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "PulseStatus"

    Returns TypedCommand<function>

  • Recenters the map to its existing position the next time the map is resized.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RecenterMapOnNextMapResize

    introduced

    1.1

    gcx-command-category

    Map Display

    Parameters

    • commandName: "RecenterMapOnNextMapResize"

    Returns TypedCommand<function>

  • Refresh the list of offline maps on the OfflineMapsList view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RefreshOfflineMapsList

    introduced

    2.6

    gcx-command-category

    Offline Profiles

    Parameters

    • commandName: "RefreshOfflineMapsList"

    Returns TypedCommand<function>

  • Reverses the last recorded undo operation or transaction.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Redo

    introduced

    2.5

    gcx-command-category

    Undo and Redo

    Parameters

    • commandName: "Redo"

    Returns TypedCommand<function>

  • Performs advanced set operations with multiple lists of results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CombineResults

    introduced

    2.6

    Parameters

    • commandName: "CombineResults"

    Returns TypedCommand<function>

  • Activates a series of views that guide the user to perform advanced set operations with multiple lists of results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CombineResultsInteractive

    introduced

    2.6

    Parameters

    • commandName: "CombineResultsInteractive"

    Returns TypedCommand<function>

  • Only keeps results from the current set of results that also appear in the supplied {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ResultsIntersect

    introduced

    2.6

    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ResultsIntersect"

    Returns TypedCommand<function>

  • Replaces the current set of results with the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} supplied as argument.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ResultsReplace

    introduced

    2.6

    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ResultsReplace"

    Returns TypedCommand<function>

  • Removes the supplied {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} from the current set of results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ResultsSubtract

    introduced

    2.6

    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ResultsSubtract"

    Returns TypedCommand<function>

  • Adds the supplied {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} to the current set of results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ResultsUnion

    introduced

    2.6

    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ResultsUnion"

    Returns TypedCommand<function>

  • Refresh the list of browsable projects.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RefreshProjectsList

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "RefreshProjectsList"

    Returns TypedCommand<function>

  • Registers a chart point data adapter if it is not already registered.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RegisterChartPointAdapter

    Parameters

    • commandName: "RegisterChartPointAdapter"

    Returns TypedCommand<function>

  • Registers a search provider if it is not already registered.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RegisterSearchProvider

    Parameters

    • commandName: "RegisterSearchProvider"

    Returns TypedCommand<function>

  • Registers a {@link geocortex.essentials.Layer} with the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.snapping.SnappingProvider}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RegisterSnappingLayer

    gcx-command-category

    Snapping

    Parameters

    • commandName: "RegisterSnappingLayer"

    Returns TypedCommand<function>

  • Registers multiple layers with the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.snapping.SnappingProvider}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RegisterSnappingLayers

    gcx-command-category

    Snapping

    Parameters

    • commandName: "RegisterSnappingLayers"

    Returns TypedCommand<function>

  • Removes a notification view by id

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveNotification

    introduced

    2.8

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "RemoveNotification"

    Returns TypedCommand<function>

  • Removes a {@link geocortex.essentials.Layer} from the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.snapping.SnappingProvider}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveSnappingLayer

    gcx-command-category

    Snapping

    Parameters

    • commandName: "RemoveSnappingLayer"

    Returns TypedCommand<function>

  • Removes multiple layers from the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.snapping.SnappingProvider}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RegisterSnappingLayers

    gcx-command-category

    Snapping

    Parameters

    • commandName: "RemoveSnappingLayers"

    Returns TypedCommand<function>

  • Removes a bookmark with the given name, if it exists.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveBookmark

    introduced

    2.0

    gcx-command-category

    Bookmark

    Parameters

    • commandName: "RemoveBookmark"

    Returns TypedCommand<function>

  • Removes the specified chart from the charting view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveChartById

    introduced

    2.3

    gcx-command-category

    Charting

    Parameters

    • commandName: "RemoveChartById"

    Returns TypedCommand<function>

  • Removes a cluster layer from an existing Geocortex Layer that holds an Esri FeatureLayer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveClusterLayer

    introduced

    2.5

    gcx-command-category

    Visualization

    Parameters

    • commandName: "RemoveClusterLayer"

    Returns TypedCommand<function>

  • Removes the supplied feature from the 'starred' (default) selected set.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFeatureFromStarredSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveFeatureFromStarredSelection"

    Returns TypedCommand<function>

  • Removes all features in the supplied FeatureSet from the 'starred' or default selection, if they are present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFeatureSetFromStarredSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveFeatureSetFromStarredSelection"

    Returns TypedCommand<function>

  • Removes an individual feature from the current {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} displayed in the results view. Typically, an end-user would click "Remove from Results" on a map tip to remove the feature from the results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFeatureFromResults

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveFeatureFromResults"

    Returns TypedCommand<function>

  • Removes an individual feature set from the current {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} displayed in the results view. Typically, an end-user would click "Remove Feature Set from Results" on a feature set element's inline context menu to remove the feature from the results.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFeatureSetFromResults

    introduced

    2.8

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveFeatureSetFromResults"

    Returns TypedCommand<function>

  • Removes the specified collection from the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFeatureSetCollection

    introduced

    1.2

    gcx-workflow-disabled
    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveFeatureSetCollection"

    Returns TypedCommand<function>

  • Removes the collection specified by ID from the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveFeatureSetCollectionById

    introduced

    1.2

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveFeatureSetCollectionById"

    Returns TypedCommand<function>

  • Removes a heat map visualization from a Geocortex layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveHeatMap

    introduced

    2.5

    gcx-command-category

    Visualization

    Parameters

    • commandName: "RemoveHeatMap"

    Returns TypedCommand<function>

  • Removes the highlight layer with the specified name, if one exists.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveHighlightLayer

    introduced

    1.2

    deprecated

    2.8 Not recommended to manage multiple highlight layers externally.

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "RemoveHighlightLayer"

    Returns TypedCommand<function>

  • Removes the marker from the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveMarker

    introduced

    2.5

    Parameters

    • commandName: "RemoveMarker"

    Returns TypedCommand<function>

  • Removes a user added {@link essentials.MapService} off of the map and out of the viewer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveMapService

    introduced

    2.7

    gcx-command-category

    Layer List

    Parameters

    • commandName: "RemoveMapService"

    Returns TypedCommand<function>

  • Removes the pushpin from the map for the given feature, if there is one. Pushpins must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemovePushpin

    introduced

    2.4

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "RemovePushpin"

    Returns TypedCommand<function>

  • Removes all pushpins from the map. Pushpins must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemovePushpins

    introduced

    2.3

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "RemovePushpins"

    Returns TypedCommand<function>

  • Removes the specified external component from the viewer. If the component is in a separate window, that window will be closed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveExternalComponentById

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "RemoveExternalComponentById"

    Returns TypedCommand<function>

  • Removes the status indicator from the results list or table.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveResultsStatus

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RemoveResultsStatus"

    Returns TypedCommand<function>

  • Removes the status indicator with the specified ID from the screen.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveStatus

    introduced

    1.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "RemoveStatus"

    Returns TypedCommand<function>

  • Remove a user added {@link essentials.Layer} (and its parent map service) off of the map and out of the viewer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveUserAddedLayer

    introduced

    2.6

    gcx-command-category

    Layer List

    Parameters

    • commandName: "RemoveUserAddedLayer"

    Returns TypedCommand<function>

  • Removes the visualization from a Geocortex layer, if one is enabled.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveVisualization

    introduced

    2.5

    gcx-command-category

    Visualization

    Parameters

    • commandName: "RemoveVisualization"

    Returns TypedCommand<function>

  • Removes any custom symbolization from a layer and returns it to the default state.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveVisualization

    introduced

    2.7

    gcx-command-category

    Visualization

    Parameters

    • commandName: "RemoveSymbolization"

    Returns TypedCommand<function>

  • Applies the supplied renderer to the supplied layer. Layer must be a feature layer or a dynamic mapservice layer that supports resymbolization.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RemoveVisualization

    introduced

    2.7

    gcx-command-category

    Visualization

    Parameters

    • commandName: "ResymbolizeLayer"

    Returns TypedCommand<function>

  • Assigns a new name to a saved selection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RenameSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RenameSelection"

    Returns TypedCommand<function>

  • Loads a named, saved selection into the results view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RestoreSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RestoreSelection"

    Returns TypedCommand<function>

  • Instructs the region hosting a view to restore itself to its previous dimensions, if it supports this action. As of version 2.4, only the BottomPanelRegion and its subregions support this action.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RestorePanel

    introduced

    2.4

    gcx-command-category

    Region and View

    Parameters

    • commandName: "RestorePanel"

    Returns TypedCommand<function>

  • Recalculate the size and layout of the shell and refresh the shell accordingly.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ResizeShell

    introduced

    1.2.1

    gcx-command-category

    Shell

    Parameters

    • commandName: "ResizeShell"

    Returns TypedCommand<function>

  • Displays previously hidden map tips by setting their visibility to true. Map tips must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RestoreAllMapTips

    introduced

    2.3.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "RestoreAllMapTips"

    Returns TypedCommand<function>

  • Resumes the previously suspended display of map tips.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ResumeMapTips

    introduced

    2.0

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ResumeMapTips"

    Returns TypedCommand<function>

  • Executes preset actions for the supplied feature set when a user clicks on a chart point. This includes highlighting, pan/zoom, opening Feature Details, or running a command.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunChartFeatureActions

    introduced

    2.3

    gcx-workflow-disabled
    gcx-command-category

    Charting

    Parameters

    • commandName: "RunChartFeatureActions"

    Returns TypedCommand<function>

  • Runs a workflow.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunWorkflowById

    introduced

    1.0

    gcx-command-category

    Workflow

    Parameters

    • commandName: "RunWorkflowById"

    Returns TypedCommand<function>

  • Runs a workflow with a set of input arguments.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunWorkflowWithArguments

    introduced

    1.2

    gcx-command-category

    Workflow

    gcx-workflow-requirements

    In order to use this command in a workflow, you must pass the arg parameter as a Newtonsoft.Json.Linq.JObject.

    Parameters

    • commandName: "RunWorkflowWithArguments"

    Returns TypedCommand<function>

  • Runs a workflow with a geometry used as an input argument.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunWorkflowWithGeometry

    introduced

    1.1

    gcx-workflow-disabled
    gcx-command-category

    Workflow

    Parameters

    • commandName: "RunWorkflowWithGeometry"

    Returns TypedCommand<function>

  • Runs a GW5 workflow by URL.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunWorkflowByUrl

    introduced

    2.9

    gcx-command-category

    GW5

    Parameters

    • commandName: "RunWorkflowByUrl"

    Returns TypedCommand<function>

  • Runs a GW5 workflow by URL.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunWorkflowByUrlAndInputs

    introduced

    2.9

    gcx-command-category

    GW5

    Parameters

    • commandName: "RunWorkflowByUrlAndInputs"

    Returns TypedCommand<function>

  • If a user has screen reader software enabled, then the provided string is immediately spoken to them.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ScreenReaderNarrate

    introduced

    2.4

    gcx-command-category

    WCAG

    Parameters

    • commandName: "ScreenReaderNarrate"

    Returns TypedCommand<function>

  • Disables the "ScreenReaderNarrate" command temporarily.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    DisableScreenReaderNarrate

    introduced

    2.6

    gcx-command-category

    WCAG

    Parameters

    • commandName: "DisableScreenReaderNarrate"

    Returns TypedCommand<function>

  • Enables screen reader narration if it was previously disabled using "DisableScreenReaderNarrate". Note that it will keep track of the number of calls to the "DisableScreenReaderNarrate" command and will only reactivate the screen reader once all disable commands have been cancelled by a matching enable command.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    EnableScreenReaderNarrate

    introduced

    2.6

    gcx-command-category

    WCAG

    Parameters

    • commandName: "EnableScreenReaderNarrate"

    Returns TypedCommand<function>

  • Selects a base map by name and makes it visible. All other base maps are faded out.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SelectBaseMap

    introduced

    2.0

    gcx-command-category

    Basemap

    Parameters

    • commandName: "SelectBaseMap"

    Returns TypedCommand<function>

  • Sets the active highlight layer to the one matching the name provided, if one exists.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetActiveHighlightLayer

    introduced

    1.2

    deprecated

    2.8 Use 'HighlightFeatureArgs' to specify a highlight layer when using commands (it will be created if not available)

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetActiveHighlightLayer"

    Returns TypedCommand<function>

  • Sets the default highlight layer as the active highlight layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetActiveHighlightLayerDefault

    deprecated

    2.8 Use 'HighlightFeatureArgs' to specify a highlight layer when using commands

    introduced

    1.3

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetActiveHighlightLayerDefault"

    Returns TypedCommand<function>

  • Sets the active tool.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetActiveTool

    introduced

    1.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "SetActiveTool"

    Returns TypedCommand<function>

  • Sets the location of the collaboration photo point.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetCollaborationImageLocation

    introduced

    2.8

    Parameters

    • commandName: "SetCollaborationImageLocation"

    Returns TypedCommand<function>

  • Sets the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} of interest that will be used to generate data for charts.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetCollectionOfInterest

    introduced

    2.3

    gcx-command-category

    Charting

    Parameters

    • commandName: "SetCollectionOfInterest"

    Returns TypedCommand<function>

  • Sets the edit log, passing it into a callback. If an error occurs, the error is passed into the callback.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetEditLog

    introduced

    1.1

    gcx-command-category

    Editing

    Parameters

    • commandName: "SetEditLog"

    Returns TypedCommand<function>

  • Sets the geometry for the feature currently being edited.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetEditorFeatureGeometry

    Parameters

    • commandName: "SetEditorFeatureGeometry"

    Returns TypedCommand<function>

  • Sets the current highlight border color to use, if the feature does not specify one.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetHighlightBorderColor

    introduced

    1.2

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetHighlightBorderColor"

    Returns TypedCommand<function>

  • Sets the current highlight border width to use, if the feature does not specify one.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetHighlightBorderWidth

    introduced

    2.7

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetHighlightBorderWidth"

    Returns TypedCommand<function>

  • Sets the current highlight fill color to use, if the feature does not specify one.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetHighlightFillColor

    introduced

    1.2

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetHighlightFillColor"

    Returns TypedCommand<function>

  • Sets the current combine mode to use for the identify tool.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetIdentifyCombineMode

    introduced

    2.8

    gcx-command-category

    Tool

    Parameters

    • commandName: "SetIdentifyCombineMode"

    Returns TypedCommand<function>

  • Sets the highlight border color to use for an focused feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetFocusedBorderColor

    introduced

    2.8

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetFocusedBorderColor"

    Returns TypedCommand<function>

  • Sets the current highlight fill color to use for an focused feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetFocusedFillColor

    introduced

    2.8

    gcx-command-category

    Highlighting

    Parameters

    • commandName: "SetFocusedFillColor"

    Returns TypedCommand<function>

  • Sets the measurement units for the measurements performed by the measurement module. Also updates existing measurements already on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetMeasurementUnits

    introduced

    2.0

    gcx-command-category

    Measurement

    Parameters

    • commandName: "SetMeasurementUnits"

    Returns TypedCommand<function>

  • Sets the geometry to be used in the offline map being edited.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetOfflineMapEditorGeometry

    introduced

    2.0

    gcx-command-category

    Offline Profiles

    Parameters

    • commandName: "SetOfflineMapEditorGeometry"

    Returns TypedCommand<function>

  • Sets the time extent for the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetTimeExtent

    introduced

    2.4

    gcx-command-category

    Map Display

    Parameters

    • commandName: "SetTimeExtent"

    Returns TypedCommand<function>

  • Used to start the process for creating a new related record/feature. Is activated by clicking 'Create A New Related ____' in the related feature details view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartEditingNewRelatedRecord

    introduced

    2.3

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "StartEditingNewRelatedRecord"

    Returns TypedCommand<function>

  • Shares the Viewer url on the specified platform.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShareOn

    introduced

    2.4

    gcx-command-category

    Share

    Parameters

    • commandName: "ShareOn"

    Returns TypedCommand<function>

  • Activates the accessibility view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowAccessibilityView

    introduced

    2.5

    gcx-command-category

    Accessibility

    Parameters

    • commandName: "ShowAccessibilityView"

    Returns TypedCommand<function>

  • Prompts the user to bookmark the current extent by entering a name. Requires that the BookmarkViewModel's property, bookmarksEnabled, is set to true.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowAddBookmark

    introduced

    2.4

    gcx-command-category

    Bookmark

    Parameters

    • commandName: "ShowAddBookmark"

    Returns TypedCommand<function>

  • Shows all plotted coordinates (including temporarily hidden ones) on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowAllCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "ShowAllCoordinates"

    Returns TypedCommand<function>

  • Opens the Collaboration event copy view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowCopyDialogForEvent

    introduced

    2.8

    gcx-command-category

    Collaboration

    Parameters

    • commandName: "ShowCopyDialogForEvent"

    Returns TypedCommand<function>

  • Shows one or many plotted, temporarily hidden Coordinates on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowCoordinates

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "ShowCoordinates"

    Returns TypedCommand<function>

  • Shows the configured coordinate actions.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowCoordinateActions

    introduced

    2.6

    gcx-command-category

    Plot Coordinates

    Parameters

    • commandName: "ShowCoordinateActions"

    Returns TypedCommand<function>

  • Shows the skip links.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowSkipLinks

    introduced

    2.9

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ShowSkipLinks"

    Returns TypedCommand<function>

  • Shows the labelOptions view

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowLabelOptionsView

    introduced

    2.7

    gcx-command-category

    Label Options

    Parameters

    • commandName: "ShowLabelOptionsView"

    Returns TypedCommand<function>

  • Opens the Layer Properties panel from the Layer Actions menu.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowLayerPropertiesView

    introduced

    2.7

    gcx-command-category

    Layer Addition

    Parameters

    • commandName: "ShowLayerPropertiesView"

    Returns TypedCommand<function>

  • Displays the available options for refining the current set of results; that is, Union, Subtract, Intersect.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    "ShowSearchOptions"

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowSearchOptions"

    Returns TypedCommand<function>

  • Displays the Bookmarked Locations menu if the BookmarkViewModel's property, bookmarksEnabled, is set to true.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowBookmarks

    introduced

    2.0

    gcx-command-category

    Bookmark

    Parameters

    • commandName: "ShowBookmarks"

    Returns TypedCommand<function>

  • Activates the charting view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowChartingView

    introduced

    2.3

    gcx-command-category

    Charting

    Parameters

    • commandName: "ShowChartingView"

    Returns TypedCommand<function>

  • Activates the export web map view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowExportWebMapDialog

    introduced

    2.6

    gcx-command-category

    Export

    Parameters

    • commandName: "ShowExportWebMapDialog"

    Returns TypedCommand<function>

  • Shows the feature attribute editor used to edit feature attributes.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureAttributeEditor

    introduced

    1.3

    deprecated

    2.3 The feature editor will automatically appear when editing a feature is started.

    gcx-command-category

    Offline

    Parameters

    • commandName: "ShowFeatureAttributeEditor"

    Returns TypedCommand<function>

  • Creates and displays the Feature Details dialog for the first feature in the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} specified.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFirstFeatureFromCollection

    introduced

    2.6

    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowFirstFeatureFromCollection"

    Returns TypedCommand<function>

  • Creates and displays the Feature Details dialog for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature} or {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} specified.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureDetails

    introduced

    1.3

    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowFeatureDetails"

    Returns TypedCommand<function>

  • Creates and displays the Feature Details dialog for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature} in Compact View mode. If the feature is not specified, details for the last feature will be displayed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureDetailsCompact

    introduced

    2.4

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowFeatureDetailsCompact"

    Returns TypedCommand<function>

  • Creates and displays the Feature Details dialog for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature} in Expanded View mode. If the feature is not specified, details for the last feature will be displayed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureDetailsExpanded

    introduced

    2.4

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowFeatureDetailsExpanded"

    Returns TypedCommand<function>

  • Deactivates the Maptip(except handheld) and Creates and displays the Feature Details dialog for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature}

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureDetailsFromMaptip

    introduced

    2.8

    gcx-command-category

    Feature

    Parameters

    • commandName: "ShowFeatureDetailsFromMaptip"

    Returns TypedCommand<function>

  • Creates and displays the Feature Details dialog for the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.Feature} in the specified view mode. If the feature is not specified, details for the last feature will be displayed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetFeatureDetailsMode

    introduced

    2.4

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "SetFeatureDetailsMode"

    Returns TypedCommand<function>

  • Creates a ModalMessageView view and displays the given message.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureLayerModalMessage

    Parameters

    • commandName: "ShowFeatureLayerModalMessage"

    Returns TypedCommand<function>

  • Shows the feature template picker used to create new features. If a layer is supplied, shows the templates for the layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureTemplatePicker

    introduced

    1.2

    gcx-command-category

    Editing

    Parameters

    • commandName: "ShowFeatureTemplatePicker"

    Returns TypedCommand<function>

  • Shows the previously opened feature when browsing related features in the feature details view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowFeatureParentDetails

    introduced

    2.3

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowFeatureParentDetails"

    Returns TypedCommand<function>

  • Displays the Geolocate Menu if at least one Geolocate option is enabled.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowBookmarks

    introduced

    2.3

    gcx-command-category

    Geolocation

    Parameters

    • commandName: "ShowGeolocateMenu"

    Returns TypedCommand<function>

  • Activates the Home Panel if it is configured to be included.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowHomePanel

    introduced

    2.0

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ShowHomePanel"

    Returns TypedCommand<function>

  • Activates the external component view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowExternalComponentView

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "ShowExternalComponentView"

    Returns TypedCommand<function>

  • Shows available actions for a given layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowLayerActions

    introduced

    1.3

    gcx-workflow-disabled
    gcx-command-category

    Layer

    Parameters

    • commandName: "ShowLayerActions"

    Returns TypedCommand<function>

  • Displays the layer list.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowLayerList

    introduced

    1.1

    deprecated

    2.3 Using ActivateView and pass the ID LayerListView.

    gcx-command-category

    Layer List

    Parameters

    • commandName: "ShowLayerList"

    Returns TypedCommand<function>

  • Shows available actions for a given map service.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapServiceActions

    introduced

    2.7

    gcx-workflow-disabled
    gcx-command-category

    Layer List

    Parameters

    • commandName: "ShowMapServiceActions"

    Returns TypedCommand<function>

  • Displays previously hidden map tips by setting their visibility to true, and resumes displaying map tips. Map tips must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapTips

    introduced

    2.3.1

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapTips"

    Returns TypedCommand<function>

  • Displays a dialog to save a {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as a named selection. If name is specified, the dialog will pre-populate the name input field.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowSaveSelectionDialog

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowSaveSelectionDialog"

    Returns TypedCommand<function>

  • If there is only a single saved selection, populates this in the results view. Otherwise the named selection picker is displayed.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowSelection"

    Returns TypedCommand<function>

  • Displays the 'starred' (default) selection in the results view, if it is populated.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowStarredSelection

    introduced

    2.12

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowStarredSelection"

    Returns TypedCommand<function>

  • Show the offline map editor.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowOfflineMapEditor

    gcx-command-category

    Offline Profiles

    Parameters

    • commandName: "ShowOfflineMapEditor"

    Returns TypedCommand<function>

  • Opens the Social Media sharing view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowShareView

    introduced

    2.4

    gcx-command-category

    Share

    Parameters

    • commandName: "ShowShareView"

    Returns TypedCommand<function>

  • Displays the layer list.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SwitchToLayerView

    introduced

    2.3

    gcx-command-category

    Layer List

    Parameters

    • commandName: "SwitchToLayerView"

    Returns TypedCommand<function>

  • Displays the legend view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SwitchToLegendView

    introduced

    2.3

    gcx-command-category

    Layer List

    Parameters

    • commandName: "SwitchToLegendView"

    Returns TypedCommand<function>

  • Shows the log view if the parameter is true.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowLog

    introduced

    2.0

    gcx-command-category

    Log

    Parameters

    • commandName: "ShowLog"

    Returns TypedCommand<function>

  • Activates the map view, ensuring that it is active and visible.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMap

    introduced

    1.1

    gcx-command-category

    Map Display

    Parameters

    • commandName: "ShowMap"

    Returns TypedCommand<function>

  • Displays a map tip callout anchored to a given point.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapCallout

    introduced

    1.0

    gcx-workflow-disabled
    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapCallout"

    Returns TypedCommand<function>

  • Displays an element anchored to a specific point on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapElement

    introduced

    1.0

    gcx-workflow-disabled
    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapElement"

    Returns TypedCommand<function>

  • Displays a feature in the map tip view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapTip

    introduced

    1.1

    gcx-workflow-disabled
    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapTip"

    Returns TypedCommand<function>

  • Displays a feature in a map tip callout anchored to the map

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapTipInCallout

    introduced

    2.4

    gcx-workflow-disabled
    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapTipInCallout"

    Returns TypedCommand<function>

  • Shows map tip results for a {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} previously added to the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapTipResults

    introduced

    1.0

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapTipResults"

    Returns TypedCommand<function>

  • Shows map tip results for a {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} previously added to the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}, in a floating callout window on the map.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMapTipResultsInCallout

    introduced

    2.4

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "ShowMapTipResultsInCallout"

    Returns TypedCommand<function>

  • Displays markers by setting their visibility to true.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowMarkers

    introduced

    2.5

    Parameters

    • commandName: "ShowMarkers"

    Returns TypedCommand<function>

  • Displays pushpins by setting their visibility to true, for each result in the results list or results table. Pushpins must be enabled for this command to work.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowPushpins

    introduced

    2.1

    gcx-command-category

    Pushpins

    Parameters

    • commandName: "ShowPushpins"

    Returns TypedCommand<function>

  • Cancels any feature placement while a feature is being created or edited.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StopFeaturePlacementState

    introduced

    2.5

    gcx-command-category

    Feature Editing

    Parameters

    • commandName: "StopFeaturePlacementState"

    Returns TypedCommand<function>

  • Presents a user interface for choosing to run a report from a list of reports that are available to the given reportable input (group of features).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ListReports

    introduced

    2.5

    gcx-command-category

    Reporting

    Parameters

    • commandName: "ListReports"

    Returns TypedCommand<function>

  • Alias to the command ListReports for backwards-compatibility with the Silverlight viewer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunFeatureReport

    introduced

    2.5

    gcx-command-category

    Reporting

    Parameters

    • commandName: "RunFeatureReport"

    Returns TypedCommand<function>

  • Alias to the command ListReports for backwards-compatibility with the Silverlight viewer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunFeaturesReport

    introduced

    2.5

    gcx-command-category

    Reporting

    Parameters

    • commandName: "RunFeaturesReport"

    Returns TypedCommand<function>

  • Runs a given report on the provided features, and displays the result (a download link to the report file) to the user.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunReport

    introduced

    2.5

    gcx-command-category

    Reporting

    Parameters

    • commandName: "RunReport"

    Returns TypedCommand<function>

  • Runs a given report and displays the result (a download link to the report file) to the user.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RunReportByUrl

    introduced

    2.11

    gcx-command-category

    Reporting

    Parameters

    • commandName: "RunReportByUrl"

    Returns TypedCommand<function>

  • Displays the user interface to fill in details about a project to be saved.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SaveAsProject

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "SaveAsProject"

    Returns TypedCommand<function>

  • Save the current state of the viewer as a project or displays the user interface to fill in details about the project to be saved.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SaveProject

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "SaveProject"

    Returns TypedCommand<function>

  • Shows the user interface for editing a project.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowProjectEditor

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "ShowProjectEditor"

    Returns TypedCommand<function>

  • Shows the user interface for browsing and loading projects.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowProjects

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "ShowProjects"

    Returns TypedCommand<function>

  • It displays the currently selected results in the currently active results view when no parameter is supplied, the results in the supplied collection otherwise.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowResults

    introduced

    2.11

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowResults"

    Returns TypedCommand<function>

  • Displays the list of features in the given {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as a list.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowResultsList

    introduced

    1.1

    gcx-hyperlink-disabled
    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowResultsList"

    Returns TypedCommand<function>

  • Displays the list of features in the given {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} in a tabular view.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowResultsTable

    introduced

    1.0

    gcx-hyperlink-disabled
    gcx-workflow-requirements

    In order to use this command in a workflow, you must use the ID of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} as the parameter.

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ShowResultsTable"

    Returns TypedCommand<function>

  • Switches from Results Table to Results List view if the Results Table view is currently active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SwitchToListResultsView

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "SwitchToListResultsView"

    Returns TypedCommand<function>

  • Restores the initial columns order in the currently visible table.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RestoreTableColumnsOrder

    introduced

    2.11

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RestoreTableColumnsOrder"

    Returns TypedCommand<function>

  • Restores the initial columns width in the currently visible table.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RestoreTableColumnsWidth

    introduced

    2.11

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RestoreTableColumnsWidth"

    Returns TypedCommand<function>

  • Restores the initial columns visibility in the currently visible table.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    RestoreTableColumnsVisibility

    introduced

    2.11

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "RestoreTableColumnsVisibility"

    Returns TypedCommand<function>

  • Switches the results table into editing mode.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ActivateResultsTableEditingMode

    introduced

    2.11

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "ActivateResultsTableEditingMode"

    Returns TypedCommand<function>

  • Switches from Results List to Results Table view if the Results List view is currently active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SwitchToTabularResultsView

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "SwitchToTabularResultsView"

    Returns TypedCommand<function>

  • Shows the user interface for sharing projects.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowShareProject

    introduced

    2.6

    gcx-command-category

    Projects

    Parameters

    • commandName: "ShowShareProject"

    Returns TypedCommand<function>

  • Shows the visualization options view for a given Geocortex layer if the layer supports any visualizations.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowVisualizationView

    introduced

    2.5

    gcx-command-category

    Visualization

    Parameters

    • commandName: "ShowVisualizationView"

    Returns TypedCommand<function>

  • Navigates to the sign-in page.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SignIn

    introduced

    2.2

    gcx-command-category

    User

    Parameters

    • commandName: "SignIn"

    Returns TypedCommand<function>

  • Signs the current user out.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SignOut

    introduced

    2.2

    gcx-command-category

    User

    Parameters

    • commandName: "SignOut"

    Returns TypedCommand<function>

  • Begins an edit attributes and geometry editing operation on an existing feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartEditingAttributesAndGeometryFeature

    Parameters

    • commandName: "StartEditingAttributesAndGeometryFeature"

    Returns TypedCommand<function>

  • Creates a view to change and existing edit.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartEditingEditLogEntry

    Parameters

    • commandName: "StartEditingEditLogEntry"

    Returns TypedCommand<function>

  • Begins an edit operation on an existing feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartEditingFeature

    Parameters

    • commandName: "StartEditingFeature"

    Returns TypedCommand<function>

  • Creates a view to edit a new feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartEditingNewFeature

    Parameters

    • commandName: "StartEditingNewFeature"

    Returns TypedCommand<function>

  • Starts syncing the feature data for a collection of offline maps, and displays the progress to the user.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartOfflineFeatureSync

    introduced

    2.8

    gcx-hyperlink-disabled
    gcx-command-category

    Offline

    Parameters

    • commandName: "StartOfflineFeatureSync"

    Returns TypedCommand<function>

  • Starts downloading an offline map and displays the progress to the user.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartOfflineDownloadAndShowProgress

    introduced

    2.6

    gcx-command-category

    Offline

    Parameters

    • commandName: "StartOfflineDownloadAndShowProgress"

    Returns TypedCommand<function>

  • Starts syncing an offline map and displays the progress to the user.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StartOfflineSyncAndShowProgress

    introduced

    2.6

    gcx-hyperlink-disabled
    gcx-command-category

    Offline

    Parameters

    • commandName: "StartOfflineSyncAndShowProgress"

    Returns TypedCommand<function>

  • Zooms in a step.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StepZoomIn

    introduced

    1.0

    gcx-command-category

    Navigation

    Parameters

    • commandName: "StepZoomIn"

    Returns TypedCommand<function>

  • Zooms out a step.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StepZoomOut

    introduced

    1.0

    gcx-command-category

    Navigation

    Parameters

    • commandName: "StepZoomOut"

    Returns TypedCommand<function>

  • Deactivates the Edit tool, if markup is being edited. If nothing is being edited, the Edit tool remains active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    StopEditingMarkup

    introduced

    2.0

    gcx-command-category

    Markup

    Parameters

    • commandName: "StopEditingMarkup"

    Returns TypedCommand<function>

  • Suspends the display of map tips, allowing other components the opportunity to interact with the map without invoking map tips on click/tap events.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SuspendMapTips

    introduced

    2.0

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "SuspendMapTips"

    Returns TypedCommand<function>

  • Switches to the specified layer theme. It activates the theme and updates the map based on the theme settings in the site.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SwitchToLayerTheme

    introduced

    2.3

    gcx-command-category

    Layer Theme

    Parameters

    • commandName: "SwitchToLayerTheme"

    Returns TypedCommand<function>

  • Puts the application in an offline state, if the application supports offline capabilities.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    TakeApplicationOffline

    introduced

    1.1

    gcx-hyperlink-disabled
    gcx-command-category

    Offline

    Parameters

    • commandName: "TakeApplicationOffline"

    Returns TypedCommand<function>

  • Dismisses the specified view on the next tap anywhere on the screen. Optionally fires specified callbacks.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    TapToDismiss

    introduced

    2.4

    gcx-hyperlink-disabled
    gcx-command-category

    Map Widget

    Parameters

    • commandName: "TapToDismiss"

    Returns TypedCommand<function>

  • Transitions the application from an offline state to an online state.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    TakeApplicationOnline

    introduced

    1.1

    gcx-hyperlink-disabled
    gcx-command-category

    Offline

    Parameters

    • commandName: "TakeApplicationOnline"

    Returns TypedCommand<function>

  • Activates or deactivates the data frame.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleDataFrame

    introduced

    1.0

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ToggleDataFrame"

    Returns TypedCommand<function>

  • Toggle Dynamic Labels

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleDynamicLabels

    introduced

    2.7

    gcx-command-category

    Label Options

    Parameters

    • commandName: "ToggleDynamicLabels"

    Returns TypedCommand<function>

  • Activates or deactivates the log view, based on whether or not it is currently active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleLogView

    introduced

    1.0

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ToggleLogView"

    Returns TypedCommand<function>

  • Activates or deactivates the mouse coordinates widget, based on whether or not it is currently active.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleMouseCoordinates

    introduced

    2.4

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ToggleMouseCoordinates"

    Returns TypedCommand<function>

  • Activates or deactivates the results frame.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleResultsFrame

    introduced

    1.1

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ToggleResultsFrame"

    Returns TypedCommand<function>

  • Toggle whether the specified external component is synchronized with the viewer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleExternalComponentSyncById

    introduced

    2.4

    gcx-command-category

    Integration

    Parameters

    • commandName: "ToggleExternalComponentSyncById"

    Returns TypedCommand<function>

  • Toggles the visibility of the toolbar, if present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ToggleToolbar

    introduced

    1.3

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ToggleToolbar"

    Returns TypedCommand<function>

  • Opens the toolbar, if present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenToolbar

    introduced

    2.5

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenToolbar"

    Returns TypedCommand<function>

  • Closes the toolbar, if present.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    CloseToolbar

    introduced

    2.5

    gcx-command-category

    Region and View

    Parameters

    • commandName: "CloseToolbar"

    Returns TypedCommand<function>

  • Opens the toolbar, if present. If already open, puts the toolbar in focus.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    OpenAndFocusToolbar

    introduced

    2.9

    gcx-command-category

    Region and View

    Parameters

    • commandName: "OpenAndFocusToolbar"

    Returns TypedCommand<function>

  • Hides and disables a named toolbar button.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideToolbarButton

    introduced

    2.12

    gcx-command-category

    Region and View

    Parameters

    • commandName: "HideToolbarButton"

    Returns TypedCommand<function>

  • Shows and enables a named toolbar button. The button must have been previously hidden with "HideToolbarButton".

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowToolbarButton

    introduced

    2.12

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ShowToolbarButton"

    Returns TypedCommand<function>

  • Hides and disables a named toolbar tab.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    HideToolbarTab

    introduced

    2.12

    gcx-command-category

    Region and View

    Parameters

    • commandName: "HideToolbarTab"

    Returns TypedCommand<function>

  • Shows and enables a named toolbar tab. The tab must have been previously hidden with "HideToolbarTab".

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ShowToolbarTab

    introduced

    2.12

    gcx-command-category

    Region and View

    Parameters

    • commandName: "ShowToolbarTab"

    Returns TypedCommand<function>

  • Activates a tab by its ID or name.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    SetCurrentTab

    introduced

    2.8

    gcx-command-category

    Region and View

    Parameters

    • commandName: "SetCurrentTab"

    Returns TypedCommand<function>

  • Invokes the last recorded undo operation or transaction.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    Undo

    introduced

    2.5

    gcx-command-category

    Undo and Redo

    Parameters

    • commandName: "Undo"

    Returns TypedCommand<function>

  • Presents a user interface showing the list of features to be unioned allowing user to pick master feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UnionFeaturesInteractive

    introduced

    2.10

    gcx-command-category

    Editing

    Parameters

    • commandName: "UnionFeaturesInteractive"

    Returns TypedCommand<function>

  • Merge graphics into a single graphic. The merged graphic will use the attributes of the first graphic, but can be updated in the successCallback. These edits are only applied to the graphics layer in memory.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UnionGraphicsInMemory

    introduced

    2.5

    Parameters

    • commandName: "UnionGraphicsInMemory"

    Returns TypedCommand<function>

  • Updates a feature attachment.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateAttachment

    Parameters

    • commandName: "UpdateAttachment"

    Returns TypedCommand<function>

  • Updates (edits) an existing feature. If the application is offline, an update entry is added to the edit log.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateFeature

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "UpdateFeature"

    Returns TypedCommand<function>

  • Updates existing graphics. These edits are only applied to the graphics layer in memory.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateGraphicsInMemory

    introduced

    2.5

    Parameters

    • commandName: "UpdateGraphicsInMemory"

    Returns TypedCommand<function>

  • Updates a related table record.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateRelatedRecord

    introduced

    1.1

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "UpdateRelatedRecord"

    Returns TypedCommand<function>

  • Update the visible ModalMessageView to also include the given message.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateFeatureLayerModalMessage

    Parameters

    • commandName: "UpdateFeatureLayerModalMessage"

    Returns TypedCommand<function>

  • Updates the marker with the given marker arguments.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateMarker

    introduced

    2.5

    Parameters

    • commandName: "UpdateMarker"

    Returns TypedCommand<function>

  • Updates an existing named, saved selection with the supplied {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection}.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateSelection

    introduced

    2.6

    gcx-command-category

    Feature and Feature Set

    Parameters

    • commandName: "UpdateSelection"

    Returns TypedCommand<function>

  • Updates the message shown on the status indicator.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UpdateStatus

    introduced

    2.4

    gcx-workflow-requirements

    In order to use this command in a workflow, you must pass the statusArgs parameter as a string.

    gcx-command-category

    Map Widget

    Parameters

    • commandName: "UpdateStatus"

    Returns TypedCommand<function>

  • Prompt the user to upload layers onto the map straight from their own computer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    UploadData

    introduced

    2.6

    gcx-command-category

    Upload Data

    Parameters

    • commandName: "UploadData"

    Returns TypedCommand<function>

  • Verify that no active room has the provided name.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    VerifyRoomNameUnique

    introduced

    2.8

    Parameters

    • commandName: "VerifyRoomNameUnique"

    Returns TypedCommand<function>

  • Executes a command on the collaboration WebSocket.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    WebSocketCommand

    introduced

    2.8

    Parameters

    • commandName: "WebSocketCommand"

      The name of the websocket command to be executed

    Returns TypedCommand<function>

  • Zooms out to the given extent.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomOutToExtent

    introduced

    1.1

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomOutToExtent"

    Returns TypedCommand<function>

  • Zooms to the extent of all the features.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToAllFeatures

    introduced

    1.1

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToAllFeatures"

    Returns TypedCommand<function>

  • Zooms to the extent of all the features in the feature set.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToEsriFeatureSet

    introduced

    1.0

    deprecated

    1.1 Use ZoomToFeatures instead, passing a Geocortex FeatureSet object.

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToEsriFeatureSet"

    Returns TypedCommand<function>

  • Zooms to the given extent.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToExtent

    introduced

    1.0

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToExtent"

    Returns TypedCommand<function>

  • Zooms to a feature.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToFeature

    introduced

    1.0

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToFeature"

    Returns TypedCommand<function>

  • Zooms to a feature if the it's outside of the map's extent, otherwise nothing happens.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToFeatureIfOutsideMapExtent

    introduced

    2.4

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToFeatureIfOutsideMapExtent"

    Returns TypedCommand<function>

  • Zooms to the extent of all the features in the feature set.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToFeatures

    introduced

    1.1

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToFeatures"

    Returns TypedCommand<function>

  • Zooms to the extent of all the features in the given Feature Set Collection.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToFeatureSetCollection

    introduced

    2.8

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToFeatureSetCollection"

    Returns TypedCommand<function>

  • Zooms to the full extent of the current Site.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToFullExtent

    introduced

    1.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToFullExtent"

    Returns TypedCommand<function>

  • Zooms to the initial extent of the current Site.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToInitialExtent

    introduced

    1.0

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToInitialExtent"

    Returns TypedCommand<function>

  • Zooms to the previous recorded map extent (if any)

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToPreviousExtent

    introduced

    2.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToPreviousExtent"

    Returns TypedCommand<function>

  • Zooms to the bookmarked extent with the specified name.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToNamedExtent

    introduced

    2.4

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToNamedExtent"

    Returns TypedCommand<function>

  • Zooms to the next recorded map extent (if any).

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToNextExtent

    introduced

    2.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToNextExtent"

    Returns TypedCommand<function>

  • Zooms to the current offline map's extent. If there is no current offline map, then nothing happens.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToOfflineMapExtent

    introduced

    2.6

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToOfflineMapExtent"

    Returns TypedCommand<function>

  • Zooms to the extent of all the features in a layer.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToLayerExtent

    introduced

    1.3

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToLayerExtent"

    Returns TypedCommand<function>

  • Zooms to the scale at which features in a layer become visible.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToLayerVisibleScale

    introduced

    1.3

    gcx-workflow-disabled
    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToLayerVisibleScale"

    Returns TypedCommand<function>

  • Zooms to the given scale.

    docs-gcx-command

    geocortex.essentialsHtmlViewer

    name

    ZoomToScale

    introduced

    1.3

    gcx-command-category

    Navigation

    Parameters

    • commandName: "ZoomToScale"

    Returns TypedCommand<function>

  • Parameters

    • commandName: string

    Returns TypedCommand<any>