mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
fe74b300be
For the "Around point" and "Cartographic" placement modes, this adds a new optional setting for the maximum distance of the labels from the feature. It's used together with the existing distance setting to define a range of distances at which labels may be placed from their corresponding point features. This adds more flexibility to the placement for these layers, ultimately allowing for more labels to be placed in busy maps. When the layer is set to the "around point" mode, then label candidates which are closer to the point will always be prefered over those which are further away. When the layer is set to the "cartographic" mode, then the default behavior is also to prioritize closer labels. A new combo box allows users to control the priority, with an option for prefering position ordering. If this option is set, then candidates at the corresponding positions (eg top left) are preferred regardless of how far they are from the point, with the labelling falling back to alternate positions only when no labels can be placed up to the maximum label distance. Sponsored by Rubicon Concierge Real Estate Services
158 lines
5.0 KiB
Plaintext
158 lines
5.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/labeling/qgslabelpointsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsLabelPointSettings
|
|
{
|
|
%Docstring(signature="appended")
|
|
|
|
Contains settings related to how the label engine places and formats
|
|
labels for point features, or polygon features which are labeled in
|
|
the "around" or "over" centroid placement modes.
|
|
|
|
.. versionadded:: 3.38
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslabelpointsettings.h"
|
|
%End
|
|
public:
|
|
static const QMetaObject staticMetaObject;
|
|
|
|
public:
|
|
|
|
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
|
|
%Docstring
|
|
Updates the point settings to respect any data defined properties
|
|
set within the specified ``properties`` collection.
|
|
%End
|
|
|
|
Qgis::LabelQuadrantPosition quadrant() const;
|
|
%Docstring
|
|
Returns the quadrant in which to offset labels from the point.
|
|
|
|
.. seealso:: :py:func:`setQuadrant`
|
|
%End
|
|
|
|
void setQuadrant( Qgis::LabelQuadrantPosition quadrant );
|
|
%Docstring
|
|
Sets the ``quadrant`` in which to offset labels from the point.
|
|
|
|
.. seealso:: :py:func:`quadrant`
|
|
%End
|
|
|
|
QVector< Qgis::LabelPredefinedPointPosition > predefinedPositionOrder() const;
|
|
%Docstring
|
|
Returns the ordered list of predefined label positions for points.
|
|
|
|
Positions earlier in the list will be prioritized over later positions.
|
|
Only used when the placement is set to :py:class:`Qgis`.LabelPlacement.OrderedPositionsAroundPoint.
|
|
|
|
.. seealso:: :py:func:`setPredefinedPositionOrder`
|
|
%End
|
|
|
|
void setPredefinedPositionOrder( const QVector< Qgis::LabelPredefinedPointPosition > &order );
|
|
%Docstring
|
|
Sets the ordered list of predefined label positions for points.
|
|
|
|
Positions earlier in the list will be prioritized over later positions.
|
|
Only used when the placement is set to :py:class:`Qgis`.LabelPlacement.OrderedPositionsAroundPoint.
|
|
|
|
.. seealso:: :py:func:`predefinedPositionOrder`
|
|
%End
|
|
|
|
double maximumDistance() const;
|
|
%Docstring
|
|
Returns the maximum distance which labels are allowed to be from their corresponding points.
|
|
|
|
This setting works alongside the standard label offset distance properties to define a permissible
|
|
range of distances at which labels can be placed from their points.
|
|
|
|
The default value is 0, which indicates that no maximum is set and the label's usual distance
|
|
from point will always be respected.
|
|
|
|
.. seealso:: :py:func:`setMaximumDistance`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
|
|
%End
|
|
|
|
void setMaximumDistance( double distance );
|
|
%Docstring
|
|
Sets the maximum ``distance`` which labels are allowed to be from their corresponding points.
|
|
|
|
This setting works alongside the standard label offset distance properties to define a permissible
|
|
range of distances at which labels can be placed from their points.
|
|
|
|
Setting ``distance`` to 0 indicates that no maximum is set and the label's usual distance
|
|
from point will always be respected.
|
|
|
|
.. seealso:: :py:func:`maximumDistance`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
|
|
%End
|
|
|
|
Qgis::RenderUnit maximumDistanceUnit() const;
|
|
%Docstring
|
|
Returns the units for label maximum distance.
|
|
|
|
.. seealso:: :py:func:`setMaximumDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`maximumDistance`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
|
|
%End
|
|
|
|
void setMaximumDistanceUnit( Qgis::RenderUnit unit );
|
|
%Docstring
|
|
Sets the ``unit`` for label maximum distance.
|
|
|
|
.. seealso:: :py:func:`maximumDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`maximumDistance`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
|
|
%End
|
|
|
|
QgsMapUnitScale maximumDistanceMapUnitScale() const;
|
|
%Docstring
|
|
Returns the map unit scale for label maximum distance.
|
|
|
|
.. seealso:: :py:func:`setMaximumDistanceMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`maximumDistance`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceUnit`
|
|
%End
|
|
|
|
void setMaximumDistanceMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Sets the map unit ``scale`` for label maximum distance.
|
|
|
|
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`maximumDistance`
|
|
|
|
.. seealso:: :py:func:`maximumDistanceUnit`
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/labeling/qgslabelpointsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|