CartoType UWP API 8.12-19-g3f49c29ef
for development in C#, VB.NET and C++
Public Member Functions | List of all members
CartoType::NoticePosition Class Reference

Positions for notices like the legend or scale bar. More...

#include <CartoTypeWrapper.h>

Public Member Functions

 NoticePosition (NoticeAnchor aAnchor)
 Creates a NoticePosition from an anchor position.
 
 NoticePosition (NoticeAnchor aAnchor, double aWidth, String^ aWidthUnit)
 Creates a NoticePosition from an anchor position and a width. The width is ignored if the width unit is null or empty.
 
 NoticePosition (NoticeAnchor aAnchor, double aWidth, String^ aWidthUnit, double aXInset, String^ aXInsetUnit, double aYInset, String^ aYInsetUnit)
 Creates an NoticePosition from an anchor position, width and insets. More...
 

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.

Constructor & Destructor Documentation

◆ NoticePosition()

CartoType::NoticePosition::NoticePosition ( NoticeAnchor  aAnchor,
double  aWidth,
String^  aWidthUnit,
double  aXInset,
String^  aXInsetUnit,
double  aYInset,
String^  aYInsetUnit 
)

Creates an NoticePosition from an anchor position, width and insets.

If no unit is specified the corresponding value is ignored, and a default value is used. The default values are 3mm for insets (zero for central positions), and zero width, meaning that the width is determined by the content.


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