From fb35d6c38f6b4adcdd6abc7dc2327fa3fb518a88 Mon Sep 17 00:00:00 2001 From: selmaVH1 Date: Fri, 3 May 2024 14:59:23 +0200 Subject: [PATCH 1/4] Custom prop added to the Information tab - working with.. chapters --- docs/user_manual/working_with_3d_tiles/3d_tiles.rst | 2 ++ docs/user_manual/working_with_mesh/mesh.rst | 3 +++ docs/user_manual/working_with_point_clouds/point_clouds.rst | 3 +++ docs/user_manual/working_with_raster/raster_properties.rst | 2 ++ docs/user_manual/working_with_vector/vector_properties.rst | 2 ++ docs/user_manual/working_with_vector_tiles/vector_tiles.rst | 2 ++ 6 files changed, 14 insertions(+) diff --git a/docs/user_manual/working_with_3d_tiles/3d_tiles.rst b/docs/user_manual/working_with_3d_tiles/3d_tiles.rst index c8cab61a651..ba26b9ca943 100644 --- a/docs/user_manual/working_with_3d_tiles/3d_tiles.rst +++ b/docs/user_manual/working_with_3d_tiles/3d_tiles.rst @@ -98,6 +98,8 @@ 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 additional information about certain objects, such as map layers. + These properties are created and managed using PyQGIS, specifically through the `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, diff --git a/docs/user_manual/working_with_mesh/mesh.rst b/docs/user_manual/working_with_mesh/mesh.rst index 23786bcfdd0..5e51fe21271 100644 --- a/docs/user_manual/working_with_mesh/mesh.rst +++ b/docs/user_manual/working_with_mesh/mesh.rst @@ -165,6 +165,8 @@ 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 additional information about certain objects, such as map layers. + These properties are created and managed using PyQGIS, specifically through the `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 @@ -172,6 +174,7 @@ Provided information are: * extracted from filled :ref:`metadata `: access, extents, links, contacts, history... +.. Change screenshot to show Custom properties .. _meshsource: diff --git a/docs/user_manual/working_with_point_clouds/point_clouds.rst b/docs/user_manual/working_with_point_clouds/point_clouds.rst index 7f8e5ae3234..f6fc2939555 100755 --- a/docs/user_manual/working_with_point_clouds/point_clouds.rst +++ b/docs/user_manual/working_with_point_clouds/point_clouds.rst @@ -104,6 +104,8 @@ 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 additional information about certain objects, such as map layers. + These properties are created and managed using PyQGIS, specifically through the `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) @@ -119,6 +121,7 @@ the current layer. Provided information are: Point cloud information tab +.. Change screenshot to show Custom properties .. _point_clouds_source: diff --git a/docs/user_manual/working_with_raster/raster_properties.rst b/docs/user_manual/working_with_raster/raster_properties.rst index e2b46ab6b87..abdd7443929 100644 --- a/docs/user_manual/working_with_raster/raster_properties.rst +++ b/docs/user_manual/working_with_raster/raster_properties.rst @@ -80,6 +80,8 @@ 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 additional information about certain objects, such as map layers. + These properties are created and managed using PyQGIS, specifically through the `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 diff --git a/docs/user_manual/working_with_vector/vector_properties.rst b/docs/user_manual/working_with_vector/vector_properties.rst index af2ae255725..10c279b050b 100644 --- a/docs/user_manual/working_with_vector/vector_properties.rst +++ b/docs/user_manual/working_with_vector/vector_properties.rst @@ -82,6 +82,8 @@ 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 additional information about certain objects, such as map layers. + These properties are created and managed using PyQGIS, specifically through the `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 diff --git a/docs/user_manual/working_with_vector_tiles/vector_tiles.rst b/docs/user_manual/working_with_vector_tiles/vector_tiles.rst index 99b5499feff..65d9732068a 100644 --- a/docs/user_manual/working_with_vector_tiles/vector_tiles.rst +++ b/docs/user_manual/working_with_vector_tiles/vector_tiles.rst @@ -79,6 +79,8 @@ 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 additional information about certain objects, such as map layers. + These properties are created and managed using PyQGIS, specifically through the `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 `: access, From eb5cdfc4d88837d81b0d3995bf16fa7718ac0e3a Mon Sep 17 00:00:00 2001 From: selmaVH1 Date: Tue, 7 May 2024 16:24:26 +0200 Subject: [PATCH 2/4] Custom properties for vector layers --- .../user_manual/working_with_vector/vector_properties.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/user_manual/working_with_vector/vector_properties.rst b/docs/user_manual/working_with_vector/vector_properties.rst index 10c279b050b..c34e635625f 100644 --- a/docs/user_manual/working_with_vector/vector_properties.rst +++ b/docs/user_manual/working_with_vector/vector_properties.rst @@ -82,8 +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 additional information about certain objects, such as map layers. - These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. +* custom properties, used to store additional information about layers, in the active project. + Default custom properties may include :ref:`layer notes `, + :ref:`legend widgets `, :ref:`layer variables `, + :ref:`form properties `... + More custom properties can be created and managed using PyQGIS, + specifically through the :pyqgis:`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 From 7c543d9fefc8f4d7b073313881ba891e664d53c5 Mon Sep 17 00:00:00 2001 From: selmaVH1 Date: Wed, 3 Jul 2024 16:29:28 +0200 Subject: [PATCH 3/4] Custom properties - raster --- docs/user_manual/working_with_raster/raster_properties.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/user_manual/working_with_raster/raster_properties.rst b/docs/user_manual/working_with_raster/raster_properties.rst index abdd7443929..e7096dcf16b 100644 --- a/docs/user_manual/working_with_raster/raster_properties.rst +++ b/docs/user_manual/working_with_raster/raster_properties.rst @@ -82,6 +82,11 @@ Provided information are: last save time and size, the used provider * custom properties, used to store additional information about certain objects, such as map layers. These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. + An example of a useful custom property is :guilabel:`Identify/format`, which influences how the results from using + |identify| :ref:`identify features ` tool over a raster layer are formatted. When using the + |identify| :ref:`identify features ` tool on different types of layers, such as XYZ or WMS layers, + you might notice that the :guilabel:`Identify/format` value differs. This is because each layer can have its + own default format for displaying identify results. * 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 From 1de1a82288f38ecb3696c8de9027457f3aa8b165 Mon Sep 17 00:00:00 2001 From: DelazJ Date: Tue, 16 Jul 2024 11:04:38 +0200 Subject: [PATCH 4/4] Update info on custom properties --- .../working_with_3d_tiles/3d_tiles.rst | 5 ++-- docs/user_manual/working_with_mesh/mesh.rst | 5 ++-- .../point_clouds.rst | 5 ++-- .../working_with_raster/raster_properties.rst | 25 +++++++++++-------- .../working_with_vector/vector_properties.rst | 2 +- .../vector_tiles.rst | 5 ++-- 6 files changed, 28 insertions(+), 19 deletions(-) diff --git a/docs/user_manual/working_with_3d_tiles/3d_tiles.rst b/docs/user_manual/working_with_3d_tiles/3d_tiles.rst index ba26b9ca943..e2bd15fc00e 100644 --- a/docs/user_manual/working_with_3d_tiles/3d_tiles.rst +++ b/docs/user_manual/working_with_3d_tiles/3d_tiles.rst @@ -98,8 +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 additional information about certain objects, such as map layers. - These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. +* 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() ` 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, diff --git a/docs/user_manual/working_with_mesh/mesh.rst b/docs/user_manual/working_with_mesh/mesh.rst index 5e51fe21271..3a7dfe2d065 100644 --- a/docs/user_manual/working_with_mesh/mesh.rst +++ b/docs/user_manual/working_with_mesh/mesh.rst @@ -165,8 +165,9 @@ 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 additional information about certain objects, such as map layers. - These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. +* 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() ` 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 diff --git a/docs/user_manual/working_with_point_clouds/point_clouds.rst b/docs/user_manual/working_with_point_clouds/point_clouds.rst index f6fc2939555..5dc0e668621 100755 --- a/docs/user_manual/working_with_point_clouds/point_clouds.rst +++ b/docs/user_manual/working_with_point_clouds/point_clouds.rst @@ -104,8 +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 additional information about certain objects, such as map layers. - These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. +* 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() ` 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) diff --git a/docs/user_manual/working_with_raster/raster_properties.rst b/docs/user_manual/working_with_raster/raster_properties.rst index e7096dcf16b..5f3b07cc05c 100644 --- a/docs/user_manual/working_with_raster/raster_properties.rst +++ b/docs/user_manual/working_with_raster/raster_properties.rst @@ -80,13 +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 additional information about certain objects, such as map layers. - These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. - An example of a useful custom property is :guilabel:`Identify/format`, which influences how the results from using - |identify| :ref:`identify features ` tool over a raster layer are formatted. When using the - |identify| :ref:`identify features ` tool on different types of layers, such as XYZ or WMS layers, - you might notice that the :guilabel:`Identify/format` value differs. This is because each layer can have its - own default format for displaying identify results. +* 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 ` tool over a raster layer are formatted. + More properties can be created and managed using PyQGIS, specifically through + the :pyqgis:`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 @@ -1001,8 +999,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 @@ -1014,7 +1019,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 diff --git a/docs/user_manual/working_with_vector/vector_properties.rst b/docs/user_manual/working_with_vector/vector_properties.rst index c34e635625f..24d8be91cf5 100644 --- a/docs/user_manual/working_with_vector/vector_properties.rst +++ b/docs/user_manual/working_with_vector/vector_properties.rst @@ -82,7 +82,7 @@ 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 additional information about layers, in the active project. +* custom properties, used to store in the active project additional information about the layer. Default custom properties may include :ref:`layer notes `, :ref:`legend widgets `, :ref:`layer variables `, :ref:`form properties `... diff --git a/docs/user_manual/working_with_vector_tiles/vector_tiles.rst b/docs/user_manual/working_with_vector_tiles/vector_tiles.rst index 65d9732068a..67f4f5b9e05 100644 --- a/docs/user_manual/working_with_vector_tiles/vector_tiles.rst +++ b/docs/user_manual/working_with_vector_tiles/vector_tiles.rst @@ -79,8 +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 additional information about certain objects, such as map layers. - These properties are created and managed using PyQGIS, specifically through the `setCustomProperty` method. +* 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() ` method. * the Coordinate Reference System: name, units, method, accuracy, reference (i.e. whether it's static or dynamic) * picked from the :ref:`filled metadata `: access,