take into account group opacity for printing

mind84 · github-actions[bot] · commit 4e874cca56f9 · 2025-03-06T08:57:23.000Z
diff --git a/assets/src/components/Print.js b/assets/src/components/Print.js
@@ -245,7 +245,7 @@ export default class Print extends HTMLElement {
 
         // Add visible layers in defined order
         const orderedVisibleLayers = {};
-        mainLizmap.state.rootMapGroup.findMapLayers().forEach(layer => {
+        mainLizmap.state.rootMapGroup.findExplodedMapLayers().forEach(layer => {
             if (layer.visibility) {
                 orderedVisibleLayers[layer.layerOrder] = layer;
             }
@@ -267,9 +267,9 @@ export default class Print extends HTMLElement {
 
             // Handle qgis layer opacity otherwise client value override it
             if (layer.layerConfig?.opacity) {
-                opacityLayers.push(parseInt(255 * layer.opacity * layer.layerConfig.opacity));
+                opacityLayers.push(parseInt(255 * layer.calculateTotalOpacity() * layer.layerConfig.opacity));
             } else {
-                opacityLayers.push(parseInt(255 * layer.opacity));
+                opacityLayers.push(parseInt(255 * layer.calculateTotalOpacity()));
             }
             if ('FILTERTOKEN' in layerWmsParams) {
                 filter.push(layerWmsParams['FILTERTOKEN']);
diff --git a/assets/src/modules/state/Layer.js b/assets/src/modules/state/Layer.js
@@ -552,6 +552,19 @@ export class LayerItemState extends EventDispatcher {
         }
         return this._visibility;
     }
+
+    /**
+     * Calculate total opacity by including also all parent groups opacity values
+     * @returns {number} the total opacity
+     */
+    calculateTotalOpacity(){
+        let opacity = this.opacity;
+        if(this._parentGroup !== null){
+            opacity = opacity*this._parentGroup.calculateTotalOpacity();
+        }
+
+        return Math.round(opacity * 100) / 100;
+    }
 }
 
 /**
diff --git a/assets/src/modules/state/MapLayer.js b/assets/src/modules/state/MapLayer.js
@@ -424,6 +424,30 @@ export class MapGroupState extends MapItemState {
         return layersCount;
     }
 
+    /**
+     * Find all layers by exploding the layers within every "group as layer" groups
+     * @returns {LayerLayerState[]} The layer states of listed layers
+    */
+    findExplodedMapLayers(){
+        let layers = [];
+        for(const item of this.getChildren()) {
+            if (item instanceof MapLayerState) {
+                const itemState = item.itemState;
+                if(itemState instanceof LayerGroupState && itemState.groupAsLayer){
+                    //count the layers inside the group
+                    layers = layers.concat(itemState.findLayers());
+                }
+                else if(itemState instanceof LayerLayerState){
+                    layers.push(item.itemState);
+                }
+            } else if (item instanceof MapGroupState) {
+                layers = layers.concat(item.findExplodedMapLayers());
+            }
+        }
+
+        return layers;
+    }
+
     /**
      * Find layer items
      * @returns {MapLayerState[]} The layer names of all map layers
diff --git a/tests/end2end/playwright/pages/printpage.js b/tests/end2end/playwright/pages/printpage.js
@@ -0,0 +1,83 @@
+// @ts-check
+import { expect } from '@playwright/test';
+import { ProjectPage } from './project';
+
+/**
+ * Playwright Page
+ * @typedef {import('@playwright/test').Page} Page
+ */
+
+/**
+ * Playwright Page
+ * @typedef {import('@playwright/test').Locator} Locator
+ */
+
+export class PrintPage extends ProjectPage {
+    // Metadata
+    /**
+     * The print panel
+     * @type {Locator}
+     */
+    printPanel;
+
+    /**
+     * The print button on menu
+     * @type {Locator}
+     */
+    printSwitcherButton;
+
+    /**
+     * The print scale combobox
+     * @type {Locator}
+     */
+    printScale;
+
+    /**
+     * The launch print button on print panel
+     * @type {Locator}
+     */
+    launchPrintButton;
+
+    /**
+     * Constructor for a QGIS project page
+     * @param {Page} page The playwright page
+     * @param {string} project The project name
+     * @param {string} repository The repository name, default to testsrepository
+     */
+    constructor(page, project, repository = 'testsrepository') {
+        super(page, project, repository);
+
+        this.printPanel = page.locator('#print');
+        this.printSwitcherButton = page.locator('#button-print');
+        this.launchPrintButton = page.locator('#print-launch');
+        this.printScaleCombobox = page.locator('#print-scale');
+    }
+
+    /**
+     * openPrintPanel function
+     * opens the print mini-dock panel
+     */
+    async openPrintPanel() {
+        await this.page.locator('#button-print').click();
+    }
+
+    /**
+     * setPrintScale function
+     * Set the print scale
+     * @param {string} scale The scale
+     */
+    async setPrintScale(scale) {
+        await this.printScaleCombobox.selectOption(scale);
+    }
+
+    /**
+     * launchPrint function
+     * Launch print
+     */
+    async launchPrint() {
+        // Launch print
+        await this.launchPrintButton.click();
+        // check message
+        await expect(this.page.locator('div.alert')).toHaveCount(1);
+    }
+}
diff --git a/tests/end2end/playwright/pages/project.js b/tests/end2end/playwright/pages/project.js
@@ -174,6 +174,27 @@ export class ProjectPage extends BasePage {
         await this.page.locator('#attribute-layer-list-table').locator(`button[value=${layer}]`).click();
     }
 
+    /**
+     * openLayerInfo function
+     * Open the info layer panel for the given layer
+     * @param {string} layer Name of the layer
+     */
+    async openLayerInfo(layer) {
+        await this.page.getByTestId(layer).locator('.node').first().hover();
+        await this.page.getByTestId(layer).locator('.layer-actions').first().locator('i.icon-info-sign').click();
+    }
+
+    /**
+     * setLayerOpacity function
+     * Open the info layer panel for the given layer
+     * @param {string} layer Name of the layer
+     * @param {string} opacity Layer opacity, possible values '0','20','40','60','80','100'
+     */
+    async setLayerOpacity(layer, opacity = '100') {
+        await this.openLayerInfo(layer);
+        await this.page.getByRole('link', { name: opacity }).click();
+    }
+
     /**
      * editingSubmitForm function
      * Submit the form
diff --git a/tests/end2end/playwright/print.spec.js b/tests/end2end/playwright/print.spec.js
@@ -1,5 +1,6 @@
 // @ts-check
 import { test, expect } from '@playwright/test';
+import {PrintPage} from "./pages/printpage";
 import { gotoMap, expectParametersToContain, getAuthStorageStatePath, expectToHaveLengthCompare } from './globals';
 
 test.describe('Print', () => {
@@ -335,6 +336,153 @@ test.describe('Print', () => {
     });
 });
 
+test.describe(
+    'Print opacities',
+    {
+        tag: ['@readonly'],
+    },() =>
+    {
+
+        test('Group as layer', async ({ page }) => {
+
+            const printPage = new PrintPage(page, 'group_as_layer_opacity');
+            await printPage.open();
+            await printPage.openPrintPanel();
+            await printPage.setPrintScale('50000');
+
+            // set opacity of `Group_opacity` (group as layer) layer to 60%
+            await printPage.setLayerOpacity('Group_opacity','60');
+
+            // opacity notes:
+            // the `raster` layer already has 80% opacity (inherited from QGIS project)
+            // setting the opacity to 60% on the `Group_opacity` causes:
+            // - `raster` layer to have a final total opacity of 48% (0.8*0.6)
+            //          -> OPACITIES PARAM = 255*0.48 ~= 122
+            // - `single_wms_polygons` layer to have a final total opacity of 60% (1*0.6)
+            //          -> OPACITIES PARAM = 255*0.6 = 153
+            // other layers have opacity 100% (255)
+
+            const mapLayers = [
+                'OpenStreetMap',
+                'raster',
+                'single_wms_polygons',
+                'single_wms_polygons_group_as_layer',
+                'single_wms_points_group',
+            ]
+
+            const expectedParameters = {
+                'SERVICE': 'WMS',
+                'REQUEST': 'GetPrint',
+                'VERSION': '1.3.0',
+                'FORMAT': 'pdf',
+                'TRANSPARENT': 'true',
+                'CRS': 'EPSG:3857',
+                'DPI': '100',
+                'TEMPLATE': 'test',
+                'map0:EXTENT': /425189.\d+,5401412.\d+,439539.\d+,5411262.\d+/,
+                'map0:SCALE': '50000',
+                'map0:LAYERS': mapLayers.join(','),
+                'map0:STYLES': 'default,default,default,default,default',
+                'map0:OPACITIES': '255,122,153,255,255',
+            }
+            // Test `test` template
+            let getPrintPromise = page.waitForRequest(
+                request =>
+                    request.method() === 'POST' &&
+                    request.postData()?.includes('GetPrint') === true
+            );
+
+            // Launch print
+            await printPage.launchPrint();
+
+            // check request
+            let getPrintRequest = await getPrintPromise;
+
+            // check response parameters
+            let name = "Group as layer opacity requests";
+            let getPrintParams = await expectParametersToContain(
+                name, getPrintRequest.postData() ?? '', expectedParameters);
+
+            await expectToHaveLengthCompare(
+                name,
+                Array.from(getPrintParams.keys()),
+                13,
+                Object.keys(expectedParameters)
+            );
+        })
+
+        test('Layers in group with opacity', async ({ page }) => {
+            const printPage = new PrintPage(page, 'group_as_layer_opacity');
+            await printPage.open();
+            await printPage.openPrintPanel();
+            await printPage.setPrintScale('50000');
+
+            // set opacity of `Group_a` group opacity to 60%
+            await printPage.setLayerOpacity('Group_a','60');
+            // set opacity of `single_wms_points_group` (belonging to `Group_a`) layer to 40%
+            await printPage.setLayerOpacity('single_wms_points_group','40');
+            // set opacity of `single_wms_polygons_group_as_layer` (belonging to `Group_a`) layer to 80%
+            await printPage.setLayerOpacity('single_wms_polygons_group_as_layer','80');
+
+            // opacity notes:
+            // setting the opacity to 60% on `Group_a` causes:
+            // - `single_wms_points_group` layer to have a final total opacity of 24% (0.4*0.6) 
+            //              -> OPACITIES PARAM = 255*0.24 ~= 61
+            // - `single_wms_polygons_group_as_layer` layer to have a final total opacity of 48% (0.8*0.6) 
+            //              -> OPACITIES PARAM = 255*0.48 ~= 122
+            // other layers have opacity 100%, except for `raster` layer which has a 80% opacity by default,
+            // resulting in a OPACITIES PARAM = 255*0.8 = 204
+
+            const mapLayers = [
+                'OpenStreetMap',
+                'raster',
+                'single_wms_polygons',
+                'single_wms_polygons_group_as_layer',
+                'single_wms_points_group',
+            ]
+
+            const expectedParameters = {
+                'SERVICE': 'WMS',
+                'REQUEST': 'GetPrint',
+                'VERSION': '1.3.0',
+                'FORMAT': 'pdf',
+                'TRANSPARENT': 'true',
+                'CRS': 'EPSG:3857',
+                'DPI': '100',
+                'TEMPLATE': 'test',
+                'map0:EXTENT': /425189.\d+,5401412.\d+,439539.\d+,5411262.\d+/,
+                'map0:SCALE': '50000',
+                'map0:LAYERS': mapLayers.join(','),
+                'map0:STYLES': 'default,default,default,default,default',
+                'map0:OPACITIES': '255,204,255,122,61',
+            }
+            // Test `test` template
+            let getPrintPromise = page.waitForRequest(
+                request =>
+                    request.method() === 'POST' &&
+                    request.postData()?.includes('GetPrint') === true
+            );
+
+            // Launch print
+            await printPage.launchPrint();
+
+            // check request
+            let getPrintRequest = await getPrintPromise;
+
+            // check response parameters
+            let name = "Layers in group with opacity request";
+            let getPrintParams = await expectParametersToContain(
+                name, getPrintRequest.postData() ?? '', expectedParameters);
+            await expectToHaveLengthCompare(
+                name,
+                Array.from(getPrintParams.keys()),
+                13,
+                Object.keys(expectedParameters)
+            );
+        })
+    }
+);
+
 test.describe('Print in popup', () => {
     test.beforeEach(async ({ page }) => {
         const url = '/index.php/view/map/?repository=testsrepository&project=print';
diff --git a/tests/qgis-projects/tests/group_as_layer_opacity.qgs b/tests/qgis-projects/tests/group_as_layer_opacity.qgs
diff --git a/tests/qgis-projects/tests/group_as_layer_opacity.qgs.cfg b/tests/qgis-projects/tests/group_as_layer_opacity.qgs.cfg

Original file line number	Diff line number	Diff line change
`@@ -552,6 +552,19 @@ export class LayerItemState extends EventDispatcher {`
`552`	`552`	`}`
`553`	`553`	`return this._visibility;`
`554`	`554`	`}`
	`555`	`+`
	`556`	`+ /**`
	`557`	`+ * Calculate total opacity by including also all parent groups opacity values`
	`558`	`+ * @returns {number} the total opacity`
	`559`	`+ */`
	`560`	`+ calculateTotalOpacity(){`
	`561`	`+ let opacity = this.opacity;`
	`562`	`+ if(this._parentGroup !== null){`
	`563`	`+ opacity = opacity*this._parentGroup.calculateTotalOpacity();`
	`564`	`+ }`
	`565`	`+`
	`566`	`+ return Math.round(opacity * 100) / 100;`
	`567`	`+ }`
`555`	`568`	`}`
`556`	`569`
`557`	`570`	`/**`