Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Callable

  • __call(eventName: "AccessibilityIconContentInitializedEvent"): TypedEvent<function>
  • __call(eventName: "AccessibleComponentStartedEvent"): TypedEvent<function>
  • __call(eventName: "AccessibleComponentCompletedEvent"): TypedEvent<function>
  • __call(eventName: "ActiveToolChangingEvent"): TypedEvent<function>
  • __call(eventName: "ActiveToolChangedEvent"): TypedEvent<function>
  • __call(eventName: "AllLayersEnabledForIdentifyEvent"): TypedEvent<function>
  • __call(eventName: "AllLayersDisabledForIdentifyEvent"): TypedEvent<function>
  • __call(eventName: "ApplicationReadyEvent"): TypedEvent<function>
  • __call(eventName: "ApplicationStorageClearedEvent"): TypedEvent<function>
  • __call(eventName: "AuthenticationFailedEvent"): TypedEvent<function>
  • __call(eventName: "AuthenticationSucceededEvent"): TypedEvent<function>
  • __call(eventName: "BookmarksModifiedEvent"): TypedEvent<function>
  • __call(eventName: "BottomRegionMaximizedEvent"): TypedEvent<function>
  • __call(eventName: "BottomRegionRestoredEvent"): TypedEvent<function>
  • __call(eventName: "ClusterLayerAddedEvent"): TypedEvent<function>
  • __call(eventName: "ClusterLayerRemovedEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateSetHiddenEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateSetVisibleEvent"): TypedEvent<function>
  • __call(eventName: "BufferingActivatedEvent"): TypedEvent<function>
  • __call(eventName: "BufferingDeactivatedEvent"): TypedEvent<function>
  • __call(eventName: "BufferDistanceChangedEvent"): TypedEvent<function>
  • __call(eventName: "BufferingCompletedEvent"): TypedEvent<function>
  • __call(eventName: "BufferingErrorEvent"): TypedEvent<function>
  • __call(eventName: "BufferOptionsDismissedEvent"): TypedEvent<function>
  • __call(eventName: "CollaborationInitializedEvent"): TypedEvent<function>
  • __call(eventName: "CompactToolbarStateChangedEvent"): TypedEvent<function>
  • __call(eventName: "ComponentViewpointUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateAddedEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateEditedEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateDeletedEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateIdUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "CoordinateSystemUpdateAppliedEvent"): TypedEvent<function>
  • __call(eventName: "ContextMenuActivated"): TypedEvent<function>
  • __call(eventName: "ContextMenuDeactivated"): TypedEvent<function>
  • __call(eventName: "CollaborationImageLoadedEvent"): TypedEvent<function>
  • __call(eventName: "CollaborationMapEventDeletedEvent"): TypedEvent<function>
  • __call(eventName: "CollaborationRoomUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "DatalinkResolutionStartedEvent"): TypedEvent<function>
  • __call(eventName: "DatalinkResolutionCompletedEvent"): TypedEvent<function>
  • __call(eventName: "DataFrameClosedEvent"): TypedEvent<function>
  • __call(eventName: "DomainStorageClearedEvent"): TypedEvent<function>
  • __call(eventName: "DataFrameOpenedEvent"): TypedEvent<function>
  • __call(eventName: "EditorClosedEvent"): TypedEvent<function>
  • __call(eventName: "EditVertexHandleMovedEvent"): TypedEvent<function>
  • __call(eventName: "EditVertexMovedEvent"): TypedEvent<function>
  • __call(eventName: "EditorPreCreateFeatureEvent"): TypedEvent<function>
  • __call(eventName: "EditorPreUpdateFeatureEvent"): TypedEvent<function>
  • __call(eventName: "EsriWebRequestStartedEvent"): TypedEvent<function>
  • __call(eventName: "EsriWebRequestCompletedEvent"): TypedEvent<function>
  • __call(eventName: "ExternalComponentInitializedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureAttachmentAddedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureChangedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureDetailsCurrentFeatureChanged"): TypedEvent<function>
  • __call(eventName: "FeatureDetailsInvokedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureCreatedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureDataSyncCompletedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureDataSyncStartedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureDeletedEvent"): TypedEvent<function>
  • __call(eventName: "FeatureEditedEvent"): TypedEvent<function>
  • __call(eventName: "FilterControlQueryChangedEvent"): TypedEvent<function>
  • __call(eventName: "FilterControlResultChangedEvent"): TypedEvent<function>
  • __call(eventName: "FlyoutActivated"): TypedEvent<function>
  • __call(eventName: "FlyoutDeactivated"): TypedEvent<function>
  • __call(eventName: "FolderClickedEvent"): TypedEvent<function>
  • __call(eventName: "FSMCollectionAddedEvent"): TypedEvent<function>
  • __call(eventName: "FSMCollectionChangedEvent"): TypedEvent<function>
  • __call(eventName: "FSMCollectionClosedEvent"): TypedEvent<function>
  • __call(eventName: "FSMCollectionOpenedEvent"): TypedEvent<function>
  • __call(eventName: "FSMCollectionRemovedEvent"): TypedEvent<function>
  • __call(eventName: "GeolocatedEvent"): TypedEvent<function>
  • __call(eventName: "GeolocationFailedEvent"): TypedEvent<function>
  • __call(eventName: "GeometryEditCompletedEvent"): TypedEvent<function>
  • __call(eventName: "GeometryEditInvokedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicAttributesChangedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicDrawActivatedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicDrawCompletedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicDrawDeactivatedEvent"): TypedEvent<function>
  • __call(eventName: "GeometryEditPointActivatedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicEditActivatedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicEditDeactivatedEvent"): TypedEvent<function>
  • __call(eventName: "GeometryChangedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicDrawAccessibleEditActivatedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicDrawAccessibleEditDeactivatedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicEditingDoneEvent"): TypedEvent<function>
  • __call(eventName: "GraphicRemovedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicSymbolChangedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicVertexAddedEvent"): TypedEvent<function>
  • __call(eventName: "GraphicVertexMovedEvent"): TypedEvent<function>
  • __call(eventName: "HeatMapAddedEvent"): TypedEvent<function>
  • __call(eventName: "HeatMapRemovedEvent"): TypedEvent<function>
  • __call(eventName: "IdentifyCombineModeChangeEvent"): TypedEvent<function>
  • __call(eventName: "LabelOptionsChanged"): TypedEvent<function>
  • __call(eventName: "LabelsResetEvent"): TypedEvent<function>
  • __call(eventName: "LayerAddedEvent"): TypedEvent<function>
  • __call(eventName: "LayerAddedWithResultEvent"): TypedEvent<function>
  • __call(eventName: "LayerClickedEvent"): TypedEvent<function>
  • __call(eventName: "LayerDisabledForIdentifyEvent"): TypedEvent<function>
  • __call(eventName: "FilterBuilderLayerDefinitionAppliedEvent"): TypedEvent<function>
  • __call(eventName: "LayerDisplayNameChanged"): TypedEvent<function>
  • __call(eventName: "LayerEnabledForIdentifyEvent"): TypedEvent<function>
  • __call(eventName: "LayerListInitializedEvent"): TypedEvent<function>
  • __call(eventName: "LayerLongPressedEvent"): TypedEvent<function>
  • __call(eventName: "LayerPressedEvent"): TypedEvent<function>
  • __call(eventName: "LayerRemovedEvent"): TypedEvent<function>
  • __call(eventName: "LayersAddedWithResultEvent"): TypedEvent<function>
  • __call(eventName: "LayerUpdateEndedEvent"): TypedEvent<function>
  • __call(eventName: "LayerCatalogProviderFinishedEvent"): TypedEvent<function>
  • __call(eventName: "LayerCatalogProviderStartedEvent"): TypedEvent<function>
  • __call(eventName: "LayerUpdateStartedEvent"): TypedEvent<function>
  • __call(eventName: "LayerVisibilityChangedEvent"): TypedEvent<function>
  • __call(eventName: "LayerThemeChangingEvent"): TypedEvent<function>
  • __call(eventName: "LayerThemeChangedEvent"): TypedEvent<function>
  • __call(eventName: "LayerVisualizationChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapCalloutClosedEvent"): TypedEvent<function>
  • __call(eventName: "MapClickedEvent"): TypedEvent<function>
  • __call(eventName: "MapClickedPointEvent"): TypedEvent<function>
  • __call(eventName: "MapContextMenuPointUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "MapExtentChangingEvent"): TypedEvent<function>
  • __call(eventName: "MapExtentChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapExtentChangeEvent"): TypedEvent<function>
  • __call(eventName: "MapLoadedEvent"): TypedEvent<function>
  • __call(eventName: "MapMouseDownEvent"): TypedEvent<function>
  • __call(eventName: "MapMouseHoverEvent"): TypedEvent<function>
  • __call(eventName: "MapMouseUpEvent"): TypedEvent<function>
  • __call(eventName: "MapPanEndedEvent"): TypedEvent<function>
  • __call(eventName: "MapPanEvent"): TypedEvent<function>
  • __call(eventName: "MapPanStartedEvent"): TypedEvent<function>
  • __call(eventName: "MapServiceAddedEvent"): TypedEvent<function>
  • __call(eventName: "MapServiceClickedEvent"): TypedEvent<function>
  • __call(eventName: "MapServiceLayersChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapServiceLayersChangedWithResultEvent"): TypedEvent<function>
  • __call(eventName: "MapServicePropertyChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapServiceRemovedEvent"): TypedEvent<function>
  • __call(eventName: "MapServiceVisibilityChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapStartupExtentChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapTimeExtentChangedEvent"): TypedEvent<function>
  • __call(eventName: "MapTipClosedEvent"): TypedEvent<function>
  • __call(eventName: "MapZoomEndedEvent"): TypedEvent<function>
  • __call(eventName: "MapZoomEvent"): TypedEvent<function>
  • __call(eventName: "MapZoomStartedEvent"): TypedEvent<function>
  • __call(eventName: "MarkerClickedEvent"): TypedEvent<function>
  • __call(eventName: "MarkerDragEndEvent"): TypedEvent<function>
  • __call(eventName: "MarkerDragEvent"): TypedEvent<function>
  • __call(eventName: "MarkerDragStartEvent"): TypedEvent<function>
  • __call(eventName: "MarkerPointerDownEvent"): TypedEvent<function>
  • __call(eventName: "MarkerPointerUpEvent"): TypedEvent<function>
  • __call(eventName: "MarkerUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupAddedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupClearedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupDeletedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupEditingStartedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupEditingStoppedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupSymbolChangedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "MarkupTypeChangedEvent"): TypedEvent<function>
  • __call(eventName: "MeasurementEditingStartedEvent"): TypedEvent<function>
  • __call(eventName: "MeasurementMarkupAdded"): TypedEvent<function>
  • __call(eventName: "MeasurementMarkupDeleted"): TypedEvent<function>
  • __call(eventName: "MenuItemInvokedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapsLoadedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapEditedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapAddedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapRemovedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapActivatedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapEditorFinishedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapSyncedEvent"): TypedEvent<function>
  • __call(eventName: "OfflineMapSyncErrorEvent"): TypedEvent<function>
  • __call(eventName: "SelectionChangedEvent"): TypedEvent<function>
  • __call(eventName: "SelectionCreatedEvent"): TypedEvent<function>
  • __call(eventName: "SelectionRemovedEvent"): TypedEvent<function>
  • __call(eventName: "PanelResizeStartEvent"): TypedEvent<function>
  • __call(eventName: "PanelResizingEvent"): TypedEvent<function>
  • __call(eventName: "PanelResizeEndEvent"): TypedEvent<function>
  • __call(eventName: "PrintPreviewLayoutChangedEvent"): TypedEvent<function>
  • __call(eventName: "PrintPreviewScaleChangedEvent"): TypedEvent<function>
  • __call(eventName: "PrintTemplateStartedEvent"): TypedEvent<function>
  • __call(eventName: "PrintTemplateCompletedEvent"): TypedEvent<function>
  • __call(eventName: "PrintTemplateErrorEvent"): TypedEvent<function>
  • __call(eventName: "ProjectDeletedEvent"): TypedEvent<function>
  • __call(eventName: "ProjectDeletingEvent"): TypedEvent<function>
  • __call(eventName: "ProjectEditorFinishedEvent"): TypedEvent<function>
  • __call(eventName: "ProjectErrorEvent"): TypedEvent<function>
  • __call(eventName: "ProjectLoadedEvent"): TypedEvent<function>
  • __call(eventName: "ProjectLoadingEvent"): TypedEvent<function>
  • __call(eventName: "ProjectSavedEvent"): TypedEvent<function>
  • __call(eventName: "ProjectSavingEvent"): TypedEvent<function>
  • __call(eventName: "PushpinClickedEvent"): TypedEvent<function>
  • __call(eventName: "PushpinMouseEnterEvent"): TypedEvent<function>
  • __call(eventName: "PushpinMouseLeaveEvent"): TypedEvent<function>
  • __call(eventName: "PushpinMouseLeftButtonDownEvent"): TypedEvent<function>
  • __call(eventName: "PushpinMouseLeftButtonUpEvent"): TypedEvent<function>
  • __call(eventName: "PushpinMouseRightButtonDownEvent"): TypedEvent<function>
  • __call(eventName: "PushpinMouseRightButtonUpEvent"): TypedEvent<function>
  • __call(eventName: "QueryCompletedEvent"): TypedEvent<function>
  • __call(eventName: "SavedQueriesChangedEvent"): TypedEvent<function>
  • __call(eventName: "SavedFiltersChangedEvent"): TypedEvent<function>
  • __call(eventName: "RedoCompletedEvent"): TypedEvent<function>
  • __call(eventName: "RedoStartedEvent"): TypedEvent<function>
  • __call(eventName: "RelatedRecordCreatedEvent"): TypedEvent<function>
  • __call(eventName: "RelatedRecordEditedEvent"): TypedEvent<function>
  • __call(eventName: "ReportTemplateStartedEvent"): TypedEvent<function>
  • __call(eventName: "ReportTemplateCompletedEvent"): TypedEvent<function>
  • __call(eventName: "ReportStartedEvent"): TypedEvent<function>
  • __call(eventName: "ReportResultEvent"): TypedEvent<function>
  • __call(eventName: "ReportErrorEvent"): TypedEvent<function>
  • __call(eventName: "ResultsListFeatureClickedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsListFeaturePressedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsPageChangedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsTableFeatureClickedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsTableFeaturePressedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsViewCollapsedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsViewOpenedEvent"): TypedEvent<function>
  • __call(eventName: "ResultsViewClosedEvent"): TypedEvent<function>
  • __call(eventName: "SearchProgressEvent"): TypedEvent<function>
  • __call(eventName: "SearchHintClickedEvent"): TypedEvent<function>
  • __call(eventName: "SiteAuthorizationFailedEvent"): TypedEvent<function>
  • __call(eventName: "SiteInitializationFailedEvent"): TypedEvent<function>
  • __call(eventName: "SiteLayerLoadingEvent"): TypedEvent<function>
  • __call(eventName: "SiteLayerLoadedEvent"): TypedEvent<function>
  • __call(eventName: "SiteLayerLoadFailedEvent"): TypedEvent<function>
  • __call(eventName: "SiteInitializingEvent"): TypedEvent<function>
  • __call(eventName: "SiteInitializedEvent"): TypedEvent<function>
  • __call(eventName: "SiteServiceLayersFailedEvent"): TypedEvent<function>
  • __call(eventName: "SiteServiceLayersLoadedEvent"): TypedEvent<function>
  • __call(eventName: "SigningInEvent"): TypedEvent<function>
  • __call(eventName: "SigningOutEvent"): TypedEvent<function>
  • __call(eventName: "SmallBottomPanelClosedEvent"): TypedEvent<function>
  • __call(eventName: "SmallShellTopRightRegionClosingEvent"): TypedEvent<function>
  • __call(eventName: "SmallShellTopRightRegionOpeningEvent"): TypedEvent<function>
  • __call(eventName: "SnappingFeedbackEvent"): TypedEvent<function>
  • __call(eventName: "SyncInfoRefreshedEvent"): TypedEvent<function>
  • __call(eventName: "StartFeaturePlacementEvent"): TypedEvent<function>
  • __call(eventName: "StateEnteredEvent"): TypedEvent<function>
  • __call(eventName: "StateExitedEvent"): TypedEvent<function>
  • __call(eventName: "StopFeaturePlacementEvent"): TypedEvent<function>
  • __call(eventName: "TimeSliderProfileChangedEvent"): TypedEvent<function>
  • __call(eventName: "TimeSliderPlayTimelineStartedEvent"): TypedEvent<function>
  • __call(eventName: "TimeSliderPlayTimelineStoppedEvent"): TypedEvent<function>
  • __call(eventName: "TimeSliderFrameChangedEvent"): TypedEvent<function>
  • __call(eventName: "TimeSliderProfileChangingEvent"): TypedEvent<function>
  • __call(eventName: "ToggleButtonStateChangedEvent"): TypedEvent<function>
  • __call(eventName: "ToolbarButtonClickedEvent"): TypedEvent<function>
  • __call(eventName: "ToolbarViewTilePressedEvent"): TypedEvent<function>
  • __call(eventName: "ToolbarFlyoutActivatedEvent"): TypedEvent<function>
  • __call(eventName: "ToolInputMethodChangedEvent"): TypedEvent<function>
  • __call(eventName: "ToolbarFlyoutDeactivatedEvent"): TypedEvent<function>
  • __call(eventName: "TransientActivatedEvent"): TypedEvent<function>
  • __call(eventName: "TransientsDeactivatedEvent"): TypedEvent<function>
  • __call(eventName: "ToolbarTabChangedEvent"): TypedEvent<function>
  • __call(eventName: "UndoCompletedEvent"): TypedEvent<function>
  • __call(eventName: "UndoOperationAddedEvent"): TypedEvent<function>
  • __call(eventName: "UndoOperationDiscardedEvent"): TypedEvent<function>
  • __call(eventName: "UndoStartedEvent"): TypedEvent<function>
  • __call(eventName: "UndoStackChangedEvent"): TypedEvent<function>
  • __call(eventName: "UploadDataCompletedEvent"): TypedEvent<function>
  • __call(eventName: "UploadDataFailedEvent"): TypedEvent<function>
  • __call(eventName: "UserAddedLayerOrMapServiceRemovedEvent"): TypedEvent<function>
  • __call(eventName: "UserSignInCancelledEvent"): TypedEvent<function>
  • __call(eventName: "UserSigningInEvent"): TypedEvent<function>
  • __call(eventName: "UserSigningOutEvent"): TypedEvent<function>
  • __call(eventName: "VertexHandleHiddenEvent"): TypedEvent<function>
  • __call(eventName: "VertexHandleShownEvent"): TypedEvent<function>
  • __call(eventName: "ViewActivatedInContainerEvent"): TypedEvent<function>
  • __call(eventName: "ViewContainerViewClosedEvent"): TypedEvent<function>
  • __call(eventName: "ViewerPositionUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "ViewpointIndicatorUpdatedEvent"): TypedEvent<function>
  • __call(eventName: "VisualizationViewActivatedEvent"): TypedEvent<function>
  • __call(eventName: "WebSocketConnectedEvent"): TypedEvent<function>
  • __call(eventName: "WebSocketDisconnectedEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowAbortedEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowActivityCompletedEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowActivityDispatchErrorEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowActivityStartedEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowCompletedEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowWebRequestCompletedEvent"): TypedEvent<function>
  • __call(eventName: "WorkflowWebRequestStartedEvent"): TypedEvent<function>
  • __call(eventName: string): TypedEvent<any>
  • Raised when the accessibility icon content has been initialized.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AccessibilityIconContentInitializedEvent

    introduced

    2.5

    gcx-event-category

    Accessibility

    Parameters

    • eventName: "AccessibilityIconContentInitializedEvent"

    Returns TypedEvent<function>

  • Raised when a keyboard accessible component begins execution.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AccessibleComponentStartedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "AccessibleComponentStartedEvent"

    Returns TypedEvent<function>

  • Raised when a keyboard accessible component has ended execution.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AccessibleComponentCompletedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "AccessibleComponentCompletedEvent"

    Returns TypedEvent<function>

  • Raised before the active tool has been changed. This event gives subscribers an opportunity to cleanup their state before the new tool is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ActiveToolChangingEvent

    introduced

    2.8

    gcx-event-category

    Tool

    Parameters

    • eventName: "ActiveToolChangingEvent"

    Returns TypedEvent<function>

  • Raised when the active tool has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ActiveToolChangedEvent

    introduced

    1.1

    gcx-event-category

    Tool

    Parameters

    • eventName: "ActiveToolChangedEvent"

    Returns TypedEvent<function>

  • Raised when the all identifiable layers are enabled for identify operations.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AllLayersEnabledForIdentifyEvent

    introduced

    2.5

    gcx-event-category

    Identify

    Parameters

    • eventName: "AllLayersEnabledForIdentifyEvent"

    Returns TypedEvent<function>

  • Raised when the all identifiable layers are disabled for identify operations.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AllLayersDisabledForIdentifyEvent

    introduced

    2.5

    gcx-event-category

    Identify

    Parameters

    • eventName: "AllLayersDisabledForIdentifyEvent"

    Returns TypedEvent<function>

  • Raised when the application is ready to go. External clients can now run code that manipulates the UI.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ApplicationReadyEvent

    introduced

    2.11

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "ApplicationReadyEvent"

    Returns TypedEvent<function>

  • Raised when an application's storage space is cleared.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ApplicationStorageClearedEvent

    introduced

    1.2

    gcx-event-category

    Offline

    Parameters

    • eventName: "ApplicationStorageClearedEvent"

    Returns TypedEvent<function>

  • Raised when a user fails to authenticate against a {@link essentials.Site}.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AuthenticationFailedEvent

    introduced

    1.0

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "AuthenticationFailedEvent"

    Returns TypedEvent<function>

  • Raised when a user successfully authenticates against a Site.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    AuthenticationSucceededEvent

    introduced

    1.0

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "AuthenticationSucceededEvent"

    Returns TypedEvent<function>

  • Raised when a bookmark is added or removed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BookmarksModifiedEvent

    introduced

    2.0

    gcx-event-category

    Bookmark

    Parameters

    • eventName: "BookmarksModifiedEvent"

    Returns TypedEvent<function>

  • Raised when the Bottom Region is maximized.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BottomRegionMaximizedEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "BottomRegionMaximizedEvent"

    Returns TypedEvent<function>

  • Raised when the Bottom Region is restored to its previous dimensions.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BottomRegionRestoredEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "BottomRegionRestoredEvent"

    Returns TypedEvent<function>

  • Raised when a new Cluster Layer is added to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ClusterLayerAddedEvent

    introduced

    2.5

    gcx-event-category

    Visualization

    Parameters

    • eventName: "ClusterLayerAddedEvent"

    Returns TypedEvent<function>

  • Raised when a Cluster Layer is removed from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ClusterLayerRemovedEvent

    introduced

    2.5

    gcx-event-category

    Visualization

    Parameters

    • eventName: "ClusterLayerRemovedEvent"

    Returns TypedEvent<function>

  • Raised when a plotted coordinate is temporarily hidden.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateSetHiddenEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateSetHiddenEvent"

    Returns TypedEvent<function>

  • Raised when a plotted coordinate which was hidden, is set visible again.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateSetHiddenEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateSetVisibleEvent"

    Returns TypedEvent<function>

  • Raised when buffering is activated for a target command or commands.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BufferingActivatedEvent

    introduced

    2.5

    gcx-event-category

    Buffering

    Parameters

    • eventName: "BufferingActivatedEvent"

    Returns TypedEvent<function>

  • Raised when buffering is deactivated for a target command or commands.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BufferingDeactivatedEvent

    introduced

    2.5

    gcx-event-category

    Buffering

    Parameters

    • eventName: "BufferingDeactivatedEvent"

    Returns TypedEvent<function>

  • Raised when the current buffer distance or units for a command are changed by the user via the Buffer Options dialog.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BufferDistanceChangedEvent

    introduced

    2.5

    gcx-event-category

    Buffering

    Parameters

    • eventName: "BufferDistanceChangedEvent"

    Returns TypedEvent<function>

  • Raised when a buffering operation successfully completes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BufferingCompletedEvent

    introduced

    2.5

    gcx-event-category

    Buffering

    Parameters

    • eventName: "BufferingCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a buffering operation returns an error.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BufferingErrorEvent

    introduced

    2.5

    gcx-event-category

    Buffering

    Parameters

    • eventName: "BufferingErrorEvent"

    Returns TypedEvent<function>

  • Raised when the Buffer Options dialog for any command is dismissed when the user clicks Continue.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    BufferOptionsDismissedEvent

    introduced

    2.5

    gcx-event-category

    Buffering

    Parameters

    • eventName: "BufferOptionsDismissedEvent"

    Returns TypedEvent<function>

  • Raised when the Collaboration module successfully Initializes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CollaborationInitializedEvent

    introduced

    2.8

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "CollaborationInitializedEvent"

    Returns TypedEvent<function>

  • Raised when the Compact Toolbar is expanded or collapsed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CompactToolbarStateChanged

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "CompactToolbarStateChangedEvent"

    Returns TypedEvent<function>

  • Raised when an external components viewpoint has been updated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ComponentViewpointUpdatedEvent

    introduced

    2.4

    gcx-event-category

    Integration

    Parameters

    • eventName: "ComponentViewpointUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when a coordinate is resolved and successfully plotted on the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateAddedEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateAddedEvent"

    Returns TypedEvent<function>

  • Raised when a coordinate is successfully edited.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateEditedEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateEditedEvent"

    Returns TypedEvent<function>

  • Raised when a coordinate is successfully deleted and removed from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateDeletedEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateDeletedEvent"

    Returns TypedEvent<function>

  • Raised when a coordinate's id is updated, possibly as a result of another coordinate in the coordinate list being deleted.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateIdUpdatedEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateIdUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when a coordinate successfully updates itself in response to a change in the global coordinate system setting.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CoordinateSystemUpdateAppliedEvent

    introduced

    2.6

    gcx-event-category

    Plot Coordinates

    Parameters

    • eventName: "CoordinateSystemUpdateAppliedEvent"

    Returns TypedEvent<function>

  • Raised when the context menu is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ContextMenuActivated

    introduced

    2.6

    gcx-event-category

    Interface

    Parameters

    • eventName: "ContextMenuActivated"

    Returns TypedEvent<function>

  • Raised when the context menu is deactivated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ContextMenuDeactivated

    introduced

    2.6

    gcx-event-category

    Interface

    Parameters

    • eventName: "ContextMenuDeactivated"

    Returns TypedEvent<function>

  • Raised when a Collaboration image event finishes loading.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CollaborationImageLoadedEvent

    introduced

    2.8

    gcx-event-category

    Collaboration

    Parameters

    • eventName: "CollaborationImageLoadedEvent"

    Returns TypedEvent<function>

  • Raised when a Collaboration event's graphics are removed from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CollaborationMapEventDeleted

    introduced

    2.8

    gcx-event-category

    Collaboration

    Parameters

    • eventName: "CollaborationMapEventDeletedEvent"

    Returns TypedEvent<function>

  • Raised when a collaboration room is updated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    CollaborationRoomUpdatedEvent

    introduced

    2.8

    gcx-event-category

    Collaboration

    Parameters

    • eventName: "CollaborationRoomUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when datalinks are discovered for the current {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSet} and resolution begins.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    DatalinkResolutionStartedEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "DatalinkResolutionStartedEvent"

    Returns TypedEvent<function>

  • Raised when datalinks are successfully resolved.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    DatalinkResolutionCompletedEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "DatalinkResolutionCompletedEvent"

    Returns TypedEvent<function>

  • Raised when the Data Frame is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    DataFrameClosedEvent

    introduced

    1.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "DataFrameClosedEvent"

    Returns TypedEvent<function>

  • Raised when offline data is cleared for an entire domain.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    DomainStorageClearedEvent

    introduced

    1.1

    gcx-event-category

    Offline

    Parameters

    • eventName: "DomainStorageClearedEvent"

    Returns TypedEvent<function>

  • Raised when the Data Frame is opened.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    DataFrameOpenedEvent

    introduced

    1.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "DataFrameOpenedEvent"

    Returns TypedEvent<function>

  • Raised when the feature editor is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EditorClosedEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "EditorClosedEvent"

    Returns TypedEvent<function>

  • Raised when a vertex within the Esri editor is dragged with the mouse.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EditVertexHandleMovedEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "EditVertexHandleMovedEvent"

    Returns TypedEvent<function>

  • Raised when a vertex is moved with the keyboard.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EditVertexMovedEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "EditVertexMovedEvent"

    Returns TypedEvent<function>

  • Raised when a new feature is about to be created.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EditorPreCreateFeatureEvent

    introduced

    1.2

    gcx-event-category

    Editing

    Parameters

    • eventName: "EditorPreCreateFeatureEvent"

    Returns TypedEvent<function>

  • Raised when an existing feature is about to be updated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EditorPreUpdateFeatureEvent

    introduced

    1.2

    gcx-event-category

    Editing

    Parameters

    • eventName: "EditorPreUpdateFeatureEvent"

    Returns TypedEvent<function>

  • Raised when an HTTP request to an Esri resource is started.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EsriWebRequestStartedEvent

    introduced

    2.5

    gcx-event-category

    Performance

    Parameters

    • eventName: "EsriWebRequestStartedEvent"

    Returns TypedEvent<function>

  • Raised when an HTTP request to an Esri resource is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    EsriWebRequestCompletedEvent

    introduced

    2.5

    gcx-event-category

    Performance

    Parameters

    • eventName: "EsriWebRequestCompletedEvent"

    Returns TypedEvent<function>

  • Raised when an external component has established a {@link essentialsHtmlViewer.integration.PostMessageTransport}.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ExternalComponentInitializedEvent

    introduced

    2.4

    gcx-event-category

    Integration

    Parameters

    • eventName: "ExternalComponentInitializedEvent"

    Returns TypedEvent<function>

  • Raised when a file attachment is added to a feature.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureAttachmentAddedEvent

    introduced

    1.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "FeatureAttachmentAddedEvent"

    Returns TypedEvent<function>

  • Raised when a feature is changed - for example when datalinks are asynchronously resolved.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureChangedEvent

    introduced

    1.2

    gcx-event-category

    Editing

    Parameters

    • eventName: "FeatureChangedEvent"

    Returns TypedEvent<function>

  • Raised when the current feature whose details are being displayed by the Feature Details module changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureDetailsCurrentFeatureChanged

    introduced

    2.4

    gcx-event-category

    Feature Details

    Parameters

    • eventName: "FeatureDetailsCurrentFeatureChanged"

    Returns TypedEvent<function>

  • Raised when the Feature Details module is invoked in order to display results for a given feature.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureDetailsInvokedEvent

    introduced

    2.6

    gcx-event-category

    Feature Details

    Parameters

    • eventName: "FeatureDetailsInvokedEvent"

    Returns TypedEvent<function>

  • Raised when a feature is created.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureCreatedEvent

    introduced

    2.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "FeatureCreatedEvent"

    Returns TypedEvent<function>

  • Raised when a feature data synchronization has completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureDataSyncCompleteEvent

    introduced

    2.6

    gcx-event-category

    Offline

    Parameters

    • eventName: "FeatureDataSyncCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a feature data synchronization has started.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureDataSyncStartedEvent

    introduced

    2.6

    gcx-event-category

    Offline

    Parameters

    • eventName: "FeatureDataSyncStartedEvent"

    Returns TypedEvent<function>

  • Raised when a feature is deleted.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureDeletedEvent

    introduced

    1.2

    gcx-event-category

    Editing

    Parameters

    • eventName: "FeatureDeletedEvent"

    Returns TypedEvent<function>

  • Raised when a feature is edited.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FeatureEditedEvent

    introduced

    1.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "FeatureEditedEvent"

    Returns TypedEvent<function>

  • Raised when the query associated with a particular filter control changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FilterControlQueryChangedEvent

    introduced

    2.8

    gcx-event-category

    Filter-Control

    Parameters

    • eventName: "FilterControlQueryChangedEvent"

    Returns TypedEvent<function>

  • Raised when the results associated with a filter control change as a result of a different query being applied to the filter.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FilterControlResultChangedEvent

    introduced

    2.8

    gcx-event-category

    Filter-Control

    Parameters

    • eventName: "FilterControlResultChangedEvent"

    Returns TypedEvent<function>

  • Raised when a module opens a flyout menu.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FlyoutActivated

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "FlyoutActivated"

    Returns TypedEvent<function>

  • Raised when a module closes a flyout menu.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FlyoutDeactivated

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "FlyoutDeactivated"

    Returns TypedEvent<function>

  • Raised when a folder item in the layer list is clicked or tapped.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FolderClickedEvent

    introduced

    2.3

    gcx-event-category

    Layer List

    Parameters

    • eventName: "FolderClickedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} is added to the {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FSMCollectionAddedEvent

    introduced

    1.0

    gcx-event-category

    Feature Set Collection

    Parameters

    • eventName: "FSMCollectionAddedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} in the {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager} is altered.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FSMCollectionChangedEvent

    introduced

    1.0

    gcx-event-category

    Feature Set Collection

    Parameters

    • eventName: "FSMCollectionChangedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} is closed in the {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FSMCollectionClosedEvent

    introduced

    1.0

    gcx-event-category

    Feature Set Collection

    Parameters

    • eventName: "FSMCollectionClosedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} is opened in the {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FSMCollectionOpenedEvent

    introduced

    1.0

    gcx-event-category

    Feature Set Collection

    Parameters

    • eventName: "FSMCollectionOpenedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} is removed from the {@link essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager}.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FSMCollectionRemovedEvent

    introduced

    1.0

    gcx-event-category

    Feature Set Collection

    Parameters

    • eventName: "FSMCollectionRemovedEvent"

    Returns TypedEvent<function>

  • Raised after a successful geolocation operation.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GeolocatedEvent

    introduced

    1.0

    gcx-event-category

    Map

    Parameters

    • eventName: "GeolocatedEvent"

    Returns TypedEvent<function>

  • Raised when a geolocation operation fails in find, track, or follow mode.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GeolocationFailedEvent

    introduced

    2.3

    gcx-event-category

    Map

    Parameters

    • eventName: "GeolocationFailedEvent"

    Returns TypedEvent<function>

  • Raised when geometry of a feature has been edited.

    name

    GeometryEditCompletedEvent

    introduced

    1.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "GeometryEditCompletedEvent"

    Returns TypedEvent<function>

  • Raised when editing of the geometry of a feature has started.

    name

    GeometryEditInvokedEvent

    introduced

    1.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "GeometryEditInvokedEvent"

    Returns TypedEvent<function>

  • Raised when the attributes of esri graphic are updated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicAttributesChangedEvent

    introduced

    2.8

    gcx-event-category

    Editing

    Parameters

    • eventName: "GraphicAttributesChangedEvent"

    Returns TypedEvent<function>

  • Raised when the component for drawing shapes is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicDrawActivatedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicDrawActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the user has ended drawing.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicDrawCompletedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicDrawCompletedEvent"

    Returns TypedEvent<function>

  • Raised when the component for drawing shapes is deactivated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicDrawDeactivatedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicDrawDeactivatedEvent"

    Returns TypedEvent<function>

  • Raised when the component for editing a point-based feature is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GeometryEditPointActivatedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "GeometryEditPointActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the component for editing graphics is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicEditActivatedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicEditActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the component for editing graphics is deactivated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicEditDeactivatedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicEditDeactivatedEvent"

    Returns TypedEvent<function>

  • Raised when mouse is released while moving, rotating, scaling or moving vertex of the esri graphic.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GeometryChangedEvent

    introduced

    2.8

    gcx-event-category

    Editing

    Parameters

    • eventName: "GeometryChangedEvent"

    Returns TypedEvent<function>

  • Raised when the component for editing draw/markup graphics is activated after a drawing is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicDrawAccessibleEditActivatedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicDrawAccessibleEditActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the component for editing draw/markup graphics is deactivated after a drawing is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicDrawAccessibleEditDeactivatedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicDrawAccessibleEditDeactivatedEvent"

    Returns TypedEvent<function>

  • Raised when we are done editing a clickable graphic.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicEditingDoneEvent

    introduced

    2.8

    gcx-event-category

    Editing

    Parameters

    • eventName: "GraphicEditingDoneEvent"

    Returns TypedEvent<function>

  • Raised when a clickable graphic is removed from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicRemovedEvent

    introduced

    2.8

    gcx-event-category

    Editing

    Parameters

    • eventName: "GraphicRemovedEvent"

    Returns TypedEvent<function>

  • Raised when the symbology of edited markup changes

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicSymbolChangedEvent

    introduced

    2.8

    gcx-event-category

    Markup

    Parameters

    • eventName: "GraphicSymbolChangedEvent"

    Returns TypedEvent<function>

  • Raised when a new vertex is added to a polyline or polygon or a new point is added to a multipoint in an active drawing session.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicVertexAddedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicVertexAddedEvent"

    Returns TypedEvent<function>

  • Raised when the graphic vertex drawing tool is moved using the keyboard.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    GraphicVertexMovedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "GraphicVertexMovedEvent"

    Returns TypedEvent<function>

  • Raised when a Geocortex layer has a heat map visualization added.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    HeatMapAddedEvent

    introduced

    2.5

    gcx-event-category

    Visualization

    Parameters

    • eventName: "HeatMapAddedEvent"

    Returns TypedEvent<function>

  • Raised when a Geocortex layer has a heat map visualization removed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    HeatMapRemovedEvent

    introduced

    2.5

    gcx-event-category

    Visualization

    Parameters

    • eventName: "HeatMapRemovedEvent"

    Returns TypedEvent<function>

  • Raised when the combine mode for the identify tool changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    IdentifyCombineModeChangeEvent

    introduced

    2.8

    gcx-event-category

    Tool

    Parameters

    • eventName: "IdentifyCombineModeChangeEvent"

    Returns TypedEvent<function>

  • Raised when label symbolization is changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LabelOptionsChanged

    introduced

    2.7

    gcx-event-category

    Label Options

    Parameters

    • eventName: "LabelOptionsChanged"

    Returns TypedEvent<function>

  • Raised when label symbolization is reset back to default.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LabelsResetEvent

    introduced

    2.7

    gcx-event-category

    Label Options

    Parameters

    • eventName: "LabelsResetEvent"

    Returns TypedEvent<function>

  • Raised when a layer has been added to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerAddedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "LayerAddedEvent"

    Returns TypedEvent<function>

  • Raised when a layer is added to the map, or a layer fails to be added to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerAddedWithResultEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "LayerAddedWithResultEvent"

    Returns TypedEvent<function>

  • Raised when a layer item in the layer list is clicked or tapped.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerClickedEvent

    introduced

    1.1

    gcx-event-category

    Layer List

    Parameters

    • eventName: "LayerClickedEvent"

    Returns TypedEvent<function>

  • Raised when a specific layer has been disabled from participating in identify operations.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerDisabledForIdentifyEvent

    introduced

    2.5

    gcx-event-category

    Identify

    Parameters

    • eventName: "LayerDisabledForIdentifyEvent"

    Returns TypedEvent<function>

  • Raised when a filter is applied using the Filter Builder tool

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    FilterBuilderLayerDefinitionAppliedEvent

    introduced

    2.7

    gcx-event-category

    Query Builder

    Parameters

    • eventName: "FilterBuilderLayerDefinitionAppliedEvent"

    Returns TypedEvent<function>

  • Raised when a specific layer's display name has been changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerDisplayNameChanged

    introduced

    2.7

    gcx-event-category

    Layer Addition

    Parameters

    • eventName: "LayerDisplayNameChanged"

    Returns TypedEvent<function>

  • Raised when a specific layer has been enabled such that it participates in identify operations.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerEnabledForIdentifyEvent

    introduced

    2.5

    gcx-event-category

    Identify

    Parameters

    • eventName: "LayerEnabledForIdentifyEvent"

    Returns TypedEvent<function>

  • Raised after the configurable layer list has initialized and the initial layer theme has been loaded.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerListInitializedEvent

    introduced

    2.3

    gcx-event-category

    Layer List

    Parameters

    • eventName: "LayerListInitializedEvent"

    Returns TypedEvent<function>

  • Raised when a layer item in the layer list is pressed for a long time.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerLongPressedEvent

    introduced

    1.1

    gcx-event-category

    Layer List

    Parameters

    • eventName: "LayerLongPressedEvent"

    Returns TypedEvent<function>

  • Raised when a layer item in the layer list is clicked or tapped.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerPressedEvent

    introduced

    1.1

    gcx-event-category

    Layer List

    Parameters

    • eventName: "LayerPressedEvent"

    Returns TypedEvent<function>

  • Raised when a layer has been removed from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerRemovedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "LayerRemovedEvent"

    Returns TypedEvent<function>

  • Raised when more than one layer is added to the map, or more than one layer fails to be added to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayersAddedWithResultEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "LayersAddedWithResultEvent"

    Returns TypedEvent<function>

  • Raised when a layer finishes updating its content.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerUpdateEndedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "LayerUpdateEndedEvent"

    Returns TypedEvent<function>

  • Raised when the provider has finished fetching all expected catalog layers.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerCatalogProviderFinishedEvent

    introduced

    2.7

    gcx-event-category

    Layer Catalog

    Parameters

    • eventName: "LayerCatalogProviderFinishedEvent"

    Returns TypedEvent<function>

  • Raised when the provider has started fetching all expected catalog layers.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerCatalogProviderStartedEvent

    introduced

    2.7

    gcx-event-category

    Layer Catalog

    Parameters

    • eventName: "LayerCatalogProviderStartedEvent"

    Returns TypedEvent<function>

  • Raised when a layer begins to update its content.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerUpdateStartedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "LayerUpdateStartedEvent"

    Returns TypedEvent<function>

  • Raised when the visibility of a layer has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerVisibilityChangedEvent

    introduced

    2.3

    gcx-event-category

    Interface

    Parameters

    • eventName: "LayerVisibilityChangedEvent"

    Returns TypedEvent<function>

  • Raised just before the layer theme is changed. At this point, the active theme property will be set, but the theme will not yet have been applied to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerThemeChangingEvent

    introduced

    2.3

    gcx-event-category

    Layer Theme

    Parameters

    • eventName: "LayerThemeChangingEvent"

    Returns TypedEvent<function>

  • Raised just after the layer theme has changed. At this point the theme will have been applied to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerThemeChangedEvent

    introduced

    2.3

    gcx-event-category

    Layer Theme

    Parameters

    • eventName: "LayerThemeChangedEvent"

    Returns TypedEvent<function>

  • Raised when a Geocortex layer has its visualization changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    LayerVisualizationChangedEvent

    introduced

    2.5

    gcx-event-category

    Visualization

    Parameters

    • eventName: "LayerVisualizationChangedEvent"

    Returns TypedEvent<function>

  • Raised when a map callout window is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapCalloutClosedEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "MapCalloutClosedEvent"

    Returns TypedEvent<function>

  • Raised when a user clicks on the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapClickedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapClickedEvent"

    Returns TypedEvent<function>

  • Raised when a user clicks on the map, containing the point where the click occured. This is a repackaging of the 'MapClickedEvent' containing only the Point object.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapClickedPointEvent

    introduced

    2.9

    gcx-event-category

    Map

    Parameters

    • eventName: "MapClickedPointEvent"

    Returns TypedEvent<function>

  • Raised when a user triggers the context menu via right-click or long press of the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapContextMenuPointUpdatedEvent

    introduced

    2.6

    gcx-event-category

    Interface

    Parameters

    • eventName: "MapContextMenuPointUpdatedEvent"

    Returns TypedEvent<function>

  • Raised as the extent of the map changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapExtentChangingEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapExtentChangingEvent"

    Returns TypedEvent<function>

  • Raised when the extent of the map completes a pan or zoom operation.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapExtentChangedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapExtentChangedEvent"

    Returns TypedEvent<function>

  • Raised as the extent of the map changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapExtentChangeEvent

    introduced

    1.0

    gcx-event-category

    Map

    Parameters

    • eventName: "MapExtentChangeEvent"

    Returns TypedEvent<function>

  • Raised when the Esri map control is loaded.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapLoadedEvent

    introduced

    1.0

    gcx-event-category

    Load

    Parameters

    • eventName: "MapLoadedEvent"

    Returns TypedEvent<function>

  • Raised when a user clicks on the map before releasing the mouse button.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapMouseDownEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapMouseDownEvent"

    Returns TypedEvent<function>

  • Raised when a user hovers on the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapMouseHoverEvent

    introduced

    2.4

    gcx-event-category

    Map

    Parameters

    • eventName: "MapMouseHoverEvent"

    Returns TypedEvent<function>

  • Raised when a user clicks on the map after releasing the mouse button.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapMouseUpEvent

    introduced

    2.4

    gcx-event-category

    Map

    Parameters

    • eventName: "MapMouseUpEvent"

    Returns TypedEvent<function>

  • Raised when a pan operation is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapPanEndedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapPanEndedEvent"

    Returns TypedEvent<function>

  • Raised while a pan operation is in progress.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapPanEvent

    introduced

    1.0

    gcx-event-category

    Map

    Parameters

    • eventName: "MapPanEvent"

    Returns TypedEvent<function>

  • Raised at the beginning of a pan operation on the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapPanStartedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapPanStartedEvent"

    Returns TypedEvent<function>

  • Raised when a map service is added to the Essentials Map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServiceAddedEvent

    introduced

    2.2

    gcx-event-category

    Map

    Parameters

    • eventName: "MapServiceAddedEvent"

    Returns TypedEvent<function>

  • Raised when a map service layer in the layer list is clicked or tapped.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServiceClickedEvent

    introduced

    1.1

    gcx-event-category

    Layer List

    Parameters

    • eventName: "MapServiceClickedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentials.MapService} has layers change by a user.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServiceLayersChangedEvent

    introduced

    2.2

    gcx-event-category

    Map

    Parameters

    • eventName: "MapServiceLayersChangedEvent"

    Returns TypedEvent<function>

  • Raised when a user changes the layers of a {@link essentials.MapService}. For example, when new dynamic layers are added to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServiceLayersChangedWithResultEvent

    introduced

    2.5.2

    gcx-event-category

    Map

    Parameters

    • eventName: "MapServiceLayersChangedWithResultEvent"

    Returns TypedEvent<function>

  • Raised when a property on a {@link essentials.MapService} changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServicePropertyChangedEvent

    introduced

    2.2

    gcx-event-category

    Map

    Parameters

    • eventName: "MapServicePropertyChangedEvent"

    Returns TypedEvent<function>

  • Raised when a map service is removed from the Essentials Map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServiceRemovedEvent

    introduced

    2.2

    gcx-event-category

    Map

    Parameters

    • eventName: "MapServiceRemovedEvent"

    Returns TypedEvent<function>

  • Raised when the visibility of a map service has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapServiceVisibilityChangedEvent

    introduced

    2.3

    gcx-event-category

    Map

    Parameters

    • eventName: "MapServiceVisibilityChangedEvent"

    Returns TypedEvent<function>

  • Raised when the preferred extent to show on startup changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapStartupExtentChangedEvent

    Parameters

    • eventName: "MapStartupExtentChangedEvent"

    Returns TypedEvent<function>

  • Raised when the time extent of the map changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapTimeExtentChangedEvent

    introduced

    2.7

    gcx-event-category

    Interface

    Parameters

    • eventName: "MapTimeExtentChangedEvent"

    Returns TypedEvent<function>

  • Raised when the map tip window is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapTipClosedEvent

    introduced

    1.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "MapTipClosedEvent"

    Returns TypedEvent<function>

  • Raised when a zoom operation completes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapZoomEndedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapZoomEndedEvent"

    Returns TypedEvent<function>

  • Raised during a zoom operation.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapZoomEvent

    introduced

    1.0

    gcx-event-category

    Map

    Parameters

    • eventName: "MapZoomEvent"

    Returns TypedEvent<function>

  • Raised when a map zoom operation begins.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MapZoomStartedEvent

    introduced

    1.1

    gcx-event-category

    Map

    Parameters

    • eventName: "MapZoomStartedEvent"

    Returns TypedEvent<function>

  • Raised when a marker is clicked.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerClickedEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerClickedEvent"

    Returns TypedEvent<function>

  • Raised when a marker stops dragging (pointer has been released).

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerDragEndEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerDragEndEvent"

    Returns TypedEvent<function>

  • Raised when a marker is being dragged.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerDragEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerDragEvent"

    Returns TypedEvent<function>

  • Raised when a marker begins dragging.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerDragStartEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerDragStartEvent"

    Returns TypedEvent<function>

  • Raised when a pointer input is pressed down on a marker.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerPointerDownEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerPointerDownEvent"

    Returns TypedEvent<function>

  • Raised when a pointer input is pressed up on a marker.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerPointerUpEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerPointerUpEvent"

    Returns TypedEvent<function>

  • Raised when a marker is updated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkerUpdatedEvent

    introduced

    2.5

    Parameters

    • eventName: "MarkerUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when markup is added to the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupAddedEvent

    introduced

    2.0

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupAddedEvent"

    Returns TypedEvent<function>

  • Raised when markup is cleared from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupClearedEvent

    introduced

    2.0

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupClearedEvent"

    Returns TypedEvent<function>

  • Raised when markup is deleted from the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupDeletedEvent

    introduced

    2.0

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupDeletedEvent"

    Returns TypedEvent<function>

  • Raised when editing of a specific piece of markup begins.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupEditingStartedEvent

    introduced

    2.0

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupEditingStartedEvent"

    Returns TypedEvent<function>

  • Raised when editing of a specific piece of markup ends.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupEditingStoppedEvent

    introduced

    2.0

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupEditingStoppedEvent"

    Returns TypedEvent<function>

  • Raised when the type of markup being configured has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupSymbolChangedEvent

    introduced

    2.8

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupSymbolChangedEvent"

    Returns TypedEvent<function>

  • Raised when markup has been updated on the map.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupUpdatedEvent

    introduced

    2.5

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when the type of markup being configured has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MarkupTypeChangedEvent

    introduced

    2.8

    gcx-event-category

    Markup

    Parameters

    • eventName: "MarkupTypeChangedEvent"

    Returns TypedEvent<function>

  • Raised when a measurement is opened in the markup editor.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MeasurementEditingStartedEvent

    introduced

    2.5

    gcx-event-category

    Measurement

    Parameters

    • eventName: "MeasurementEditingStartedEvent"

    Returns TypedEvent<function>

  • Raised when a measurement markup is successfully and completely added without errors for a given geometry, including all applicable measurements and labels.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MeasurementMarkupAdded

    introduced

    2.0

    gcx-event-category

    Measurement

    Parameters

    • eventName: "MeasurementMarkupAdded"

    Returns TypedEvent<function>

  • Raised when a measurement markup is successfully and completely added without errors for a given geometry, including all applicable measurements and labels.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MeasurementMarkupDeleted

    introduced

    2.0

    gcx-event-category

    Measurement

    Parameters

    • eventName: "MeasurementMarkupDeleted"

    Returns TypedEvent<function>

  • Raised when an item in a menu is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    MenuItemInvokedEvent

    introduced

    2.4

    gcx-event-category

    Menus

    Parameters

    • eventName: "MenuItemInvokedEvent"

    Returns TypedEvent<function>

  • Raised when the offline manager has finished loading the offline maps from storage.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapsLoadedEvent

    introduced

    2.6

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapsLoadedEvent"

    Returns TypedEvent<function>

  • Raised when a user has made edits to their offline map

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapEditedEvent

    introduced

    2.7

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapEditedEvent"

    Returns TypedEvent<function>

  • Raised when a new offline map has been added to the offline manager.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapAddedEvent

    introduced

    2.6

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapAddedEvent"

    Returns TypedEvent<function>

  • Raised when a new offline map has been added to the offline manager.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapRemovedEvent

    introduced

    2.6

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapRemovedEvent"

    Returns TypedEvent<function>

  • Raised when an offline map has been activated (or null offlineMap arg for none).

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapActivatedEvent

    introduced

    2.6

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the offline map editor has finished.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapEditorFinishedEvent

    introduced

    2.6

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapEditorFinishedEvent"

    Returns TypedEvent<function>

  • Raised when a new offline map has been synced.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapSyncedEvent

    introduced

    2.6

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapSyncedEvent"

    Returns TypedEvent<function>

  • Raised when an offline map sync error occurs. Either on initial download or subsequent sync.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    OfflineMapSyncErrorEvent

    introduced

    2.8

    gcx-event-category

    Offline Maps

    Parameters

    • eventName: "OfflineMapSyncErrorEvent"

    Returns TypedEvent<function>

  • Raised when a named selection has been changed in any way. Renaming a selection raises this event.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SelectionChangedEvent

    introduced

    2.6

    gcx-event-category

    Named Selection

    Parameters

    • eventName: "SelectionChangedEvent"

    Returns TypedEvent<function>

  • Raised when named selection has been successfully saved.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SelectionCreatedEvent

    introduced

    2.6

    gcx-event-category

    Named Selection

    Parameters

    • eventName: "SelectionCreatedEvent"

    Returns TypedEvent<function>

  • Raised when named selection has been removed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SelectionRemovedEvent

    introduced

    2.6

    gcx-event-category

    Named Selection

    Parameters

    • eventName: "SelectionRemovedEvent"

    Returns TypedEvent<function>

  • Raised when a smart panel starts to be resized.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PanelResizeStartEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "PanelResizeStartEvent"

    Returns TypedEvent<function>

  • Raised as a smart panel is resized.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PanelResizingEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "PanelResizingEvent"

    Returns TypedEvent<function>

  • Raised when the resizing operation for a smart panel is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PanelResizeEndEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "PanelResizeEndEvent"

    Returns TypedEvent<function>

  • Raised when user selects a different print layout.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PrintPreviewLayoutChangedEvent

    introduced

    2.6

    gcx-event-category

    Print

    Parameters

    • eventName: "PrintPreviewLayoutChangedEvent"

    Returns TypedEvent<function>

  • Raised when user selects a different print scale.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PrintPreviewScaleChangedEvent

    introduced

    2.6

    gcx-event-category

    Print

    Parameters

    • eventName: "PrintPreviewScaleChangedEvent"

    Returns TypedEvent<function>

  • Raised when a request to print a template is sent to the server.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PrintTemplateStartedEvent

    introduced

    2.5

    gcx-event-category

    Print

    Parameters

    • eventName: "PrintTemplateStartedEvent"

    Returns TypedEvent<function>

  • Raised when a print template operation has completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PrintTemplateCompletedEvent

    introduced

    2.5

    gcx-event-category

    Print

    Parameters

    • eventName: "PrintTemplateCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a print template operation has errored.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PrintTemplateErrorEvent

    introduced

    2.7

    gcx-event-category

    Print

    Parameters

    • eventName: "PrintTemplateErrorEvent"

    Returns TypedEvent<function>

  • Raised when a project is successfully deleted.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectDeletedEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectDeletedEvent"

    Returns TypedEvent<function>

  • Raised when a project has begun being deleted.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectDeletingEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectDeletingEvent"

    Returns TypedEvent<function>

  • Raised when the project editor has finished editing.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectEditorFinishedEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectEditorFinishedEvent"

    Returns TypedEvent<function>

  • Raised when an attempt to save, load, or delete a project fails.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectErrorEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectErrorEvent"

    Returns TypedEvent<function>

  • Raised when a project is successfully loaded and applied.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectLoadedEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectLoadedEvent"

    Returns TypedEvent<function>

  • Raised when a project has begun loading.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectLoadingEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectLoadingEvent"

    Returns TypedEvent<function>

  • Raised when a project is successfully saved.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectSavedEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectSavedEvent"

    Returns TypedEvent<function>

  • Raised when a project has begun saving.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ProjectSavingEvent

    introduced

    2.6

    gcx-event-category

    Projects

    Parameters

    • eventName: "ProjectSavingEvent"

    Returns TypedEvent<function>

  • Raised when a pushpin has been clicked.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinClickedEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinClickedEvent"

    Returns TypedEvent<function>

  • Raised when the mouse first enters the bounding area of a pushpin.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinMouseEnterEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinMouseEnterEvent"

    Returns TypedEvent<function>

  • Raised when the mouse exits the bounding area of a pushpin.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinMouseLeaveEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinMouseLeaveEvent"

    Returns TypedEvent<function>

  • Raised when the left mouse button is pressed down while the mouse cursor is on a pushpin.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinMouseButtonDownEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinMouseLeftButtonDownEvent"

    Returns TypedEvent<function>

  • Raised when the left mouse button is released while the mouse cursor is on a pushpin.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinMouseButtonUpEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinMouseLeftButtonUpEvent"

    Returns TypedEvent<function>

  • Raised when the right mouse button is pressed down while the mouse cursor is on a pushpin.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinMouseButtonDownEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinMouseRightButtonDownEvent"

    Returns TypedEvent<function>

  • Raised when the right mouse button is released while the mouse cursor is on a pushpin.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    PushpinMouseButtonUpEvent

    introduced

    2.1

    gcx-event-category

    Pushpins

    Parameters

    • eventName: "PushpinMouseRightButtonUpEvent"

    Returns TypedEvent<function>

  • Raised after a query is completed using the query builder tool.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    QueryCompletedEvent

    introduced

    2.7

    gcx-event-category

    Query

    Parameters

    • eventName: "QueryCompletedEvent"

    Returns TypedEvent<function>

  • Raised after the saved query collection is changed

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SavedQueriesChangedEvent

    introduced

    2.8

    gcx-event-category

    Query

    Parameters

    • eventName: "SavedQueriesChangedEvent"

    Returns TypedEvent<function>

  • Raised after the saved filters collection is changed

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SavedFiltersChangedEvent

    introduced

    2.8

    gcx-event-category

    Query

    Parameters

    • eventName: "SavedFiltersChangedEvent"

    Returns TypedEvent<function>

  • Raised after the Undo Manager performs a redo operation.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    RedoCompletedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "RedoCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a redo operation begins.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    RedoStartedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "RedoStartedEvent"

    Returns TypedEvent<function>

  • Raised when a new related record has been created.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    RelatedRecordCreatedEvent

    introduced

    2.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "RelatedRecordCreatedEvent"

    Returns TypedEvent<function>

  • Raised when an existing related record has been edited.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    RelatedRecordCreatedEvent

    introduced

    2.3

    gcx-event-category

    Editing

    Parameters

    • eventName: "RelatedRecordEditedEvent"

    Returns TypedEvent<function>

  • Raised when a request to print a layer report template is sent to the server.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ReportTemplateStartedEvent

    introduced

    2.5

    gcx-event-category

    Print

    Parameters

    • eventName: "ReportTemplateStartedEvent"

    Returns TypedEvent<function>

  • Raised when a layer report print template operation has completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ReportTemplateCompletedEvent

    introduced

    2.5

    gcx-event-category

    Print

    Parameters

    • eventName: "ReportTemplateCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a RunReport or 'RunReportByUrl' command is executed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ReportStartedEvent

    introduced

    2.7

    gcx-event-category

    Reporting

    Parameters

    • eventName: "ReportStartedEvent"

    Returns TypedEvent<function>

  • The result of a successful RunReport or 'RunReportByUrl' command, which contains a download link to the report file.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ReportResultEvent

    introduced

    2.5

    gcx-event-category

    Reporting

    Parameters

    • eventName: "ReportResultEvent"

    Returns TypedEvent<function>

  • Raised when a RunReport or 'RunReportByUrl' command fails in error.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ReportErrorEventl

    introduced

    2.5

    gcx-event-category

    Reporting

    Parameters

    • eventName: "ReportErrorEvent"

    Returns TypedEvent<function>

  • When a feature is clicked in the results list view.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsListFeatureClickedEvent

    introduced

    1.0

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsListFeatureClickedEvent"

    Returns TypedEvent<function>

  • When a feature is pressed using a long press in the results list view.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsListFeaturePressedEvent

    introduced

    1.0

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsListFeaturePressedEvent"

    Returns TypedEvent<function>

  • When the current page of results has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsPageChangedEvent

    introduced

    2.3

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsPageChangedEvent"

    Returns TypedEvent<function>

  • When a feature is clicked in the results table view.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsTableFeatureClickedEvent

    introduced

    1.0

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsTableFeatureClickedEvent"

    Returns TypedEvent<function>

  • When a feature is pressed using a long press in the results table view.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsTableFeaturePressedEvent

    introduced

    1.0

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsTableFeaturePressedEvent"

    Returns TypedEvent<function>

  • Raised when the Results view is collapsed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsViewCollapsedEvent

    introduced

    2.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsViewCollapsedEvent"

    Returns TypedEvent<function>

  • Raised when the Results view is opened.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsViewOpenedEvent

    introduced

    2.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsViewOpenedEvent"

    Returns TypedEvent<function>

  • Raised when the Results view is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ResultsViewClosedEvent

    introduced

    2.6

    gcx-event-category

    Interface

    Parameters

    • eventName: "ResultsViewClosedEvent"

    Returns TypedEvent<function>

  • Raised when progress updates are available for a search that is in progress. The progress event may represent an error, failure, success etc.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SearchProgressEvent

    introduced

    1.1

    gcx-event-category

    Search

    Parameters

    • eventName: "SearchProgressEvent"

    Returns TypedEvent<function>

  • Raised when a search hint is clicked in the search auto-complete drop down.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SearchHintClickedEvent

    introduced

    2.0

    gcx-event-category

    Search

    Parameters

    • eventName: "SearchHintClickedEvent"

    Returns TypedEvent<function>

  • Raised when a user is not authorized for a site. This event is fired instead of SiteInitializationFailedEvent.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteAuthorizationFailedEvent

    introduced

    1.2

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "SiteAuthorizationFailedEvent"

    Returns TypedEvent<function>

  • Raised when the site fails to initialize. This event does not fire if SiteAuthorizationFailedEvent has fired.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteInitializationFailedEvent

    introduced

    1.0

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "SiteInitializationFailedEvent"

    Returns TypedEvent<function>

  • Raised when a site layer's initialization begins.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteLayerLoadingEvent

    introduced

    2.5

    gcx-event-category

    Load

    Parameters

    • eventName: "SiteLayerLoadingEvent"

    Returns TypedEvent<function>

  • Raised when a site layer is loaded.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteLayerLoadedEvent

    introduced

    1.1

    gcx-event-category

    Load

    Parameters

    • eventName: "SiteLayerLoadedEvent"

    Returns TypedEvent<function>

  • Raised when a site layer fails to load.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteLayerLoadFailedEvent

    introduced

    1.1

    gcx-event-category

    Load

    Parameters

    • eventName: "SiteLayerLoadFailedEvent"

    Returns TypedEvent<function>

  • Raised when the site begins to initialize.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteInitializingEvent

    introduced

    2.5

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "SiteInitializingEvent"

    Returns TypedEvent<function>

  • Raised when the site successfully initializes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteInitializedEvent

    introduced

    1.0

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "SiteInitializedEvent"

    Returns TypedEvent<function>

  • Raised when the site has finished loading and there are layers that failed to load.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteServiceLayersFailedEvent

    introduced

    1.3

    gcx-event-category

    Start-Up, Initialization and Shutdown

    Parameters

    • eventName: "SiteServiceLayersFailedEvent"

    Returns TypedEvent<function>

  • Raised when all service layers in a site are loaded.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SiteServiceLayersLoadedEvent

    introduced

    1.1

    gcx-event-category

    Load

    Parameters

    • eventName: "SiteServiceLayersLoadedEvent"

    Returns TypedEvent<function>

  • Raised when the viewer begins federated sign in. The application may close at any time if sign in happens in the same browser tab. This differs from UserSigningInEvent in that the sign in need not be initiated by the user and cannot be cancelled.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SigningInEvent

    introduced

    2.4

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "SigningInEvent"

    Returns TypedEvent<function>

  • Raised when the viewer begins signing out. The application may close at any time. This differs from UserSigningOutEvent in that the sign out need not be initiated by the user and cannot be cancelled.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SigningOutEvent

    introduced

    2.4

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "SigningOutEvent"

    Returns TypedEvent<function>

  • Raised when the bottom panel is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SmallBottomPanelClosedEvent

    introduced

    2.6

    gcx-event-category

    Interface

    Parameters

    • eventName: "SmallBottomPanelClosedEvent"

    Returns TypedEvent<function>

  • Raised when the top right region is about to close in the small shell.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SmallShellTopRightRegionClosingEvent

    introduced

    2.8

    gcx-event-category

    Interface

    Parameters

    • eventName: "SmallShellTopRightRegionClosingEvent"

    Returns TypedEvent<function>

  • Raised when the top right region is about to open in the small shell.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SmallShellTopRightRegionOpeningEvent

    introduced

    2.8

    gcx-event-category

    Interface

    Parameters

    • eventName: "SmallShellTopRightRegionOpeningEvent"

    Returns TypedEvent<function>

  • Raised when the SnappingModule handles input movement. Contains the original input location as well as a snapping point or null if none was found.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SnappingFeedbackEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "SnappingFeedbackEvent"

    Returns TypedEvent<function>

  • Raised when the sync info is refreshed. Sync info has information about which feature layers have been downloaded (synced).

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    SyncInfoRefreshedEvent

    introduced

    2.8.1

    gcx-event-category

    Offline

    Parameters

    • eventName: "SyncInfoRefreshedEvent"

    Returns TypedEvent<function>

  • Raised when the user chooses a template from the template picker.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    StartFeaturePlacementEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "StartFeaturePlacementEvent"

    Returns TypedEvent<function>

  • Raised when an application state is entered by a triggering command or event.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    StateEnteredEvent

    introduced

    2.5

    gcx-event-category

    Interface

    Parameters

    • eventName: "StateEnteredEvent"

    Returns TypedEvent<function>

  • Raised when an application state is exited by a triggering command or event.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    StateEnteredEvent

    introduced

    2.5

    gcx-event-category

    Interface

    Parameters

    • eventName: "StateExitedEvent"

    Returns TypedEvent<function>

  • Raised after a user places a new feature on the map to be opened in the editor.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    StopFeaturePlacementEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "StopFeaturePlacementEvent"

    Returns TypedEvent<function>

  • Raised after a new time slider profile is set.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TimeSliderProfileChanged

    introduced

    2.7

    gcx-event-category

    TimeSlider

    Parameters

    • eventName: "TimeSliderProfileChangedEvent"

    Returns TypedEvent<function>

  • Raised when the current timeslider profile starts playing.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TimeSliderPlayTimelineStartedEvent

    introduced

    2.7

    gcx-event-category

    TimeSlider

    Parameters

    • eventName: "TimeSliderPlayTimelineStartedEvent"

    Returns TypedEvent<function>

  • Raised when the current timeslider profile stops playing.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TimeSliderPlayTimelineStoppedEvent

    introduced

    2.7

    gcx-event-category

    TimeSlider

    Parameters

    • eventName: "TimeSliderPlayTimelineStoppedEvent"

    Returns TypedEvent<function>

  • Raised when the time slider items move forward or backward.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TimeSliderFrameChangedEvent

    introduced

    2.9

    gcx-event-category

    TimeSlider

    Parameters

    • eventName: "TimeSliderFrameChangedEvent"

    Returns TypedEvent<function>

  • Raised immediately after the command SetTimeSliderProfile is executed. Used to track the time slider playback state and profile before it is changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TimeSliderProfileChangingEvent

    introduced

    2.9

    gcx-event-category

    TimeSlider

    Parameters

    • eventName: "TimeSliderProfileChangingEvent"

    Returns TypedEvent<function>

  • Raised after a toggle button changes its state.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToggleButtonStateChangedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "ToggleButtonStateChangedEvent"

    Returns TypedEvent<function>

  • Raised when a button on the toolbar is clicked.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToolbarButtonClickedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "ToolbarButtonClickedEvent"

    Returns TypedEvent<function>

  • Raised when a view tile is pressed in the toolbar in the small/handheld shell.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToolbarViewTilePressedEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "ToolbarViewTilePressedEvent"

    Returns TypedEvent<function>

  • Raised when a multitool flyout menu is opened.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToolbarFlyoutActivatedEvent

    introduced

    2.4

    gcx-event-category

    Interface

    Parameters

    • eventName: "ToolbarFlyoutActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the input method (for example, keyboard or mouse) for the active tool has changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToolInputMethodChangedEvent

    introduced

    2.4

    gcx-event-category

    Tool

    Parameters

    • eventName: "ToolInputMethodChangedEvent"

    Returns TypedEvent<function>

  • Raised when a multitool flyout menu is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToolbarFlyoutDeactivatedEvent

    introduced

    1.0

    gcx-event-category

    Interface

    Parameters

    • eventName: "ToolbarFlyoutDeactivatedEvent"

    Returns TypedEvent<function>

  • Raised when a transient toolbar is activated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TransientActivatedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "TransientActivatedEvent"

    Returns TypedEvent<function>

  • Raised when all transient toolbars are deactivated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    TransientsDeactivatedEvent

    introduced

    2.5

    gcx-event-category

    Tool

    Parameters

    • eventName: "TransientsDeactivatedEvent"

    Returns TypedEvent<function>

  • Raised when active toolbar tab is changed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ToolbarTabChangedEvent

    introduced

    2.7

    gcx-event-category

    Tool

    Parameters

    • eventName: "ToolbarTabChangedEvent"

    Returns TypedEvent<function>

  • Raised when the last recorded operation has been reversed or rolled back by the Undo Manager.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UndoCompletedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "UndoCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a new undo operation is added to the undo stack.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UndoOperationAddedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "UndoOperationAddedEvent"

    Returns TypedEvent<function>

  • Raised when an undo operation is discarded from the undo stack because the stack size exceeded the maximum number of operations.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UndoOperationAddedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "UndoOperationDiscardedEvent"

    Returns TypedEvent<function>

  • Raised when an undo operation begins.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UndoStartedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "UndoStartedEvent"

    Returns TypedEvent<function>

  • Raised when the undo stack changes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UndoStackChangedEvent

    introduced

    2.5

    gcx-event-category

    Undo and Redo

    Parameters

    • eventName: "UndoStackChangedEvent"

    Returns TypedEvent<function>

  • Raised when an upload data process completes.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UploadDataCompletedEvent

    introduced

    2.6

    gcx-event-category

    Upload Data

    Parameters

    • eventName: "UploadDataCompletedEvent"

    Returns TypedEvent<function>

  • Raised when an upload data process fails.

    docs-gcx-event

    geocortex.UploadDataProcess

    name

    UploadDataFailedEvent

    introduced

    2.6

    gcx-event-category

    Upload Data

    Parameters

    • eventName: "UploadDataFailedEvent"

    Returns TypedEvent<function>

  • Raised when a user added layer or MapService is removed(Not raised when removed due to project restore).

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UserAddedLayerOrMapServiceRemovedEvent

    introduced

    2.9.1

    gcx-event-category

    User Added Layer

    Parameters

    • eventName: "UserAddedLayerOrMapServiceRemovedEvent"

    Returns TypedEvent<function>

  • Raised when the user cancels the ArcGIS Online sign in process.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UserSignInCancelledEvent

    introduced

    1.3

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "UserSignInCancelledEvent"

    Returns TypedEvent<function>

  • Raised when the user is about to navigate to the federated sign in page.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UserSigningInEvent

    introduced

    2.1

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "UserSigningInEvent"

    Returns TypedEvent<function>

  • Raised when the user is about to sign out of the application.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    UserSigningOutEvent

    introduced

    2.1

    gcx-event-category

    Authentication and Authorization

    Parameters

    • eventName: "UserSigningOutEvent"

    Returns TypedEvent<function>

  • Raised when the vertex edit handle is hidden.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    VertexHandleHiddenEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "VertexHandleHiddenEvent"

    Returns TypedEvent<function>

  • Raised when the vertex edit handle is shown.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    VertexHandleShownEvent

    introduced

    2.5

    gcx-event-category

    Editing

    Parameters

    • eventName: "VertexHandleShownEvent"

    Returns TypedEvent<function>

  • Raised when a view is activated inside a view container.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ViewActivatedInContainerEvent

    introduced

    1.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "ViewActivatedInContainerEvent"

    Returns TypedEvent<function>

  • Raised when a ViewContainer View is closed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ViewContainerViewClosedEvent

    introduced

    1.1

    gcx-event-category

    Interface

    Parameters

    • eventName: "ViewContainerViewClosedEvent"

    Returns TypedEvent<function>

  • Raised when a {@link essentialsHtmlViewer.integration.PostMessageTransport} has been wired up with an external component and the viewers position has been updated.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ViewerPositionUpdatedEvent

    introduced

    2.4

    gcx-event-category

    Integration

    Parameters

    • eventName: "ViewerPositionUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when a viewpoint indicator of an external component has been updated on the viewer.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    ViewpointIndicatorUpdatedEvent

    introduced

    2.4

    gcx-event-category

    Integration

    Parameters

    • eventName: "ViewpointIndicatorUpdatedEvent"

    Returns TypedEvent<function>

  • Raised when the visualization options view has been activated for a Geocortex layer.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    VisualizationViewActivatedEvent

    introduced

    2.5

    gcx-event-category

    Visualization

    Parameters

    • eventName: "VisualizationViewActivatedEvent"

    Returns TypedEvent<function>

  • Raised when the WebSocket successfully connects.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WebSocketConnectedEvent

    introduced

    2.8

    gcx-event-category

    Collaboration

    Parameters

    • eventName: "WebSocketConnectedEvent"

    Returns TypedEvent<function>

  • Raised when the WebSocket disconnects.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WebSocketDisconnected

    introduced

    2.8

    gcx-event-category

    Collaboration

    Parameters

    • eventName: "WebSocketDisconnectedEvent"

    Returns TypedEvent<function>

  • Raised when a workflow is aborted.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowAbortedEvent

    introduced

    1.1

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowAbortedEvent"

    Returns TypedEvent<function>

  • Raised when a workflow activity is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowActivityCompletedEvent

    introduced

    1.1

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowActivityCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a workflow activity fails to dispatch.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowActivityDispatchErrorEvent

    introduced

    1.1

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowActivityDispatchErrorEvent"

    Returns TypedEvent<function>

  • Raised when a workflow activity begins execution.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowActivityStartedEvent

    introduced

    1.1

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowActivityStartedEvent"

    Returns TypedEvent<function>

  • Raised when a workflow execution is completed.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowCompletedEvent

    introduced

    1.1

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a single web request for a workflow completes. Note that a workflow typically consists of many requests to the server.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowWebRequestCompletedEvent

    introduced

    2.5

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowWebRequestCompletedEvent"

    Returns TypedEvent<function>

  • Raised when a single web request for a workflow is started. Note that a workflow typically consists of many requests to the server.

    docs-gcx-event

    geocortex.essentialsHtmlViewer

    name

    WorkflowWebRequestStartedEvent

    introduced

    2.5

    gcx-event-category

    Workflow

    Parameters

    • eventName: "WorkflowWebRequestStartedEvent"

    Returns TypedEvent<function>

  • Parameters

    • eventName: string

    Returns TypedEvent<any>