ArcGIS Runtime SDK for iOS: AGSFeatureLayer.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSFeatureLayer.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/AGSLayer.h>
29 #import <ArcGIS/AGSPopupSource.h>
30 #import <ArcGIS/AGSTimeAware.h>
31 #import <ArcGIS/AGSColor.h>
32 #import <ArcGIS/AGSFloorAware.h>
33 #import <ArcGIS/AGSCancelable.h>
34 
35 
36 
40 typedef NS_ENUM(NSInteger, AGSFeatureRenderingMode) {
44 };
45 
50 typedef NS_ENUM(NSInteger, AGSSelectionMode) {
54 };
55 
60 typedef NS_ENUM(NSInteger, AGSFeatureTilingMode) {
63 };
64 
65 @class AGSFeatureTable;
66 @class AGSRenderer;
67 @class AGSFeature;
68 @class AGSQueryParameters;
70 @class AGSItem;
71 @class AGSLabelDefinition;
74 
180 
181 #pragma mark -
182 #pragma mark ␄initializers
183 
192 -(instancetype)initWithFeatureTable:(AGSFeatureTable *)featureTable;
193 
198 -(instancetype)init ;
199 
207 -(instancetype)initWithItem:(AGSItem*)item layerID:(NSInteger)layerID;
208 
217 +(instancetype)featureLayerWithItem:(AGSItem*)item layerID:(NSInteger)layerID;
218 
224 +(instancetype)featureLayer ;
225 
234 +(instancetype)featureLayerWithFeatureTable:(AGSFeatureTable*)featureTable;
235 
244 - (instancetype)initWithItem:(AGSItem *)item;
245 
254 + (instancetype)featureLayerWithItem:(AGSItem *)item;
255 
256 #pragma mark -
257 #pragma mark properties
258 
266 @property (nonatomic, copy, readwrite) NSString *definitionExpression;
267 
271 @property (nonatomic, assign, readwrite) BOOL labelsEnabled;
272 
276 @property (nullable, nonatomic, strong, readwrite) AGSRenderer *renderer;
277 
282 @property (nonatomic, assign, readwrite) AGSFeatureRenderingMode renderingMode;
283 
288 @property (nonatomic, assign, readwrite) BOOL scaleSymbols;
289 
293 @property (nullable, nonatomic, strong, readwrite) AGSLayerSceneProperties *sceneProperties;
294 
299 @property (nullable, nonatomic, strong, readwrite) AGSColor *selectionColor ;
300 
305 @property (nonatomic, assign, readwrite) double selectionWidth ;
306 
310 @property (nullable, nonatomic, strong, readonly) AGSFeatureTable *featureTable;
311 
315 @property (nonatomic, strong, readonly) NSMutableArray<AGSLabelDefinition*> *labelDefinitions;
316 
320 @property (nonatomic, assign, readwrite) NSTimeInterval refreshInterval;
321 
327 @property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *unknownJSON;
328 
334 @property (nonatomic, copy, readonly) NSDictionary<NSString *, id> *unsupportedJSON;
335 
342 @property (nonatomic, assign, readwrite) AGSFeatureTilingMode tilingMode;
343 
352 @property (nullable, nonatomic, strong, readwrite) AGSDisplayFilterDefinition *displayFilterDefinition;
353 
354 #pragma mark -
355 #pragma mark methods
356 
360 -(void)resetFeaturesVisible;
361 
366 -(void)resetRenderer;
367 
374 -(void)setFeature:(AGSFeature *)feature visible:(BOOL)visible;
375 
381 -(void)setFeatures:(NSArray<AGSFeature*> *)features visible:(BOOL)visible;
382 
386 -(void)clearSelection;
387 
393 -(id<AGSCancelable>)getSelectedFeaturesWithCompletion:(void(^)(AGSFeatureQueryResult *__nullable featureQueryResult, NSError *__nullable error))completion;
394 
401 -(void)selectFeature:(AGSFeature *)feature;
402 
408 -(void)selectFeatures:(NSArray<AGSFeature*> *)features;
409 
417 -(id<AGSCancelable>)selectFeaturesWithQuery:(AGSQueryParameters *)parameters mode:(AGSSelectionMode)mode completion:(nullable void (^)(AGSFeatureQueryResult *__nullable featureQueryResult, NSError *__nullable error))completion;
418 
419 
425 -(void)unselectFeature:(AGSFeature *)feature;
426 
431 -(void)unselectFeatures:(NSArray<AGSFeature*> *)features;
432 
433 @end
434 
435 
#define AGSColor
Definition: AGSColor.h:34
AGSFeatureRenderingMode
Definition: AGSFeatureLayer.h:40
@ AGSFeatureRenderingModeAutomatic
Definition: AGSFeatureLayer.h:41
@ AGSFeatureRenderingModeStatic
Definition: AGSFeatureLayer.h:42
@ AGSFeatureRenderingModeDynamic
Definition: AGSFeatureLayer.h:43
AGSSelectionMode
Definition: AGSFeatureLayer.h:50
@ AGSSelectionModeAdd
Definition: AGSFeatureLayer.h:51
@ AGSSelectionModeNew
Definition: AGSFeatureLayer.h:52
@ AGSSelectionModeSubtract
Definition: AGSFeatureLayer.h:53
AGSFeatureTilingMode
Definition: AGSFeatureLayer.h:60
@ AGSFeatureTilingModeDisabled
Definition: AGSFeatureLayer.h:62
@ AGSFeatureTilingModeEnabledWhenSupported
Definition: AGSFeatureLayer.h:61
Provides definition on how features are filtered from the display.
Definition: AGSDisplayFilterDefinition.h:40
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
AGSFeatureTilingMode tilingMode
Definition: AGSFeatureLayer.h:342
AGSDisplayFilterDefinition * displayFilterDefinition
Definition: AGSFeatureLayer.h:352
instancetype init()
AGSLayerSceneProperties * sceneProperties
Definition: AGSFeatureLayer.h:293
NSString * definitionExpression
Definition: AGSFeatureLayer.h:266
AGSRenderer * renderer
Definition: AGSFeatureLayer.h:276
AGSFeatureTable * featureTable
Definition: AGSFeatureLayer.h:310
NSMutableArray< AGSLabelDefinition * > * labelDefinitions
Definition: AGSFeatureLayer.h:315
AGSColor * selectionColor
Definition: AGSFeatureLayer.h:299
NSDictionary< NSString *, id > * unknownJSON
Definition: AGSFeatureLayer.h:327
BOOL scaleSymbols
Definition: AGSFeatureLayer.h:288
void resetFeaturesVisible()
double selectionWidth
Definition: AGSFeatureLayer.h:305
NSDictionary< NSString *, id > * unsupportedJSON
Definition: AGSFeatureLayer.h:334
instancetype featureLayer()
AGSFeatureRenderingMode renderingMode
Definition: AGSFeatureLayer.h:282
NSTimeInterval refreshInterval
Definition: AGSFeatureLayer.h:320
BOOL labelsEnabled
Definition: AGSFeatureLayer.h:271
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
Object representing a unit of content.
Definition: AGSItem.h:43
An object that defines the text, appearance, and position of labels for features within a given scale...
Definition: AGSLabelDefinition.h:224
An abstract base class for all layers.
Definition: AGSLayer.h:201
Layer properties that apply to 3D scenes.
Definition: AGSLayerSceneProperties.h:38
Parameters to perform a query using AGSFeatureTable.
Definition: AGSQueryParameters.h:45
An abstract base class for renderers.
Definition: AGSRenderer.h:55
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
A protocol that can be implemented by layers that support floor filtering.
Definition: AGSFloorAware.h:36
A source for popups.
Definition: AGSPopupSource.h:40
A protocol that can be implemented by layers that support time.
Definition: AGSTimeAware.h:41