AGSTextSymbol.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <ArcGIS/AGSMarkerSymbol.h>



typedef NS_ENUM(NSInteger, AGSFontDecoration) {
    AGSFontDecorationLineThrough = 0,   
    AGSFontDecorationNone = 1,          
    AGSFontDecorationUnderline = 2      
};

typedef NS_ENUM(NSInteger, AGSFontStyle) {
    AGSFontStyleItalic = 0,     
    AGSFontStyleNormal = 1,     
    AGSFontStyleOblique = 2     
};

typedef NS_ENUM(NSInteger, AGSFontWeight) {
    AGSFontWeightBold = 0,      
    AGSFontWeightNormal = 1     
};

typedef NS_ENUM(NSInteger, AGSHorizontalAlignment) {
    AGSHorizontalAlignmentCenter = 0,   
    AGSHorizontalAlignmentJustify = 1,  
    AGSHorizontalAlignmentLeft = 2,     
    AGSHorizontalAlignmentRight = 3     
};

typedef NS_ENUM(NSInteger, AGSVerticalAlignment) {
    AGSVerticalAlignmentBaseline = 0,   
    AGSVerticalAlignmentBottom = 1,     
    AGSVerticalAlignmentMiddle = 2,     
    AGSVerticalAlignmentTop = 3         
};

@interface AGSTextSymbol : AGSMarkerSymbol

#pragma mark -
#pragma mark initializers

-(instancetype)initWithText:(NSString *)text
                      color:(AGSColor *)color
                       size:(CGFloat)size
        horizontalAlignment:(AGSHorizontalAlignment)horizontalAlignment
          verticalAlignment:(AGSVerticalAlignment)verticalAlignment;

+(instancetype)textSymbolWithText:(NSString *)text
                            color:(AGSColor *)color
                             size:(CGFloat)size
              horizontalAlignment:(AGSHorizontalAlignment)horizontalAlignment
                verticalAlignment:(AGSVerticalAlignment)verticalAlignment;

+(instancetype)textSymbol;

#pragma mark -
#pragma mark properties

@property (nonatomic, strong, readwrite) AGSColor *backgroundColor;

@property (nonatomic, strong, readwrite) AGSColor *color;

@property (nonatomic, assign, readwrite) AGSFontDecoration fontDecoration;

@property (nonatomic, copy, readwrite) NSString *fontFamily;

@property (nonatomic, assign, readwrite) AGSFontStyle fontStyle;

@property (nonatomic, assign, readwrite) AGSFontWeight fontWeight;

@property (nullable, nonatomic, strong, readwrite) AGSColor *haloColor;

@property (nonatomic, assign, readwrite) CGFloat haloWidth;

@property (nonatomic, assign, readwrite) AGSHorizontalAlignment horizontalAlignment;

@property (nonatomic, assign, readwrite, getter=isKerningEnabled) BOOL kerningEnabled;

@property (nullable, nonatomic, strong, readwrite) AGSColor *outlineColor;

@property (nonatomic, assign, readwrite) CGFloat outlineWidth;

@property (nonatomic, assign, readwrite) CGFloat size;

@property (nonatomic, copy, readwrite) NSString *text;

@property (nonatomic, assign, readwrite) AGSVerticalAlignment verticalAlignment;

#pragma mark -
#pragma mark methods

@end