AGSLabelDefinition.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 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 <Foundation/Foundation.h>
#import <CoreGraphics/CGBase.h>
#import <ArcGIS/AGSObject.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSLabelingInfo.h>
 
 
 
typedef NS_ENUM(NSInteger, AGSLabelDeconflictionStrategy) {
    AGSLabelDeconflictionStrategyAutomatic = 0,           
    AGSLabelDeconflictionStrategyDynamic = 1,             
    AGSLabelDeconflictionStrategyNone = 2,                
    AGSLabelDeconflictionStrategyStatic = 3,              
    AGSLabelDeconflictionStrategyDynamicNeverRemove = 4   
};
 
typedef NS_ENUM(NSInteger, AGSLabelLineConnection) {
    AGSLabelLineConnectionAutomatic = 0,          
    AGSLabelLineConnectionMinimizeLabels = 1,     
    AGSLabelLineConnectionNone = 2,               
    AGSLabelLineConnectionUnambiguousLabels = 3   
};
 
typedef NS_ENUM(NSInteger, AGSLabelMultipartStrategy) {
    AGSLabelMultipartStrategyAutomatic = 0,        
    AGSLabelMultipartStrategyLabelLargest = 1,     
    AGSLabelMultipartStrategyLabelPerFeature = 2,  
    AGSLabelMultipartStrategyLabelPerPart = 3,     
    AGSLabelMultipartStrategyLabelPerSegment = 4   
};
 
typedef NS_ENUM(NSInteger, AGSLabelOverlapStrategy) {
    AGSLabelOverlapStrategyAutomatic = 0,  
    AGSLabelOverlapStrategyAllow = 1,      
    AGSLabelOverlapStrategyAvoid = 2,      
    AGSLabelOverlapStrategyExclude = 3     
};
 
typedef NS_ENUM(NSInteger, AGSLabelOverrunStrategy) {
    AGSLabelOverrunStrategyAutomatic = 0,  
    AGSLabelOverrunStrategyNone = 1,       
    AGSLabelOverrunStrategyAllow = 2       
};
 
typedef NS_ENUM(NSInteger, AGSLabelRemoveDuplicatesStrategy) {
    AGSLabelRemoveDuplicatesStrategyAutomatic = 0,    
    AGSLabelRemoveDuplicatesStrategyAll = 1,          
    AGSLabelRemoveDuplicatesStrategyFeatureType = 2,  
    AGSLabelRemoveDuplicatesStrategyLabelClass = 3,   
    AGSLabelRemoveDuplicatesStrategyNone = 4          
};
 
typedef NS_ENUM(NSInteger, AGSLabelRepeatStrategy) {
    AGSLabelRepeatStrategyAutomatic = 0,  
    AGSLabelRepeatStrategyNone = 1,       
    AGSLabelRepeatStrategyRepeat = 2      
};
 
typedef NS_ENUM(NSInteger, AGSLabelTextLayout) {
    AGSLabelTextLayoutAutomatic = 0,      
    AGSLabelTextLayoutHorizontal = 1,     
    AGSLabelTextLayoutPerpendicular = 2,  
    AGSLabelTextLayoutStraight = 3,       
    AGSLabelTextLayoutFollowFeature = 4   
};
 
typedef NS_ENUM(NSInteger, AGSLabelTextOrientation) {
    AGSLabelTextOrientationAutomatic = 0,  
    AGSLabelTextOrientationDirection = 1,  
    AGSLabelTextOrientationScreen = 2      
};
 
typedef NS_ENUM(NSInteger, AGSLabelStackAlignment) {
    AGSLabelStackAlignmentAutomatic = 0,   
    AGSLabelStackAlignmentDynamic = 1,     
    AGSLabelStackAlignmentTextSymbol = 2   
};
 
typedef NS_ENUM(NSInteger, AGSLabelStackBreakPosition) {
    AGSLabelStackBreakPositionAutomatic = 0,  
    AGSLabelStackBreakPositionAfter = 1,      
    AGSLabelStackBreakPositionBefore = 2      
};
 
