mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
303 lines
8.1 KiB
Plaintext
303 lines
8.1 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/labeling/qgslabelthinningsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsLabelThinningSettings
|
|
{
|
|
%Docstring(signature="appended")
|
|
Contains settings related to how the label engine removes candidate
|
|
label positions and reduces the number of displayed labels.
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslabelthinningsettings.h"
|
|
%End
|
|
public:
|
|
|
|
bool limitNumberOfLabelsEnabled() const;
|
|
%Docstring
|
|
Returns ``True`` if the number of labels drawn for the layer should be
|
|
limited.
|
|
|
|
.. seealso:: :py:func:`maximumNumberLabels`
|
|
|
|
.. seealso:: :py:func:`setLimitNumberLabelsEnabled`
|
|
%End
|
|
|
|
void setLimitNumberLabelsEnabled( bool enabled );
|
|
%Docstring
|
|
Sets whether the the number of labels drawn for the layer should be
|
|
limited.
|
|
|
|
.. seealso:: :py:func:`setMaximumNumberLabels`
|
|
|
|
.. seealso:: :py:func:`limitNumberOfLabelsEnabled`
|
|
%End
|
|
|
|
int maximumNumberLabels() const;
|
|
%Docstring
|
|
Returns the maximum number of labels which should be drawn for this
|
|
layer. This only has an effect if
|
|
:py:func:`~QgsLabelThinningSettings.limitNumberOfLabelsEnabled` is
|
|
``True``.
|
|
|
|
.. seealso:: :py:func:`limitNumberOfLabelsEnabled`
|
|
|
|
.. seealso:: :py:func:`setMaximumNumberLabels`
|
|
%End
|
|
|
|
void setMaximumNumberLabels( int number );
|
|
%Docstring
|
|
Sets the maximum ``number`` of labels which should be drawn for this
|
|
layer. This only has an effect if
|
|
:py:func:`~QgsLabelThinningSettings.limitNumberOfLabelsEnabled` is
|
|
``True``.
|
|
|
|
.. seealso:: :py:func:`setLimitNumberLabelsEnabled`
|
|
|
|
.. seealso:: :py:func:`maximumNumberLabels`
|
|
%End
|
|
|
|
double minimumFeatureSize() const;
|
|
%Docstring
|
|
Returns the minimum feature size (in millimeters) for a feature to be
|
|
labelled.
|
|
|
|
.. seealso:: :py:func:`setMinimumFeatureSize`
|
|
%End
|
|
|
|
void setMinimumFeatureSize( double size );
|
|
%Docstring
|
|
Sets the minimum feature ``size`` (in millimeters) for a feature to be
|
|
labelled.
|
|
|
|
.. seealso:: :py:func:`minimumFeatureSize`
|
|
%End
|
|
|
|
double labelMarginDistance() const;
|
|
%Docstring
|
|
Returns the minimum distance to other labels (i.e. the minimum
|
|
space/margin around labels).
|
|
|
|
Units are specified through
|
|
:py:func:`~QgsLabelThinningSettings.labelMarginDistanceUnit`.
|
|
|
|
.. seealso:: :py:func:`setLabelMarginDistance`
|
|
|
|
.. seealso:: :py:func:`labelMarginDistanceUnit`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setLabelMarginDistance( double distance );
|
|
%Docstring
|
|
Sets the minimum ``distance`` to other labels (i.e. the minimum
|
|
space/margin around labels).
|
|
|
|
Units are specified through
|
|
:py:func:`~QgsLabelThinningSettings.setLabelMarginDistanceUnit`.
|
|
|
|
.. seealso:: :py:func:`labelMarginDistance`
|
|
|
|
.. seealso:: :py:func:`setLabelMarginDistanceUnit`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setLabelMarginDistanceUnit( Qgis::RenderUnit unit );
|
|
%Docstring
|
|
Sets the ``unit`` for the minimum distance to other labels.
|
|
|
|
.. seealso:: :py:func:`labelMarginDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`setLabelMarginDistance`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
Qgis::RenderUnit labelMarginDistanceUnit() const;
|
|
%Docstring
|
|
Returns the units for the minimum distance to other labels.
|
|
|
|
.. seealso:: :py:func:`setLabelMarginDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`labelMarginDistance`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setLabelMarginDistanceMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Sets the map unit ``scale`` for the minimum distance to other labels.
|
|
|
|
.. seealso:: :py:func:`labelMarginDistanceMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`labelMarginDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`setLabelMarginDistance`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
const QgsMapUnitScale &labelMarginDistanceMapUnitScale() const;
|
|
%Docstring
|
|
Returns the map unit scale for the minimum distance to other labels.
|
|
|
|
.. seealso:: :py:func:`setLabelMarginDistanceMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`labelMarginDistanceUnit`
|
|
|
|
.. seealso:: :py:func:`labelMarginDistance`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
|
|
double minimumDistanceToDuplicate() const;
|
|
%Docstring
|
|
Returns the minimum distance to labels with duplicate text.
|
|
|
|
Units are specified through
|
|
:py:func:`~QgsLabelThinningSettings.minimumDistanceToDuplicateUnit`.
|
|
|
|
.. note::
|
|
|
|
This setting is only respected if :py:func:`~QgsLabelThinningSettings.allowDuplicateRemoval` is ``True``.
|
|
|
|
.. seealso:: :py:func:`setMinimumDistanceToDuplicate`
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicateUnit`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setMinimumDistanceToDuplicate( double distance );
|
|
%Docstring
|
|
Sets the minimum ``distance`` to labels with duplicate text.
|
|
|
|
Units are specified through
|
|
:py:func:`~QgsLabelThinningSettings.setMinimumDistanceToDuplicateUnit`.
|
|
|
|
.. note::
|
|
|
|
This setting is only respected if :py:func:`~QgsLabelThinningSettings.allowDuplicateRemoval` is ``True``.
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicate`
|
|
|
|
.. seealso:: :py:func:`setMinimumDistanceToDuplicateUnit`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setMinimumDistanceToDuplicateUnit( Qgis::RenderUnit unit );
|
|
%Docstring
|
|
Sets the ``unit`` for the minimum distance to labels with duplicate
|
|
text.
|
|
|
|
.. note::
|
|
|
|
This setting is only respected if :py:func:`~QgsLabelThinningSettings.allowDuplicateRemoval` is ``True``.
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicateUnit`
|
|
|
|
.. seealso:: :py:func:`setMinimumDistanceToDuplicate`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
Qgis::RenderUnit minimumDistanceToDuplicateUnit() const;
|
|
%Docstring
|
|
Returns the units for the minimum distance to labels with duplicate
|
|
text.
|
|
|
|
.. note::
|
|
|
|
This setting is only respected if :py:func:`~QgsLabelThinningSettings.allowDuplicateRemoval` is ``True``.
|
|
|
|
.. seealso:: :py:func:`setMinimumDistanceToDuplicateUnit`
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicate`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setMinimumDistanceToDuplicateMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Sets the map unit ``scale`` for the minimum distance to labels with
|
|
duplicate text.
|
|
|
|
.. note::
|
|
|
|
This setting is only respected if :py:func:`~QgsLabelThinningSettings.allowDuplicateRemoval` is ``True``.
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicateMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicateUnit`
|
|
|
|
.. seealso:: :py:func:`setMinimumDistanceToDuplicate`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
const QgsMapUnitScale &minimumDistanceToDuplicateMapUnitScale() const;
|
|
%Docstring
|
|
Returns the map unit scale for the minimum distance to labels with
|
|
duplicate text.
|
|
|
|
.. note::
|
|
|
|
This setting is only respected if :py:func:`~QgsLabelThinningSettings.allowDuplicateRemoval` is ``True``.
|
|
|
|
.. seealso:: :py:func:`setMinimumDistanceToDuplicateMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicateUnit`
|
|
|
|
.. seealso:: :py:func:`minimumDistanceToDuplicate`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
bool allowDuplicateRemoval() const;
|
|
%Docstring
|
|
Returns whether duplicate label removal is permitted for this layer.
|
|
|
|
.. seealso:: :py:func:`setAllowDuplicateRemoval`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void setAllowDuplicateRemoval( bool allow );
|
|
%Docstring
|
|
Sets whether duplicate label removal is permitted for this layer.
|
|
|
|
.. seealso:: :py:func:`setAllowDuplicateRemoval`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
|
|
%Docstring
|
|
Updates the thinning settings to respect any data defined properties set
|
|
within the specified ``properties`` collection.
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/labeling/qgslabelthinningsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|