ArcGIS Runtime SDK for iOS
100.15
|
A popup definition.
Instances of this class respresent popup definitions for geo-elements that need to be displayed in popups. Popup definitions contain information such as -
Instance Methods | |
(instancetype) | - initWithGeoElement: |
(instancetype) | - initWithPopupSource: |
Class Methods | |
(instancetype) | + popupDefinition |
(instancetype) | + popupDefinitionWithGeoElement: |
(instancetype) | + popupDefinitionWithPopupSource: |
Properties | |
BOOL | allowDelete |
BOOL | allowEdit |
BOOL | allowEditGeometry |
NSString * | customDescription |
NSArray< AGSPopupElement * > * | elements |
NSArray< AGSPopupExpression * > * | expressions |
NSArray< AGSPopupField * > * | fields |
NSArray< AGSPopupMedia * > * | media |
AGSPopupRelatedFeaturesDefinition * | relatedFeaturesDefinition |
BOOL | showAttachments |
BOOL | showEditSummary |
BOOL | showRelatedRecords |
NSString * | title |
- (instancetype) initWithGeoElement: | (id< AGSGeoElement >) | geoElement |
Creates a new popup definition with default properties and default popup elements based on the geo-element fields.
By default, all the attributes will be included in the popup fields.
geoElement | The geo-element for the popup definition, such as an AGSFeature or AGSGraphic . |
- (instancetype) initWithPopupSource: | (id< AGSPopupSource >) | popupSource |
Creates new popup definition with default properties and default popup elements based on the popup source fields.
By default, all the fields available in the source will be included in the popup fields.
popupSource | A popup source for which popup definition should be created. |
+ (instancetype) popupDefinition |
Creates a new popup definition.
Use this object to define the look and feel of pop-up windows when users click or query a feature.
+ (instancetype) popupDefinitionWithGeoElement: | (id< AGSGeoElement >) | geoElement |
Creates a new popup definition with default properties and default popup elements based on the geo-element fields.
By default, all the attributes will be included in the popup fields.
geoElement | The geo-element for the popup definition, such as an AGSFeature or AGSGraphic . |
+ (instancetype) popupDefinitionWithPopupSource: | (id< AGSPopupSource >) | popupSource |
Creates new popup definition with default properties and default popup elements based on the popup source fields.
By default, all the fields available in the source will be included in the popup fields.
popupSource | A popup source for which popup definition should be created. |
|
readwritenonatomicassign |
Whether or not the popup should allow the geo-element to be deleted.
|
readwritenonatomicassign |
Whether or not the popup should allow the geo-element to be edited.
|
readwritenonatomicassign |
Whether or not the popup should allow the geo-element's geometry should be edited. Only applicable when allowEdit
is YES
.
|
readwritenonatomiccopy |
The description that is shown for the geo-element in the popup. This can be html. If description is nil
then the #popupFields
are used when viewing attributes. This can contain a literal value, or a placeholder for value from the geo-element's attribute. The placeholder needs to be of the form {field_name} where field_name is a key in the geo-element's attributes.
|
readwritenonatomiccopy |
An array of AGSPopupElement
objects that represent an ordered list of pop-up elements.
The order of the array 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:
AGSTextPopupElement
if AGSPopupDefinition::customDescription
is not empty AGSFieldsPopupElement
if AGSPopupDefinition::customDescription
is empty AGSMediaPopupElement
if AGSPopupDefinition::media
is not empty AGSAttachmentsPopupElement
if AGSPopupDefinition::showAttachments
is YES
Vice versa, if the user updates the popup elements, the legacy popup style is updated during the AGSPopupDefinition
serialization, in order to match as much as possible the popup elements, so that older clients can display a popup that looks similar.
|
readwritenonatomiccopy |
A list of expressions based on the Arcade language that can be evaluated to display computed information in fields
, media
, title
, or customDescription
.
|
readwritenonatomiccopy |
The geo-element's fields (as an array of AGSPopupField
objects) that are to be displayed in the popup. If description is not nil
then the popup fields are not used when viewing attributes. The order of the array is the order that fields are shown in the popup.
|
readwritenonatomiccopy |
The media (as an array of AGSPopupMedia
objects) that is to be displayed in the popup.
The order of the array is the order that medias are shown in the pop-up window.
|
readwritenonatomicstrong |
A definition that dictates whether related features should be displayed in the popup and how they should be sorted.
|
readwritenonatomicassign |
Whether or not the popup should show attachments of the geo-element.
|
readwritenonatomicassign |
Whether or not the popup should display a summary of when the geo-element was last edited and by whom.
|
readwritenonatomicassign |
Whether or not the popup should show additional geo-elements that are related to this popup's geo-element.
#relatedFeaturesDefinition.showRelatedFeatures
instead.
|
readwritenonatomiccopy |
The title that is displayed for the geo-element in the popup. This can contain a literal value, or a placeholder for value from the geo-element's attribute. The placeholder needs to be of the form {field_name} where field_name is a key in the geo-element's attributes.