typedef NS_ENUM(NSInteger, AGSLabelStackStrategy) {
    AGSLabelStackStrategyAutomatic = 0,  
    AGSLabelStackStrategyNone = 1,       
    AGSLabelStackStrategyAllow = 2       
};
 
@class AGSLabelExpression;
@class AGSLabelStackSeparator;
@class AGSTextSymbol;
@class AGSLabelAngle;
 
@interface AGSLabelDefinition : AGSObject <AGSJSONSerializable>
 
#pragma mark -
#pragma mark initializers
 
- (instancetype)initWithLabelExpression:(AGSLabelExpression *)labelExpression
                             textSymbol:(nullable AGSTextSymbol *)textSymbol;
 
+ (instancetype)labelDefinitionWithLabelExpression:(AGSLabelExpression *)labelExpression
                                        textSymbol:(nullable AGSTextSymbol *)textSymbol;
 
#pragma mark -
#pragma mark properties
 
@property (nullable, nonatomic, strong, readwrite) AGSLabelAngle *angle;
 
@property (nonatomic, assign, readwrite) AGSLabelDeconflictionStrategy deconflictionStrategy;
 
@property (nonatomic, strong, readwrite) AGSLabelExpression *expression;
 
@property (nonatomic, assign, readwrite) AGSLabelOverlapStrategy featureBoundaryOverlapStrategy;
 
@property (nonatomic, assign, readwrite) AGSLabelOverlapStrategy featureInteriorOverlapStrategy;
 
@property (nonatomic, assign, readwrite) AGSLabelOverlapStrategy labelOverlapStrategy;
 
@property (nonatomic, assign, readwrite) AGSLabelLineConnection lineConnection;
 
@property (nonatomic, assign, readwrite) double maxScale;
 
@property (nonatomic, assign, readwrite) double minScale;
 
@property (nonatomic, assign, readwrite) AGSLabelMultipartStrategy multipartStrategy;
 
@property (nonatomic, copy, readwrite) NSString *name;
 
@property (nonatomic, assign, readwrite) CGFloat offsetDistance;
 
@property (nonatomic, assign, readwrite) AGSLabelOverrunStrategy overrunStrategy;
 
@property (nonatomic, assign, readwrite) AGSLabelingPlacement placement;
 
@property (nonatomic, assign, readwrite) double priority;
 
@property (nonatomic, assign, readwrite) CGFloat removeDuplicatesDistance;
 
@property (nonatomic, assign, readwrite) AGSLabelRemoveDuplicatesStrategy removeDuplicatesStrategy;
 
@property (nonatomic, assign, readwrite) CGFloat repeatDistance;
 
@property (nonatomic, assign, readwrite) AGSLabelRepeatStrategy repeatStrategy;
 
@property (nonatomic, assign, readwrite) AGSLabelStackAlignment stackAlignment;
 
@property (nonatomic, assign, readwrite) double stackRowLength;
 
@property (nonatomic, copy, readwrite) NSArray<AGSLabelStackSeparator *> *stackSeparators;
 
@property (nonatomic, assign, readwrite) AGSLabelStackStrategy stackStrategy;
 
@property (nonatomic, assign, readwrite) AGSLabelTextLayout textLayout;
 
@property (nonatomic, assign, readwrite) AGSLabelTextOrientation textOrientation;
 
@property (nullable, nonatomic, strong, readwrite) AGSTextSymbol *textSymbol;
 
@property (nonatomic, assign, readwrite) BOOL useCodedValues;
 
@property (nonatomic, copy, readwrite) NSString *whereClause;
 
@property (nonatomic, assign, readwrite) AGSLabelStackBreakPosition stackBreakPosition;
 
@end
 
@interface AGSLabelDefinition (AGSDeprecated)
 
- (instancetype)init ;
 
+ (instancetype)labelDefinition ;
 
@end