PopupDefinition QML Type
Defines how a Popup will be displayed and behave. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
- List of all members, including inherited members
- PopupDefinition is part of QML Type List.
Properties
- deleteAllowed : bool
- description : string
- editGeometryAllowed : bool
- editingAllowed : bool
- elements : list<PopupElement>
- expressions : list<PopupExpression>
- fields : list<PopupField>
- initGeoElement : GeoElement
- initPopupSource : PopupSource
- media : list<PopupMedia>
- relatedFeaturesDefinition : PopupRelatedFeaturesDefinition
- showAttachments : bool
- showEditSummary : bool
- title : string
Signals
- deleteAllowedChanged()
- descriptionChanged()
- editGeometryAllowedChanged()
- editingAllowedChanged()
- elementsChanged()
- expressionsChanged()
- fieldsChanged()
- initGeoElementChanged()
- initPopupSourceChanged()
- mediaChanged()
- relatedFeaturesDefinitionChanged()
- showAttachmentsChanged()
- showEditSummaryChanged()
- titleChanged()
Detailed Description
Use this object to define the look and feel of pop-up windows when users click or query a feature. Popup definitions contain information such as:
- Which attributes the Popup should display
- Whether the attributes are editable
- How to format numbers and dates
- Whether the Popup should show attachments for the GeoElement
- What media, such as charts and images, should be displayed for the GeoElement
A PopupDefinition can be instantiated the following ways:
1: Setting a GeoElement (initGeoElement) 2: Setting a PopupSource (initPopupSource) 3: Neither of those (which equates to a default-constructed object).
If initGeoElement and initPopupSource are both provided, initGeoElement will take precedence.
The initGeoElement and initPopupSource properties cannot be changed once any properties have been written to. See option three above for how to instantiate a PopupDefinition.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| GeoElement | initGeoElement |
| PopupSource | initPopupSource |
| PopupField | fields (appends to list) |
| PopupMedia | media (appends to list) |
| PopupRelatedFeaturesDefinition | relatedFeaturesDefinition (since Esri.ArcGISRuntime 100.1) |
Property Documentation
deleteAllowed : bool |
Whether the PopupSource allows the GeoElement to be deleted.
description : string |
The string that appears in the body of the Popup as a description.
editGeometryAllowed : bool |
Whether the PopupSource allows the GeoElement's geometry to be edited.
editingAllowed : bool |
Whether the PopupSource allows the GeoElement's attributes to be edited.
[read-only, since Esri.ArcGISRuntime 100.14] elements : list<PopupElement> |
A list of PopupElement objects that represent an ordered list of pop-up elements. The order of the list is the order that elements are shown in the pop-up window.
For backward compatibility with a webmap or webscene created by clients that don't support the popup elements, a few popup elements are created to match the legacy popup style when reading a popup definition without popup elements:
- - a TextPopupElement if description is not empty
- - a FieldsPopupElement if description is empty
- - a MediaPopupElement if media is not empty
- - a AttachmentsPopupElement if showAttachments is
true
Vice versa, if the user updates the popup elements, the legacy popup style is updated during the PopupDefinition serialization, in order to match as much as possible the popup elements, so that older clients can display a popup that looks similar.
This property was introduced in Esri.ArcGISRuntime 100.14.
[read-only, since Esri.ArcGISRuntime 100.3] expressions : list<PopupExpression> |
Returns a list of PopupExpression objects defining the various Arcade expressions on the popup.
This property was introduced in Esri.ArcGISRuntime 100.3.
[default] fields : list<PopupField> |
Returns a list of PopupField objects defining how each field participates in the Popup.
[default] initGeoElement : GeoElement |
The GeoElement used to create the PopupDefinition.
This creates a new popup definition with default properties and default popup elements based on the geoelement fields. Once this is property is set, the PopupDefinition is created with it, and the property is immutable. Use this to define the look and feel of pop-up windows when users click or query a feature.
[default] initPopupSource : PopupSource |
The PopupSource used to create the PopupDefinition.
This creates a new popup definition with default properties and default popup elements based on the popup source fields. Use this object to define the look and feel of pop-up windows when users click or query a feature. Once this is property is set, the PopupDefinition is created with it, and the property is be immutable.
[default] media : list<PopupMedia> |
Returns a list of PopupMedia objects that define images and charts displayed in the Popup (read-only).
[default, since Esri.ArcGISRuntime 100.1] relatedFeaturesDefinition : PopupRelatedFeaturesDefinition |
The PopupRelatedFeaturesDefinition for the PopupDefinition.
This property was introduced in Esri.ArcGISRuntime 100.1.
showAttachments : bool |
Whether the Popup should show attachments of the GeoElement.
showEditSummary : bool |
Whether the Popup should show the edit summary of the GeoElement.
title : string |
A string that appears at the top of the Popup as a title.
Signal Documentation
deleteAllowedChanged() |
Emitted when the deleteAllowed property changes.
Note: The corresponding handler is onDeleteAllowedChanged.
descriptionChanged() |
Emitted when the description property changes.
Note: The corresponding handler is onDescriptionChanged.
editGeometryAllowedChanged() |
Emitted when the editGeometryAllowed property changes.
Note: The corresponding handler is onEditGeometryAllowedChanged.
editingAllowedChanged() |
Emitted when the editingAllowed property changes.
Note: The corresponding handler is onEditingAllowedChanged.
|
Emitted when the elements property changes.
Note: The corresponding handler is onElementsChanged.
This signal was introduced in Esri.ArcGISRuntime 100.14.
|
Emitted when the expressions property changes.
Note: The corresponding handler is onExpressionsChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
fieldsChanged() |
Emitted when the fields property changes.
Note: The corresponding handler is onFieldsChanged.
initGeoElementChanged() |
Emitted when the initGeoElement property changes.
Note: The corresponding handler is onInitGeoElementChanged.
initPopupSourceChanged() |
Emitted when the initPopupSource property changes.
Note: The corresponding handler is onInitPopupSourceChanged.
mediaChanged() |
Emitted when the media property changes.
Note: The corresponding handler is onMediaChanged.
|
Emitted when the relatedFeaturesDefinition property changes.
Note: The corresponding handler is onRelatedFeaturesDefinitionChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
showAttachmentsChanged() |
Emitted when the showAttachments property changes.
Note: The corresponding handler is onShowAttachmentsChanged.
showEditSummaryChanged() |
Emitted when the showEditSummary property changes.
Note: The corresponding handler is onShowEditSummaryChanged.
titleChanged() |
Emitted when the title property changes.
Note: The corresponding handler is onTitleChanged.