QGIS Project - use a project variablelizmap_pgrouting_enabled=yes to activate the module.
Before, the project file name must contain the word pgrouting so that the module was activated,
@@ -801,7 +827,7 @@
QGIS Project - use a project variablelizmap_pgrouting_enabled=yes to activate the module.
Before, the project file name must contain the word pgrouting so that the module was activated,
@@ -1156,7 +1202,7 @@
Installation - Grant the write access on the schema pgrouting and its content to the
given group (use installation parameter postgresql_user_group)
diff --git a/configuration/index.html b/configuration/index.html
index 22ec715..f7efac8 100644
--- a/configuration/index.html
+++ b/configuration/index.html
@@ -15,7 +15,7 @@
-
+
diff --git a/contributing/index.html b/contributing/index.html
index 7501f4e..dfcdf42 100644
--- a/contributing/index.html
+++ b/contributing/index.html
@@ -15,7 +15,7 @@
-
+
diff --git a/index.html b/index.html
index f362824..b10aaeb 100644
--- a/index.html
+++ b/index.html
@@ -15,7 +15,7 @@
-
+
diff --git a/installation/index.html b/installation/index.html
index 2faec39..303bebf 100644
--- a/installation/index.html
+++ b/installation/index.html
@@ -15,7 +15,7 @@
-
+
diff --git a/search/search_index.json b/search/search_index.json
index e919f28..83cca36 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Module PgRouting # Lizmap 3.5 minium install the module. configure the QGIS project. Funded by CRIGE PACA in France","title":"Home"},{"location":"#module-pgrouting","text":"Lizmap 3.5 minium install the module. configure the QGIS project. Funded by CRIGE PACA in France","title":"Module PgRouting"},{"location":"CHANGELOG/","text":"Changelog # Unreleased # 1.0.9 - 2024-01-18 # Fixed # Fix: copy-route button not visible when active with Lizmap 3.7 Changed # Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo 1.0.8 - 2023-07-11 # Fixed # Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap. 1.0.7 - 2023-07-06 # Changed # Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support Fixed # Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes 1.0.6 - 2023-06-30 # Changed # Improve the style of the route and start, intermediate & end points Fixed # Geometry saved to local storage & WKT exported - Export all the missing nodes. 1.0.5 - 2023-06-29 # Fixed # Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade. 1.0.4 - 2023-06-27 # Changed # QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource. 1.0.3 - 2023-06-27 # Fixed # Handle other map projections than 4326 and 3857 1.0.2 - 2023-06-26 # Added # Missing script to call during the upgrade, to set write access to a group on the pgrouting schema 1.0.1 - 2023-06-21 # Added # Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry. Changed # Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group ) 1.0.0 - 2023-06-09 # Added # Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7 Fixed # Fix the button \"Reverse edges\" to respect the routing direction Improve robustness 0.3.1 - 2022-12-15 # Fixed # Improve compatibility with Lizmap 3.6 0.3.0 - 2022-10-13 # Added # Experimental compatibility with Lizmap 3.6 Fixed # The module is now compatible with Lizmap 3.5.6 0.2.1 - 2021-10-19 # Drop the previous roadmap when no routes were found in the database and display a message 0.2.0 - 2021-10-15 # Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point 0.1.0 - 2021-06-22 # First version of the module","title":"Changelog"},{"location":"CHANGELOG/#changelog","text":"","title":"Changelog"},{"location":"CHANGELOG/#unreleased","text":"","title":"Unreleased"},{"location":"CHANGELOG/#109-2024-01-18","text":"","title":"1.0.9 - 2024-01-18"},{"location":"CHANGELOG/#fixed","text":"Fix: copy-route button not visible when active with Lizmap 3.7","title":"Fixed"},{"location":"CHANGELOG/#changed","text":"Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo","title":"Changed"},{"location":"CHANGELOG/#108-2023-07-11","text":"","title":"1.0.8 - 2023-07-11"},{"location":"CHANGELOG/#fixed_1","text":"Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap.","title":"Fixed"},{"location":"CHANGELOG/#107-2023-07-06","text":"","title":"1.0.7 - 2023-07-06"},{"location":"CHANGELOG/#changed_1","text":"Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support","title":"Changed"},{"location":"CHANGELOG/#fixed_2","text":"Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes","title":"Fixed"},{"location":"CHANGELOG/#106-2023-06-30","text":"","title":"1.0.6 - 2023-06-30"},{"location":"CHANGELOG/#changed_2","text":"Improve the style of the route and start, intermediate & end points","title":"Changed"},{"location":"CHANGELOG/#fixed_3","text":"Geometry saved to local storage & WKT exported - Export all the missing nodes.","title":"Fixed"},{"location":"CHANGELOG/#105-2023-06-29","text":"","title":"1.0.5 - 2023-06-29"},{"location":"CHANGELOG/#fixed_4","text":"Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade.","title":"Fixed"},{"location":"CHANGELOG/#104-2023-06-27","text":"","title":"1.0.4 - 2023-06-27"},{"location":"CHANGELOG/#changed_3","text":"QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource.","title":"Changed"},{"location":"CHANGELOG/#103-2023-06-27","text":"","title":"1.0.3 - 2023-06-27"},{"location":"CHANGELOG/#fixed_5","text":"Handle other map projections than 4326 and 3857","title":"Fixed"},{"location":"CHANGELOG/#102-2023-06-26","text":"","title":"1.0.2 - 2023-06-26"},{"location":"CHANGELOG/#added","text":"Missing script to call during the upgrade, to set write access to a group on the pgrouting schema","title":"Added"},{"location":"CHANGELOG/#101-2023-06-21","text":"","title":"1.0.1 - 2023-06-21"},{"location":"CHANGELOG/#added_1","text":"Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry.","title":"Added"},{"location":"CHANGELOG/#changed_4","text":"Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group )","title":"Changed"},{"location":"CHANGELOG/#100-2023-06-09","text":"","title":"1.0.0 - 2023-06-09"},{"location":"CHANGELOG/#added_2","text":"Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7","title":"Added"},{"location":"CHANGELOG/#fixed_6","text":"Fix the button \"Reverse edges\" to respect the routing direction Improve robustness","title":"Fixed"},{"location":"CHANGELOG/#031-2022-12-15","text":"","title":"0.3.1 - 2022-12-15"},{"location":"CHANGELOG/#fixed_7","text":"Improve compatibility with Lizmap 3.6","title":"Fixed"},{"location":"CHANGELOG/#030-2022-10-13","text":"","title":"0.3.0 - 2022-10-13"},{"location":"CHANGELOG/#added_3","text":"Experimental compatibility with Lizmap 3.6","title":"Added"},{"location":"CHANGELOG/#fixed_8","text":"The module is now compatible with Lizmap 3.5.6","title":"Fixed"},{"location":"CHANGELOG/#021-2021-10-19","text":"Drop the previous roadmap when no routes were found in the database and display a message","title":"0.2.1 - 2021-10-19"},{"location":"CHANGELOG/#020-2021-10-15","text":"Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point","title":"0.2.0 - 2021-10-15"},{"location":"CHANGELOG/#010-2021-06-22","text":"First version of the module","title":"0.1.0 - 2021-06-22"},{"location":"CONTRIBUTING/","text":"Contribution # You can contribute to the SQL code or the frontend Lizmap interface. How to build JS # JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"Contribution"},{"location":"CONTRIBUTING/#contribution","text":"You can contribute to the SQL code or the frontend Lizmap interface.","title":"Contribution"},{"location":"CONTRIBUTING/#how-to-build-js","text":"JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"How to build JS"},{"location":"changelog/","text":"Changelog # Unreleased # 1.0.9 - 2024-01-18 # Fixed # Fix: copy-route button not visible when active with Lizmap 3.7 Changed # Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo 1.0.8 - 2023-07-11 # Fixed # Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap. 1.0.7 - 2023-07-06 # Changed # Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support Fixed # Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes 1.0.6 - 2023-06-30 # Changed # Improve the style of the route and start, intermediate & end points Fixed # Geometry saved to local storage & WKT exported - Export all the missing nodes. 1.0.5 - 2023-06-29 # Fixed # Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade. 1.0.4 - 2023-06-27 # Changed # QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource. 1.0.3 - 2023-06-27 # Fixed # Handle other map projections than 4326 and 3857 1.0.2 - 2023-06-26 # Added # Missing script to call during the upgrade, to set write access to a group on the pgrouting schema 1.0.1 - 2023-06-21 # Added # Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry. Changed # Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group ) 1.0.0 - 2023-06-09 # Added # Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7 Fixed # Fix the button \"Reverse edges\" to respect the routing direction Improve robustness 0.3.1 - 2022-12-15 # Fixed # Improve compatibility with Lizmap 3.6 0.3.0 - 2022-10-13 # Added # Experimental compatibility with Lizmap 3.6 Fixed # The module is now compatible with Lizmap 3.5.6 0.2.1 - 2021-10-19 # Drop the previous roadmap when no routes were found in the database and display a message 0.2.0 - 2021-10-15 # Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point 0.1.0 - 2021-06-22 # First version of the module","title":"Changelog"},{"location":"changelog/#changelog","text":"","title":"Changelog"},{"location":"changelog/#unreleased","text":"","title":"Unreleased"},{"location":"changelog/#109-2024-01-18","text":"","title":"1.0.9 - 2024-01-18"},{"location":"changelog/#fixed","text":"Fix: copy-route button not visible when active with Lizmap 3.7","title":"Fixed"},{"location":"changelog/#changed","text":"Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo","title":"Changed"},{"location":"changelog/#108-2023-07-11","text":"","title":"1.0.8 - 2023-07-11"},{"location":"changelog/#fixed_1","text":"Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap.","title":"Fixed"},{"location":"changelog/#107-2023-07-06","text":"","title":"1.0.7 - 2023-07-06"},{"location":"changelog/#changed_1","text":"Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support","title":"Changed"},{"location":"changelog/#fixed_2","text":"Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes","title":"Fixed"},{"location":"changelog/#106-2023-06-30","text":"","title":"1.0.6 - 2023-06-30"},{"location":"changelog/#changed_2","text":"Improve the style of the route and start, intermediate & end points","title":"Changed"},{"location":"changelog/#fixed_3","text":"Geometry saved to local storage & WKT exported - Export all the missing nodes.","title":"Fixed"},{"location":"changelog/#105-2023-06-29","text":"","title":"1.0.5 - 2023-06-29"},{"location":"changelog/#fixed_4","text":"Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade.","title":"Fixed"},{"location":"changelog/#104-2023-06-27","text":"","title":"1.0.4 - 2023-06-27"},{"location":"changelog/#changed_3","text":"QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource.","title":"Changed"},{"location":"changelog/#103-2023-06-27","text":"","title":"1.0.3 - 2023-06-27"},{"location":"changelog/#fixed_5","text":"Handle other map projections than 4326 and 3857","title":"Fixed"},{"location":"changelog/#102-2023-06-26","text":"","title":"1.0.2 - 2023-06-26"},{"location":"changelog/#added","text":"Missing script to call during the upgrade, to set write access to a group on the pgrouting schema","title":"Added"},{"location":"changelog/#101-2023-06-21","text":"","title":"1.0.1 - 2023-06-21"},{"location":"changelog/#added_1","text":"Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry.","title":"Added"},{"location":"changelog/#changed_4","text":"Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group )","title":"Changed"},{"location":"changelog/#100-2023-06-09","text":"","title":"1.0.0 - 2023-06-09"},{"location":"changelog/#added_2","text":"Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7","title":"Added"},{"location":"changelog/#fixed_6","text":"Fix the button \"Reverse edges\" to respect the routing direction Improve robustness","title":"Fixed"},{"location":"changelog/#031-2022-12-15","text":"","title":"0.3.1 - 2022-12-15"},{"location":"changelog/#fixed_7","text":"Improve compatibility with Lizmap 3.6","title":"Fixed"},{"location":"changelog/#030-2022-10-13","text":"","title":"0.3.0 - 2022-10-13"},{"location":"changelog/#added_3","text":"Experimental compatibility with Lizmap 3.6","title":"Added"},{"location":"changelog/#fixed_8","text":"The module is now compatible with Lizmap 3.5.6","title":"Fixed"},{"location":"changelog/#021-2021-10-19","text":"Drop the previous roadmap when no routes were found in the database and display a message","title":"0.2.1 - 2021-10-19"},{"location":"changelog/#020-2021-10-15","text":"Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point","title":"0.2.0 - 2021-10-15"},{"location":"changelog/#010-2021-06-22","text":"First version of the module","title":"0.1.0 - 2021-06-22"},{"location":"configuration/","text":"Configuration # Data integration # Once the module is installed, you have to fill the tables with your data, for example from a road table containing linestrings. pgrouting.nodes : nodes of the routing graph, for example the start and end nodes of the linestrings, pgrouting.edges : edges of the graph, which mean the links between the nodes, characterized by their source and target nodes, pgrouring.routing_poi : optional points of interests along the roads (point geometries) We presented below an example of data import based on the French IGN BDTopo road layer loaded in a table bdtopo.troncon_de_route . The first step is to import the data to your PostgreSQL database. We recommend to use another schema, such as bdtopo . The second step is to add data in the pgrouting nodes and edges tables, taken from the source table. Import your source data in PostgreSQL # Your source data must be topological , which means roads must be cut at each physical intersection and do not overlap other roads. graph TD; A-->B; A-->C; A-->E; B-->D; B-->C; C-->D; C-->E; D-->E; You can use ogr2ogr to import your data in batch, for example with 1 ogr2ogr -progress --config PG_USE_COPY YES -f PostgreSQL PG: 'service=lizmap-pgrouting active_schema=bdtopo' -lco DIM = 2 -append -lco GEOMETRY_NAME = geom -lco FID = gid -nln bdtopo.troncon_de_route -t_srs EPSG:2154 -nlt PROMOTE_TO_MULTI \"TRONCON_DE_ROUTE.shp\" In the example above, the -append option allows to import several SHP inside the same table if needed. This command will add a gid column as the primary key. Be careful to delete the duplicate geometries, for example when you import data from multiple source files with overlapping data (such as in the French IGN BDTOPO \"d\u00e9partement\" extracts). You can use this kind of query to remove the duplicates based on the primary key gid and the IGN BDTOPO key id : 1 DELETE FROM bdtopo . troncon_de_route AS a USING bdtopo . troncon_de_route AS b WHERE a . gid < b . gid AND a . id = b . id ; Import the road data into PgRouting graph (nodes and edges) # Depending on your source layer, you might not have the same field names. Here, fid is the unique ID, geom is the geometry field, sens_de_circulation is the field with the road direction, nom_voie_ban_gauche is the field containing the road name We also decide to keep other interesting fields describing the edges : nature : the category of the road, importance : the road level of importance etat_de_l_objet : the road state, largeur_de_chaussee : the road width prive : if the road is private or public vitesse_moyenne_vl : the average speed for light vehicles acces_vehicule_leger : if the road can be accessed by light vehicles Display the SQL 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 BEGIN ; -- Copy data from the route source table -- For example: bdtopo.troncon_de_route -- to create the temporary edges -- with added start and end point point geometries. DROP TABLE IF EXISTS temp_edges ; CREATE TABLE temp_edges AS WITH source AS ( SELECT -- Stores the original data inside a JSON field to_jsonb ( t . * ) AS raw_data , -- Move the geometries nodes to a grid ST_SnapToGrid ( ST_geometryN ( geom , 1 ), 0 . 1 ) AS geom -- bdtopo.troncon_de_route is the source road table FROM bdtopo . troncon_de_route AS t WHERE TRUE ) SELECT source . * , -- get the start point ST_StartPoint ( geom ) AS start_point , -- get the end point ST_EndPoint ( geom ) AS end_point FROM source ; -- Create the needed indexes CREATE INDEX ON temp_edges USING GIST ( geom ); CREATE INDEX ON temp_edges USING GIST ( start_point ); CREATE INDEX ON temp_edges USING GIST ( end_point ); -- Create the temporary nodes from the start and end points DROP TABLE IF EXISTS temp_nodes ; CREATE TABLE temp_nodes AS WITH union_start_end AS ( SELECT raw_data ->> 'fid' AS start_of , NULL AS end_of , start_point AS geom FROM temp_edges UNION ALL SELECT NULL AS start_of , raw_data ->> 'fid' AS end_of , end_point AS geom FROM temp_edges ), distinct_nodes AS ( SELECT json_agg ( DISTINCT start_of ) FILTER ( WHERE start_of IS NOT NULL ) AS start_of , json_agg ( DISTINCT end_of ) FILTER ( WHERE end_of IS NOT NULL ) AS end_of , geom FROM union_start_end GROUP BY geom ) SELECT * FROM distinct_nodes ; CREATE INDEX ON temp_nodes USING GIST ( geom ); -- Insert them in the pgrouting.nodes table TRUNCATE pgrouting . nodes RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . nodes ( geom ) SELECT geom FROM temp_nodes ; -- Insert the temporary edges into the pgrouting.edges table -- with additional information about nodes, costs, etc. TRUNCATE pgrouting . edges RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . edges ( label , length , source , target , cost , reverse_cost , source_data , geom ) SELECT DISTINCT -- label of the edge e . raw_data ->> 'nom_voie_ban_gauche' AS label , -- length ST_length ( e . geom ) AS \"length\" , -- start and end nodes id ns . id , ne . id , -- cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens direct' ) THEN ST_length ( e . geom ) ELSE - 1 END AS cost , -- reverse cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens inverse' ) THEN ST_length ( e . geom ) ELSE - 1 END AS reverse_cost , -- Keep some useful columns from the source table jsonb_build_object ( 'fid' , e . raw_data -> 'fid' , 'nature' , e . raw_data -> 'nature' , 'importance' , e . raw_data -> 'importance' , 'etat_de_l_objet' , e . raw_data -> 'etat_de_l_objet' , 'largeur_de_chaussee' , e . raw_data -> 'largeur_de_chaussee' , 'prive' , e . raw_data -> 'prive' , 'sens_de_circulation' , e . raw_data -> 'sens_de_circulation' , 'vitesse_moyenne_vl' , e . raw_data -> 'vitesse_moyenne_vl' , 'acces_vehicule_leger' , e . raw_data -> 'acces_vehicule_leger' ) AS source_data , -- geometry. Needed for the astar route engine e . geom FROM temp_edges AS e LEFT JOIN pgrouting . nodes AS ns -- = is faster than ST_Equals ON ns . geom = e . start_point LEFT JOIN pgrouting . nodes AS ne ON ne . geom = e . end_point ; -- Drop the temporary tables DROP TABLE IF EXISTS temp_nodes ; DROP TABLE IF EXISTS temp_edges ; COMMIT ; -- VACUUM and analyse VACUUM ANALYSE pgrouting . nodes ; VACUUM ANALYSE pgrouting . edges ; Import data in the POI tables (optional) # Here is an example based on a \"point of interest\" layer loaded in a table called your_schema.point_of_interest . This query fill the pgrouting.routing_poi table. In the SELECT you can replace the fields by your fields of your point of interest layer. 1 2 3 INSERT INTO pgrouting . routing_poi ( label , type , description , geom ) SELECT poi . label , poi . type , poi . description , poi . geom FROM your_schema . point_of_interest AS poi ; In QGIS # Configure the QGIS project # To use the pgrouting module in Lizmap Web Client you must first configure a QGIS project : You can download the PgRouting demo, in the \"Modules\" section which contains a basic project with only the layers required and configured for Lizmap. If you want to create your project or use another existing project to use this module: Add the edges and nodes layers with these exact names. You can rename them in the plugin. The QGIS project must be called pgrouting.qgs or contain a QGIS project variable called lizmap_pgrouting_enabled with the value yes You must then create a configuration for Lizmap with the Lizmap plugin . No specific configuration is needed for the module. You can configure like you want or just click on the apply button.","title":"Configuration"},{"location":"configuration/#configuration","text":"","title":"Configuration"},{"location":"configuration/#data-integration","text":"Once the module is installed, you have to fill the tables with your data, for example from a road table containing linestrings. pgrouting.nodes : nodes of the routing graph, for example the start and end nodes of the linestrings, pgrouting.edges : edges of the graph, which mean the links between the nodes, characterized by their source and target nodes, pgrouring.routing_poi : optional points of interests along the roads (point geometries) We presented below an example of data import based on the French IGN BDTopo road layer loaded in a table bdtopo.troncon_de_route . The first step is to import the data to your PostgreSQL database. We recommend to use another schema, such as bdtopo . The second step is to add data in the pgrouting nodes and edges tables, taken from the source table.","title":"Data integration"},{"location":"configuration/#import-your-source-data-in-postgresql","text":"Your source data must be topological , which means roads must be cut at each physical intersection and do not overlap other roads. graph TD; A-->B; A-->C; A-->E; B-->D; B-->C; C-->D; C-->E; D-->E; You can use ogr2ogr to import your data in batch, for example with 1 ogr2ogr -progress --config PG_USE_COPY YES -f PostgreSQL PG: 'service=lizmap-pgrouting active_schema=bdtopo' -lco DIM = 2 -append -lco GEOMETRY_NAME = geom -lco FID = gid -nln bdtopo.troncon_de_route -t_srs EPSG:2154 -nlt PROMOTE_TO_MULTI \"TRONCON_DE_ROUTE.shp\" In the example above, the -append option allows to import several SHP inside the same table if needed. This command will add a gid column as the primary key. Be careful to delete the duplicate geometries, for example when you import data from multiple source files with overlapping data (such as in the French IGN BDTOPO \"d\u00e9partement\" extracts). You can use this kind of query to remove the duplicates based on the primary key gid and the IGN BDTOPO key id : 1 DELETE FROM bdtopo . troncon_de_route AS a USING bdtopo . troncon_de_route AS b WHERE a . gid < b . gid AND a . id = b . id ;","title":"Import your source data in PostgreSQL"},{"location":"configuration/#import-the-road-data-into-pgrouting-graph-nodes-and-edges","text":"Depending on your source layer, you might not have the same field names. Here, fid is the unique ID, geom is the geometry field, sens_de_circulation is the field with the road direction, nom_voie_ban_gauche is the field containing the road name We also decide to keep other interesting fields describing the edges : nature : the category of the road, importance : the road level of importance etat_de_l_objet : the road state, largeur_de_chaussee : the road width prive : if the road is private or public vitesse_moyenne_vl : the average speed for light vehicles acces_vehicule_leger : if the road can be accessed by light vehicles Display the SQL 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 BEGIN ; -- Copy data from the route source table -- For example: bdtopo.troncon_de_route -- to create the temporary edges -- with added start and end point point geometries. DROP TABLE IF EXISTS temp_edges ; CREATE TABLE temp_edges AS WITH source AS ( SELECT -- Stores the original data inside a JSON field to_jsonb ( t . * ) AS raw_data , -- Move the geometries nodes to a grid ST_SnapToGrid ( ST_geometryN ( geom , 1 ), 0 . 1 ) AS geom -- bdtopo.troncon_de_route is the source road table FROM bdtopo . troncon_de_route AS t WHERE TRUE ) SELECT source . * , -- get the start point ST_StartPoint ( geom ) AS start_point , -- get the end point ST_EndPoint ( geom ) AS end_point FROM source ; -- Create the needed indexes CREATE INDEX ON temp_edges USING GIST ( geom ); CREATE INDEX ON temp_edges USING GIST ( start_point ); CREATE INDEX ON temp_edges USING GIST ( end_point ); -- Create the temporary nodes from the start and end points DROP TABLE IF EXISTS temp_nodes ; CREATE TABLE temp_nodes AS WITH union_start_end AS ( SELECT raw_data ->> 'fid' AS start_of , NULL AS end_of , start_point AS geom FROM temp_edges UNION ALL SELECT NULL AS start_of , raw_data ->> 'fid' AS end_of , end_point AS geom FROM temp_edges ), distinct_nodes AS ( SELECT json_agg ( DISTINCT start_of ) FILTER ( WHERE start_of IS NOT NULL ) AS start_of , json_agg ( DISTINCT end_of ) FILTER ( WHERE end_of IS NOT NULL ) AS end_of , geom FROM union_start_end GROUP BY geom ) SELECT * FROM distinct_nodes ; CREATE INDEX ON temp_nodes USING GIST ( geom ); -- Insert them in the pgrouting.nodes table TRUNCATE pgrouting . nodes RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . nodes ( geom ) SELECT geom FROM temp_nodes ; -- Insert the temporary edges into the pgrouting.edges table -- with additional information about nodes, costs, etc. TRUNCATE pgrouting . edges RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . edges ( label , length , source , target , cost , reverse_cost , source_data , geom ) SELECT DISTINCT -- label of the edge e . raw_data ->> 'nom_voie_ban_gauche' AS label , -- length ST_length ( e . geom ) AS \"length\" , -- start and end nodes id ns . id , ne . id , -- cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens direct' ) THEN ST_length ( e . geom ) ELSE - 1 END AS cost , -- reverse cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens inverse' ) THEN ST_length ( e . geom ) ELSE - 1 END AS reverse_cost , -- Keep some useful columns from the source table jsonb_build_object ( 'fid' , e . raw_data -> 'fid' , 'nature' , e . raw_data -> 'nature' , 'importance' , e . raw_data -> 'importance' , 'etat_de_l_objet' , e . raw_data -> 'etat_de_l_objet' , 'largeur_de_chaussee' , e . raw_data -> 'largeur_de_chaussee' , 'prive' , e . raw_data -> 'prive' , 'sens_de_circulation' , e . raw_data -> 'sens_de_circulation' , 'vitesse_moyenne_vl' , e . raw_data -> 'vitesse_moyenne_vl' , 'acces_vehicule_leger' , e . raw_data -> 'acces_vehicule_leger' ) AS source_data , -- geometry. Needed for the astar route engine e . geom FROM temp_edges AS e LEFT JOIN pgrouting . nodes AS ns -- = is faster than ST_Equals ON ns . geom = e . start_point LEFT JOIN pgrouting . nodes AS ne ON ne . geom = e . end_point ; -- Drop the temporary tables DROP TABLE IF EXISTS temp_nodes ; DROP TABLE IF EXISTS temp_edges ; COMMIT ; -- VACUUM and analyse VACUUM ANALYSE pgrouting . nodes ; VACUUM ANALYSE pgrouting . edges ;","title":"Import the road data into PgRouting graph (nodes and edges)"},{"location":"configuration/#import-data-in-the-poi-tables-optional","text":"Here is an example based on a \"point of interest\" layer loaded in a table called your_schema.point_of_interest . This query fill the pgrouting.routing_poi table. In the SELECT you can replace the fields by your fields of your point of interest layer. 1 2 3 INSERT INTO pgrouting . routing_poi ( label , type , description , geom ) SELECT poi . label , poi . type , poi . description , poi . geom FROM your_schema . point_of_interest AS poi ;","title":"Import data in the POI tables (optional)"},{"location":"configuration/#in-qgis","text":"","title":"In QGIS"},{"location":"configuration/#configure-the-qgis-project","text":"To use the pgrouting module in Lizmap Web Client you must first configure a QGIS project : You can download the PgRouting demo, in the \"Modules\" section which contains a basic project with only the layers required and configured for Lizmap. If you want to create your project or use another existing project to use this module: Add the edges and nodes layers with these exact names. You can rename them in the plugin. The QGIS project must be called pgrouting.qgs or contain a QGIS project variable called lizmap_pgrouting_enabled with the value yes You must then create a configuration for Lizmap with the Lizmap plugin . No specific configuration is needed for the module. You can configure like you want or just click on the apply button.","title":"Configure the QGIS project"},{"location":"contributing/","text":"Contribution # You can contribute to the SQL code or the frontend Lizmap interface. How to build JS # JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"Contribution"},{"location":"contributing/#contribution","text":"You can contribute to the SQL code or the frontend Lizmap interface.","title":"Contribution"},{"location":"contributing/#how-to-build-js","text":"JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"How to build JS"},{"location":"installation/","text":"requirements # a PostgreSQL database with the postgis and pgrouting extensions installed Lizmap Web Client 3.5 or above Installation # Automatic installation of files with Composer # into lizmap/my-packages , create the file composer.json (if it doesn't exist) by copying the file composer.json.dist , and install the modules with Composer: 1 2 cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json composer require --working-dir = lizmap/my-packages \"lizmap/lizmap-pgrouting-module\" Manual installation of files without Composer # Get the last ZIP archive in the repository page . Extract the archive and copy the pgrouting directory (the one containing the module.xml file) into the Lizmap Web Client folder lizmap/lizmap-modules/ With Lizmap 3.5 or lower: edit the config file lizmap/var/config/localconfig.ini.php and add into the section [modules] : 1 pgrouting.access = 2 Launching the installer with Lizmap Web Client 3.6/3.7 # Use following instructions if you are using Lizmap Web Client 3.6 or higher . First you need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters, by replacing values with your own credentials. Only replace host, database, user and password values. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Then execute: 1 php lizmap/install/configurator.php pgrouting It will install some files, and ask you some parameters: The SRID (code of spatial coordinate system). It must correspond to the projection of your source data and will be used for the tables created by the module. Default is 2154 (French official code) The name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). Then, execute Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh A new schema pgrouting must be visible in your PostgreSQL database, containing the needed tables and functions used by the module. Launching the installer with Lizmap 3.5 # If you are using Lizmap Web Client 3.5 , you must manually edit the configuration file of your instance to specify some options. Edit the file lizmap/var/config/localconfig.ini.php and add the following variable in the section [modules] : 1 pgrouting.installparam = \"srid=2154 ;postgresql_user_group=gis_group\" You can replace: 2154 by another SRID that you use. It must correspond to the projection of your source data. gis_group must be replaced by the name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). You need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Only replace host, database, user and password values. Then, execute the Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh","title":"Installation"},{"location":"installation/#requirements","text":"a PostgreSQL database with the postgis and pgrouting extensions installed Lizmap Web Client 3.5 or above","title":"requirements"},{"location":"installation/#installation","text":"","title":"Installation"},{"location":"installation/#automatic-installation-of-files-with-composer","text":"into lizmap/my-packages , create the file composer.json (if it doesn't exist) by copying the file composer.json.dist , and install the modules with Composer: 1 2 cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json composer require --working-dir = lizmap/my-packages \"lizmap/lizmap-pgrouting-module\"","title":"Automatic installation of files with Composer"},{"location":"installation/#manual-installation-of-files-without-composer","text":"Get the last ZIP archive in the repository page . Extract the archive and copy the pgrouting directory (the one containing the module.xml file) into the Lizmap Web Client folder lizmap/lizmap-modules/ With Lizmap 3.5 or lower: edit the config file lizmap/var/config/localconfig.ini.php and add into the section [modules] : 1 pgrouting.access = 2","title":"Manual installation of files without Composer"},{"location":"installation/#launching-the-installer-with-lizmap-web-client-3637","text":"Use following instructions if you are using Lizmap Web Client 3.6 or higher . First you need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters, by replacing values with your own credentials. Only replace host, database, user and password values. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Then execute: 1 php lizmap/install/configurator.php pgrouting It will install some files, and ask you some parameters: The SRID (code of spatial coordinate system). It must correspond to the projection of your source data and will be used for the tables created by the module. Default is 2154 (French official code) The name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). Then, execute Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh A new schema pgrouting must be visible in your PostgreSQL database, containing the needed tables and functions used by the module.","title":"Launching the installer with Lizmap Web Client 3.6/3.7"},{"location":"installation/#launching-the-installer-with-lizmap-35","text":"If you are using Lizmap Web Client 3.5 , you must manually edit the configuration file of your instance to specify some options. Edit the file lizmap/var/config/localconfig.ini.php and add the following variable in the section [modules] : 1 pgrouting.installparam = \"srid=2154 ;postgresql_user_group=gis_group\" You can replace: 2154 by another SRID that you use. It must correspond to the projection of your source data. gis_group must be replaced by the name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). You need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Only replace host, database, user and password values. Then, execute the Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh","title":"Launching the installer with Lizmap 3.5"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Module PgRouting # Lizmap 3.5 minium install the module. configure the QGIS project. Funded by CRIGE PACA in France","title":"Home"},{"location":"#module-pgrouting","text":"Lizmap 3.5 minium install the module. configure the QGIS project. Funded by CRIGE PACA in France","title":"Module PgRouting"},{"location":"CHANGELOG/","text":"Changelog # Unreleased # 1.1.0 - 2024-06-17 # Changed # Compatibility with Lizmap 3.8 Update JavaScript to use OpenLayers and lit-html exposed APIs from Lizmap 1.0.9 - 2024-01-18 # Fixed # Fix: copy-route button not visible when active with Lizmap 3.7 Changed # Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo 1.0.8 - 2023-07-11 # Fixed # Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap. 1.0.7 - 2023-07-06 # Changed # Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support Fixed # Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes 1.0.6 - 2023-06-30 # Changed # Improve the style of the route and start, intermediate & end points Fixed # Geometry saved to local storage & WKT exported - Export all the missing nodes. 1.0.5 - 2023-06-29 # Fixed # Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade. 1.0.4 - 2023-06-27 # Changed # QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource. 1.0.3 - 2023-06-27 # Fixed # Handle other map projections than 4326 and 3857 1.0.2 - 2023-06-26 # Added # Missing script to call during the upgrade, to set write access to a group on the pgrouting schema 1.0.1 - 2023-06-21 # Added # Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry. Changed # Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group ) 1.0.0 - 2023-06-09 # Added # Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7 Fixed # Fix the button \"Reverse edges\" to respect the routing direction Improve robustness 0.3.1 - 2022-12-15 # Fixed # Improve compatibility with Lizmap 3.6 0.3.0 - 2022-10-13 # Added # Experimental compatibility with Lizmap 3.6 Fixed # The module is now compatible with Lizmap 3.5.6 0.2.1 - 2021-10-19 # Drop the previous roadmap when no routes were found in the database and display a message 0.2.0 - 2021-10-15 # Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point 0.1.0 - 2021-06-22 # First version of the module","title":"Changelog"},{"location":"CHANGELOG/#changelog","text":"","title":"Changelog"},{"location":"CHANGELOG/#unreleased","text":"","title":"Unreleased"},{"location":"CHANGELOG/#110-2024-06-17","text":"","title":"1.1.0 - 2024-06-17"},{"location":"CHANGELOG/#changed","text":"Compatibility with Lizmap 3.8 Update JavaScript to use OpenLayers and lit-html exposed APIs from Lizmap","title":"Changed"},{"location":"CHANGELOG/#109-2024-01-18","text":"","title":"1.0.9 - 2024-01-18"},{"location":"CHANGELOG/#fixed","text":"Fix: copy-route button not visible when active with Lizmap 3.7","title":"Fixed"},{"location":"CHANGELOG/#changed_1","text":"Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo","title":"Changed"},{"location":"CHANGELOG/#108-2023-07-11","text":"","title":"1.0.8 - 2023-07-11"},{"location":"CHANGELOG/#fixed_1","text":"Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap.","title":"Fixed"},{"location":"CHANGELOG/#107-2023-07-06","text":"","title":"1.0.7 - 2023-07-06"},{"location":"CHANGELOG/#changed_2","text":"Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support","title":"Changed"},{"location":"CHANGELOG/#fixed_2","text":"Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes","title":"Fixed"},{"location":"CHANGELOG/#106-2023-06-30","text":"","title":"1.0.6 - 2023-06-30"},{"location":"CHANGELOG/#changed_3","text":"Improve the style of the route and start, intermediate & end points","title":"Changed"},{"location":"CHANGELOG/#fixed_3","text":"Geometry saved to local storage & WKT exported - Export all the missing nodes.","title":"Fixed"},{"location":"CHANGELOG/#105-2023-06-29","text":"","title":"1.0.5 - 2023-06-29"},{"location":"CHANGELOG/#fixed_4","text":"Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade.","title":"Fixed"},{"location":"CHANGELOG/#104-2023-06-27","text":"","title":"1.0.4 - 2023-06-27"},{"location":"CHANGELOG/#changed_4","text":"QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource.","title":"Changed"},{"location":"CHANGELOG/#103-2023-06-27","text":"","title":"1.0.3 - 2023-06-27"},{"location":"CHANGELOG/#fixed_5","text":"Handle other map projections than 4326 and 3857","title":"Fixed"},{"location":"CHANGELOG/#102-2023-06-26","text":"","title":"1.0.2 - 2023-06-26"},{"location":"CHANGELOG/#added","text":"Missing script to call during the upgrade, to set write access to a group on the pgrouting schema","title":"Added"},{"location":"CHANGELOG/#101-2023-06-21","text":"","title":"1.0.1 - 2023-06-21"},{"location":"CHANGELOG/#added_1","text":"Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry.","title":"Added"},{"location":"CHANGELOG/#changed_5","text":"Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group )","title":"Changed"},{"location":"CHANGELOG/#100-2023-06-09","text":"","title":"1.0.0 - 2023-06-09"},{"location":"CHANGELOG/#added_2","text":"Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7","title":"Added"},{"location":"CHANGELOG/#fixed_6","text":"Fix the button \"Reverse edges\" to respect the routing direction Improve robustness","title":"Fixed"},{"location":"CHANGELOG/#031-2022-12-15","text":"","title":"0.3.1 - 2022-12-15"},{"location":"CHANGELOG/#fixed_7","text":"Improve compatibility with Lizmap 3.6","title":"Fixed"},{"location":"CHANGELOG/#030-2022-10-13","text":"","title":"0.3.0 - 2022-10-13"},{"location":"CHANGELOG/#added_3","text":"Experimental compatibility with Lizmap 3.6","title":"Added"},{"location":"CHANGELOG/#fixed_8","text":"The module is now compatible with Lizmap 3.5.6","title":"Fixed"},{"location":"CHANGELOG/#021-2021-10-19","text":"Drop the previous roadmap when no routes were found in the database and display a message","title":"0.2.1 - 2021-10-19"},{"location":"CHANGELOG/#020-2021-10-15","text":"Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point","title":"0.2.0 - 2021-10-15"},{"location":"CHANGELOG/#010-2021-06-22","text":"First version of the module","title":"0.1.0 - 2021-06-22"},{"location":"CONTRIBUTING/","text":"Contribution # You can contribute to the SQL code or the frontend Lizmap interface. How to build JS # JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"Contribution"},{"location":"CONTRIBUTING/#contribution","text":"You can contribute to the SQL code or the frontend Lizmap interface.","title":"Contribution"},{"location":"CONTRIBUTING/#how-to-build-js","text":"JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"How to build JS"},{"location":"changelog/","text":"Changelog # Unreleased # 1.1.0 - 2024-06-17 # Changed # Compatibility with Lizmap 3.8 Update JavaScript to use OpenLayers and lit-html exposed APIs from Lizmap 1.0.9 - 2024-01-18 # Fixed # Fix: copy-route button not visible when active with Lizmap 3.7 Changed # Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo 1.0.8 - 2023-07-11 # Fixed # Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap. 1.0.7 - 2023-07-06 # Changed # Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support Fixed # Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes 1.0.6 - 2023-06-30 # Changed # Improve the style of the route and start, intermediate & end points Fixed # Geometry saved to local storage & WKT exported - Export all the missing nodes. 1.0.5 - 2023-06-29 # Fixed # Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade. 1.0.4 - 2023-06-27 # Changed # QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource. 1.0.3 - 2023-06-27 # Fixed # Handle other map projections than 4326 and 3857 1.0.2 - 2023-06-26 # Added # Missing script to call during the upgrade, to set write access to a group on the pgrouting schema 1.0.1 - 2023-06-21 # Added # Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry. Changed # Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group ) 1.0.0 - 2023-06-09 # Added # Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7 Fixed # Fix the button \"Reverse edges\" to respect the routing direction Improve robustness 0.3.1 - 2022-12-15 # Fixed # Improve compatibility with Lizmap 3.6 0.3.0 - 2022-10-13 # Added # Experimental compatibility with Lizmap 3.6 Fixed # The module is now compatible with Lizmap 3.5.6 0.2.1 - 2021-10-19 # Drop the previous roadmap when no routes were found in the database and display a message 0.2.0 - 2021-10-15 # Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point 0.1.0 - 2021-06-22 # First version of the module","title":"Changelog"},{"location":"changelog/#changelog","text":"","title":"Changelog"},{"location":"changelog/#unreleased","text":"","title":"Unreleased"},{"location":"changelog/#110-2024-06-17","text":"","title":"1.1.0 - 2024-06-17"},{"location":"changelog/#changed","text":"Compatibility with Lizmap 3.8 Update JavaScript to use OpenLayers and lit-html exposed APIs from Lizmap","title":"Changed"},{"location":"changelog/#109-2024-01-18","text":"","title":"1.0.9 - 2024-01-18"},{"location":"changelog/#fixed","text":"Fix: copy-route button not visible when active with Lizmap 3.7","title":"Fixed"},{"location":"changelog/#changed_1","text":"Update QGIS test project to 3.28 for Lizmap 3.7 Add a localized string for the dock title instead of pgRouting Fix some typo","title":"Changed"},{"location":"changelog/#108-2023-07-11","text":"","title":"1.0.8 - 2023-07-11"},{"location":"changelog/#fixed_1","text":"Fix: correct built JS Install assets outside the assets/ directory, as it is reserved to Lizmap.","title":"Fixed"},{"location":"changelog/#107-2023-07-06","text":"","title":"1.0.7 - 2023-07-06"},{"location":"changelog/#changed_2","text":"Rename pgrouting.umd.cjs to pgrouting.umd.js for better web server support","title":"Changed"},{"location":"changelog/#fixed_2","text":"Fix rights on pgrouting schema sequences to allow the user to set or reset the PostgreSQL sequences when re-importing edges and nodes","title":"Fixed"},{"location":"changelog/#106-2023-06-30","text":"","title":"1.0.6 - 2023-06-30"},{"location":"changelog/#changed_3","text":"Improve the style of the route and start, intermediate & end points","title":"Changed"},{"location":"changelog/#fixed_3","text":"Geometry saved to local storage & WKT exported - Export all the missing nodes.","title":"Fixed"},{"location":"changelog/#105-2023-06-29","text":"","title":"1.0.5 - 2023-06-29"},{"location":"changelog/#fixed_4","text":"Upgrade method - Overwrite the existing JavaScript and CSS files by the new versions when running the upgrade.","title":"Fixed"},{"location":"changelog/#104-2023-06-27","text":"","title":"1.0.4 - 2023-06-27"},{"location":"changelog/#changed_4","text":"QGIS Project - use a project variable lizmap_pgrouting_enabled=yes to activate the module. Before, the project file name must contain the word pgrouting so that the module was activated, which was not very practical. Docs - Improve the installation documentation. Docs - Adapt the SQL import example to the new field names of the BDTOPO road datasource.","title":"Changed"},{"location":"changelog/#103-2023-06-27","text":"","title":"1.0.3 - 2023-06-27"},{"location":"changelog/#fixed_5","text":"Handle other map projections than 4326 and 3857","title":"Fixed"},{"location":"changelog/#102-2023-06-26","text":"","title":"1.0.2 - 2023-06-26"},{"location":"changelog/#added","text":"Missing script to call during the upgrade, to set write access to a group on the pgrouting schema","title":"Added"},{"location":"changelog/#101-2023-06-21","text":"","title":"1.0.1 - 2023-06-21"},{"location":"changelog/#added_1","text":"Trigger a Lizmap event lizmapPgroutingWktGeometryExported containing the generated WKT to allow JavaScript scripts for LWC <= 3.6 to use the generated route geometry.","title":"Added"},{"location":"changelog/#changed_5","text":"Installation - Grant the write access on the schema pgrouting and its content to the given group (use installation parameter postgresql_user_group )","title":"Changed"},{"location":"changelog/#100-2023-06-09","text":"","title":"1.0.0 - 2023-06-09"},{"location":"changelog/#added_2","text":"Support for intermediate points when drawing Copy the geometry which has been computed, Lizmap Web Client 3.7 only. Useful for pasting geometry when editing Installable into the future Lizmap 3.7","title":"Added"},{"location":"changelog/#fixed_6","text":"Fix the button \"Reverse edges\" to respect the routing direction Improve robustness","title":"Fixed"},{"location":"changelog/#031-2022-12-15","text":"","title":"0.3.1 - 2022-12-15"},{"location":"changelog/#fixed_7","text":"Improve compatibility with Lizmap 3.6","title":"Fixed"},{"location":"changelog/#030-2022-10-13","text":"","title":"0.3.0 - 2022-10-13"},{"location":"changelog/#added_3","text":"Experimental compatibility with Lizmap 3.6","title":"Added"},{"location":"changelog/#fixed_8","text":"The module is now compatible with Lizmap 3.5.6","title":"Fixed"},{"location":"changelog/#021-2021-10-19","text":"Drop the previous roadmap when no routes were found in the database and display a message","title":"0.2.1 - 2021-10-19"},{"location":"changelog/#020-2021-10-15","text":"Add some checks for SQL query results Add a PHP class to check the configuration (database extension and structure, required QGIS project layers) Improve the import script example for French IGN BdTopo Improve the spatial query performance Add a default label 'unnamed road' in the pgRouting dock when the edge has no label Add a button to reset start and end point","title":"0.2.0 - 2021-10-15"},{"location":"changelog/#010-2021-06-22","text":"First version of the module","title":"0.1.0 - 2021-06-22"},{"location":"configuration/","text":"Configuration # Data integration # Once the module is installed, you have to fill the tables with your data, for example from a road table containing linestrings. pgrouting.nodes : nodes of the routing graph, for example the start and end nodes of the linestrings, pgrouting.edges : edges of the graph, which mean the links between the nodes, characterized by their source and target nodes, pgrouring.routing_poi : optional points of interests along the roads (point geometries) We presented below an example of data import based on the French IGN BDTopo road layer loaded in a table bdtopo.troncon_de_route . The first step is to import the data to your PostgreSQL database. We recommend to use another schema, such as bdtopo . The second step is to add data in the pgrouting nodes and edges tables, taken from the source table. Import your source data in PostgreSQL # Your source data must be topological , which means roads must be cut at each physical intersection and do not overlap other roads. graph TD; A-->B; A-->C; A-->E; B-->D; B-->C; C-->D; C-->E; D-->E; You can use ogr2ogr to import your data in batch, for example with 1 ogr2ogr -progress --config PG_USE_COPY YES -f PostgreSQL PG: 'service=lizmap-pgrouting active_schema=bdtopo' -lco DIM = 2 -append -lco GEOMETRY_NAME = geom -lco FID = gid -nln bdtopo.troncon_de_route -t_srs EPSG:2154 -nlt PROMOTE_TO_MULTI \"TRONCON_DE_ROUTE.shp\" In the example above, the -append option allows to import several SHP inside the same table if needed. This command will add a gid column as the primary key. Be careful to delete the duplicate geometries, for example when you import data from multiple source files with overlapping data (such as in the French IGN BDTOPO \"d\u00e9partement\" extracts). You can use this kind of query to remove the duplicates based on the primary key gid and the IGN BDTOPO key id : 1 DELETE FROM bdtopo . troncon_de_route AS a USING bdtopo . troncon_de_route AS b WHERE a . gid < b . gid AND a . id = b . id ; Import the road data into PgRouting graph (nodes and edges) # Depending on your source layer, you might not have the same field names. Here, fid is the unique ID, geom is the geometry field, sens_de_circulation is the field with the road direction, nom_voie_ban_gauche is the field containing the road name We also decide to keep other interesting fields describing the edges : nature : the category of the road, importance : the road level of importance etat_de_l_objet : the road state, largeur_de_chaussee : the road width prive : if the road is private or public vitesse_moyenne_vl : the average speed for light vehicles acces_vehicule_leger : if the road can be accessed by light vehicles Display the SQL 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 BEGIN ; -- Copy data from the route source table -- For example: bdtopo.troncon_de_route -- to create the temporary edges -- with added start and end point point geometries. DROP TABLE IF EXISTS temp_edges ; CREATE TABLE temp_edges AS WITH source AS ( SELECT -- Stores the original data inside a JSON field to_jsonb ( t . * ) AS raw_data , -- Move the geometries nodes to a grid ST_SnapToGrid ( ST_geometryN ( geom , 1 ), 0 . 1 ) AS geom -- bdtopo.troncon_de_route is the source road table FROM bdtopo . troncon_de_route AS t WHERE TRUE ) SELECT source . * , -- get the start point ST_StartPoint ( geom ) AS start_point , -- get the end point ST_EndPoint ( geom ) AS end_point FROM source ; -- Create the needed indexes CREATE INDEX ON temp_edges USING GIST ( geom ); CREATE INDEX ON temp_edges USING GIST ( start_point ); CREATE INDEX ON temp_edges USING GIST ( end_point ); -- Create the temporary nodes from the start and end points DROP TABLE IF EXISTS temp_nodes ; CREATE TABLE temp_nodes AS WITH union_start_end AS ( SELECT raw_data ->> 'fid' AS start_of , NULL AS end_of , start_point AS geom FROM temp_edges UNION ALL SELECT NULL AS start_of , raw_data ->> 'fid' AS end_of , end_point AS geom FROM temp_edges ), distinct_nodes AS ( SELECT json_agg ( DISTINCT start_of ) FILTER ( WHERE start_of IS NOT NULL ) AS start_of , json_agg ( DISTINCT end_of ) FILTER ( WHERE end_of IS NOT NULL ) AS end_of , geom FROM union_start_end GROUP BY geom ) SELECT * FROM distinct_nodes ; CREATE INDEX ON temp_nodes USING GIST ( geom ); -- Insert them in the pgrouting.nodes table TRUNCATE pgrouting . nodes RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . nodes ( geom ) SELECT geom FROM temp_nodes ; -- Insert the temporary edges into the pgrouting.edges table -- with additional information about nodes, costs, etc. TRUNCATE pgrouting . edges RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . edges ( label , length , source , target , cost , reverse_cost , source_data , geom ) SELECT DISTINCT -- label of the edge e . raw_data ->> 'nom_voie_ban_gauche' AS label , -- length ST_length ( e . geom ) AS \"length\" , -- start and end nodes id ns . id , ne . id , -- cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens direct' ) THEN ST_length ( e . geom ) ELSE - 1 END AS cost , -- reverse cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens inverse' ) THEN ST_length ( e . geom ) ELSE - 1 END AS reverse_cost , -- Keep some useful columns from the source table jsonb_build_object ( 'fid' , e . raw_data -> 'fid' , 'nature' , e . raw_data -> 'nature' , 'importance' , e . raw_data -> 'importance' , 'etat_de_l_objet' , e . raw_data -> 'etat_de_l_objet' , 'largeur_de_chaussee' , e . raw_data -> 'largeur_de_chaussee' , 'prive' , e . raw_data -> 'prive' , 'sens_de_circulation' , e . raw_data -> 'sens_de_circulation' , 'vitesse_moyenne_vl' , e . raw_data -> 'vitesse_moyenne_vl' , 'acces_vehicule_leger' , e . raw_data -> 'acces_vehicule_leger' ) AS source_data , -- geometry. Needed for the astar route engine e . geom FROM temp_edges AS e LEFT JOIN pgrouting . nodes AS ns -- = is faster than ST_Equals ON ns . geom = e . start_point LEFT JOIN pgrouting . nodes AS ne ON ne . geom = e . end_point ; -- Drop the temporary tables DROP TABLE IF EXISTS temp_nodes ; DROP TABLE IF EXISTS temp_edges ; COMMIT ; -- VACUUM and analyse VACUUM ANALYSE pgrouting . nodes ; VACUUM ANALYSE pgrouting . edges ; Import data in the POI tables (optional) # Here is an example based on a \"point of interest\" layer loaded in a table called your_schema.point_of_interest . This query fill the pgrouting.routing_poi table. In the SELECT you can replace the fields by your fields of your point of interest layer. 1 2 3 INSERT INTO pgrouting . routing_poi ( label , type , description , geom ) SELECT poi . label , poi . type , poi . description , poi . geom FROM your_schema . point_of_interest AS poi ; In QGIS # Configure the QGIS project # To use the pgrouting module in Lizmap Web Client you must first configure a QGIS project : You can download the PgRouting demo, in the \"Modules\" section which contains a basic project with only the layers required and configured for Lizmap. If you want to create your project or use another existing project to use this module: Add the edges and nodes layers with these exact names. You can rename them in the plugin. The QGIS project must be called pgrouting.qgs or contain a QGIS project variable called lizmap_pgrouting_enabled with the value yes You must then create a configuration for Lizmap with the Lizmap plugin . No specific configuration is needed for the module. You can configure like you want or just click on the apply button.","title":"Configuration"},{"location":"configuration/#configuration","text":"","title":"Configuration"},{"location":"configuration/#data-integration","text":"Once the module is installed, you have to fill the tables with your data, for example from a road table containing linestrings. pgrouting.nodes : nodes of the routing graph, for example the start and end nodes of the linestrings, pgrouting.edges : edges of the graph, which mean the links between the nodes, characterized by their source and target nodes, pgrouring.routing_poi : optional points of interests along the roads (point geometries) We presented below an example of data import based on the French IGN BDTopo road layer loaded in a table bdtopo.troncon_de_route . The first step is to import the data to your PostgreSQL database. We recommend to use another schema, such as bdtopo . The second step is to add data in the pgrouting nodes and edges tables, taken from the source table.","title":"Data integration"},{"location":"configuration/#import-your-source-data-in-postgresql","text":"Your source data must be topological , which means roads must be cut at each physical intersection and do not overlap other roads. graph TD; A-->B; A-->C; A-->E; B-->D; B-->C; C-->D; C-->E; D-->E; You can use ogr2ogr to import your data in batch, for example with 1 ogr2ogr -progress --config PG_USE_COPY YES -f PostgreSQL PG: 'service=lizmap-pgrouting active_schema=bdtopo' -lco DIM = 2 -append -lco GEOMETRY_NAME = geom -lco FID = gid -nln bdtopo.troncon_de_route -t_srs EPSG:2154 -nlt PROMOTE_TO_MULTI \"TRONCON_DE_ROUTE.shp\" In the example above, the -append option allows to import several SHP inside the same table if needed. This command will add a gid column as the primary key. Be careful to delete the duplicate geometries, for example when you import data from multiple source files with overlapping data (such as in the French IGN BDTOPO \"d\u00e9partement\" extracts). You can use this kind of query to remove the duplicates based on the primary key gid and the IGN BDTOPO key id : 1 DELETE FROM bdtopo . troncon_de_route AS a USING bdtopo . troncon_de_route AS b WHERE a . gid < b . gid AND a . id = b . id ;","title":"Import your source data in PostgreSQL"},{"location":"configuration/#import-the-road-data-into-pgrouting-graph-nodes-and-edges","text":"Depending on your source layer, you might not have the same field names. Here, fid is the unique ID, geom is the geometry field, sens_de_circulation is the field with the road direction, nom_voie_ban_gauche is the field containing the road name We also decide to keep other interesting fields describing the edges : nature : the category of the road, importance : the road level of importance etat_de_l_objet : the road state, largeur_de_chaussee : the road width prive : if the road is private or public vitesse_moyenne_vl : the average speed for light vehicles acces_vehicule_leger : if the road can be accessed by light vehicles Display the SQL 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 BEGIN ; -- Copy data from the route source table -- For example: bdtopo.troncon_de_route -- to create the temporary edges -- with added start and end point point geometries. DROP TABLE IF EXISTS temp_edges ; CREATE TABLE temp_edges AS WITH source AS ( SELECT -- Stores the original data inside a JSON field to_jsonb ( t . * ) AS raw_data , -- Move the geometries nodes to a grid ST_SnapToGrid ( ST_geometryN ( geom , 1 ), 0 . 1 ) AS geom -- bdtopo.troncon_de_route is the source road table FROM bdtopo . troncon_de_route AS t WHERE TRUE ) SELECT source . * , -- get the start point ST_StartPoint ( geom ) AS start_point , -- get the end point ST_EndPoint ( geom ) AS end_point FROM source ; -- Create the needed indexes CREATE INDEX ON temp_edges USING GIST ( geom ); CREATE INDEX ON temp_edges USING GIST ( start_point ); CREATE INDEX ON temp_edges USING GIST ( end_point ); -- Create the temporary nodes from the start and end points DROP TABLE IF EXISTS temp_nodes ; CREATE TABLE temp_nodes AS WITH union_start_end AS ( SELECT raw_data ->> 'fid' AS start_of , NULL AS end_of , start_point AS geom FROM temp_edges UNION ALL SELECT NULL AS start_of , raw_data ->> 'fid' AS end_of , end_point AS geom FROM temp_edges ), distinct_nodes AS ( SELECT json_agg ( DISTINCT start_of ) FILTER ( WHERE start_of IS NOT NULL ) AS start_of , json_agg ( DISTINCT end_of ) FILTER ( WHERE end_of IS NOT NULL ) AS end_of , geom FROM union_start_end GROUP BY geom ) SELECT * FROM distinct_nodes ; CREATE INDEX ON temp_nodes USING GIST ( geom ); -- Insert them in the pgrouting.nodes table TRUNCATE pgrouting . nodes RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . nodes ( geom ) SELECT geom FROM temp_nodes ; -- Insert the temporary edges into the pgrouting.edges table -- with additional information about nodes, costs, etc. TRUNCATE pgrouting . edges RESTART IDENTITY CASCADE ; INSERT INTO pgrouting . edges ( label , length , source , target , cost , reverse_cost , source_data , geom ) SELECT DISTINCT -- label of the edge e . raw_data ->> 'nom_voie_ban_gauche' AS label , -- length ST_length ( e . geom ) AS \"length\" , -- start and end nodes id ns . id , ne . id , -- cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens direct' ) THEN ST_length ( e . geom ) ELSE - 1 END AS cost , -- reverse cost based on the length CASE WHEN e . raw_data ->> 'sens_de_circulation' in ( 'Sans objet' , 'Double sens' , 'Sens inverse' ) THEN ST_length ( e . geom ) ELSE - 1 END AS reverse_cost , -- Keep some useful columns from the source table jsonb_build_object ( 'fid' , e . raw_data -> 'fid' , 'nature' , e . raw_data -> 'nature' , 'importance' , e . raw_data -> 'importance' , 'etat_de_l_objet' , e . raw_data -> 'etat_de_l_objet' , 'largeur_de_chaussee' , e . raw_data -> 'largeur_de_chaussee' , 'prive' , e . raw_data -> 'prive' , 'sens_de_circulation' , e . raw_data -> 'sens_de_circulation' , 'vitesse_moyenne_vl' , e . raw_data -> 'vitesse_moyenne_vl' , 'acces_vehicule_leger' , e . raw_data -> 'acces_vehicule_leger' ) AS source_data , -- geometry. Needed for the astar route engine e . geom FROM temp_edges AS e LEFT JOIN pgrouting . nodes AS ns -- = is faster than ST_Equals ON ns . geom = e . start_point LEFT JOIN pgrouting . nodes AS ne ON ne . geom = e . end_point ; -- Drop the temporary tables DROP TABLE IF EXISTS temp_nodes ; DROP TABLE IF EXISTS temp_edges ; COMMIT ; -- VACUUM and analyse VACUUM ANALYSE pgrouting . nodes ; VACUUM ANALYSE pgrouting . edges ;","title":"Import the road data into PgRouting graph (nodes and edges)"},{"location":"configuration/#import-data-in-the-poi-tables-optional","text":"Here is an example based on a \"point of interest\" layer loaded in a table called your_schema.point_of_interest . This query fill the pgrouting.routing_poi table. In the SELECT you can replace the fields by your fields of your point of interest layer. 1 2 3 INSERT INTO pgrouting . routing_poi ( label , type , description , geom ) SELECT poi . label , poi . type , poi . description , poi . geom FROM your_schema . point_of_interest AS poi ;","title":"Import data in the POI tables (optional)"},{"location":"configuration/#in-qgis","text":"","title":"In QGIS"},{"location":"configuration/#configure-the-qgis-project","text":"To use the pgrouting module in Lizmap Web Client you must first configure a QGIS project : You can download the PgRouting demo, in the \"Modules\" section which contains a basic project with only the layers required and configured for Lizmap. If you want to create your project or use another existing project to use this module: Add the edges and nodes layers with these exact names. You can rename them in the plugin. The QGIS project must be called pgrouting.qgs or contain a QGIS project variable called lizmap_pgrouting_enabled with the value yes You must then create a configuration for Lizmap with the Lizmap plugin . No specific configuration is needed for the module. You can configure like you want or just click on the apply button.","title":"Configure the QGIS project"},{"location":"contributing/","text":"Contribution # You can contribute to the SQL code or the frontend Lizmap interface. How to build JS # JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"Contribution"},{"location":"contributing/#contribution","text":"You can contribute to the SQL code or the frontend Lizmap interface.","title":"Contribution"},{"location":"contributing/#how-to-build-js","text":"JavaScript source code is in pgrouting/www/js/ directory and has to be build with ViteJS. 1 2 3 4 5 # Build for production npm run build # Build when developping. Sources are built when modified npm run watch","title":"How to build JS"},{"location":"installation/","text":"requirements # a PostgreSQL database with the postgis and pgrouting extensions installed Lizmap Web Client 3.5 or above Installation # Automatic installation of files with Composer # into lizmap/my-packages , create the file composer.json (if it doesn't exist) by copying the file composer.json.dist , and install the modules with Composer: 1 2 cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json composer require --working-dir = lizmap/my-packages \"lizmap/lizmap-pgrouting-module\" Manual installation of files without Composer # Get the last ZIP archive in the repository page . Extract the archive and copy the pgrouting directory (the one containing the module.xml file) into the Lizmap Web Client folder lizmap/lizmap-modules/ With Lizmap 3.5 or lower: edit the config file lizmap/var/config/localconfig.ini.php and add into the section [modules] : 1 pgrouting.access = 2 Launching the installer with Lizmap Web Client 3.6/3.7 # Use following instructions if you are using Lizmap Web Client 3.6 or higher . First you need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters, by replacing values with your own credentials. Only replace host, database, user and password values. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Then execute: 1 php lizmap/install/configurator.php pgrouting It will install some files, and ask you some parameters: The SRID (code of spatial coordinate system). It must correspond to the projection of your source data and will be used for the tables created by the module. Default is 2154 (French official code) The name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). Then, execute Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh A new schema pgrouting must be visible in your PostgreSQL database, containing the needed tables and functions used by the module. Launching the installer with Lizmap 3.5 # If you are using Lizmap Web Client 3.5 , you must manually edit the configuration file of your instance to specify some options. Edit the file lizmap/var/config/localconfig.ini.php and add the following variable in the section [modules] : 1 pgrouting.installparam = \"srid=2154 ;postgresql_user_group=gis_group\" You can replace: 2154 by another SRID that you use. It must correspond to the projection of your source data. gis_group must be replaced by the name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). You need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Only replace host, database, user and password values. Then, execute the Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh","title":"Installation"},{"location":"installation/#requirements","text":"a PostgreSQL database with the postgis and pgrouting extensions installed Lizmap Web Client 3.5 or above","title":"requirements"},{"location":"installation/#installation","text":"","title":"Installation"},{"location":"installation/#automatic-installation-of-files-with-composer","text":"into lizmap/my-packages , create the file composer.json (if it doesn't exist) by copying the file composer.json.dist , and install the modules with Composer: 1 2 cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json composer require --working-dir = lizmap/my-packages \"lizmap/lizmap-pgrouting-module\"","title":"Automatic installation of files with Composer"},{"location":"installation/#manual-installation-of-files-without-composer","text":"Get the last ZIP archive in the repository page . Extract the archive and copy the pgrouting directory (the one containing the module.xml file) into the Lizmap Web Client folder lizmap/lizmap-modules/ With Lizmap 3.5 or lower: edit the config file lizmap/var/config/localconfig.ini.php and add into the section [modules] : 1 pgrouting.access = 2","title":"Manual installation of files without Composer"},{"location":"installation/#launching-the-installer-with-lizmap-web-client-3637","text":"Use following instructions if you are using Lizmap Web Client 3.6 or higher . First you need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters, by replacing values with your own credentials. Only replace host, database, user and password values. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Then execute: 1 php lizmap/install/configurator.php pgrouting It will install some files, and ask you some parameters: The SRID (code of spatial coordinate system). It must correspond to the projection of your source data and will be used for the tables created by the module. Default is 2154 (French official code) The name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). Then, execute Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh A new schema pgrouting must be visible in your PostgreSQL database, containing the needed tables and functions used by the module.","title":"Launching the installer with Lizmap Web Client 3.6/3.7"},{"location":"installation/#launching-the-installer-with-lizmap-35","text":"If you are using Lizmap Web Client 3.5 , you must manually edit the configuration file of your instance to specify some options. Edit the file lizmap/var/config/localconfig.ini.php and add the following variable in the section [modules] : 1 pgrouting.installparam = \"srid=2154 ;postgresql_user_group=gis_group\" You can replace: 2154 by another SRID that you use. It must correspond to the projection of your source data. gis_group must be replaced by the name of the PostgreSQL role that need to be granted with write access on the tables in the PostgreSQL schema pgrouting (that will be created by the module installation script). You need to configure the database access in your Lizmap configuration. Add in lizmap/var/config/profiles.ini.php the following parameters. 1 2 3 4 5 6 7 8 9 [jdb:pgrouting] driver = pgsql host = pgsql port = 5432 database = lizmap user = lizmap password = \"yourpassword\" search_path = pgrouting,public Only replace host, database, user and password values. Then, execute the Lizmap install scripts into lizmap/install/ : 1 2 3 php lizmap/install/installer.php ./lizmap/install/clean_vartmp.sh ./lizmap/install/set_rights.sh","title":"Launching the installer with Lizmap 3.5"}]}
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index a6fd95f..ce2f733 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -2,37 +2,37 @@
https://docs.3liz.org/lizmap-pgrouting-module/
- 2024-02-13
+ 2024-06-17dailyhttps://docs.3liz.org/lizmap-pgrouting-module/CHANGELOG/
- 2024-02-13
+ 2024-06-17dailyhttps://docs.3liz.org/lizmap-pgrouting-module/CONTRIBUTING/
- 2024-02-13
+ 2024-06-17dailyhttps://docs.3liz.org/lizmap-pgrouting-module/changelog/
- 2024-02-13
+ 2024-06-17dailyhttps://docs.3liz.org/lizmap-pgrouting-module/configuration/
- 2024-02-13
+ 2024-06-17dailyhttps://docs.3liz.org/lizmap-pgrouting-module/contributing/
- 2024-02-13
+ 2024-06-17dailyhttps://docs.3liz.org/lizmap-pgrouting-module/installation/
- 2024-02-13
+ 2024-06-17daily
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 2e0a54b..81eaeab 100644
Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