QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Types | List of all members
QgsLabeling Class Reference

Contains constants and enums relating to labeling. More...

#include <qgslabeling.h>

Public Types

enum  LinePlacementFlag : int { LinePlacementFlag::OnLine = 1, LinePlacementFlag::AboveLine = 2, LinePlacementFlag::BelowLine = 4, LinePlacementFlag::MapOrientation = 8 }
 Line placement flags, which control how candidates are generated for a linear feature. More...
 

Detailed Description

Contains constants and enums relating to labeling.

Since
QGIS 3.12

Definition at line 31 of file qgslabeling.h.

Member Enumeration Documentation

◆ LinePlacementFlag

enum QgsLabeling::LinePlacementFlag : int
strong

Line placement flags, which control how candidates are generated for a linear feature.

Enumerator
OnLine 

Labels can be placed directly over a line feature.

AboveLine 

Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed below the line feature.

BelowLine 

Labels can be placed below a line feature. Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed above the line feature.

MapOrientation 

Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather than the feature's orientation. For example, AboveLine will always result in label's being placed above a line, regardless of the line's direction.

Definition at line 38 of file qgslabeling.h.


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