Interactive interface for browsing global, full-resolution satellite imagery
WV-2373: Adding Coordinate Format Selection to Settings Menu (#3946)
Ryan Weilera56bda7d04b6
diff --git a/e2e/features/global-unit/coordinate-format-test.js b/e2e/features/global-unit/coordinate-format-test.jsnew file mode 100644index 000000000..b25230992--- /dev/null+++ b/e2e/features/global-unit/coordinate-format-test.js@@ -0,0 +1,68 @@+const reuseables = require('../../reuseables/skip-tour.js');+const localSelectors = require('../../reuseables/selectors.js');++const {+ infoToolbarButton,+} = localSelectors;++const TIME_LIMIT = 5000;+const settingsInfoItem = '#settings_info_item';+const globalSettingsModal = '#global_settings_modal';+const latlondmSettingsButton = '#latlon-dm-btn';+const latlonddSettingsButton = '#latlon-dd-btn';+const tooltipCoordinates = '.tooltip-coordinates';+const coordinatesMapBtn = '#coords-panel';+const copyCoordsToClipboardBtn = '#copy-coordinates-to-clipboard-button';++const locationMarkerQueryString = '?v=-97.7284840660436,15.91105901837444,-63.44259121174646,45.128898266232824&s=-81.3507,28.5946&t=2022-08-09-T15%3A32%3A01Z';++module.exports = {+ before: (c) => {+ reuseables.loadAndSkipTour(c, TIME_LIMIT);+ },++ 'Click the change coordinate format map button changes the active coordinate format selection in global settings': (c) => {+ c.url(c.globals.url + locationMarkerQueryString);++ c.click(copyCoordsToClipboardBtn);+ c.pause(500);++ c.waitForElementVisible(coordinatesMapBtn, TIME_LIMIT);+ c.click(coordinatesMapBtn);++ c.click(infoToolbarButton);++ c.waitForElementVisible(settingsInfoItem, TIME_LIMIT);+ c.click(settingsInfoItem);++ c.waitForElementVisible(globalSettingsModal);+ c.pause(500);++ c.expect+ .element(latlondmSettingsButton)+ .to.have.property('className').contains('active');+ },++ 'Selecting LATLON-DD in Global Settings changes coordinate format in location marker': (c) => {+ c.url(c.globals.url + locationMarkerQueryString);++ c.click(infoToolbarButton);++ c.waitForElementVisible(settingsInfoItem, TIME_LIMIT);+ c.click(settingsInfoItem);++ c.waitForElementVisible(globalSettingsModal);+ c.pause(500);++ c.click(latlonddSettingsButton);+ c.pause(500);++ c.expect+ .element(tooltipCoordinates)+ .text.to.contain('28.5946°, -81.3507°');+ },++ after: (c) => {+ c.end();+ },+};diff --git a/package-lock.json b/package-lock.jsonindex 8570777fc..df34f5107 100644--- a/package-lock.json+++ b/package-lock.json@@ -5063,13 +5063,13 @@"dev": true,"hasInstallScript": true,"dependencies": {- "@testim/chrome-version": "^1.1.2",- "axios": "^0.27.2",- "del": "^6.0.0",- "extract-zip": "^2.0.1",- "https-proxy-agent": "^5.0.0",- "proxy-from-env": "^1.1.0",- "tcp-port-used": "^1.0.1"+ "@testim/chrome-version": "^1.1.2",+ "axios": "^0.27.2",+ "del": "^6.0.0",+ "extract-zip": "^2.0.1",+ "https-proxy-agent": "^5.0.0",+ "proxy-from-env": "^1.1.0",+ "tcp-port-used": "^1.0.1"},"bin": {"chromedriver": "bin/chromedriver"diff --git a/web/js/components/global-settings/coordinate-format-buttons.js b/web/js/components/global-settings/coordinate-format-buttons.jsnew file mode 100644index 000000000..e234e5548--- /dev/null+++ b/web/js/components/global-settings/coordinate-format-buttons.js@@ -0,0 +1,48 @@+import React from 'react';+import PropTypes from 'prop-types';+import { Button, ButtonGroup } from 'reactstrap';+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';+import HoverTooltip from '../util/hover-tooltip';+import { COORDINATE_FORMATS } from '../../modules/settings/constants';++function CoordinateFormatButtons ({ changeCoordinateFormat, coordinateFormat }) {+ const coordinateMenuOptions = ['DD', 'DDM', 'DMS'];++ return (+ <div className="settings-component">+ <h3 className="wv-header">+ Coordinate Format (latitude, longitude)+ {' '}+ <span><FontAwesomeIcon id="coordinate-format-buttons-info-icon" icon="info-circle" /></span>+ <HoverTooltip+ isMobile={false}+ labelText="Applied to all on screen coordinates"+ target="coordinate-format-buttons-info-icon"+ placement="right"+ />+ </h3>+ <ButtonGroup>+ {COORDINATE_FORMATS.map((format, i) => (+ <Button+ key={`${format}-button`}+ aria-label={`Set ${format} Format`}+ outline+ className="setting-button"+ active={coordinateFormat === format}+ onClick={() => changeCoordinateFormat(format)}+ id={`${format}-btn`}+ >+ {coordinateMenuOptions[i]}+ </Button>+ ))}+ </ButtonGroup>+ </div>+ );+}++CoordinateFormatButtons.propTypes = {+ changeCoordinateFormat: PropTypes.func,+ coordinateFormat: PropTypes.string,+};++export default CoordinateFormatButtons;diff --git a/web/js/components/global-settings/global-settings.js b/web/js/components/global-settings/global-settings.jsindex 1b6558e68..558c4f449 100644--- a/web/js/components/global-settings/global-settings.js+++ b/web/js/components/global-settings/global-settings.js@@ -5,9 +5,11 @@ import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';import { Button, ButtonGroup } from 'reactstrap';import HoverTooltip from '../util/hover-tooltip';import TemperatureUnitButtons from './temperature-unit-buttons';+import CoordinateFormatButtons from './coordinate-format-buttons';import {changeTemperatureUnit,changeDatelineVisibility,+ changeCoordinateFormat,} from '../../modules/settings/actions';function GlobalSettings(props) {@@ -16,6 +18,8 @@ function GlobalSettings(props) {toggleAlwaysShowDatelines,changeTemperatureUnitAction,globalTemperatureUnit,+ changeCoordinateFormatAction,+ coordinateFormat,} = props;return (@@ -27,6 +31,11 @@ function GlobalSettings(props) {globalTemperatureUnit={globalTemperatureUnit}/>+ <CoordinateFormatButtons+ changeCoordinateFormat={changeCoordinateFormatAction}+ coordinateFormat={coordinateFormat}+ />+<div className="settings-component"><h3 className="wv-header">Show Antimeridian / Approximate Date Line@@ -65,10 +74,11 @@ function GlobalSettings(props) {function mapStateToProps(state) {const { settings } = state;- const { globalTemperatureUnit, alwaysShowDatelines } = settings;+ const { globalTemperatureUnit, alwaysShowDatelines, coordinateFormat } = settings;return {globalTemperatureUnit,alwaysShowDatelines,+ coordinateFormat,};}@@ -79,6 +89,9 @@ const mapDispatchToProps = (dispatch) => ({toggleAlwaysShowDatelines: (value) => {dispatch(changeDatelineVisibility(value));},+ changeCoordinateFormatAction: (value) => {+ dispatch(changeCoordinateFormat(value));+ },});export default connect(@@ -91,4 +104,6 @@ GlobalSettings.propTypes = {toggleAlwaysShowDatelines: PropTypes.func,changeTemperatureUnitAction: PropTypes.func,globalTemperatureUnit: PropTypes.string,+ changeCoordinateFormatAction: PropTypes.func,+ coordinateFormat: PropTypes.string,};diff --git a/web/js/components/location-search/coordinates-dialog.js b/web/js/components/location-search/coordinates-dialog.jsindex 4f1bc09d9..fa9a320ba 100644--- a/web/js/components/location-search/coordinates-dialog.js+++ b/web/js/components/location-search/coordinates-dialog.js@@ -6,14 +6,19 @@ import copy from 'copy-to-clipboard';import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';import CopyClipboardTooltip from './copy-tooltip';import { getFormattedCoordinates } from './util';+import util from '../../util/util';++const { events } = util;class CoordinatesDialog extends Component {constructor(props) {super(props);+ const { coordinates } = this.props;this.state = {tooltipToggleTime: 0,showTooltips: false,isCopyToClipboardTooltipVisible: false,+ formattedCoordinates: getFormattedCoordinates(coordinates),};this.copyToClipboard = this.copyToClipboard.bind(this);}@@ -22,8 +27,18 @@ class CoordinatesDialog extends Component {setTimeout(() => {this.setState({ showTooltips: true });}, 200);+ events.on('location-search:coordinate-format', this.updateCoordinateFormat);+ }++ componentWillUnmount() {+ events.off('location-search:coordinate-format', this.updateCoordinateFormat);}+ updateCoordinateFormat = () => {+ const { coordinates } = this.props;+ this.setState({ formattedCoordinates: getFormattedCoordinates(coordinates) });+ };+copyToClipboard(coords) {const options = window.clipboardData ? {} : { format: 'text/plain' };options.onCopy = () => {@@ -126,20 +141,19 @@ class CoordinatesDialog extends Component {// render copy to clipboard buttonrenderCopyToClipboardButton = () => {- const { coordinates, isMobile } = this.props;- const { isCopyToClipboardTooltipVisible, showTooltips } = this.state;+ const { isMobile } = this.props;+ const { isCopyToClipboardTooltipVisible, showTooltips, formattedCoordinates } = this.state;const buttonId = 'copy-coordinates-to-clipboard-button';const labelText = 'Copy coordinates to clipboard';const tooltipVisibilityCondition = !isMobile && !isCopyToClipboardTooltipVisible && showTooltips;- const formattedCoords = getFormattedCoordinates(coordinates);return (<divid={buttonId}className={buttonId}- onClick={() => this.copyToClipboard(formattedCoords)}- onTouchEnd={() => this.copyToClipboard(formattedCoords)}+ onClick={() => this.copyToClipboard(formattedCoordinates)}+ onTouchEnd={() => this.copyToClipboard(formattedCoordinates)}>{tooltipVisibilityCondition && (<UncontrolledTooltip@@ -158,16 +172,14 @@ class CoordinatesDialog extends Component {render() {const {tooltipId,- coordinates,title,} = this.props;const {showTooltips,tooltipToggleTime,+ formattedCoordinates,} = this.state;- const formattedCoords = getFormattedCoordinates(coordinates);-return (<div className={`tooltip-custom-black tooltip-static tooltip-coordinates-container ${tooltipId}`}>{showTooltips && (@@ -178,7 +190,7 @@ class CoordinatesDialog extends Component {/>)}<div className="tooltip-coordinates-title">{title}</div>- <div className="tooltip-coordinates">{formattedCoords}</div>+ <div className="tooltip-coordinates">{formattedCoordinates}</div>{this.renderDialogButtonControls()}{this.renderCopyToClipboardButton()}</div>diff --git a/web/js/components/map/coordinates.js b/web/js/components/map/coordinates.jsindex c7df83b0d..1539402b8 100644--- a/web/js/components/map/coordinates.js+++ b/web/js/components/map/coordinates.js@@ -1,6 +1,5 @@import React from 'react';import PropTypes from 'prop-types';-import util from '../../util/util';// previous : next@@ -67,3 +66,7 @@ Coordinates.propTypes = {latitude: PropTypes.number,longitude: PropTypes.number,};++++diff --git a/web/js/components/map/ol-coordinates.js b/web/js/components/map/ol-coordinates.jsindex 75f5bd52f..d98388fac 100644--- a/web/js/components/map/ol-coordinates.js+++ b/web/js/components/map/ol-coordinates.js@@ -1,4 +1,5 @@import React from 'react';+import { connect } from 'react-redux';import PropTypes from 'prop-types';import {throttle as lodashThrottle,@@ -8,6 +9,7 @@ import { UncontrolledTooltip } from 'reactstrap';import Coordinates from './coordinates';import util from '../../util/util';import { getNormalizedCoordinate } from '../location-search/util';+import { changeCoordinateFormat } from '../../modules/settings/actions';const { events } = util;const getContainerWidth = (format) => {@@ -19,7 +21,7 @@ const getContainerWidth = (format) => {return formatWidth[format];};-export default class OlCoordinates extends React.Component {+class OlCoordinates extends React.Component {constructor(props) {super(props);this.state = {@@ -43,6 +45,14 @@ export default class OlCoordinates extends React.Component {this.setInitFormat();}+ // listening to state changes from the settings menu+ componentDidUpdate(prevProps) {+ const { coordinateFormat } = this.props;+ if (prevProps.coordinateFormat !== coordinateFormat) {+ this.changeFormat(coordinateFormat);+ }+ }+componentWillUnmount() {events.off('map:mousemove', this.mouseMove);events.off('map:mouseout', this.mouseOut);@@ -102,7 +112,9 @@ export default class OlCoordinates extends React.Component {});}- changeFormat(format) {+ changeFormat = (format) => {+ const { changeCoordinateFormat } = this.props;+ changeCoordinateFormat(format);util.setCoordinateFormat(format);const width = getContainerWidth(format);this.setState({@@ -116,6 +128,7 @@ export default class OlCoordinates extends React.Component {hasMouse, format, latitude, longitude, crs, width,} = this.state;const { show } = this.props;+return (<div id="ol-coords-case" className="wv-coords-container" style={{ width }}>{hasMouse && show && (@@ -139,6 +152,27 @@ export default class OlCoordinates extends React.Component {}}+function mapStateToProps (state) {+ const { settings } = state;+ const { coordinateFormat } = settings;+ return {+ coordinateFormat,+ };+}++const mapDispatchToProps = (dispatch) => ({+ changeCoordinateFormat: (value) => {+ dispatch(changeCoordinateFormat(value));+ },+});+OlCoordinates.propTypes = {show: PropTypes.bool,+ changeCoordinateFormat: PropTypes.func,+ coordinateFormat: PropTypes.string,};++export default connect(+ mapStateToProps,+ mapDispatchToProps,+)(OlCoordinates);diff --git a/web/js/components/map/ol-coordinates.test.js b/web/js/components/map/ol-coordinates.test.jsindex 2df6702a2..ebd417bea 100644--- a/web/js/components/map/ol-coordinates.test.js+++ b/web/js/components/map/ol-coordinates.test.js@@ -5,6 +5,8 @@ import util from '../../util/util';import OlCoordinates from './ol-coordinates';import { registerProjections } from '../../fixtures';+jest.mock('react-redux', () => ({ connect: () => (OlCoordinates) => OlCoordinates }));+const { events } = util;let container;let map;diff --git a/web/js/modules/settings/actions.js b/web/js/modules/settings/actions.jsindex f735f93db..f3073e00a 100644--- a/web/js/modules/settings/actions.js+++ b/web/js/modules/settings/actions.js@@ -1,10 +1,14 @@import {CHANGE_TEMPERATURE_UNIT,CHANGE_DATELINE_VISIBILITY,+ CHANGE_COORDINATE_FORMAT,} from './constants';import safeLocalStorage from '../../util/local-storage';+import util from '../../util/util';-const { GLOBAL_TEMPERATURE_UNIT, ALWAYS_SHOW_DATELINES } = safeLocalStorage.keys;+const { events } = util;++const { GLOBAL_TEMPERATURE_UNIT, ALWAYS_SHOW_DATELINES, COORDINATE_FORMAT } = safeLocalStorage.keys;export function changeTemperatureUnit(value) {if (!value) {@@ -29,3 +33,12 @@ export function changeDatelineVisibility(value) {value,};}++export function changeCoordinateFormat(value) {+ safeLocalStorage.setItem(COORDINATE_FORMAT, value);+ events.trigger('location-search:coordinate-format');+ return {+ type: CHANGE_COORDINATE_FORMAT,+ value,+ };+}diff --git a/web/js/modules/settings/constants.js b/web/js/modules/settings/constants.jsindex 77f2d57f6..b0af6a1c0 100644--- a/web/js/modules/settings/constants.js+++ b/web/js/modules/settings/constants.js@@ -2,3 +2,5 @@export const CHANGE_TEMPERATURE_UNIT = 'SETTINGS/CHANGE_TEMPERATURE_UNIT';export const CHANGE_DATELINE_VISIBILITY = 'SETTINGS/CHANGE_DATELINE_VISIBILITY';export const TEMPERATURE_UNITS = ['Kelvin', 'Celsius', 'Fahrenheit'];+export const CHANGE_COORDINATE_FORMAT = 'SETTINGS/CHANGE_COORDINATE_FORMAT';+export const COORDINATE_FORMATS = ['latlon-dd', 'latlon-dm', 'latlon-dms'];diff --git a/web/js/modules/settings/reducer.js b/web/js/modules/settings/reducer.jsindex 056e315d1..94b177afe 100644--- a/web/js/modules/settings/reducer.js+++ b/web/js/modules/settings/reducer.js@@ -1,19 +1,31 @@import safeLocalStorage from '../../util/local-storage';-import { CHANGE_TEMPERATURE_UNIT, CHANGE_DATELINE_VISIBILITY } from './constants';+import { CHANGE_TEMPERATURE_UNIT, CHANGE_DATELINE_VISIBILITY, CHANGE_COORDINATE_FORMAT } from './constants';-const { GLOBAL_TEMPERATURE_UNIT, ALWAYS_SHOW_DATELINES } = safeLocalStorage.keys;+const { GLOBAL_TEMPERATURE_UNIT, ALWAYS_SHOW_DATELINES, COORDINATE_FORMAT } = safeLocalStorage.keys;export const initialState = {globalTemperatureUnit: '',alwaysShowDatelines: false,-+ coordinateFormat: '',};export function getInitialState() {const alwaysShowDatelines = Boolean(safeLocalStorage.getItem(ALWAYS_SHOW_DATELINES));+ const initialCoordinateFormat = safeLocalStorage.getItem(COORDINATE_FORMAT);+ const defaultCoordinateFormat = 'latlon-dd';++ if (initialCoordinateFormat === null) {+ return {+ globalTemperatureUnit: safeLocalStorage.getItem(GLOBAL_TEMPERATURE_UNIT),+ alwaysShowDatelines,+ coordinateFormat: defaultCoordinateFormat,+ };+ }+return {globalTemperatureUnit: safeLocalStorage.getItem(GLOBAL_TEMPERATURE_UNIT),alwaysShowDatelines,+ coordinateFormat: safeLocalStorage.getItem(COORDINATE_FORMAT),};}@@ -30,6 +42,12 @@ export const settingsReducer = (state = initialState, action) => {alwaysShowDatelines: action.value,};}+ case CHANGE_COORDINATE_FORMAT: {+ return {+ ...state,+ coordinateFormat: action.value,+ };+ }default:return state;}