ArcGIS Runtime SDK for iOS: AGSMapViewCommon.h Source File
ArcGIS Runtime SDK for iOS  100.9
AGSMapViewCommon.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 1995-2020 ESRI
3 
4  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
5  Unpublished material - all rights reserved under the
6  Copyright Laws of the United States and applicable international
7  laws, treaties, and conventions.
8 
9  For additional information, contact:
10  Environmental Systems Research Institute, Inc.
11  Attn: Contracts and Legal Services Department
12  380 New York Street
13  Redlands, California, 92373
14  USA
15 
16  email: contracts@esri.com
17  */
18  //Required for Globals API doc
20 
21 #import <ArcGIS/AGSGeoView.h>
22 #import <ArcGIS/AGSEdgeInsets.h>
23 
24 
25 
30 typedef NS_ENUM(NSInteger, AGSAnimationCurve) {
53 };
54 
59 typedef NS_ENUM(NSInteger, AGSWrapAroundMode) {
62 };
63 
64 @class AGSMap;
66 @class AGSPolygon;
67 @class AGSEnvelope;
68 @class AGSPoint;
69 @class AGSLocationDisplay;
70 @class AGSBackgroundGrid;
71 @class AGSGrid;
73 @class AGSGeometry;
74 @class AGSSketchEditor;
75 @protocol AGSGeoViewTouchDelegate;
76 
84 
85 #pragma mark -
86 #pragma mark initializers
87 #pragma mark -
88 
89 #pragma mark -
90 #pragma mark properties
91 #pragma mark -
92 
96 @property (nullable, nonatomic, strong, readwrite) AGSMap *map;
97 
101 @property (nullable, nonatomic, strong, readwrite) AGSGrid *grid;
102 
115 @property (nullable, nonatomic, strong, readwrite) AGSBackgroundGrid *backgroundGrid;
116 
120 @property (nullable, nonatomic, strong, readwrite) AGSViewLabelProperties *labeling;
121 
125 @property (nonatomic, assign, readonly) double rotation;
126 
130 @property (nonatomic, assign, readonly) double mapScale;
131 
135 @property (nonatomic, assign, readonly) double unitsPerPoint;
136 
145 @property (nullable, nonatomic, strong, readonly) AGSPolygon *visibleArea;
146 
150 @property (nonatomic, strong, readwrite) AGSLocationDisplay *locationDisplay;
151 
155 @property (nullable, nonatomic, strong, readwrite) AGSSketchEditor *sketchEditor;
156 
157 #pragma mark - behavioral
158 
162 @property (nonatomic, strong, readwrite) AGSMapViewInteractionOptions *interactionOptions;
163 
168 @property (nonatomic, assign, readwrite) AGSWrapAroundMode wrapAroundMode;
169 
175 @property (nonatomic, assign, readwrite) AGSEdgeInsets contentInset;
176 
181 @property (nonatomic, assign, readonly) AGSEdgeInsets adjustedContentInset;
182 
183 #if __has_include(<UIKit/UIView.h>)
184 
190 @property (nonatomic, assign, readwrite) BOOL insetsContentInsetFromSafeArea;
191 #endif
192 
193 #pragma mark -
194 #pragma mark methods
195 
196 #pragma mark -
197 #pragma mark conversion methods
198 
204 -(CGPoint)locationToScreen:(AGSPoint *)mapLocation;
205 
211 -(AGSPoint*)screenToLocation:(CGPoint)screen;
212 
213 #pragma mark navigation methods
214 
224 -(id<AGSCancelable>)setViewpoint:(AGSViewpoint*)viewpoint duration:(double)duration curve:(AGSAnimationCurve)curve completion:(nullable void(^)(BOOL finished))completion;
225 
233 -(id<AGSCancelable>)setViewpointCenter:(AGSPoint*)center completion:(nullable void(^)(BOOL finished))completion;
234 
243 -(id<AGSCancelable>)setViewpointCenter:(AGSPoint*)center scale:(double)scale completion:(nullable void(^)(BOOL finished))completion;
244 
252 -(id<AGSCancelable>)setViewpointScale:(double)scale completion:(nullable void(^)(BOOL finished))completion;
253 
261 -(id<AGSCancelable>)setViewpointRotation:(double)angle completion:(nullable void(^)(BOOL finished))completion;
262 
270 -(id<AGSCancelable>)setViewpointGeometry:(AGSGeometry*)geometry completion:(nullable void(^)(BOOL finished))completion;
271 
280 -(id<AGSCancelable>)setViewpointGeometry:(AGSGeometry*)geometry padding:(double)paddingInScreenPoints completion:(nullable void(^)(BOOL finished))completion;
281 
282 @end
283 
284 
Definition: AGSMapViewCommon.h:33
AGSGrid * grid
Definition: AGSMapViewCommon.h:101
AGSMapViewInteractionOptions * interactionOptions
Definition: AGSMapViewCommon.h:162
A touch delegate for AGSGeoView.
Definition: AGSGeoView.h:367
A background grid defines the default color and context grid for display behind a map or scene surfac...
Definition: AGSBackgroundGrid.h:31
Definition: AGSMapViewCommon.h:48
Defines common members for all specific types of geometry.
Definition: AGSGeometry.h:106
double unitsPerPoint
Definition: AGSMapViewCommon.h:135
Definition: AGSMapViewCommon.h:39
A multipart shape used to represent an area.
Definition: AGSPolygon.h:57
AGSEdgeInsets adjustedContentInset
Definition: AGSMapViewCommon.h:181
Definition: AGSMapViewCommon.h:61
Definition: AGSMapViewCommon.h:32
Definition: AGSMapViewCommon.h:37
Definition: AGSMapViewCommon.h:45
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:47
AGSAnimationCurve
Definition: AGSMapViewCommon.h:30
Definition: AGSMapViewCommon.h:42
AGSLocationDisplay * locationDisplay
Definition: AGSMapViewCommon.h:150
Definition: AGSMapViewCommon.h:31
Definition: AGSMapViewCommon.h:50
A base class for all views that can display geographic content on screen.
Definition: AGSGeoView.h:61
Represents the view location of AGSMapView or AGSSceneView.
Definition: AGSViewpoint.h:49
AGSPolygon * visibleArea
Definition: AGSMapViewCommon.h:145
AGSWrapAroundMode wrapAroundMode
Definition: AGSMapViewCommon.h:168
Options to configure Map View user interactions.
Definition: AGSMapViewInteractionOptions.h:29
AGSMap * map
Definition: AGSMapViewCommon.h:96
Definition: AGSMapViewCommon.h:51
Definition: AGSMapViewCommon.h:34
double mapScale
Definition: AGSMapViewCommon.h:130
Definition: AGSMapViewCommon.h:44
A base class for displaying coordinate system grids on a map.
Definition: AGSGrid.h:62
Definition: AGSMapViewCommon.h:52
Definition: AGSMapViewCommon.h:60
Definition: AGSMapViewCommon.h:40
A map containing 2D geographic content.
Definition: AGSMap.h:59
AGSBackgroundGrid * backgroundGrid
Definition: AGSMapViewCommon.h:115
Definition: AGSMapViewCommon.h:49
Definition: AGSMapViewCommon.h:35
Definition: AGSMapViewCommon.h:46
AGSWrapAroundMode
Definition: AGSMapViewCommon.h:59
A base class for AGSMapView.
Definition: AGSMapViewCommon.h:83
Definition: AGSMapViewCommon.h:43
AGSViewLabelProperties * labeling
Definition: AGSMapViewCommon.h:120
Definition: AGSMapViewCommon.h:36
AGSSketchEditor * sketchEditor
Definition: AGSMapViewCommon.h:155
Definition: AGSMapViewCommon.h:41
Definition: AGSMapViewCommon.h:47
Definition: AGSMapViewCommon.h:38
Displays device location on a map.
Definition: AGSLocationDisplay.h:58
Label properties for AGSGeoView.
Definition: AGSViewLabelProperties.h:29
A class that allows the user to sketch geometries on the map.
Definition: AGSSketchEditor.h:68
AGSEdgeInsets contentInset
Definition: AGSMapViewCommon.h:175
double rotation
Definition: AGSMapViewCommon.h:125
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:57
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:32