CartoTypeLegend.h

Go to the documentation of this file.

/*
CartoTypeLegend.h
Copyright 2015-2024 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#ifndef CartoTypeLegend_h__
#define CartoTypeLegend_h__
 
#import <CartoType/CartoTypeBase.h>


typedef NS_OPTIONS(uint32_t,CtLegendStyle)
    {
    CtLegendStyleFlagTitle = 1,
    CtLegendStyleFlagScaleInTitle = 2,
    CtLegendStyleFlagMapObjects = 4,
    CtLegendStyleFlagScaleBar = 8,
    CtLegendStyleStandard = CtLegendStyleFlagTitle | CtLegendStyleFlagScaleInTitle | CtLegendStyleFlagMapObjects | CtLegendStyleFlagScaleBar,
    CtLegendStyleTurn = 16,
    CtLegendStyleScale = 32,
    CtLegendStyleEmpty = 0
    };

typedef CtLegendStyle CartoTypeLegendStyle;
 
@class CtFramework; // forward declaration

@interface CtLegend: NSObject

-(id)initWithFramework:(CtFramework*)aFramework;

-(id)initWithFramework:(CtFramework*)aFramework style:(CtLegendStyle)aStyle;

-(void)dealloc;

-(void)clear;

-(void)addMapObjectLine:(CtMapObjectType)aType layer:(NSString*)aLayer freatureInfo:(CtFeatureInfo*)aFeatureInfo stringAttrib:(NSString*)aStringAttrib label:(NSString*)aLabel;

-(void)addTextLine:(NSString*)aText;

-(void)addScaleLine;

-(void)setMainStyleSheet:(NSString*)aData;

-(void)setExtraStyleSheet:(NSString*)aData;

-(void)setBackgroundColor:(CtColor)aColor;

-(void)setBorderColor:(CtColor)aColor strokeWidth:(double)aStrokeWidth radius:(double)aRadius unit:(NSString*)aUnit;

-(void)setMarginWidth:(double)aMarginWidth unit:(NSString*)aUnit;

-(void)setMinLineHeight:(double)aLineHeight unit:(NSString*)aUnit;

-(void)setLabelWrapWidth:(double)aWrapWidth unit:(NSString*)aUnit;

-(void)setFontFamily:(NSString*)aFontFamily;

-(void)setFontStyle:(uint32_t)aStyle;

-(void)setFontSize:(double)aFontSize unit:(NSString*)aUnit;

-(void)setTextColor:(CtColor)aTextColor;

-(void)setDiagramColor:(CtColor)aDiagramColor;

-(void)setAlignment:(CtAlign)aAlignment;

-(void)setPolygonRotation:(double)aDegrees;

-(bool)hasTurnInstruction;

-(void)setTurnInstruction:(NSString*)aText;

-(NSString*)turnInstruction;

-(void*)legend;
 
@end
@compatibility_alias CartoTypeLegend CtLegend;
 
#endif