ArcGIS Runtime SDK for iOS: AGSTextSymbol.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSTextSymbol.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/AGSMarkerSymbol.h>
29 
30 
31 
36 typedef NS_ENUM(NSInteger, AGSFontDecoration) {
40 };
41 
46 typedef NS_ENUM(NSInteger, AGSFontStyle) {
50 };
51 
56 typedef NS_ENUM(NSInteger, AGSFontWeight) {
59 };
60 
65 typedef NS_ENUM(NSInteger, AGSHorizontalAlignment) {
70 };
71 
76 typedef NS_ENUM(NSInteger, AGSVerticalAlignment) {
81 };
82 
93 
94 #pragma mark -
95 #pragma mark initializers
96 
103 -(instancetype)initWithText:(NSString *)text
104  color:(AGSColor *)color
105  size:(CGFloat)size
106  horizontalAlignment:(AGSHorizontalAlignment)horizontalAlignment
107  verticalAlignment:(AGSVerticalAlignment)verticalAlignment;
108 
116 +(instancetype)textSymbolWithText:(NSString *)text
117  color:(AGSColor *)color
118  size:(CGFloat)size
119  horizontalAlignment:(AGSHorizontalAlignment)horizontalAlignment
120  verticalAlignment:(AGSVerticalAlignment)verticalAlignment;
121 
126 +(instancetype)textSymbol;
127 
128 #pragma mark -
129 #pragma mark properties
130 
134 @property (nonatomic, strong, readwrite) AGSColor *backgroundColor;
135 
139 @property (nonatomic, strong, readwrite) AGSColor *color;
140 
144 @property (nonatomic, assign, readwrite) AGSFontDecoration fontDecoration;
145 
150 @property (nonatomic, copy, readwrite) NSString *fontFamily;
151 
155 @property (nonatomic, assign, readwrite) AGSFontStyle fontStyle;
156 
160 @property (nonatomic, assign, readwrite) AGSFontWeight fontWeight;
161 
166 @property (nullable, nonatomic, strong, readwrite) AGSColor *haloColor;
167 
172 @property (nonatomic, assign, readwrite) CGFloat haloWidth;
173 
177 @property (nonatomic, assign, readwrite) AGSHorizontalAlignment horizontalAlignment;
178 
182 @property (nonatomic, assign, readwrite, getter=isKerningEnabled) BOOL kerningEnabled;
183 
188 @property (nullable, nonatomic, strong, readwrite) AGSColor *outlineColor;
189 
194 @property (nonatomic, assign, readwrite) CGFloat outlineWidth;
195 
199 @property (nonatomic, assign, readwrite) CGFloat size;
200 
204 @property (nonatomic, copy, readwrite) NSString *text;
205 
209 @property (nonatomic, assign, readwrite) AGSVerticalAlignment verticalAlignment;
210 
211 #pragma mark -
212 #pragma mark methods
213 
214 @end
215 
216 
#define AGSColor
Definition: AGSColor.h:34
AGSFontDecoration
Definition: AGSTextSymbol.h:36
@ AGSFontDecorationUnderline
Definition: AGSTextSymbol.h:39
@ AGSFontDecorationNone
Definition: AGSTextSymbol.h:38
@ AGSFontDecorationLineThrough
Definition: AGSTextSymbol.h:37
AGSVerticalAlignment
Definition: AGSTextSymbol.h:76
@ AGSVerticalAlignmentBaseline
Definition: AGSTextSymbol.h:77
@ AGSVerticalAlignmentBottom
Definition: AGSTextSymbol.h:78
@ AGSVerticalAlignmentMiddle
Definition: AGSTextSymbol.h:79
@ AGSVerticalAlignmentTop
Definition: AGSTextSymbol.h:80
AGSHorizontalAlignment
Definition: AGSTextSymbol.h:65
@ AGSHorizontalAlignmentCenter
Definition: AGSTextSymbol.h:66
@ AGSHorizontalAlignmentRight
Definition: AGSTextSymbol.h:69
@ AGSHorizontalAlignmentJustify
Definition: AGSTextSymbol.h:67
@ AGSHorizontalAlignmentLeft
Definition: AGSTextSymbol.h:68
AGSFontStyle
Definition: AGSTextSymbol.h:46
@ AGSFontStyleNormal
Definition: AGSTextSymbol.h:48
@ AGSFontStyleItalic
Definition: AGSTextSymbol.h:47
@ AGSFontStyleOblique
Definition: AGSTextSymbol.h:49
AGSFontWeight
Definition: AGSTextSymbol.h:56
@ AGSFontWeightBold
Definition: AGSTextSymbol.h:57
@ AGSFontWeightNormal
Definition: AGSTextSymbol.h:58
An abstract base class for marker symbols.
Definition: AGSMarkerSymbol.h:89
A text symbol.
Definition: AGSTextSymbol.h:93
AGSColor * backgroundColor
Definition: AGSTextSymbol.h:134
CGFloat haloWidth
Definition: AGSTextSymbol.h:172
AGSFontStyle fontStyle
Definition: AGSTextSymbol.h:155
CGFloat size
Definition: AGSTextSymbol.h:199
NSString * text
Definition: AGSTextSymbol.h:204
AGSFontDecoration fontDecoration
Definition: AGSTextSymbol.h:144
AGSFontWeight fontWeight
Definition: AGSTextSymbol.h:160
AGSColor * outlineColor
Definition: AGSTextSymbol.h:188
CGFloat outlineWidth
Definition: AGSTextSymbol.h:194
AGSColor * color
Definition: AGSTextSymbol.h:139
AGSColor * haloColor
Definition: AGSTextSymbol.h:166
AGSHorizontalAlignment horizontalAlignment
Definition: AGSTextSymbol.h:177
BOOL kerningEnabled
Definition: AGSTextSymbol.h:182
instancetype textSymbol()
NSString * fontFamily
Definition: AGSTextSymbol.h:150
AGSVerticalAlignment verticalAlignment
Definition: AGSTextSymbol.h:209