Skip to content

Commit

Permalink
Custom properties added to the Information tab - "working with..." ch…
Browse files Browse the repository at this point in the history
…apters (#9078)
  • Loading branch information
DelazJ authored Jul 19, 2024
2 parents af3759f + 1de1a82 commit 5ace25e
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/user_manual/working_with_3d_tiles/3d_tiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ Provided information are:

* based on the provider of the layer: name, URL, source type and path, number
of zoom levels
* custom properties, used to store in the active project additional information about the layer.
More properties can be created and managed using PyQGIS, specifically through
the :pyqgis:`setCustomProperty() <qgis.core.QgsMapLayer.setCustomProperty>` method.
* the Coordinate Reference System: name, units, method, accuracy, reference
(i.e. whether it's static or dynamic)
* picked from the :ref:`filled metadata <3dtilesmetadatamenu>`: access,
Expand Down
4 changes: 4 additions & 0 deletions docs/user_manual/working_with_mesh/mesh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,17 @@ Provided information are:

* general such as name in the project, source path, list of auxiliary files,
last save time and size, the used provider
* custom properties, used to store in the active project additional information about the layer.
More properties can be created and managed using PyQGIS, specifically through
the :pyqgis:`setCustomProperty() <qgis.core.QgsMapLayer.setCustomProperty>` method.
* based on the provider of the layer: extent, vertex, face, edges
and/or dataset groups count
* the Coordinate Reference System: name, units, method, accuracy, reference
(i.e. whether it's static or dynamic)
* extracted from filled :ref:`metadata <meshmetadata>`: access, extents,
links, contacts, history...

.. Change screenshot to show Custom properties
.. _meshsource:

Expand Down
4 changes: 4 additions & 0 deletions docs/user_manual/working_with_point_clouds/point_clouds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ the current layer. Provided information are:

* General such as name in the project, source path, last save time and size,
the used provider
* custom properties, used to store in the active project additional information about the layer.
More properties can be created and managed using PyQGIS, specifically through
the :pyqgis:`setCustomProperty() <qgis.core.QgsMapLayer.setCustomProperty>` method.
* Based on the provider of the layer: extent and number of points
* The Coordinate Reference System: name, units, method, accuracy, reference
(i.e. whether it's static or dynamic)
Expand All @@ -119,6 +122,7 @@ the current layer. Provided information are:

Point cloud information tab

.. Change screenshot to show Custom properties
.. _point_clouds_source:

Expand Down
18 changes: 15 additions & 3 deletions docs/user_manual/working_with_raster/raster_properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ Provided information are:

* general such as name in the project, source path, list of auxiliary files,
last save time and size, the used provider
* custom properties, used to store in the active project additional information about the layer.
Default custom properties include :guilabel:`Identify/format`, which influences how the results from using
the |identify| :ref:`Identify features <raster_identify>` tool over a raster layer are formatted.
More properties can be created and managed using PyQGIS, specifically through
the :pyqgis:`setCustomProperty() <qgis.core.QgsMapLayer.setCustomProperty>` method.
* based on the provider of the layer: extent, width and height, data type,
GDAL driver, bands statistics
* the Coordinate Reference System: name, units, method, accuracy, reference
Expand Down Expand Up @@ -1035,8 +1040,15 @@ To use the |identify|:guilabel:`Identify features` tool:

The Identify Results panel will open in its default ``Tree`` view
and display information about the clicked point.
Below the name of the raster layer, you have on the left the band(s) of the clicked pixel,
and on the right their respective value.
Formatting of the results vary depending on the provider of the layer. For example:

* For a local raster layer: below the name of the layer,
you have on the left the band(s) of the clicked pixel,
and on the right their respective value.
* For a remote layer such as WMS, a :guilabel:`Format` menu allows you to select
whether the information should be displayed as :guilabel:`HTML`, :guilabel:`Feature`
or :guilabel:`Text`.

These values can also be rendered (from the :guilabel:`View` menu located at the bottom of the panel) in:

* a ``Table`` view - organizes the information about the identified features
Expand All @@ -1048,7 +1060,7 @@ Under the pixel attributes, you will find the :guilabel:`Derived` information,
such as:

* ``X`` and ``Y`` coordinate values of the point clicked
* Column and row of the point clicked (pixel)
* Column and row of the point clicked (pixel) when compatible


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
Expand Down
6 changes: 6 additions & 0 deletions docs/user_manual/working_with_vector/vector_properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ Provided information are:

* general such as name in the project, source path, list of auxiliary files,
last save time and size, the used provider
* custom properties, used to store in the active project additional information about the layer.
Default custom properties may include :ref:`layer notes <layer_notes>`,
:ref:`legend widgets <vectorlegendmenu>`, :ref:`layer variables <general_tools_variables>`,
:ref:`form properties <vector_attributes_menu>`...
More custom properties can be created and managed using PyQGIS,
specifically through the :pyqgis:`setCustomProperty() <qgis.core.QgsMapLayer.setCustomProperty>` method.
* based on the provider of the layer: format of storage, geometry type,
data source encoding, extent, feature count...
* the Coordinate Reference System: name, units, method, accuracy, reference
Expand Down
3 changes: 3 additions & 0 deletions docs/user_manual/working_with_vector_tiles/vector_tiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ Provided information are:

* based on the provider of the layer: name, URI, source type and path, number
of zoom levels
* custom properties, used to store in the active project additional information about the layer.
More properties can be created and managed using PyQGIS, specifically through
the :pyqgis:`setCustomProperty() <qgis.core.QgsMapLayer.setCustomProperty>` method.
* the Coordinate Reference System: name, units, method, accuracy, reference
(i.e. whether it's static or dynamic)
* picked from the :ref:`filled metadata <vectortilesmetadatamenu>`: access,
Expand Down

0 comments on commit 5ace25e

Please sign in to comment.