CartoType iOS API 9.2-12-g6c2dcf66f
for development in Swift and Objective C for iOS and Mac OS
Instance Methods | List of all members
CtNoticePosition Class Reference

#import <CartoTypeBase.h>

Inheritance diagram for CtNoticePosition:

Instance Methods

(id) - init:
 
(id) - init:width:widthUnit:xInset:xUnit:yInset:yUnit:
 
(void *) - position
 

Detailed Description

Positions for notices like the legend or scale bar.

Notices are positioned by moving them inwards from the designated position by the specified insets. For central positions (e.g., the X inset in Top, or both insets in Center) X insets move the position right and Y insets move it down. Units may be 'cm', 'mm', 'in', 'pt' (points: 1/72in), or 'pc' (picas: 1/6in).

The default inset is 3mm, or zero for central positions.

Method Documentation

◆ init:

- (id) init: (CtNoticeAnchor aAnchor

Creates a notice position from an anchor position.

◆ init:width:widthUnit:xInset:xUnit:yInset:yUnit:

- (id) init: (CtNoticeAnchor aAnchor
width: (double)  aWidth
widthUnit: (NSString *)  aWidthUnit
xInset: (double)  aXInset
xUnit: (NSString *)  aXUnit
yInset: (double)  aYInset
yUnit: (NSString *)  aYUnit 

Creates a notice position from an achor position,width and X and Y insets. Any values with null or empty units are ignored, and default values are used.

◆ position

- (void *) position

Returns the native position object. For internal use only.


The documentation for this class was generated from the following file: