A view for displaying and editing information about a feature. More...
Import Statement: | import Esri.ArcGISRuntime.Toolkit |
Since: | Esri.ArcGISRuntime 100.10 |
- List of all members, including inherited members
- Deprecated members
- PopupView is part of ArcGISQtToolkit group and ArcGISQtToolkitUiQmlViews group.
Properties
- closeCallback : var
- openAttachmentsWithSystemDefaultApplication : bool
- openImagesInApp : bool
- openUrlsWithSystemDefaultApplication : bool
- popup : Popup
Signals
- attachmentDataFetched(var attachmentData, var name)
- attachmentThumbnailClicked(var index)
- clickedUrl(var url)
- imageClicked(var sourceUrl, var linkUrl)
Detailed Description
A PopupView can be used to display information for any type that implements the PopupSource interface. For example, FeatureLayer implements PopupSource. This means that it has a PopupDefinition, which defines how the Popup should look for any features in that layer. An example workflow for displaying a PopupView for a feature in a FeatureLayer would be:
- Declare a PopupView and anchor it to a desired location.
- Perform an identify operation on a GeoView and select a Feature from the identify result.
- Create a Popup from the Feature.
- Optionally obtain the Popup's PopupDefinition and set the title, whether to show attachments, and so on.
- Create a PopupManager from the Popup.
- Assign the PopupView's
popupManager
property the PopupManager created in the previous step.
The PopupView is a QML Item that can be anchored, given to a dialog, or positioned using XY screen coordinates. Transform, Transition, and other QML animation types can be used to animate the showing and dissmisal of the view. For more information, please see the Popup and PopupManager documentation.
Note: Each time a change is made to the Popup, PopupDefinition, PopupManager, or any of their properties, the PopupManager must be re-set to the PopupView.
PopupView { id:popupView anchors { left: parent.left top: parent.top bottom: parent.bottom } visible: false popupManager: model.popupManager }
Property Documentation
closeCallback : var |
Callback function called when the close button is clicked. When this property is set to null the close button does not render. When the close button is clicked the function in this property is called. Defaults to setting visible to false.
openAttachmentsWithSystemDefaultApplication : bool |
Boolean that controls if the PopupView will attempt to open attachments with an external viewer. For more information see Qt.openUrlExternally.
Defaults to true.
openImagesInApp : bool |
Boolean that controls if the PopupView will attempt to open images with a full screen takeover.
Defaults to true.
openUrlsWithSystemDefaultApplication : bool |
Boolean that controls if the PopupView will attempt to open URL's with an external browser. For more information see Qt.openUrlExternally.
Defaults to true.
popup : Popup |
The Popup that controls the information being displayed in the view.
Signal Documentation
attachmentDataFetched(var attachmentData, var name) |
Signal emitted when a Popup Attachment is clicked to download the data. The attachmentData of the Popup Attachment is the raw QByteData of the attachment. The name of the Popup Attachment is the name of the attachment.
Note: The corresponding handler is onAttachmentDataFetched
.
attachmentThumbnailClicked(var index) |
Signal emitted when an attachment thumbnail is clicked. The index of the PopupAttachment in the PopupAttachmentListModel that was clicked on by the user.
Note: The corresponding handler is onAttachmentThumbnailClicked
.
clickedUrl(var url) |
Signal emitted when a url or hyperlink is clicked. The url of the hyperlink from the Popup that was clicked on.
Note: The corresponding handler is onClickedUrl
.
imageClicked(var sourceUrl, var linkUrl) |
Signal emitted when a Image Popup Media is clicked. The sourceUrl of the image that was clicked on. sourceUrl is the url of the image currently being displayed. The linkUrl of the image that was clicked on. linkUrl is used when the image is clicked on to load in a browser.
Note: The corresponding handler is onImageClicked
.