ArcGIS Runtime SDK for iOS: AGSFeatureTable.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSFeatureTable.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  //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 #import <ArcGIS/AGSCancelable.h>
32 
33 
34 
40 typedef NS_ENUM(NSInteger, AGSFeatureRequestMode) {
45 };
46 
47 @class AGSEnvelope;
48 @class AGSField;
49 @class AGSQueryParameters;
50 @class AGSFeature;
52 @class AGSEditResult;
53 @class AGSFeatureLayer;
56 @class AGSSpatialReference;
57 @class AGSLayer;
58 
66 
67 #pragma mark -
68 #pragma mark initializers
69 
70 #pragma mark -
71 #pragma mark properties
72 
77 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *extent;
78 
84 @property (nonatomic, copy, readonly) NSArray<AGSField*> *fields;
85 
89 @property (nonatomic, assign, readonly) AGSGeometryType geometryType;
90 
97 @property (nonatomic, assign, readonly) BOOL hasGeometry;
98 
102 @property (nonatomic, assign, readonly) BOOL hasM;
103 
107 @property (nonatomic, assign, readonly) BOOL hasZ;
108 
114 @property (nonatomic, assign, readonly, getter=isEditable) BOOL editable;
115 
119 @property (nonatomic, assign, readonly) BOOL canAddFeature;
120 
124 @property (nonatomic, assign, readonly) BOOL canEditGeometry;
125 
130 @property (nonatomic, assign, readonly) NSInteger numberOfFeatures;
131 
136 @property (nullable, nonatomic, strong, readonly) AGSSpatialReference *spatialReference;
137 
142 @property (nonatomic, copy, readonly) NSString *tableName;
143 
147 @property (nonatomic, copy, readwrite) NSString *displayName;
148 
154 @property (nullable, nonatomic, weak, readonly) AGSLayer *layer;
155 
156 #pragma mark -
157 #pragma mark methods
158 
159 
172 -(id<AGSCancelable>)addFeature:(AGSFeature *)feature completion:(nullable void(^)(NSError *__nullable error))completion;
173 
184 -(id<AGSCancelable>)addFeatures:(NSArray<AGSFeature*> *)features completion:(nullable void(^)(NSError *__nullable error))completion;
185 
191 -(BOOL)canDeleteFeature:(AGSFeature *)feature;
192 
198 -(BOOL)canUpdateFeature:(AGSFeature *)feature;
199 
207 
216 -(AGSFeature *)createFeatureWithAttributes:(NSDictionary<NSString*,id> *)attributes geometry:(nullable AGSGeometry *)geometry;
217 
228 -(id<AGSCancelable>)deleteFeature:(AGSFeature *)feature completion:(nullable void(^)(NSError *__nullable error))completion;
229 
241 -(id<AGSCancelable>)deleteFeatures:(NSArray<AGSFeature*> *)features completion:(nullable void(^)(NSError *__nullable error))completion;
242 
248 -(nullable AGSField *)fieldForName:(NSString *)fieldName;
249 
258 -(id<AGSCancelable>)queryFeaturesWithParameters:(AGSQueryParameters *)parameters
259  completion:(nullable void(^)(AGSFeatureQueryResult *__nullable result, NSError *__nullable error))completion;
260 
268 -(id<AGSCancelable>)queryExtentWithParameters:(AGSQueryParameters *)parameters
269  completion:(void(^)(AGSEnvelope *__nullable extent, NSError *__nullable error))completion;
270 
278 -(id<AGSCancelable>)queryFeatureCountWithParameters:(AGSQueryParameters *)parameters
279  completion:(void(^)(NSInteger count, NSError *__nullable error))completion;
280 
288 -(id<AGSCancelable>)queryStatisticsWithParameters:(AGSStatisticsQueryParameters *)parameters
289  completion:(void(^)(AGSStatisticsQueryResult *__nullable result, NSError *__nullable error))completion;
290 
304 -(id<AGSCancelable>)updateFeature:(AGSFeature *)feature completion:(nullable void(^)(NSError *__nullable error))completion;
305 
317 -(id<AGSCancelable>)updateFeatures:(NSArray<AGSFeature*> *)features completion:(nullable void(^)(NSError *__nullable error))completion;
318 
319 @end
320 
322 
329 @property (nullable, nonatomic, weak, readonly) AGSFeatureLayer *featureLayer ;
330 
331 @end
332 
333 
AGSFeatureRequestMode
Definition: AGSFeatureTable.h:40
@ AGSFeatureRequestModeOnInteractionCache
Definition: AGSFeatureTable.h:42
@ AGSFeatureRequestModeManualCache
Definition: AGSFeatureTable.h:44
@ AGSFeatureRequestModeOnInteractionNoCache
Definition: AGSFeatureTable.h:43
@ AGSFeatureRequestModeUndefined
Definition: AGSFeatureTable.h:41
AGSGeometryType
Definition: AGSGeometry.h:49
Definition: AGSFeatureTable.h:321
AGSFeatureLayer * featureLayer
Definition: AGSFeatureTable.h:329
Information about the outcome of an attachment edit operation.
Definition: AGSEditResult.h:42
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:179
Result of queries that return features.
Definition: AGSFeatureQueryResult.h:49
A source for dataset containing geographic features or non-spatial records.
Definition: AGSFeatureTable.h:65
BOOL hasGeometry
Definition: AGSFeatureTable.h:97
AGSLayer * layer
Definition: AGSFeatureTable.h:154
AGSEnvelope * extent
Definition: AGSFeatureTable.h:77
BOOL canAddFeature
Definition: AGSFeatureTable.h:119
NSInteger numberOfFeatures
Definition: AGSFeatureTable.h:130
NSString * displayName
Definition: AGSFeatureTable.h:147
AGSFeature * createFeature()
NSArray< AGSField * > * fields
Definition: AGSFeatureTable.h:84
AGSGeometryType geometryType
Definition: AGSFeatureTable.h:89
NSString * tableName
Definition: AGSFeatureTable.h:142
BOOL editable
Definition: AGSFeatureTable.h:114
BOOL hasZ
Definition: AGSFeatureTable.h:107
BOOL canEditGeometry
Definition: AGSFeatureTable.h:124
BOOL hasM
Definition: AGSFeatureTable.h:102
AGSSpatialReference * spatialReference
Definition: AGSFeatureTable.h:136
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:201
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:49
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