ArcGIS Runtime SDK for iOS: AGSKMLNode.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSKMLNode.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/AGSObject.h>
29 #import <ArcGIS/AGSColor.h>
30 #import <ArcGIS/AGSImage.h>
31 
32 
33 
38 typedef NS_ENUM(NSInteger, AGSKMLRefreshStatus) {
43 };
44 
45 @class AGSEnvelope;
46 @class AGSKMLViewpoint;
47 @class AGSKMLStyle;
48 @class AGSTimeExtent;
49 
50 @protocol AGSCancelable;
51 
56 @interface AGSKMLNode : AGSObject
57 
58 #pragma mark -
59 #pragma mark initializers
60 
64 +(instancetype)KMLNode ;
65 
66 #pragma mark -
67 #pragma mark properties
68 
72 @property (nonatomic, copy, readwrite) NSString *nodeID;
73 
78 @property (nullable, nonatomic, strong, readonly) AGSColor *balloonBackgroundColor;
79 
83 @property (nonatomic, copy, readonly) NSString *balloonContent;
84 
88 @property (nonatomic, copy, readwrite) NSString *nodeDescription;
89 
95 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *extent;
96 
102 @property (nonatomic, assign, readwrite, getter=isHighlighted) BOOL highlighted;
103 
109 @property (nonatomic, assign, readwrite, getter=isVisible) BOOL visible;
110 
114 @property (nonatomic, copy, readwrite) NSString *name;
115 
120 @property (nullable, nonatomic, strong, readonly) NSError *refreshError;
121 
130 @property (nonatomic, assign, readonly) AGSKMLRefreshStatus refreshStatus;
131 
135 @property (nullable, nonatomic, strong, readonly) AGSKMLNode *parentNode;
136 
142 @property (nonatomic, copy, readwrite) NSString *snippet;
143 
149 @property (nonatomic, assign, readwrite) NSInteger snippetMaxLines;
150 
154 @property (nonatomic, assign, readonly) NSInteger UXIconID;
155 
162 @property (nullable, nonatomic, strong, readonly) AGSImage *UXIcon;
163 
170 @property (nullable, nonatomic, strong, readonly) AGSColor *UXIconColor;
171 
179 @property (nullable, nonatomic, strong, readwrite) AGSKMLViewpoint *viewpoint;
180 
185 @property (nullable, nonatomic, strong, readwrite) AGSKMLStyle *style;
186 
192 @property (nullable, nonatomic, strong, readwrite) AGSKMLStyle *highlightStyle;
193 
198 @property (nonatomic, copy, readwrite) NSString *address;
199 
204 @property (nullable, nonatomic, strong, readwrite) AGSTimeExtent *timeExtent;
205 
206 #pragma mark -
207 #pragma mark methods
208 
232 -(id<AGSCancelable>)saveToFileURL:(NSURL *)fileURL
233  completion:(void(^)(NSError * __nullable error))completion;
234 
235 @end
236 
237 
#define AGSColor
Definition: AGSColor.h:34
#define AGSImage
Definition: AGSImage.h:34
AGSKMLRefreshStatus
Definition: AGSKMLNode.h:38
@ AGSKMLRefreshStatusNone
Definition: AGSKMLNode.h:39
@ AGSKMLRefreshStatusFailed
Definition: AGSKMLNode.h:42
@ AGSKMLRefreshStatusInProgress
Definition: AGSKMLNode.h:40
@ AGSKMLRefreshStatusCompleted
Definition: AGSKMLNode.h:41
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A single node within a KML document.
Definition: AGSKMLNode.h:57
AGSEnvelope * extent
Definition: AGSKMLNode.h:95
NSInteger UXIconID
Definition: AGSKMLNode.h:154
NSString * nodeID
Definition: AGSKMLNode.h:72
BOOL visible
Definition: AGSKMLNode.h:109
BOOL highlighted
Definition: AGSKMLNode.h:102
NSError * refreshError
Definition: AGSKMLNode.h:120
AGSKMLViewpoint * viewpoint
Definition: AGSKMLNode.h:179
AGSColor * UXIconColor
Definition: AGSKMLNode.h:170
NSInteger snippetMaxLines
Definition: AGSKMLNode.h:149
instancetype KMLNode()
AGSKMLNode * parentNode
Definition: AGSKMLNode.h:135
NSString * snippet
Definition: AGSKMLNode.h:142
NSString * address
Definition: AGSKMLNode.h:198
AGSTimeExtent * timeExtent
Definition: AGSKMLNode.h:204
NSString * name
Definition: AGSKMLNode.h:114
AGSKMLStyle * highlightStyle
Definition: AGSKMLNode.h:192
AGSColor * balloonBackgroundColor
Definition: AGSKMLNode.h:78
AGSKMLRefreshStatus refreshStatus
Definition: AGSKMLNode.h:130
AGSImage * UXIcon
Definition: AGSKMLNode.h:162
NSString * balloonContent
Definition: AGSKMLNode.h:83
NSString * nodeDescription
Definition: AGSKMLNode.h:88
AGSKMLStyle * style
Definition: AGSKMLNode.h:185
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