Skip To Content ArcGIS for Developers Sign In Dashboard

PopupDefinition QML Type

Defines how a Popup will be displayed and behave. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Detailed Description

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.

TypeDefault Property
GeoElementinitGeoElement
PopupSourceinitPopupSource
PopupFieldfields (appends to list)
PopupMediamedia (appends to list)
PopupRelatedFeaturesDefinitionrelatedFeaturesDefinition (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.


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.

Once this is property is set, the PopupDefinition will be created with it, and the property will be immutable.


[default] initPopupSource : PopupSource

The PopupSource used to create the PopupDefinition.

Once this is property is set, the PopupDefinition will be created with it, and the property will be immutable.


[default] media : list<PopupMedia>

Returns a list of PopupMedia objects that define images and charts displayed in the Popup (read-only).


[default] 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.


expressionsChanged()

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.


relatedFeaturesDefinitionChanged()

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.



Feedback on this topic?