Floating Dynamic Legend Plugin for ArcGIS & WMS layers #11118
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -412,7 +412,7 @@ | |
| { "name": "WidgetsTray" } | ||
| ], | ||
| "desktop": [ | ||
| "Details","DynamicLegend", | ||
|
||
| { | ||
| "name": "BrandNavbar", | ||
| "cfg": { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -76,6 +76,9 @@ | |
| } | ||
| ], | ||
| "desktop": [ | ||
| { | ||
| "name": "DynamicLegend" | ||
| }, | ||
|
||
| { | ||
| "name": "Map", | ||
| "cfg": { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* eslint-disable react/jsx-boolean-value */ | ||
| import React from 'react'; | ||
| import { connect } from 'react-redux'; | ||
| import { createSelector } from 'reselect'; | ||
| import { get } from 'lodash'; | ||
| import { Glyphicon } from 'react-bootstrap'; | ||
|
|
||
| import { createPlugin } from '../utils/PluginsUtils'; | ||
| import { groupsSelector, layersSelector } from '../selectors/layers'; | ||
| import { keepLayer } from '../selectors/dynamiclegend'; | ||
| import { mapSelector } from '../selectors/map'; | ||
| import { updateNode } from '../actions/layers'; | ||
| import controls from '../reducers/controls'; | ||
| import { toggleControl } from '../actions/controls'; | ||
| import Message from '../components/I18N/Message'; | ||
|
|
||
| import DynamicLegend from './dynamicLegend/components/DynamicLegend'; | ||
|
|
||
| export default createPlugin('DynamicLegend', { | ||
| component: connect( | ||
| createSelector([ | ||
| (state) => get(state, 'controls.dynamic-legend.enabled'), | ||
| groupsSelector, | ||
| layersSelector, | ||
| mapSelector | ||
| ], (isVisible, groups, layers, map) => ({ | ||
| isVisible, | ||
| groups, | ||
| layers: layers.filter(keepLayer), | ||
| currentZoomLvl: map?.zoom, | ||
| mapBbox: map?.bbox | ||
| })), | ||
| { | ||
| onClose: toggleControl.bind(null, 'dynamic-legend', null), | ||
| onUpdateNode: updateNode | ||
| } | ||
| )(DynamicLegend), | ||
| options: { | ||
| disablePluginIf: "{state('router') && (state('router').endsWith('new') || state('router').includes('newgeostory') || state('router').endsWith('dashboard'))}" | ||
| }, | ||
|
||
| reducers: { controls }, | ||
| epics: {}, | ||
| containers: { | ||
| BurgerMenu: { | ||
| name: 'dynamic-legend', | ||
| position: 1000, | ||
| priority: 2, | ||
| doNotHide: true, | ||
| text: <Message msgId="dynamiclegend.title" />, | ||
| tooltip: <Message msgId="dynamiclegend.tooltip" />, | ||
| icon: <Glyphicon glyph="align-left" />, | ||
| action: toggleControl.bind(null, 'dynamic-legend', null), | ||
| toggle: true | ||
| }, | ||
| SidebarMenu: { | ||
| name: 'dynamic-legend', | ||
| position: 1000, | ||
| priority: 1, | ||
| doNotHide: true, | ||
| text: <Message msgId="dynamiclegend.title" />, | ||
| tooltip: <Message msgId="dynamiclegend.tooltip" />, | ||
| icon: <Glyphicon glyph="align-left" />, | ||
| action: toggleControl.bind(null, 'dynamic-legend', null), | ||
| toggle: true | ||
| }, | ||
| Toolbar: { | ||
| name: 'dynamic-legend', | ||
| alwaysVisible: true, | ||
| position: 2, | ||
| priority: 0, | ||
| doNotHide: true, | ||
| tooltip: <Message msgId="dynamiclegend.title" />, | ||
| icon: <Glyphicon glyph="align-left" />, | ||
| action: toggleControl.bind(null, 'dynamic-legend', null), | ||
| toggle: true | ||
| } | ||
| } | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,9 +17,11 @@ import { getLayerIds } from '../../../utils/ArcGISUtils'; | |
| /** | ||
| * ArcGISLegend renders legend from a MapServer or ImageServer service | ||
| * @prop {object} node layer node options | ||
| * @prop {function} onUpdateNode return the changes of a specific node | ||
| */ | ||
| function ArcGISLegend({ | ||
| node = {}, | ||
| onUpdateNode = () => {} | ||
| }) { | ||
| const [legendData, setLegendData] = useState(null); | ||
| const [error, setError] = useState(false); | ||
|
|
@@ -31,7 +33,13 @@ function ArcGISLegend({ | |
| f: 'json' | ||
| } | ||
| }) | ||
| .then(({ data }) => { | ||
| const dynamicLegendIsEmpty = data.layers.every(layer => layer.legend.length === 0); | ||
| if ((node.dynamicLegendIsEmpty ?? null) !== dynamicLegendIsEmpty) { | ||
| onUpdateNode({ dynamicLegendIsEmpty }); | ||
| } | ||
|
||
| setLegendData(data); | ||
| }) | ||
| .catch(() => setError(true)); | ||
| } | ||
| }, [legendUrl]); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,6 +35,7 @@ import { getWMSLegendConfig, LEGEND_FORMAT } from '../../../utils/LegendUtils'; | |
| * @prop {string} language current language code | ||
| * @prop {number} legendWidth width of the legend symbols | ||
| * @prop {number} legendHeight height of the legend symbols | ||
| * @prop {function} onUpdateNode return the changes of a specific node | ||
| */ | ||
| class Legend extends React.Component { | ||
| static propTypes = { | ||
|
|
@@ -49,15 +50,17 @@ class Legend extends React.Component { | |
| language: PropTypes.string, | ||
| projection: PropTypes.string, | ||
| mapSize: PropTypes.object, | ||
| bbox: PropTypes.object, | ||
| onUpdateNode: PropTypes.func | ||
| }; | ||
|
|
||
| static defaultProps = { | ||
| legendHeight: 12, | ||
| legendWidth: 12, | ||
| legendOptions: "forceLabels:on", | ||
| style: {maxWidth: "100%"}, | ||
| scaleDependent: true, | ||
| onUpdateNode: () => {} | ||
| }; | ||
| state = { | ||
| error: false | ||
|
|
@@ -132,9 +135,13 @@ class Legend extends React.Component { | |
| validateImg = (img) => { | ||
| // GeoServer response is a 1x2 px size when legend is not available. | ||
| // In this case we need to show the "Legend Not available" message | ||
| const imgError = img.height <= 1 && img.width <= 2; | ||
| if (imgError) { | ||
| this.onImgError(); | ||
| } | ||
| if ((this.props.layer.dynamicLegendIsEmpty ?? null) !== imgError) { | ||
| this.props.onUpdateNode({ dynamicLegendIsEmpty: imgError }); | ||
| } | ||
|
||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,7 +46,8 @@ class StyleBasedWMSJsonLegend extends React.Component { | |
| interactive: PropTypes.bool, // the indicator flag that refers if this legend is interactive or not | ||
| projection: PropTypes.string, | ||
| mapSize: PropTypes.object, | ||
| mapBbox: PropTypes.object, | ||
| onUpdateNode: PropTypes.func | ||
| }; | ||
|
|
||
| static defaultProps = { | ||
|
|
@@ -56,7 +57,8 @@ class StyleBasedWMSJsonLegend extends React.Component { | |
| style: {maxWidth: "100%"}, | ||
| scaleDependent: true, | ||
| onChange: () => {}, | ||
| interactive: false, | ||
| onUpdateNode: () => {} | ||
| }; | ||
| state = { | ||
| error: false, | ||
|
|
@@ -104,6 +106,10 @@ class StyleBasedWMSJsonLegend extends React.Component { | |
| } | ||
| this.setState({ loading: true }); | ||
| getJsonWMSLegend(jsonLegendUrl).then(data => { | ||
| const dynamicLegendIsEmpty = data.length === 0 || data[0].rules.length === 0; | ||
| if ((this.props.layer.dynamicLegendIsEmpty ?? null) !== dynamicLegendIsEmpty) { | ||
| this.props.onUpdateNode({ dynamicLegendIsEmpty }); | ||
| } | ||
|
||
| this.setState({ jsonLegend: data[0], loading: false }); | ||
| }).catch(() => { | ||
| this.setState({ error: true, loading: false }); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| .ms-resizable-modal > .modal-content.legend-dialog { | ||
| top: 0vh; | ||
| right: -100vw; | ||
| } | ||
|
|
||
| .legend-content * .ms-node-title { | ||
| font-weight: bold !important | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import React from 'react'; | ||
| import { keepNode, isLayerVisible } from '../../../selectors/dynamiclegend'; | ||
| import { getResolutions } from '../../../utils/MapUtils'; | ||
| import Message from '../../../components/I18N/Message'; | ||
| import ResizableModal from '../../../components/misc/ResizableModal'; | ||
| import { ControlledTOC } from '../../TOC/components/TOC'; | ||
| import DefaultGroup from '../../TOC/components/DefaultGroup'; | ||
| import DefaultLayer from '../../TOC/components/DefaultLayer'; | ||
|
|
||
| import '../assets/dynamicLegend.css'; | ||
|
|
||
| function applyVersionParamToLegend(layer) { | ||
| // we need to pass a parameter that invalidate the cache for GetLegendGraphic | ||
| // all layer inside the dataset viewer apply a new _v_ param each time we switch page | ||
| return { ...layer, legendParams: { ...layer?.legendParams, _v_: layer?._v_ } }; | ||
| } | ||
|
|
||
| function filterNode(node, currentResolution) { | ||
| const nodes = Array.isArray(node.nodes) ? node.nodes.filter(keepNode).map(applyVersionParamToLegend).map(n => filterNode(n, currentResolution)) : undefined; | ||
|
|
||
| return { | ||
| ...node, | ||
| isVisible: (node.visibility ?? true) && (nodes ? nodes.length > 0 && nodes.some(n => n.isVisible) : isLayerVisible(node, currentResolution)), | ||
| ...(nodes && { nodes }) | ||
| }; | ||
| } | ||
|
|
||
| export default ({ | ||
| layers, | ||
| onUpdateNode, | ||
| currentZoomLvl, | ||
| onClose, | ||
| isVisible, | ||
| groups, | ||
| mapBbox | ||
| }) => { | ||
| const layerDict = layers.reduce((acc, layer) => ({ | ||
| ...acc, | ||
| ...{ | ||
| [layer.id]: { | ||
| ...layer, | ||
| ...{enableDynamicLegend: true, enableInteractiveLegend: false} | ||
| } | ||
| } | ||
| }), {}); | ||
| const getVisibilityStyle = nodeVisibility => ({ | ||
| opacity: nodeVisibility ? 1 : 0, | ||
| height: nodeVisibility ? "auto" : "0" | ||
| }); | ||
|
|
||
| const customGroupNodeComponent = props => ( | ||
| <div style={getVisibilityStyle(props.node?.isVisible ?? true)}> | ||
| <DefaultGroup {...props} /> | ||
| </div> | ||
| ); | ||
| const customLayerNodeComponent = props => { | ||
| const layer = layerDict[props.node.id]; | ||
| if (!layer) { | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <div style={getVisibilityStyle(props.node?.isVisible ?? true)}> | ||
| <DefaultLayer {...props} node={layer} /> | ||
| </div> | ||
| ); | ||
| }; | ||
|
||
|
|
||
| return ( | ||
| <ResizableModal | ||
| onClose = {onClose} | ||
| enableFooter={false} | ||
| title={<Message msgId="dynamiclegend.title" />} | ||
| dialogClassName=" legend-dialog" | ||
| show={isVisible} | ||
| draggable | ||
| style={{zIndex: 1993}}> | ||
| <ControlledTOC | ||
| tree={[filterNode(groups[0] ?? {}, getResolutions()[Math.round(currentZoomLvl)])]} | ||
| className="legend-content" | ||
| theme="legend" | ||
| onChange={onUpdateNode} | ||
| groupNodeComponent={customGroupNodeComponent} | ||
| layerNodeComponent={customLayerNodeComponent} | ||
| config={{ | ||
| sortable: false, | ||
| showFullTitle: true, | ||
| hideOpacitySlider: true, | ||
| hideVisibilityButton: true, | ||
| expanded: true, | ||
| zoom: currentZoomLvl, | ||
| layerOptions: { | ||
| enableDynamicLegend: true, | ||
| legendOptions: { | ||
| legendWidth: 12, | ||
| legendHeight: 12, | ||
| mapBbox | ||
| } | ||
| } | ||
| }} | ||
| /> | ||
| </ResizableModal> | ||
| ); | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In allyoucanmap@a11b673 only the SidebarMenu is included as dependency because is the current preferred container for all side plugins