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.

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

[Backport 2.8] Improve documentation on snapping #10817

Merged
merged 1 commit into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions doc/administrator/editing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ Enable snapping
To be able to snap while editing, the ``snappingConfig`` must be set on the layer metadata.
The value is a ``json`` object containing the following optional properties:

* activated (boolean): whether snapping is activated by default (default: true);
* edge (boolean): whether to allow snapping on edges or not;
* vertex (boolean): whether to allow snapping on vertices or not;
* tolerance (number): the pixel tolerance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -682,9 +682,9 @@ vars:
- name: snappingConfig
type: json
description: >
The snapping configuration for the layer. If set, the layer is considered to be
"snappable", even if the config itself is empty. Example value: {"tolerance": 50, "edge":
false}.
The snapping configuration for the layer. If set, even if empty, the layer is considered to be
"snappable" and snapping is activated by default. To disable snapping by default, set "activated"
to false. Example value: {"tolerance": 50, "edge": false}.
relevant_for:
- layer_wms
- name: geometryValidation
Expand Down
Loading