Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a section about the symbol's extent buffer #9568

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a section about the symbol's extent buffer #9568

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b87661
Add a section about the symbol's extent buffer
JuhoErvasti Jan 17, 2025
f23e232
Address review
JuhoErvasti Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/user_manual/working_with_vector/img/extent_buffer.gif
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't get what we want to show here, in relation with the feature? Filling data-defined widget? I really much prefer the gif in the issue report showing the feature in play in the map canvas. Or it can just be an image from that gif when we have features showing their buffer but not the actual point and others showing both.
Also there are request for modifying/renaming that dialog (qgis/QGIS#60017, qgis/QGIS#60010) so IMHO the less we show it the less outdated we will look (description is often easier to adjust).

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/user_manual/working_with_vector/vector_properties.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1310,6 +1310,34 @@ symbol, following some rules:

.. _vector_labels_tab:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This row acts as a shortcut throughout the docs to the vector label section that starts just after and nothing should be in-between. Or it would reference a wrong section.


Extent buffer
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a dedicated shortcut

Suggested change
Extent buffer
.. _extent_buffer:
Extent buffer

.............

You may set an extent buffer for a symbol. This means that a buffer is applied to
the current map extent so that if a feature is outside of the actual map extent
but inside the buffered extent it will still be rendered. This is useful for example
with symbols which use the geometry generator where you would like to still see the
generated geometries even if the actual feature is outside of the map extent.

To edit the extent buffer you can utilize the :guilabel:`Extent buffer` panel.

#. Start by going to the top symbol level and select :guilabel:`Advanced`
menu in the bottom right of the dialog
#. Find :guilabel:`Extent buffer` option
#. In the new panel you can set the buffer distance

The buffer distance units can be changed. You can also control the distance value
by using the data defined override widget. For example you can change the value
based on the current map scale ``if(@map_scale > 50000, 5000, 0)``:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioning this is great as I also wondered what the DD button could be about before I read docs in implementation. But not sure it deserves a screncast.


.. only:: html

.. figure:: img/extent_buffer.gif
:align: center
:width: 50%

Setting the symbol's extent buffer according to data defined expression
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Show another type of example?


Labels Properties
=================

Expand Down
Loading