ArcGIS Runtime SDK for iOS: AGSPopup.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSPopup.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSObject.h>
27 #import <ArcGIS/AGSCancelable.h>
28 #import <ArcGIS/AGSGeoElement.h>
29 
30 @class AGSPopupDefinition;
31 @class AGSPopupElement;
32 @class AGSPopupField;
33 @class AGSSymbol;
35  //Required for Globals API doc
37 
43 @interface AGSPopup : AGSObject
44 
45 
46 
47 #pragma mark -
48 #pragma mark initializers
49 
50 
51 
58 -(instancetype)initWithGeoElement:(id<AGSGeoElement>)geoElement popupDefinition:(nullable AGSPopupDefinition*)popupDefinition;
59 
65 -(instancetype)initWithGeoElement:(id<AGSGeoElement>)geoElement;
66 
74 +(instancetype)popupWithGeoElement:(id<AGSGeoElement>)geoElement popupDefinition:(nullable AGSPopupDefinition*)popupDefinition;
75 
82 +(instancetype)popupWithGeoElement:(id<AGSGeoElement>)geoElement;
83 
84 #pragma mark -
85 #pragma mark properties
86 
104 @property (nonatomic, copy, readonly) NSArray<AGSPopupElement *> *evaluatedElements;
105 
110 @property (nonatomic, strong, readonly) AGSPopupDefinition *popupDefinition;
111 
115 @property (nonatomic, strong, readonly) id<AGSGeoElement> geoElement;
116 
120 @property (nullable, nonatomic, copy, readonly) NSString *title;
121 
125 @property (nullable, nonatomic, strong, readonly) AGSSymbol *symbol;
126 
127 
128 #pragma mark -
129 #pragma mark methods
130 
150 - (id<AGSCancelable>)evaluateExpressionsWithCompletion:(void(^)(NSArray<AGSPopupExpressionEvaluation *> * __nullable results, NSError * __nullable error))completion;
151 
165 -(NSString*)formattedValueForField:(AGSPopupField*)popupField;
166 
177 -(nullable NSString*)stringForTemplatedString:(NSString*)templatedString;
178 
179 
180 @end
Definition: AGSObject.h:28
A popup definition.
Definition: AGSPopupDefinition.h:49
Represents an element that is displayed in a pop-up for a geoelement.
Definition: AGSPopupElement.h:37
The result of an attempt to evaluate popup expression.
Definition: AGSPopupExpressionEvaluation.h:41
Information about a field in a popup.
Definition: AGSPopupField.h:51
A popup which displays a geo-element's information.
Definition: AGSPopup.h:44
NSArray< AGSPopupElement * > * evaluatedElements
Definition: AGSPopup.h:104
AGSSymbol * symbol
Definition: AGSPopup.h:125
AGSPopupDefinition * popupDefinition
Definition: AGSPopup.h:110
id< AGSGeoElement > geoElement
Definition: AGSPopup.h:115
NSString * title
Definition: AGSPopup.h:120
A symbol used to display a graphic or a feature.
Definition: AGSSymbol.h:93
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
An abstract representation of geographic entities on a map.
Definition: AGSGeoElement.h:43