From f973c0aa06b5d14b1abedefbcb0551442357e3a3 Mon Sep 17 00:00:00 2001 From: Harrissou Sant-anna Date: Mon, 30 Dec 2024 21:35:44 +0100 Subject: [PATCH 1/2] Format the callout properties description as table instead of list items --- .../style_library/label_settings.rst | 130 ++++++++++-------- 1 file changed, 70 insertions(+), 60 deletions(-) diff --git a/docs/user_manual/style_library/label_settings.rst b/docs/user_manual/style_library/label_settings.rst index 6947ad1db31..71f20d16ccf 100644 --- a/docs/user_manual/style_library/label_settings.rst +++ b/docs/user_manual/style_library/label_settings.rst @@ -541,66 +541,76 @@ tab and activate the |checkbox| :guilabel:`Draw callouts`. Then you can: * :guilabel:`Balloons`: a speech bubble surrounding the label and pointing to the feature. It can have rounded corners. -#. For a line-based callout: - - #. Select the :guilabel:`Line style` with full capabilities of a :ref:`line - symbol ` including layer effects, and data-defined - settings - #. If curved, you also define: - - * the percentage of :guilabel:`Curvature` of the connection line - * and its :guilabel:`Orientation`: starting from the label to the feature, - it can be :guilabel:`Clockwise` or :guilabel:`Counter-clockwise`, or - :guilabel:`Automatic` (determining an optimal orientation for each label) - #. Set the :guilabel:`Minimum length` of callout lines - #. Check whether to |checkbox| :guilabel:`Draw lines to all feature parts` - from the feature's label - #. Set the :guilabel:`Label anchor point`: controls where the connector - line should join to the label text. Available options: - - * :guilabel:`Closest point` - * :guilabel:`Centroid` - * Fixed position at the edge (:guilabel:`Top left`, :guilabel:`Top center`, - :guilabel:`Top right`, :guilabel:`Left middle`, :guilabel:`Right middle`, - :guilabel:`Bottom left`, :guilabel:`Bottom center` and :guilabel:`Bottom right`). - #. Set the :guilabel:`Offset from label area` option: controls the distance - from the label anchor point (where the callout line ends). - This avoids drawing lines right up against the text. - -#. For a balloon callout, you'd need to set: - - * the :guilabel:`Fill style` with full capabilities of a :ref:`fill - symbol ` including layer effects, and data-defined - settings - * the :guilabel:`Corner radius` of the speech bubble - * the :guilabel:`Wedge width`: how large the bubble speech connection with - feature's pointer should be - * the :guilabel:`Margins` around the label's text - -#. Set the :guilabel:`Offset from feature` option: controls the distance - from the feature (or its anchor point if a polygon) where callout lines end. - Eg, this avoids drawing lines right up against the edges of the features. -#. Set the :guilabel:`Feature anchor point` for the (polygon) feature (the end - point of the connector line). Available options: - - * :guilabel:`Pole of inaccessibility` - * :guilabel:`Point on exterior` - * :guilabel:`Point on surface` - * :guilabel:`Centroid` -#. Set the :guilabel:`Blend mode`: controls the :ref:`blending ` - of the callout. - -Under the :guilabel:`Data defined placement` group, coordinates of the -:guilabel:`Origin` (on the label side) and/or :guilabel:`Destination` -(on the feature side) points of the callout can be controlled. -Callouts can also be controlled manually by using the |moveLabel| -:sup:`Move Label, Diagram or Callout` tool in the :ref:`Labeling Toolbar -`. -The start and end points of each callout can be moved this way. -The nodes should be highlighted when the mouse pointer is nearby. -If needed the :kbd:`Shift` Key can be held during the movement. -This will snap the point in a way that the angle between the two callout points -increments by 15 degrees. +#. Set the properties of the callout. + The following table shows the different properties, with description + and compatible connector style. + + .. table:: Label callout properties + :widths: auto + + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | Property | Style of callout | Description | + +================================================+===================+=======================================================================================+ + | :guilabel:`Fill style` | Balloons | A :ref:`fill symbol ` with full display capabilities, | + | | | including layer effects, data-defined settings, ... for drawing the balloon shape. | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Corner radius` | | Corner radius of the speech bubble | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Wedge width` | | Sets how large the bubble speech connection with feature's pointer should be | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Margins` | | Margins around the label's text, in the unit of your choice | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | :guilabel:`Line style` | All but balloons | A :ref:`line symbol ` with full display capabilities, including | + | | | layer effects, data-defined settings, ... for drawing the connector line. | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | :guilabel:`Curvature` | Curved lines | The percentage of curvature of the connection line | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Orientation` | | Orientation, starting from the label to the feature. | + | | | It can be :guilabel:`Clockwise`, :guilabel:`Counter-clockwise`, | + | | | or :guilabel:`Automatic` (determining an optimal orientation for each label). | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | :guilabel:`Minimum length` | All but balloons | Minimum length of the connector line | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Draw lines to all feature parts` | | In case of a multi-part feature, indicates whether a connector line | + | | | should be drawn from the label to each geometry part. | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Label anchor point` | | Controls where the connector line should join to the label text. | + | | | Available options: | + | | | | + | | | * :guilabel:`Closest point` | + | | | * :guilabel:`Centroid` | + | | | * Fixed position at the edge (:guilabel:`Top left`, :guilabel:`Top center`, | + | | | :guilabel:`Top right`, :guilabel:`Left middle`, :guilabel:`Right middle`, | + | | | :guilabel:`Bottom left`, :guilabel:`Bottom center` and :guilabel:`Bottom right`). | + | | | | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Offset from label area` | | Controls the distance from the label anchor point (where the callout line ends). | + | | | This avoids drawing lines right up against the text. | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | :guilabel:`Offset from feature` | All | Controls the distance from the feature (or its anchor point if a polygon) | + | | | where callout lines end. | + | | | E.g., this avoids drawing lines right up against the edges of the features. | + +------------------------------------------------+ +---------------------------------------------------------------------------------------+ + | :guilabel:`Feature anchor point` | | Where the connector line ends on the (polygon) feature. Available options: | + | | | | + | | | * :guilabel:`Pole of inaccessibility` | + | | | * :guilabel:`Point on exterior` | + | | | * :guilabel:`Point on surface` | + | | | * :guilabel:`Centroid` | + | | | | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | :guilabel:`Blend mode` | All | Controls the :ref:`blending ` of the callout. | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + + + Under the :guilabel:`Data defined placement` group, coordinates of the :guilabel:`Origin` (on the label side) + and/or :guilabel:`Destination` (on the feature side) points of the callout can be controlled. + Callouts can also be controlled manually by using the |moveLabel| + :sup:`Move Label, Diagram or Callout` tool in the :ref:`Labeling Toolbar `. + The start and end points of each callout can be moved this way. + The nodes should be highlighted when the mouse pointer is nearby. + If needed the :kbd:`Shift` Key can be held during the movement. + This will snap the point in a way that the angle between the two callout points increments by 15 degrees. .. _labels_placement: From 9cd69344803e6ef5ce31162c6d0b0e4c2fdce28e Mon Sep 17 00:00:00 2001 From: Harrissou Sant-anna Date: Mon, 30 Dec 2024 21:37:25 +0100 Subject: [PATCH 2/2] Add end point marker property for callout Fixes #9201 --- docs/user_manual/style_library/label_settings.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user_manual/style_library/label_settings.rst b/docs/user_manual/style_library/label_settings.rst index 71f20d16ccf..95b7404239c 100644 --- a/docs/user_manual/style_library/label_settings.rst +++ b/docs/user_manual/style_library/label_settings.rst @@ -599,6 +599,10 @@ tab and activate the |checkbox| :guilabel:`Draw callouts`. Then you can: | | | * :guilabel:`Centroid` | | | | | +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ + | :guilabel:`End point marker` | Balloons | A :ref:`marker symbol ` with full display capabilities | + | | | including layer effects, data-defined, ... for rendering a marker symbol below | + | | | the endpoint of the balloon callout. | + +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+ | :guilabel:`Blend mode` | All | Controls the :ref:`blending ` of the callout. | +------------------------------------------------+-------------------+---------------------------------------------------------------------------------------+