ArcGIS Runtime SDK for iOS: AGSTextSymbol.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSTextSymbol.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/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 
92 
93 #pragma mark -
94 #pragma mark initializers
95 
102 -(instancetype)initWithText:(NSString *)text
103  color:(AGSColor *)color
104  size:(CGFloat)size
105  horizontalAlignment:(AGSHorizontalAlignment)horizontalAlignment
106  verticalAlignment:(AGSVerticalAlignment)verticalAlignment;
107 
114 +(instancetype)textSymbolWithText:(NSString *)text
115  color:(AGSColor *)color
116  size:(CGFloat)size
117  horizontalAlignment:(AGSHorizontalAlignment)horizontalAlignment
118  verticalAlignment:(AGSVerticalAlignment)verticalAlignment;
119 
123 +(instancetype)textSymbol;
124 
125 #pragma mark -
126 #pragma mark properties
127 
131 @property (nonatomic, strong, readwrite) AGSColor *backgroundColor;
132 
136 @property (nonatomic, strong, readwrite) AGSColor *color;
137 
141 @property (nonatomic, assign, readwrite) AGSFontDecoration fontDecoration;
142 
147 @property (nonatomic, copy, readwrite) NSString *fontFamily;
148 
152 @property (nonatomic, assign, readwrite) AGSFontStyle fontStyle;
153 
157 @property (nonatomic, assign, readwrite) AGSFontWeight fontWeight;
158 
163 @property (nullable, nonatomic, strong, readwrite) AGSColor *haloColor;
164 
169 @property (nonatomic, assign, readwrite) CGFloat haloWidth;
170 
174 @property (nonatomic, assign, readwrite) AGSHorizontalAlignment horizontalAlignment;
175 
179 @property (nonatomic, assign, readwrite, getter=isKerningEnabled) BOOL kerningEnabled;
180 
185 @property (nullable, nonatomic, strong, readwrite) AGSColor *outlineColor;
186 
191 @property (nonatomic, assign, readwrite) CGFloat outlineWidth;
192 
196 @property (nonatomic, assign, readwrite) CGFloat size;
197 
201 @property (nonatomic, copy, readwrite) NSString *text;
202 
206 @property (nonatomic, assign, readwrite) AGSVerticalAlignment verticalAlignment;
207 
208 #pragma mark -
209 #pragma mark methods
210 
211 @end
212 
213 
#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:92
AGSColor * backgroundColor
Definition: AGSTextSymbol.h:131
CGFloat haloWidth
Definition: AGSTextSymbol.h:169
AGSFontStyle fontStyle
Definition: AGSTextSymbol.h:152
CGFloat size
Definition: AGSTextSymbol.h:196
NSString * text
Definition: AGSTextSymbol.h:201
AGSFontDecoration fontDecoration
Definition: AGSTextSymbol.h:141
AGSFontWeight fontWeight
Definition: AGSTextSymbol.h:157
AGSColor * outlineColor
Definition: AGSTextSymbol.h:185
CGFloat outlineWidth
Definition: AGSTextSymbol.h:191
AGSColor * color
Definition: AGSTextSymbol.h:136
AGSColor * haloColor
Definition: AGSTextSymbol.h:163
AGSHorizontalAlignment horizontalAlignment
Definition: AGSTextSymbol.h:174
BOOL kerningEnabled
Definition: AGSTextSymbol.h:179
instancetype textSymbol()
NSString * fontFamily
Definition: AGSTextSymbol.h:147
AGSVerticalAlignment verticalAlignment
Definition: AGSTextSymbol.h:206