QGIS API Documentation
2.10.1-Pisa
|
#include <qgspallabeling.h>
Public Member Functions | |
QgsPalLayerSettings () | |
QgsPalLayerSettings (const QgsPalLayerSettings &s) | |
~QgsPalLayerSettings () | |
void | calculateLabelSize (const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f=0) |
bool | dataDefinedEvaluate (QgsPalLayerSettings::DataDefinedProperties p, QVariant &exprVal) const |
Get data defined property value from expression string or attribute field name. More... | |
bool | dataDefinedIsActive (QgsPalLayerSettings::DataDefinedProperties p) const |
Whether data definition is active. More... | |
QMap< QString, QString > | dataDefinedMap (QgsPalLayerSettings::DataDefinedProperties p) const |
Get property value as separate values split into Qmap. More... | |
QMap < QgsPalLayerSettings::DataDefinedProperties, QPair< QString, int > > | dataDefinedNames () const |
Map of data defined enum to names and old-style indecies The QPair contains a new string for layer property key, and a reference to old-style numeric key (< QGIS 2.0) More... | |
QgsDataDefined * | dataDefinedProperty (QgsPalLayerSettings::DataDefinedProperties p) |
Get a data defined property pointer. More... | |
bool | dataDefinedUseExpression (QgsPalLayerSettings::DataDefinedProperties p) const |
Whether data definition is set to use an expression. More... | |
QVariant | dataDefinedValue (QgsPalLayerSettings::DataDefinedProperties p, QgsFeature &f, const QgsFields &fields) const |
Get data defined property value from expression string or attribute field name. More... | |
QgsExpression * | getLabelExpression () |
Returns the QgsExpression for this label settings. More... | |
void | readFromLayer (QgsVectorLayer *layer) |
void | registerFeature (QgsFeature &f, const QgsRenderContext &context, QString dxfLayer) |
void | removeDataDefinedProperty (QgsPalLayerSettings::DataDefinedProperties p) |
Set a property to static instead data defined. More... | |
double | scaleToPixelContext (double size, const QgsRenderContext &c, SizeUnit unit, bool rasterfactor=false, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale()) const |
Calculates size (considering output size should be in pixel or map units, scale factors and optionally oversampling) More... | |
void | setDataDefinedProperty (QgsPalLayerSettings::DataDefinedProperties p, bool active, bool useExpr, const QString &expr, const QString &field) |
Set a property as data defined. More... | |
int | sizeToPixel (double size, const QgsRenderContext &c, SizeUnit unit, bool rasterfactor=false, const QgsMapUnitScale &mapUnitScale=QgsMapUnitScale()) const |
Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling) More... | |
QString | updateDataDefinedString (const QString &value) |
Convert old property value to new one as delimited values. More... | |
void | writeToLayer (QgsVectorLayer *layer) |
Static Public Member Functions | |
static QgsPalLayerSettings | fromLayer (QgsVectorLayer *layer) |
Definition at line 59 of file qgspallabeling.h.
Definition at line 164 of file qgspallabeling.h.
Enumerator | |
---|---|
SymbolLeftRight |
place direction symbols on left/right of label |
SymbolAbove |
place direction symbols on above label |
SymbolBelow |
place direction symbols on below label |
Definition at line 107 of file qgspallabeling.h.
Enumerator | |
---|---|
OnLine | |
AboveLine | |
BelowLine | |
MapOrientation |
Definition at line 79 of file qgspallabeling.h.
Enumerator | |
---|---|
MultiLeft | |
MultiCenter | |
MultiRight | |
MultiFollowPlacement |
Alignment follows placement of label, eg labels to the left of a feature will be drawn with right alignment |
Definition at line 114 of file qgspallabeling.h.
Enumerator | |
---|---|
AroundPoint | |
OverPoint | |
Line | |
Curved | |
Horizontal | |
Free |
Definition at line 69 of file qgspallabeling.h.
Enumerator | |
---|---|
QuadrantAboveLeft | |
QuadrantAbove | |
QuadrantAboveRight | |
QuadrantLeft | |
QuadrantOver | |
QuadrantRight | |
QuadrantBelowLeft | |
QuadrantBelow | |
QuadrantBelowRight |
Definition at line 87 of file qgspallabeling.h.
Enumerator | |
---|---|
RotationSync | |
RotationOffset | |
RotationFixed |
Definition at line 139 of file qgspallabeling.h.
Enumerator | |
---|---|
ShadowLowest | |
ShadowText | |
ShadowBuffer | |
ShadowShape |
Definition at line 155 of file qgspallabeling.h.
Enumerator | |
---|---|
ShapeRectangle | |
ShapeSquare | |
ShapeEllipse | |
ShapeCircle | |
ShapeSVG |
Definition at line 123 of file qgspallabeling.h.
Enumerator | |
---|---|
SizeBuffer | |
SizeFixed | |
SizePercent |
Definition at line 132 of file qgspallabeling.h.
Units used for option sizes, before being converted to rendered sizes.
Enumerator | |
---|---|
Points | |
MM | |
MapUnits | |
Percent |
Definition at line 147 of file qgspallabeling.h.
Definition at line 100 of file qgspallabeling.h.
QgsPalLayerSettings::QgsPalLayerSettings | ( | ) |
Definition at line 80 of file qgspallabeling.cpp.
QgsPalLayerSettings::QgsPalLayerSettings | ( | const QgsPalLayerSettings & | s | ) |
Definition at line 317 of file qgspallabeling.cpp.
QgsPalLayerSettings::~QgsPalLayerSettings | ( | ) |
Definition at line 465 of file qgspallabeling.cpp.
void QgsPalLayerSettings::calculateLabelSize | ( | const QFontMetricsF * | fm, |
QString | text, | ||
double & | labelX, | ||
double & | labelY, | ||
QgsFeature * | f = 0 |
||
) |
Definition at line 1248 of file qgspallabeling.cpp.
bool QgsPalLayerSettings::dataDefinedEvaluate | ( | QgsPalLayerSettings::DataDefinedProperties | p, |
QVariant & | exprVal | ||
) | const |
Get data defined property value from expression string or attribute field name.
Definition at line 1201 of file qgspallabeling.cpp.
bool QgsPalLayerSettings::dataDefinedIsActive | ( | QgsPalLayerSettings::DataDefinedProperties | p | ) | const |
Whether data definition is active.
Definition at line 1219 of file qgspallabeling.cpp.
QMap< QString, QString > QgsPalLayerSettings::dataDefinedMap | ( | QgsPalLayerSettings::DataDefinedProperties | p | ) | const |
Get property value as separate values split into Qmap.
Definition at line 1133 of file qgspallabeling.cpp.
|
inline |
Map of data defined enum to names and old-style indecies The QPair contains a new string for layer property key, and a reference to old-style numeric key (< QGIS 2.0)
Definition at line 507 of file qgspallabeling.h.
QgsDataDefined * QgsPalLayerSettings::dataDefinedProperty | ( | QgsPalLayerSettings::DataDefinedProperties | p | ) |
Get a data defined property pointer.
Definition at line 1123 of file qgspallabeling.cpp.
bool QgsPalLayerSettings::dataDefinedUseExpression | ( | QgsPalLayerSettings::DataDefinedProperties | p | ) | const |
Whether data definition is set to use an expression.
Definition at line 1231 of file qgspallabeling.cpp.
QVariant QgsPalLayerSettings::dataDefinedValue | ( | QgsPalLayerSettings::DataDefinedProperties | p, |
QgsFeature & | f, | ||
const QgsFields & | fields | ||
) | const |
Get data defined property value from expression string or attribute field name.
Definition at line 1144 of file qgspallabeling.cpp.
|
static |
Definition at line 478 of file qgspallabeling.cpp.
QgsExpression * QgsPalLayerSettings::getLabelExpression | ( | ) |
Returns the QgsExpression for this label settings.
Definition at line 486 of file qgspallabeling.cpp.
void QgsPalLayerSettings::readFromLayer | ( | QgsVectorLayer * | layer | ) |
Definition at line 703 of file qgspallabeling.cpp.
void QgsPalLayerSettings::registerFeature | ( | QgsFeature & | f, |
const QgsRenderContext & | context, | ||
QString | dxfLayer | ||
) |
Definition at line 1409 of file qgspallabeling.cpp.
void QgsPalLayerSettings::removeDataDefinedProperty | ( | QgsPalLayerSettings::DataDefinedProperties | p | ) |
Set a property to static instead data defined.
Definition at line 1096 of file qgspallabeling.cpp.
double QgsPalLayerSettings::scaleToPixelContext | ( | double | size, |
const QgsRenderContext & | c, | ||
SizeUnit | unit, | ||
bool | rasterfactor = false , |
||
const QgsMapUnitScale & | mapUnitScale = QgsMapUnitScale() |
||
) | const |
Calculates size (considering output size should be in pixel or map units, scale factors and optionally oversampling)
size | size to convert |
c | rendercontext |
unit | SizeUnit enum value of size |
rasterfactor | whether to consider oversampling |
mapUnitScale | a mapUnitScale clamper |
Definition at line 2997 of file qgspallabeling.cpp.
void QgsPalLayerSettings::setDataDefinedProperty | ( | QgsPalLayerSettings::DataDefinedProperties | p, |
bool | active, | ||
bool | useExpr, | ||
const QString & | expr, | ||
const QString & | field | ||
) |
Set a property as data defined.
Definition at line 1072 of file qgspallabeling.cpp.
int QgsPalLayerSettings::sizeToPixel | ( | double | size, |
const QgsRenderContext & | c, | ||
SizeUnit | unit, | ||
bool | rasterfactor = false , |
||
const QgsMapUnitScale & | mapUnitScale = QgsMapUnitScale() |
||
) | const |
Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling)
size | size to convert |
c | rendercontext |
unit | SizeUnit enum value of size |
rasterfactor | whether to consider oversampling |
mapUnitScale | a mapUnitScale clamper |
Definition at line 2992 of file qgspallabeling.cpp.
Convert old property value to new one as delimited values.
Definition at line 1106 of file qgspallabeling.cpp.
void QgsPalLayerSettings::writeToLayer | ( | QgsVectorLayer * | layer | ) |
Definition at line 922 of file qgspallabeling.cpp.
bool QgsPalLayerSettings::addDirectionSymbol |
Definition at line 302 of file qgspallabeling.h.
double QgsPalLayerSettings::angleOffset |
Definition at line 391 of file qgspallabeling.h.
QPainter::CompositionMode QgsPalLayerSettings::blendMode |
Definition at line 290 of file qgspallabeling.h.
QPainter::CompositionMode QgsPalLayerSettings::bufferBlendMode |
Definition at line 322 of file qgspallabeling.h.
QColor QgsPalLayerSettings::bufferColor |
Definition at line 318 of file qgspallabeling.h.
bool QgsPalLayerSettings::bufferDraw |
Definition at line 314 of file qgspallabeling.h.
Qt::PenJoinStyle QgsPalLayerSettings::bufferJoinStyle |
Definition at line 321 of file qgspallabeling.h.
bool QgsPalLayerSettings::bufferNoFill |
Definition at line 319 of file qgspallabeling.h.
double QgsPalLayerSettings::bufferSize |
Definition at line 315 of file qgspallabeling.h.
bool QgsPalLayerSettings::bufferSizeInMapUnits |
Definition at line 316 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::bufferSizeMapUnitScale |
Definition at line 317 of file qgspallabeling.h.
int QgsPalLayerSettings::bufferTransp |
Definition at line 320 of file qgspallabeling.h.
bool QgsPalLayerSettings::centroidInside |
Definition at line 374 of file qgspallabeling.h.
bool QgsPalLayerSettings::centroidWhole |
Definition at line 373 of file qgspallabeling.h.
const QgsCoordinateTransform* QgsPalLayerSettings::ct |
Definition at line 516 of file qgspallabeling.h.
QMap< QgsPalLayerSettings::DataDefinedProperties, QgsDataDefined* > QgsPalLayerSettings::dataDefinedProperties |
Map of current data defined properties.
Definition at line 480 of file qgspallabeling.h.
int QgsPalLayerSettings::decimals |
Definition at line 309 of file qgspallabeling.h.
bool QgsPalLayerSettings::displayAll |
Definition at line 409 of file qgspallabeling.h.
double QgsPalLayerSettings::dist |
Definition at line 375 of file qgspallabeling.h.
bool QgsPalLayerSettings::distInMapUnits |
Definition at line 376 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::distMapUnitScale |
Definition at line 377 of file qgspallabeling.h.
bool QgsPalLayerSettings::enabled |
Definition at line 270 of file qgspallabeling.h.
QgsGeometry* QgsPalLayerSettings::extentGeom |
Definition at line 519 of file qgspallabeling.h.
int QgsPalLayerSettings::fieldIndex |
Definition at line 514 of file qgspallabeling.h.
QString QgsPalLayerSettings::fieldName |
Definition at line 274 of file qgspallabeling.h.
bool QgsPalLayerSettings::fontLimitPixelSize |
Definition at line 405 of file qgspallabeling.h.
int QgsPalLayerSettings::fontMaxPixelSize |
Definition at line 407 of file qgspallabeling.h.
int QgsPalLayerSettings::fontMinPixelSize |
Definition at line 406 of file qgspallabeling.h.
bool QgsPalLayerSettings::fontSizeInMapUnits |
Definition at line 286 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::fontSizeMapUnitScale |
Definition at line 287 of file qgspallabeling.h.
bool QgsPalLayerSettings::formatNumbers |
Definition at line 308 of file qgspallabeling.h.
QList<QgsPalGeometry*> QgsPalLayerSettings::geometries |
Definition at line 518 of file qgspallabeling.h.
bool QgsPalLayerSettings::isExpression |
Is this label made from a expression string eg FieldName || 'mm'.
Definition at line 278 of file qgspallabeling.h.
bool QgsPalLayerSettings::labelOffsetInMapUnits |
Definition at line 389 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::labelOffsetMapUnitScale |
Definition at line 390 of file qgspallabeling.h.
bool QgsPalLayerSettings::labelPerPart |
Definition at line 412 of file qgspallabeling.h.
QString QgsPalLayerSettings::leftDirectionSymbol |
Definition at line 303 of file qgspallabeling.h.
bool QgsPalLayerSettings::limitNumLabels |
Definition at line 415 of file qgspallabeling.h.
double QgsPalLayerSettings::maxCurvedCharAngleIn |
Definition at line 394 of file qgspallabeling.h.
double QgsPalLayerSettings::maxCurvedCharAngleOut |
Definition at line 395 of file qgspallabeling.h.
int QgsPalLayerSettings::maxNumLabels |
Definition at line 416 of file qgspallabeling.h.
QgsFeature* QgsPalLayerSettings::mCurFeat |
Definition at line 512 of file qgspallabeling.h.
const QgsFields* QgsPalLayerSettings::mCurFields |
Definition at line 513 of file qgspallabeling.h.
bool QgsPalLayerSettings::mergeLines |
Definition at line 413 of file qgspallabeling.h.
int QgsPalLayerSettings::mFeatsRegPal |
Definition at line 522 of file qgspallabeling.h.
int QgsPalLayerSettings::mFeatsSendingToPal |
Definition at line 521 of file qgspallabeling.h.
int QgsPalLayerSettings::mFeaturesToLabel |
Definition at line 520 of file qgspallabeling.h.
double QgsPalLayerSettings::minFeatureSize |
Definition at line 418 of file qgspallabeling.h.
QString QgsPalLayerSettings::mTextFontFamily |
Definition at line 524 of file qgspallabeling.h.
bool QgsPalLayerSettings::mTextFontFound |
Definition at line 525 of file qgspallabeling.h.
MultiLineAlign QgsPalLayerSettings::multilineAlign |
Definition at line 297 of file qgspallabeling.h.
double QgsPalLayerSettings::multilineHeight |
Definition at line 296 of file qgspallabeling.h.
bool QgsPalLayerSettings::obstacle |
Definition at line 419 of file qgspallabeling.h.
pal::Layer* QgsPalLayerSettings::palLayer |
Definition at line 511 of file qgspallabeling.h.
DirectionSymbols QgsPalLayerSettings::placeDirectionSymbol |
Definition at line 305 of file qgspallabeling.h.
Placement QgsPalLayerSettings::placement |
Definition at line 370 of file qgspallabeling.h.
unsigned int QgsPalLayerSettings::placementFlags |
Definition at line 371 of file qgspallabeling.h.
bool QgsPalLayerSettings::plusSign |
Definition at line 310 of file qgspallabeling.h.
bool QgsPalLayerSettings::preserveRotation |
Definition at line 392 of file qgspallabeling.h.
QColor QgsPalLayerSettings::previewBkgrdColor |
Definition at line 291 of file qgspallabeling.h.
int QgsPalLayerSettings::priority |
Definition at line 397 of file qgspallabeling.h.
QgsPoint QgsPalLayerSettings::ptOne |
Definition at line 517 of file qgspallabeling.h.
QgsPoint QgsPalLayerSettings::ptZero |
Definition at line 517 of file qgspallabeling.h.
QuadrantPosition QgsPalLayerSettings::quadOffset |
Definition at line 385 of file qgspallabeling.h.
double QgsPalLayerSettings::rasterCompressFactor |
Definition at line 423 of file qgspallabeling.h.
double QgsPalLayerSettings::repeatDistance |
Definition at line 379 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::repeatDistanceMapUnitScale |
Definition at line 381 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::repeatDistanceUnit |
Definition at line 380 of file qgspallabeling.h.
bool QgsPalLayerSettings::reverseDirectionSymbol |
Definition at line 306 of file qgspallabeling.h.
QString QgsPalLayerSettings::rightDirectionSymbol |
Definition at line 304 of file qgspallabeling.h.
int QgsPalLayerSettings::scaleMax |
Definition at line 403 of file qgspallabeling.h.
int QgsPalLayerSettings::scaleMin |
Definition at line 402 of file qgspallabeling.h.
bool QgsPalLayerSettings::scaleVisibility |
Definition at line 401 of file qgspallabeling.h.
QPainter::CompositionMode QgsPalLayerSettings::shadowBlendMode |
Definition at line 366 of file qgspallabeling.h.
QColor QgsPalLayerSettings::shadowColor |
Definition at line 365 of file qgspallabeling.h.
bool QgsPalLayerSettings::shadowDraw |
Definition at line 352 of file qgspallabeling.h.
int QgsPalLayerSettings::shadowOffsetAngle |
Definition at line 354 of file qgspallabeling.h.
double QgsPalLayerSettings::shadowOffsetDist |
Definition at line 355 of file qgspallabeling.h.
bool QgsPalLayerSettings::shadowOffsetGlobal |
Definition at line 358 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::shadowOffsetMapUnitScale |
Definition at line 357 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::shadowOffsetUnits |
Definition at line 356 of file qgspallabeling.h.
double QgsPalLayerSettings::shadowRadius |
Definition at line 359 of file qgspallabeling.h.
bool QgsPalLayerSettings::shadowRadiusAlphaOnly |
Definition at line 362 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::shadowRadiusMapUnitScale |
Definition at line 361 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::shadowRadiusUnits |
Definition at line 360 of file qgspallabeling.h.
int QgsPalLayerSettings::shadowScale |
Definition at line 364 of file qgspallabeling.h.
int QgsPalLayerSettings::shadowTransparency |
Definition at line 363 of file qgspallabeling.h.
ShadowType QgsPalLayerSettings::shadowUnder |
Definition at line 353 of file qgspallabeling.h.
QPainter::CompositionMode QgsPalLayerSettings::shapeBlendMode |
Definition at line 342 of file qgspallabeling.h.
QColor QgsPalLayerSettings::shapeBorderColor |
Definition at line 344 of file qgspallabeling.h.
double QgsPalLayerSettings::shapeBorderWidth |
Definition at line 345 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::shapeBorderWidthMapUnitScale |
Definition at line 347 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::shapeBorderWidthUnits |
Definition at line 346 of file qgspallabeling.h.
bool QgsPalLayerSettings::shapeDraw |
Definition at line 326 of file qgspallabeling.h.
QColor QgsPalLayerSettings::shapeFillColor |
Definition at line 343 of file qgspallabeling.h.
Qt::PenJoinStyle QgsPalLayerSettings::shapeJoinStyle |
Definition at line 348 of file qgspallabeling.h.
QPointF QgsPalLayerSettings::shapeOffset |
Definition at line 335 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::shapeOffsetMapUnitScale |
Definition at line 337 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::shapeOffsetUnits |
Definition at line 336 of file qgspallabeling.h.
QPointF QgsPalLayerSettings::shapeRadii |
Definition at line 338 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::shapeRadiiMapUnitScale |
Definition at line 340 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::shapeRadiiUnits |
Definition at line 339 of file qgspallabeling.h.
double QgsPalLayerSettings::shapeRotation |
Definition at line 334 of file qgspallabeling.h.
RotationType QgsPalLayerSettings::shapeRotationType |
Definition at line 333 of file qgspallabeling.h.
QPointF QgsPalLayerSettings::shapeSize |
Definition at line 330 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::shapeSizeMapUnitScale |
Definition at line 332 of file qgspallabeling.h.
SizeType QgsPalLayerSettings::shapeSizeType |
Definition at line 329 of file qgspallabeling.h.
SizeUnit QgsPalLayerSettings::shapeSizeUnits |
Definition at line 331 of file qgspallabeling.h.
QString QgsPalLayerSettings::shapeSVGFile |
Definition at line 328 of file qgspallabeling.h.
int QgsPalLayerSettings::shapeTransparency |
Definition at line 341 of file qgspallabeling.h.
ShapeType QgsPalLayerSettings::shapeType |
Definition at line 327 of file qgspallabeling.h.
bool QgsPalLayerSettings::showingShadowRects |
Definition at line 527 of file qgspallabeling.h.
QColor QgsPalLayerSettings::textColor |
Definition at line 288 of file qgspallabeling.h.
QFont QgsPalLayerSettings::textFont |
Definition at line 284 of file qgspallabeling.h.
QString QgsPalLayerSettings::textNamedStyle |
Definition at line 285 of file qgspallabeling.h.
int QgsPalLayerSettings::textTransp |
Definition at line 289 of file qgspallabeling.h.
unsigned int QgsPalLayerSettings::upsidedownLabels |
Definition at line 410 of file qgspallabeling.h.
double QgsPalLayerSettings::vectorScaleFactor |
Definition at line 422 of file qgspallabeling.h.
QString QgsPalLayerSettings::wrapChar |
Definition at line 295 of file qgspallabeling.h.
const QgsMapToPixel* QgsPalLayerSettings::xform |
Definition at line 515 of file qgspallabeling.h.
double QgsPalLayerSettings::xOffset |
Definition at line 387 of file qgspallabeling.h.
double QgsPalLayerSettings::yOffset |
Definition at line 388 of file qgspallabeling.h.