ArcGIS Runtime SDK for iOS: AGSPopup.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSPopup.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 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 
28 @class AGSPopupDefinition;
29 @class AGSPopupField;
30 @class AGSSymbol;
32 @protocol AGSGeoElement;
33 @protocol AGSCancelable;
34  //Required for Globals API doc
36 
42 @interface AGSPopup : AGSObject
43 
44 
45 
46 #pragma mark -
47 #pragma mark initializers
48 
49 
50 
57 -(instancetype)initWithGeoElement:(id<AGSGeoElement>)geoElement popupDefinition:(nullable AGSPopupDefinition*)popupDefinition;
58 
63 -(instancetype)initWithGeoElement:(id<AGSGeoElement>)geoElement;
64 
72 +(instancetype)popupWithGeoElement:(id<AGSGeoElement>)geoElement popupDefinition:(nullable AGSPopupDefinition*)popupDefinition;
73 
79 +(instancetype)popupWithGeoElement:(id<AGSGeoElement>)geoElement;
80 
81 #pragma mark -
82 #pragma mark properties
83 
84 
88 @property (nonatomic, strong, readonly) AGSPopupDefinition *popupDefinition;
89 
93 @property (nonatomic, strong, readonly) id<AGSGeoElement> geoElement;
94 
98 @property (nullable, nonatomic, copy, readonly) NSString *title;
99 
103 @property (nullable, nonatomic, strong, readonly) AGSSymbol *symbol;
104 
105 
106 #pragma mark -
107 #pragma mark methods
108 
119 - (id<AGSCancelable>)evaluateExpressionsWithCompletion:(void(^)(NSArray<AGSPopupExpressionEvaluation *> * __nullable results, NSError * __nullable error))completion;
120 
133 -(NSString*)formattedValueForField:(AGSPopupField*)popupField;
134 
145 -(nullable NSString*)stringForTemplatedString:(NSString*)templatedString;
146 
147 
148 @end
Definition: AGSObject.h:28
A popup definition.
Definition: AGSPopupDefinition.h:49
An object that represents the result of an attempt to evaluate popup expression.
Definition: AGSPopupExpressionEvaluation.h:39
Information about a field in a popup.
Definition: AGSPopupField.h:51
A popup which displays a geo-element's information.
Definition: AGSPopup.h:43
AGSSymbol * symbol
Definition: AGSPopup.h:103
AGSPopupDefinition * popupDefinition
Definition: AGSPopup.h:88
id< AGSGeoElement > geoElement
Definition: AGSPopup.h:93
NSString * title
Definition: AGSPopup.h:98
A symbol used to display a graphic or a feature.
Definition: AGSSymbol.h:91
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