ArcGIS Runtime SDK for iOS: AGSFeatureTable.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSFeatureTable.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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 #import <ArcGIS/AGSPopupSource.h>
30 #import <ArcGIS/AGSGeometry.h>
31 
32 
33 
39 typedef NS_ENUM(NSInteger, AGSFeatureRequestMode) {
44 };
45 
46 @class AGSEnvelope;
47 @class AGSField;
48 @class AGSQueryParameters;
49 @class AGSFeature;
51 @class AGSEditResult;
52 @class AGSFeatureLayer;
55 @class AGSSpatialReference;
56 @class AGSLayer;
57 
58 @protocol AGSCancelable;
59 
67 
68 #pragma mark -
69 #pragma mark initializers
70 
71 #pragma mark -
72 #pragma mark properties
73 
78 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *extent;
79 
85 @property (nonatomic, copy, readonly) NSArray<AGSField*> *fields;
86 
90 @property (nonatomic, assign, readonly) AGSGeometryType geometryType;
91 
98 @property (nonatomic, assign, readonly) BOOL hasGeometry;
99 
103 @property (nonatomic, assign, readonly) BOOL hasM;
104 
108 @property (nonatomic, assign, readonly) BOOL hasZ;
109 
115 @property (nonatomic, assign, readonly, getter=isEditable) BOOL editable;
116 
120 @property (nonatomic, assign, readonly) BOOL canAddFeature;
121 
125 @property (nonatomic, assign, readonly) BOOL canEditGeometry;
126 
131 @property (nonatomic, assign, readonly) NSInteger numberOfFeatures;
132 
137 @property (nullable, nonatomic, strong, readonly) AGSSpatialReference *spatialReference;
138 
143 @property (nonatomic, copy, readonly) NSString *tableName;
144 
148 @property (nonatomic, copy, readwrite) NSString *displayName;
149 
155 @property (nullable, nonatomic, weak, readonly) AGSLayer *layer;
156 
157 #pragma mark -
158 #pragma mark methods
159 
160 
170 -(id<AGSCancelable>)addFeature:(AGSFeature *)feature completion:(nullable void(^)(NSError *__nullable error))completion;
171 
182 -(id<AGSCancelable>)addFeatures:(NSArray<AGSFeature*> *)features completion:(nullable void(^)(NSError *__nullable error))completion;
183 
189 -(BOOL)canDeleteFeature:(AGSFeature *)feature;
190 
196 -(BOOL)canUpdateFeature:(AGSFeature *)feature;
197 
205 
214 -(AGSFeature *)createFeatureWithAttributes:(NSDictionary<NSString*,id> *)attributes geometry:(nullable AGSGeometry *)geometry;
215 
226 -(id<AGSCancelable>)deleteFeature:(AGSFeature *)feature completion:(nullable void(^)(NSError *__nullable error))completion;
227 
239 -(id<AGSCancelable>)deleteFeatures:(NSArray<AGSFeature*> *)features completion:(nullable void(^)(NSError *__nullable error))completion;
240 
246 -(nullable AGSField *)fieldForName:(NSString *)fieldName;
247 
256 -(id<AGSCancelable>)queryFeaturesWithParameters:(AGSQueryParameters *)parameters
257  completion:(nullable void(^)(AGSFeatureQueryResult *__nullable result, NSError *__nullable error))completion;
258 
266 -(id<AGSCancelable>)queryExtentWithParameters:(AGSQueryParameters *)parameters
267  completion:(void(^)(AGSEnvelope *__nullable extent, NSError *__nullable error))completion;
268 
276 -(id<AGSCancelable>)queryFeatureCountWithParameters:(AGSQueryParameters *)parameters
277  completion:(void(^)(NSInteger count, NSError *__nullable error))completion;
278 
286 -(id<AGSCancelable>)queryStatisticsWithParameters:(AGSStatisticsQueryParameters *)parameters
287  completion:(void(^)(AGSStatisticsQueryResult *__nullable result, NSError *__nullable error))completion;
288 
299 -(id<AGSCancelable>)updateFeature:(AGSFeature *)feature completion:(nullable void(^)(NSError *__nullable error))completion;
300 
312 -(id<AGSCancelable>)updateFeatures:(NSArray<AGSFeature*> *)features completion:(nullable void(^)(NSError *__nullable error))completion;
313 
314 @end
315 
317 
324 @property (nullable, nonatomic, weak, readonly) AGSFeatureLayer *featureLayer ;
325 
326 @end
327 
328 
AGSFeatureRequestMode
Definition: AGSFeatureTable.h:39
@ AGSFeatureRequestModeOnInteractionCache
Definition: AGSFeatureTable.h:41
@ AGSFeatureRequestModeManualCache
Definition: AGSFeatureTable.h:43
@ AGSFeatureRequestModeOnInteractionNoCache
Definition: AGSFeatureTable.h:42
@ AGSFeatureRequestModeUndefined
Definition: AGSFeatureTable.h:40
AGSGeometryType
Definition: AGSGeometry.h:49
Definition: AGSFeatureTable.h:316
AGSFeatureLayer * featureLayer
Definition: AGSFeatureTable.h:324
Information about the outcome of an attachment edit operation.
Definition: AGSEditResult.h:52
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A representation of a real-world object on a map.
Definition: AGSFeature.h:47
A layer that can visualize vector/feature data.
Definition: AGSFeatureLayer.h:174
Result of queries that return features.
Definition: AGSFeatureQueryResult.h:49
A source for dataset containing geographic features or non-spatial records.
Definition: AGSFeatureTable.h:66
BOOL hasGeometry
Definition: AGSFeatureTable.h:98
AGSLayer * layer
Definition: AGSFeatureTable.h:155
AGSEnvelope * extent
Definition: AGSFeatureTable.h:78
BOOL canAddFeature
Definition: AGSFeatureTable.h:120
NSInteger numberOfFeatures
Definition: AGSFeatureTable.h:131
NSString * displayName
Definition: AGSFeatureTable.h:148
AGSFeature * createFeature()
NSArray< AGSField * > * fields
Definition: AGSFeatureTable.h:85
AGSGeometryType geometryType
Definition: AGSFeatureTable.h:90
NSString * tableName
Definition: AGSFeatureTable.h:143
BOOL editable
Definition: AGSFeatureTable.h:115
BOOL hasZ
Definition: AGSFeatureTable.h:108
BOOL canEditGeometry
Definition: AGSFeatureTable.h:125
BOOL hasM
Definition: AGSFeatureTable.h:103
AGSSpatialReference * spatialReference
Definition: AGSFeatureTable.h:137
An object that represents information about a field.
Definition: AGSField.h:62
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
An abstract base class for all layers.
Definition: AGSLayer.h:194
A base class for loadables.
Definition: AGSLoadableBase.h:45
Parameters to perform a query using AGSFeatureTable.
Definition: AGSQueryParameters.h:45
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:46
Parameters to perform a statistic query using AGSFeatureTable.
Definition: AGSStatisticsQueryParameters.h:44
Result of queries that return statistics.
Definition: AGSStatisticsQueryResult.h:48
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
A source for popups.
Definition: AGSPopupSource.h:40