ArcGIS Runtime SDK for iOS: AGSSymbolStyle.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSSymbolStyle.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 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSLoadableRemoteResourceBase.h>
27 #import <ArcGIS/AGSRemoteResource.h>
28 #import <ArcGIS/AGSCancelable.h>
29 
32 @class AGSSymbol;
33 @class AGSPortal;
34 @class AGSPortalItem;
35  //Required for Globals API doc
37 
55 
56 
57 
58 #pragma mark -
59 #pragma mark initializers
60 
61 
62 
68 -(instancetype)initWithURL:(NSURL*)URL;
69 
75 +(instancetype)symbolStyleWithURL:(NSURL*)URL;
76 
82 -(instancetype)initWithName:(NSString*)name;
83 
89 +(instancetype)symbolStyleWithName:(NSString*)name;
90 
98 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem;
99 
107 + (instancetype)symbolStyleWithPortalItem:(AGSPortalItem *)portalItem;
108 
123 - (instancetype)initWithStyleName:(NSString *)styleName
124  portal:(nullable AGSPortal *)portal;
125 
140 + (instancetype)symbolStyleWithStyleName:(NSString *)styleName
141  portal:(nullable AGSPortal *)portal;
142 
143 #pragma mark -
144 #pragma mark properties
145 
149 @property (nullable, nonatomic, strong, readonly) AGSPortal *portal;
150 
160 @property (nullable, nonatomic, strong, readonly) AGSPortalItem *portalItem;
161 
165 @property (nonatomic, copy, readonly) NSString *styleName;
166 
167 #pragma mark -
168 #pragma mark methods
169 
179 -(id<AGSCancelable>)defaultSearchParametersWithCompletion:(void(^)(AGSSymbolStyleSearchParameters * __nullable searchParams, NSError * __nullable error))completion;
180 
196 -(id<AGSCancelable>)symbolForKeys:(NSArray<NSString*>*)keys completion:(void(^)(AGSSymbol * __nullable symbol, NSError * __nullable error))completion;
197 
206 -(id<AGSCancelable>)searchSymbolsWithParameters:(AGSSymbolStyleSearchParameters*)searchParameters completion:(void(^)(NSArray<AGSSymbolStyleSearchResult*> * __nullable searchResults, NSError * __nullable error))completion;
207 
208 
209 
210 
211 @end
Definition: AGSLoadableRemoteResourceBase.h:35
An object representing a portal for ArcGIS.
Definition: AGSPortal.h:98
Object representing a unit of content in an ArcGIS portal.
Definition: AGSPortalItem.h:93
A symbol used to display a graphic or a feature.
Definition: AGSSymbol.h:93
A symbol style object.
Definition: AGSSymbolStyle.h:55
AGSPortal * portal
Definition: AGSSymbolStyle.h:149
NSString * styleName
Definition: AGSSymbolStyle.h:165
AGSPortalItem * portalItem
Definition: AGSSymbolStyle.h:160
Search parameters used to search for symbols in a symbol style.
Definition: AGSSymbolStyleSearchParameters.h:39
Results of search operations on a symbol style.
Definition: AGSSymbolStyleSearchResult.h:42
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38