ArcGIS Runtime SDK for iOS: AGSKMLNode.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSKMLNode.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/AGSObject.h>
29 #import <ArcGIS/AGSColor.h>
30 #import <ArcGIS/AGSImage.h>
31 #import <ArcGIS/AGSCancelable.h>
32 
33 
34 
39 typedef NS_ENUM(NSInteger, AGSKMLRefreshStatus) {
44 };
45 
46 @class AGSEnvelope;
47 @class AGSKMLViewpoint;
48 @class AGSKMLStyle;
49 @class AGSTimeExtent;
50 
55 @interface AGSKMLNode : AGSObject
56 
57 #pragma mark -
58 #pragma mark initializers
59 
63 +(instancetype)KMLNode ;
64 
65 #pragma mark -
66 #pragma mark properties
67 
71 @property (nonatomic, copy, readwrite) NSString *nodeID;
72 
77 @property (nullable, nonatomic, strong, readonly) AGSColor *balloonBackgroundColor;
78 
82 @property (nonatomic, copy, readonly) NSString *balloonContent;
83 
87 @property (nonatomic, copy, readwrite) NSString *nodeDescription;
88 
94 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *extent;
95 
101 @property (nonatomic, assign, readwrite, getter=isHighlighted) BOOL highlighted;
102 
108 @property (nonatomic, assign, readwrite, getter=isVisible) BOOL visible;
109 
113 @property (nonatomic, copy, readwrite) NSString *name;
114 
119 @property (nullable, nonatomic, strong, readonly) NSError *refreshError;
120 
129 @property (nonatomic, assign, readonly) AGSKMLRefreshStatus refreshStatus;
130 
134 @property (nullable, nonatomic, strong, readonly) AGSKMLNode *parentNode;
135 
141 @property (nonatomic, copy, readwrite) NSString *snippet;
142 
148 @property (nonatomic, assign, readwrite) NSInteger snippetMaxLines;
149 
153 @property (nonatomic, assign, readonly) NSInteger UXIconID;
154 
161 @property (nullable, nonatomic, strong, readonly) AGSImage *UXIcon;
162 
169 @property (nullable, nonatomic, strong, readonly) AGSColor *UXIconColor;
170 
178 @property (nullable, nonatomic, strong, readwrite) AGSKMLViewpoint *viewpoint;
179 
184 @property (nullable, nonatomic, strong, readwrite) AGSKMLStyle *style;
185 
191 @property (nullable, nonatomic, strong, readwrite) AGSKMLStyle *highlightStyle;
192 
197 @property (nonatomic, copy, readwrite) NSString *address;
198 
225 @property (nullable, nonatomic, strong, readwrite) AGSTimeExtent *timeExtent;
226 
227 #pragma mark -
228 #pragma mark methods
229 
253 -(id<AGSCancelable>)saveToFileURL:(NSURL *)fileURL
254  completion:(void(^)(NSError * __nullable error))completion;
255 
256 @end
257 
258 
#define AGSColor
Definition: AGSColor.h:34
#define AGSImage
Definition: AGSImage.h:34
AGSKMLRefreshStatus
Definition: AGSKMLNode.h:39
@ AGSKMLRefreshStatusNone
Definition: AGSKMLNode.h:40
@ AGSKMLRefreshStatusFailed
Definition: AGSKMLNode.h:43
@ AGSKMLRefreshStatusInProgress
Definition: AGSKMLNode.h:41
@ AGSKMLRefreshStatusCompleted
Definition: AGSKMLNode.h:42
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A single node within a KML document.
Definition: AGSKMLNode.h:56
AGSEnvelope * extent
Definition: AGSKMLNode.h:94
NSInteger UXIconID
Definition: AGSKMLNode.h:153
NSString * nodeID
Definition: AGSKMLNode.h:71
BOOL visible
Definition: AGSKMLNode.h:108
BOOL highlighted
Definition: AGSKMLNode.h:101
NSError * refreshError
Definition: AGSKMLNode.h:119
AGSKMLViewpoint * viewpoint
Definition: AGSKMLNode.h:178
AGSColor * UXIconColor
Definition: AGSKMLNode.h:169
NSInteger snippetMaxLines
Definition: AGSKMLNode.h:148
instancetype KMLNode()
AGSKMLNode * parentNode
Definition: AGSKMLNode.h:134
NSString * snippet
Definition: AGSKMLNode.h:141
NSString * address
Definition: AGSKMLNode.h:197
AGSTimeExtent * timeExtent
Definition: AGSKMLNode.h:225
NSString * name
Definition: AGSKMLNode.h:113
AGSKMLStyle * highlightStyle
Definition: AGSKMLNode.h:191
AGSColor * balloonBackgroundColor
Definition: AGSKMLNode.h:77
AGSKMLRefreshStatus refreshStatus
Definition: AGSKMLNode.h:129
AGSImage * UXIcon
Definition: AGSKMLNode.h:161
NSString * balloonContent
Definition: AGSKMLNode.h:82
NSString * nodeDescription
Definition: AGSKMLNode.h:87
AGSKMLStyle * style
Definition: AGSKMLNode.h:184
Specifies the drawing style for a AGSKMLNode.
Definition: AGSKMLStyle.h:45
KML viewpoint specifying a vantage point for looking at a node.
Definition: AGSKMLViewpoint.h:55
Definition: AGSObject.h:28
Represents a span of time between a start time and end time.
Definition: AGSTimeExtent.h:42
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38