#9825: Add an config option to enable mapInfo highlight by default

web/client/actions/__tests__/mapInfo-test.js

@@ -42,7 +42,9 @@ import {
     checkIdentifyIsMounted,
     IDENTIFY_IS_MOUNTED,
     onInitPlugin,
-    INIT_PLUGIN
+    INIT_PLUGIN,
+    INIT_IDENTIFY_HIGHLIGHT,
+    initiateOrResetHighlight
 } from '../mapInfo';
 
 describe('Test correctness of the map actions', () => {
@@ -166,4 +168,10 @@ describe('Test correctness of the map actions', () => {
     it('onInitPlugin', () => {
         expect(onInitPlugin({cfg1: false})).toEqual({type: INIT_PLUGIN, cfg: {cfg1: false} });
     });
+    it('initiateOrResetHighlight if highlight default value equal true', () => {
+        expect(initiateOrResetHighlight(true)).toEqual({type: INIT_IDENTIFY_HIGHLIGHT, identifyHighlight: true });
+    });
+    it('initiateOrResetHighlight if highlight default value equal false', () => {
+        expect(initiateOrResetHighlight(false)).toEqual({type: INIT_IDENTIFY_HIGHLIGHT, identifyHighlight: false });
+    });
 });

web/client/actions/mapInfo.js

@@ -38,6 +38,7 @@ export const TOGGLE_EMPTY_MESSAGE_GFI = "IDENTIFY:TOGGLE_EMPTY_MESSAGE_GFI";
 export const SET_SHOW_IN_MAP_POPUP = "IDENTIFY:SET_SHOW_IN_MAP_POPUP";
 export const IDENTIFY_IS_MOUNTED = "IDENTIFY:IDENTIFY_IS_MOUNTED";
 export const INIT_PLUGIN = 'IDENTIFY:INIT_PLUGIN';
+export const INIT_IDENTIFY_HIGHLIGHT = 'IDENTIFY:INIT_IDENTIFY_HIGHLIGHT';
 
 export const toggleEmptyMessageGFI = () => ({type: TOGGLE_EMPTY_MESSAGE_GFI});
 
@@ -288,3 +289,9 @@ export const checkIdentifyIsMounted = (isMounted)=> ({
 });
 
 export const onInitPlugin = (cfg) => ({type: INIT_PLUGIN, cfg});
+/**
+ * Action performed when the identify component opened to initiate the default value of highight
+ * @param {boolean} highlight
+ * @returns {{type: string, identifyHighlight: boolean}}
+ */
+export const initiateOrResetHighlight = (highlight) => ({type: INIT_IDENTIFY_HIGHLIGHT, identifyHighlight: highlight});

web/client/components/data/identify/IdentifyContainer.jsx

@@ -71,9 +71,10 @@ export default props => {
         formatCoord,
         loaded,
         validator = () => null,
-        toggleHighlightFeature = () => {},
         disableCoordinatesRow,
-        disableInfoAlert
+        disableInfoAlert,
+        initiateOrResetHighlight,
+        pluginCfg
     } = props;
     const latlng = point && point.latlng || null;
 
@@ -122,7 +123,7 @@ export default props => {
             draggable={draggable}
             onClose={() => {
                 onClose();
-                toggleHighlightFeature(false);
+                initiateOrResetHighlight(pluginCfg?.identifyHighlight || false);
             }}
             dock={dock}
             style={dockStyle}

web/client/components/data/identify/__tests__/IdentifyContainer-test.jsx

@@ -257,12 +257,12 @@ describe("test IdentifyContainer", () => {
         expect(glyphIcons.forEach(glyph => glyph.className) !== 'zoom-to').toBeTruthy();
     });
 
-    it('test call toggleHighlightFeature on Close', () => {
+    it('test call initiateOrResetHighlight on Close', () => {
         const requests = [{reqId: 1}, {reqId: 2}];
         const callbacks = {
-            toggleHighlightFeature: () => {}
+            initiateOrResetHighlight: () => {}
         };
-        const toggleHighlightFeatureSpy = expect.spyOn(callbacks, 'toggleHighlightFeature');
+        const initiateOrResetHighlightSpy = expect.spyOn(callbacks, 'initiateOrResetHighlight');
         const responses = [{layerMetadata: {title: "Layer 1"}}, {layerMetadata: {title: "Layer 2"}}];
         const CMP = (<IdentifyContainer
             enabled
@@ -272,7 +272,7 @@ describe("test IdentifyContainer", () => {
             getFeatureButtons={getFeatureButtons}
             point={{latlng: {lat: 1, lng: 1}}}
             showCoordinateEditor={false}
-            toggleHighlightFeature={callbacks.toggleHighlightFeature}
+            initiateOrResetHighlight={callbacks.initiateOrResetHighlight}
         />);
         ReactDOM.render(CMP, document.getElementById("container"));
         const container = document.getElementById('container');
@@ -281,7 +281,7 @@ describe("test IdentifyContainer", () => {
         TestUtils.act(() => {
             ReactDOM.render(CMP, document.getElementById("container"));
         });
-        expect(toggleHighlightFeatureSpy).toHaveBeenCalled();
+        expect(initiateOrResetHighlightSpy).toHaveBeenCalled();
         // Test since when the highlight feature is disabled the zoom Icon is not shown
         const zoomIcon = document.querySelector('.glyphicon-zoom-to');
         expect(zoomIcon).toNotExist();

web/client/components/data/identify/enhancers/identify.js

@@ -78,7 +78,8 @@ export const identifyLifecycle = compose(
                 onEnableCenterToMarker = () => {},
                 setShowInMapPopup = () => {},
                 checkIdentifyIsMounted = () => {},
-                onInitPlugin = () => {}
+                onInitPlugin = () => {},
+                initiateOrResetHighlight = () => {}
             } = this.props;
 
             // Initialize plugin configuration
@@ -89,7 +90,7 @@ export const identifyLifecycle = compose(
                 },
                 showAllResponses
             });
-
+            initiateOrResetHighlight(this.props?.pluginCfg?.identifyHighlight || false);
             if (enabled || showInMapPopup) {
                 changeMousePointer('pointer');
                 checkIdentifyIsMounted(true);

web/client/configs/localConfig.json

@@ -408,6 +408,7 @@
                 "name": "Identify",
                 "cfg": {
                     "showHighlightFeatureButton": true,
+                    "identifyHighlight":false,
                     "viewerOptions": {
                         "container": "{context.ReactSwipe}"
                     },

web/client/plugins/Identify.jsx

@@ -36,7 +36,8 @@ import {
     updateCenterToMarker,
     updateFeatureInfoClickPoint,
     checkIdentifyIsMounted,
-    onInitPlugin
+    onInitPlugin,
+    initiateOrResetHighlight
 } from '../actions/mapInfo';
 import DefaultViewerComp from '../components/data/identify/DefaultViewer';
 import { defaultViewerDefaultProps, defaultViewerHandlers } from '../components/data/identify/enhancers/defaultViewer';
@@ -196,6 +197,7 @@ const identifyDefaultProps = defaultProps({
  * @prop cfg.dock {bool} true shows dock panel, false shows modal
  * @prop cfg.draggable {boolean} draggable info window, when modal
  * @prop cfg.showHighlightFeatureButton {boolean} show the highlight feature button if the interrogation returned valid features (openlayers only)
+ * @prop cfg.identifyHighlight {boolean} the highlight feature button will be activated by default if true
  * @prop cfg.viewerOptions.container {expression} the container of the viewer, expression from the context
  * @prop cfg.viewerOptions.header {expression} the header of the viewer, expression from the context{expression}
  * @prop cfg.disableCenterToMarker {bool} disable zoom to marker action
@@ -225,6 +227,7 @@ const identifyDefaultProps = defaultProps({
 const IdentifyPlugin = compose(
     connect(selector, {
         onInitPlugin,
+        initiateOrResetHighlight,
         purgeResults: purgeMapInfoResults,
         closeIdentify,
         onSubmitClickPoint: updateFeatureInfoClickPoint,

web/client/reducers/__tests__/mapInfo-test.js

@@ -20,7 +20,8 @@ import {
     toggleHighlightFeature,
     setMapTrigger,
     setShowInMapPopup,
-    onInitPlugin
+    onInitPlugin,
+    initiateOrResetHighlight
 } from '../../actions/mapInfo';
 import {changeVisualizationMode} from '../../actions/maptype';
 import { MAP_CONFIG_LOADED } from '../../actions/config';
@@ -449,4 +450,14 @@ describe('Test the mapInfo reducer', () => {
         expect(state.cfg1).toEqual("test");
         expect(state.configuration).toEqual({maxItems: 3});
     });
+    it('initiateOrResetHighlight if highlight default value equal true', () => {
+        const initialState = { configuration: {} };
+        const state = mapInfo(initialState, initiateOrResetHighlight(true));
+        expect(state.highlight).toEqual(true);
+    });
+    it('initiateOrResetHighlight if highlight default value equal false', () => {
+        const initialState = { configuration: {} };
+        const state = mapInfo(initialState, initiateOrResetHighlight(false));
+        expect(state.highlight).toEqual(false);
+    });
 });

web/client/reducers/mapInfo.js

@@ -35,7 +35,8 @@ import {
     SET_CURRENT_EDIT_FEATURE_QUERY,
     SET_MAP_TRIGGER,
     SET_SHOW_IN_MAP_POPUP,
-    INIT_PLUGIN
+    INIT_PLUGIN,
+    INIT_IDENTIFY_HIGHLIGHT
 } from '../actions/mapInfo';
 import { VISUALIZATION_MODE_CHANGED } from '../actions/maptype';
 
@@ -410,6 +411,12 @@ function mapInfo(state = initState, action) {
             }
         };
     }
+    case INIT_IDENTIFY_HIGHLIGHT: {
+        return {
+            ...state,
+            highlight: action.identifyHighlight
+        };
+    }
     default:
         return state;
     }