Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Feat] Pinned tooltip + Compare (#1132)
Valentine Panchinbe83eb1463e3
diff --git a/src/components/map-container.js b/src/components/map-container.jsindex 99e5b0cbd..e632f1eec 100644--- a/src/components/map-container.js+++ b/src/components/map-container.js@@ -38,6 +38,7 @@ import {generateMapboxLayers, updateMapboxLayers} from 'layers/mapbox-utils';import {OVERLAY_TYPE} from 'layers/base-layer';import {setLayerBlending} from 'utils/gl-utils';import {transformRequest} from 'utils/map-style-utils/mapbox-utils';+import {getLayerHoverProp} from 'utils/layer-utils';// default-settingsimport ThreeDBuildingLayer from 'deckgl-layers/3d-building-layer/3d-building-layer';@@ -249,54 +250,67 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor) {return null;}// if clicked something, ignore hover behavior- const objectInfo = clicked || hoverInfo;let layerHoverProp = null;- let position = {x: mousePosition[0], y: mousePosition[1]};-- if (interactionConfig.tooltip.enabled && objectInfo && objectInfo.picked) {- // if anything hovered- const {object, layer: overlay} = objectInfo;-- // deckgl layer to kepler-gl layer- const layer = layers[overlay.props.idx];-- if (layer.getHoverData && layersToRender[layer.id]) {- // if layer is visible and have hovered data- const {- config: {dataId}- } = layer;- const {allData, fields} = datasets[dataId];- const data = layer.getHoverData(object, allData);- const fieldsToShow = interactionConfig.tooltip.config.fieldsToShow[dataId];-- layerHoverProp = {- data,- fields,- fieldsToShow,- layer- };- }- }+ let layerPinnedProp = null;+ const position = {x: mousePosition[0], y: mousePosition[1]};+ let pinnedPosition = {};++ layerHoverProp = getLayerHoverProp({+ interactionConfig,+ hoverInfo,+ layers,+ layersToRender,+ datasets+ });++ const compareMode = interactionConfig.tooltip.config+ ? interactionConfig.tooltip.config.compareMode+ : false;++ const hasTooltip = pinned || clicked;+ const hasComparisonTooltip = compareMode || (!clicked && !pinned);- if (pinned || clicked) {+ if (hasTooltip) {// project lnglat to screen so that tooltip follows the object on zoomconst viewport = new WebMercatorViewport(mapState);const lngLat = clicked ? clicked.lngLat : pinned.coordinate;- position = this._getHoverXY(viewport, lngLat);+ pinnedPosition = this._getHoverXY(viewport, lngLat);+ layerPinnedProp = getLayerHoverProp({+ interactionConfig,+ hoverInfo: clicked,+ layers,+ layersToRender,+ datasets+ });+ if (layerHoverProp) {+ layerHoverProp.primaryData = layerPinnedProp.data;+ layerHoverProp.compareType = interactionConfig.tooltip.config.compareType;+ }}return (<div>- <MapPopover- {...position}- layerHoverProp={layerHoverProp}- coordinate={- interactionConfig.coordinate.enabled && ((pinned || {}).coordinate || coordinate)- }- freezed={Boolean(clicked || pinned)}- onClose={this._onCloseMapPopover}- mapW={mapState.width}- mapH={mapState.height}- />+ {hasTooltip && (+ <MapPopover+ {...pinnedPosition}+ layerHoverProp={layerPinnedProp}+ coordinate={interactionConfig.coordinate.enabled && (pinned || {}).coordinate}+ frozen={Boolean(hasTooltip)}+ onClose={this._onCloseMapPopover}+ mapW={mapState.width}+ mapH={mapState.height}+ isBase={compareMode}+ />+ )}+ {hasComparisonTooltip && (+ <MapPopover+ {...position}+ layerHoverProp={layerHoverProp}+ coordinate={interactionConfig.coordinate.enabled && coordinate}+ onClose={this._onCloseMapPopover}+ mapW={mapState.width}+ mapH={mapState.height}+ />+ )}</div>);}diff --git a/src/components/map/layer-hover-info.js b/src/components/map/layer-hover-info.jsindex 1b6198643..e10fcffea 100644--- a/src/components/map/layer-hover-info.js+++ b/src/components/map/layer-hover-info.js@@ -23,7 +23,8 @@ import styled from 'styled-components';import {CenterFlexbox} from 'components/common/styled-components';import {Layers} from 'components/common/icons';import PropTypes from 'prop-types';-import {parseFieldValue, getFormatter} from 'utils/data-utils';+import {notNullorUndefined} from 'utils/data-utils';+import {getTooltipDisplayValue, getTooltipDisplayDeltaValue} from 'utils/interaction-utils';export const StyledLayerName = styled(CenterFlexbox)`color: ${props => props.theme.textColorHl};@@ -38,7 +39,21 @@ export const StyledLayerName = styled(CenterFlexbox)`}`;-const Row = ({name, value, url}) => {+const StyledTable = styled.table`+ & .row__delta-value {+ text-align: right;++ &.positive {+ color: ${props => props.theme.primaryBtnBgd};+ }++ &.negative {+ color: ${props => props.theme.negativeBtnActBgd};+ }+ }+`;++const Row = ({name, value, deltaValue, url}) => {// Set 'url' to 'value' if it looks like a urlif (!url && value && typeof value === 'string' && value.match(/^http/)) {url = value;@@ -59,31 +74,55 @@ const Row = ({name, value, url}) => {value)}</td>+ {notNullorUndefined(deltaValue) && (+ <td+ className={`row__delta-value ${+ deltaValue.toString().charAt(0) === '+' ? 'positive' : 'negative'+ }`}+ >+ {deltaValue}+ </td>+ )}</tr>);};-const EntryInfo = ({fieldsToShow, fields, data}) => (+const EntryInfo = ({fieldsToShow, fields, data, primaryData, compareType}) => (<tbody>{fieldsToShow.map(item => (- <EntryInfoRow key={item.name} item={item} fields={fields} data={data} />+ <EntryInfoRow+ key={item.name}+ item={item}+ fields={fields}+ data={data}+ primaryData={primaryData}+ compareType={compareType}+ />))}</tbody>);-const EntryInfoRow = ({item, fields, data}) => {- const field = fields.find(f => f.name === item.name);- if (!field) {+const EntryInfoRow = ({item, fields, data, primaryData, compareType}) => {+ const fieldIdx = fields.findIndex(f => f.name === item.name);+ if (fieldIdx < 0) {return null;}+ const field = fields[fieldIdx];+ const displayValue = getTooltipDisplayValue({item, field, data, fieldIdx});++ const displayDeltaValue = getTooltipDisplayDeltaValue({+ item,+ field,+ data,+ fieldIdx,+ primaryData,+ compareType+ });- const valueIdx = field.tableFieldIndex - 1;- const displayValue = item.format- ? getFormatter(item.format, field)(data[valueIdx])- : parseFieldValue(data[valueIdx], field.type);- return <Row name={item.name} value={displayValue} />;+ return <Row name={item.name} value={displayValue} deltaValue={displayDeltaValue} />;};+// TODO: supporting comparative value for aggregated cells as wellconst CellInfo = ({data, layer}) => {const {colorField, sizeField} = layer.config;@@ -122,9 +161,9 @@ const LayerHoverInfoFactory = () => {<Layers height="12px" />{props.layer.config.label}</StyledLayerName>- <table className="map-popover__table">+ <StyledTable>{props.layer.isAggregated ? <CellInfo {...props} /> : <EntryInfo {...props} />}- </table>+ </StyledTable></div>);};diff --git a/src/components/map/map-popover.js b/src/components/map/map-popover.jsindex a8fc1f2cd..aab1fe928 100644--- a/src/components/map/map-popover.js+++ b/src/components/map/map-popover.js@@ -23,8 +23,9 @@ import styled from 'styled-components';import PropTypes from 'prop-types';import LayerHoverInfoFactory from './layer-hover-info';import CoordinateInfoFactory from './coordinate-info';-import {Pin} from 'components/common/icons';+import {Pin, ArrowLeft, ArrowRight} from 'components/common/icons';import ErrorBoundary from 'components/common/error-boundary';+import {FormattedMessage, injectIntl} from 'react-intl';const MAX_WIDTH = 500;const MAX_HEIGHT = 600;@@ -38,9 +39,23 @@ const StyledMapPopover = styled.div`z-index: 1000;position: absolute;overflow-x: auto;+ box-shadow: ${props => props.theme.panelBoxShadow};++ :hover {+ background-color: ${props => `${props.theme.panelBackground}dd`};+ }.gutter {height: 6px;+ margin-bottom: 20px;+ }++ .primary-label {+ color: ${props => props.theme.notificationColors.success};+ position: absolute;+ right: 18px;+ top: 10px;+ font-size: 10px;}table {@@ -66,13 +81,23 @@ const StyledMapPopover = styled.div`}`;-const StyledPin = styled.div`+const StyledIcon = styled.div`position: absolute;left: 50%;transform: rotate(30deg);top: 10px;color: ${props => props.theme.primaryBtnBgd};+ &.popover-arrow-left {+ left: 40%;+ transform: rotate(0deg);+ }++ &.popover-arrow-right {+ left: 60%;+ transform: rotate(0deg);+ }+:hover {cursor: pointer;color: ${props => props.theme.linkBtnColor};@@ -86,19 +111,21 @@ export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {static propTypes = {layerHoverProp: PropTypes.object,coordinate: PropTypes.oneOfType([PropTypes.array, PropTypes.bool]),- freezed: PropTypes.bool,+ frozen: PropTypes.bool,x: PropTypes.number,y: PropTypes.number,mapW: PropTypes.number.isRequired,mapH: PropTypes.number.isRequired,- onClose: PropTypes.func.isRequired+ onClose: PropTypes.func.isRequired,+ isBase: PropTypes.bool};constructor(props) {super(props);this.state = {width: 380,- height: 160+ height: 160,+ isLeft: false};}@@ -126,13 +153,13 @@ export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {}}- _getPosition(x, y) {+ _getPosition(x, y, isLeft) {const topOffset = 20;const leftOffset = 20;const {mapW, mapH} = this.props;const {width, height} = this.state;const pos = {};- if (x + leftOffset + width > mapW) {+ if (x + leftOffset + width > mapW || isLeft) {pos.right = mapW - x + leftOffset;} else {pos.left = x + leftOffset;@@ -147,10 +174,19 @@ export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {return pos;}+ moveLeft = () => {+ this.setState({isLeft: true});+ };++ moveRight = () => {+ this.setState({isLeft: false});+ };+render() {- const {x, y, freezed, coordinate, layerHoverProp} = this.props;+ const {x, y, frozen, coordinate, layerHoverProp, isBase} = this.props;+ const {isLeft} = this.state;- const style = Number.isFinite(x) && Number.isFinite(y) ? this._getPosition(x, y) : {};+ const style = Number.isFinite(x) && Number.isFinite(y) ? this._getPosition(x, y, isLeft) : {};return (<ErrorBoundary>@@ -162,12 +198,27 @@ export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {maxWidth: MAX_WIDTH}}>- {freezed ? (+ {frozen ? (<div className="map-popover__top"><div className="gutter" />- <StyledPin className="popover-pin" onClick={this.props.onClose}>+ {!isLeft && (+ <StyledIcon className="popover-arrow-left" onClick={this.moveLeft}>+ <ArrowLeft />+ </StyledIcon>+ )}+ <StyledIcon className="popover-pin" onClick={this.props.onClose}><Pin height="16px" />- </StyledPin>+ </StyledIcon>+ {isLeft && (+ <StyledIcon className="popover-arrow-right" onClick={this.moveRight}>+ <ArrowRight />+ </StyledIcon>+ )}+ {isBase && (+ <div className="primary-label">+ <FormattedMessage id="mapPopover.primary" />+ </div>+ )}</div>) : null}{Array.isArray(coordinate) && <CoordinateInfo coordinate={coordinate} />}@@ -178,5 +229,5 @@ export default function MapPopoverFactory(LayerHoverInfo, CoordinateInfo) {}}- return MapPopover;+ return injectIntl(MapPopover);}diff --git a/src/components/side-panel/interaction-panel/tooltip-config.js b/src/components/side-panel/interaction-panel/tooltip-config.jsindex a28f08a7b..a81754705 100644--- a/src/components/side-panel/interaction-panel/tooltip-config.js+++ b/src/components/side-panel/interaction-panel/tooltip-config.js@@ -20,12 +20,19 @@import React, {Component} from 'react';import styled from 'styled-components';-import {FormattedMessage} from 'react-intl';-import {SidePanelSection, SBFlexboxNoMargin, Button} from 'components/common/styled-components';+import {FormattedMessage, injectIntl} from 'react-intl';+import {+ SidePanelSection,+ SBFlexboxNoMargin,+ Button,+ PanelLabel+} from 'components/common/styled-components';import FieldSelector from 'components/common/field-selector';import DatasetTagFactory from 'components/side-panel/common/dataset-tag';import TooltipChickletFactory from './tooltip-config/tooltip-chicklet';-+import Switch from 'components/common/switch';+import ItemSelector from 'components/common/item-selector/item-selector';+import {COMPARE_TYPES} from 'constants/tooltip';TooltipConfigFactory.deps = [DatasetTagFactory];const TooltipConfigWrapper = styled.div`@@ -50,10 +57,19 @@ const ButtonWrapper = styled.div`}`;+const CompareSwitchWrapper = styled.div`+ color: ${props => props.theme.labelColor};+ display: flex;+ font-size: ${props => props.theme.inputFontSize};+ justify-content: space-between;+ line-height: 11px;+ margin-bottom: 8px;+`;+function TooltipConfigFactory(DatasetTag) {class TooltipConfig extends Component {render() {- const {config, datasets, onChange} = this.props;+ const {config, datasets, onChange, intl} = this.props;return (<TooltipConfigWrapper>{Object.keys(config.fieldsToShow).map(dataId => (@@ -107,12 +123,53 @@ function TooltipConfigFactory(DatasetTag) {/></SidePanelSection>))}+ <CompareSwitchWrapper>+ <FormattedMessage id="compare.modeLabel" />+ <Switch+ checked={config.compareMode}+ id="compare-mode-toggle"+ onChange={() => {+ const newConfig = {+ ...config,+ compareMode: !config.compareMode+ };+ onChange(newConfig);+ }}+ secondary+ />+ </CompareSwitchWrapper>+ <SidePanelSection>+ <PanelLabel>+ <FormattedMessage id="compare.typeLabel" />+ </PanelLabel>+ <ItemSelector+ disabled={!config.compareMode}+ displayOption={d =>+ intl.formatMessage({+ id: `compare.types.${d}`+ })+ }+ selectedItems={config.compareType}+ options={Object.values(COMPARE_TYPES)}+ multiSelect={false}+ searchable={false}+ inputTheme={'secondary'}+ getOptionValue={d => d}+ onChange={option => {+ const newConfig = {+ ...config,+ compareType: option+ };+ onChange(newConfig);+ }}+ />+ </SidePanelSection></TooltipConfigWrapper>);}}- return TooltipConfig;+ return injectIntl(TooltipConfig);}export default TooltipConfigFactory;diff --git a/src/constants/tooltip.js b/src/constants/tooltip.jsindex ed0ada7e9..8d2a138f5 100644--- a/src/constants/tooltip.js+++ b/src/constants/tooltip.js@@ -169,3 +169,8 @@ export const TOOLTIP_FORMATS = {type: TOOLTIP_FORMAT_TYPES.DATE_TIME}};++export const COMPARE_TYPES = {+ ABSOLUTE: 'absolute',+ RELATIVE: 'relative'+};diff --git a/src/localization/en.js b/src/localization/en.jsindex 498025520..0a1d5a639 100644--- a/src/localization/en.js+++ b/src/localization/en.js@@ -441,6 +441,17 @@ export default {clearAll: 'Clear All',formatting: 'Formatting'},+ compare: {+ modeLabel: 'Comparison Mode',+ typeLabel: 'Comparison Type',+ types: {+ absolute: 'Absolute',+ relative: 'Relative'+ }+ },+ mapPopover: {+ primary: 'Primary'+ },density: 'density','Bug Report': 'Bug Report','User Guide': 'User Guide',diff --git a/src/reducers/vis-state-updaters.d.ts b/src/reducers/vis-state-updaters.d.tsindex d4c665db9..da341b926 100644--- a/src/reducers/vis-state-updaters.d.ts+++ b/src/reducers/vis-state-updaters.d.ts@@ -222,21 +222,24 @@ export type AnimationConfig = {speed: number;};-type BaseInteraction = {+export type BaseInteraction = {id: string;label: string;enabled: boolean;iconComponent: any;};-type TooltipField = {+export type TooltipField = {name: string;format: string | null;};+export type CompareType = string | null;export type Tooltip = BaseInteraction & {config: {fieldsToShow: {[key: string]: TooltipField[];};+ compareMode: boolean;+ compareType: CompareType;};};export type Geocoder = BaseInteraction & {diff --git a/src/reducers/vis-state-updaters.js b/src/reducers/vis-state-updaters.jsindex 4590c9e73..0017d0fc9 100644--- a/src/reducers/vis-state-updaters.js+++ b/src/reducers/vis-state-updaters.js@@ -57,7 +57,7 @@ import {assignGpuChannel, setFilterGpuMode} from 'utils/gpu-filter-utils';import {createNewDataEntry, sortDatasetByColumn} from 'utils/dataset-utils';import {set, toArray} from 'utils/utils';-import {calculateLayerData, findDefaultLayer} from 'utils/layer-utils/layer-utils';+import {calculateLayerData, findDefaultLayer} from 'utils/layer-utils';import {mergeAnimationConfig,diff --git a/src/utils/data-utils.d.ts b/src/utils/data-utils.d.tsindex 3c815441d..e822eb668 100644--- a/src/utils/data-utils.d.ts+++ b/src/utils/data-utils.d.ts@@ -1,25 +1,20 @@import {Millisecond} from 'reducers/types';-import {Layer} from 'reducers/vis-state-updaters';+import {Layer, Field} from 'reducers/vis-state-updaters';import {Bounds} from 'reducers/map-state-updaters';-export function maybeToDate(- isTime: boolean,- fieldIdx: number,- format: string,- d: any[]-): any;+export function maybeToDate(isTime: boolean, fieldIdx: number, format: string, d: any[]): any;export function timeToUnixMilli(value: any, format: string): Millisecond | null;-export function notNullorUndefined(d: any): boolean-export function isPlainObject(d: any): boolean-export function numberSort(a: any, b: any): any-export function unique(values: any[]): any[]+export function notNullorUndefined(d: any): boolean;+export function isNumber(d: any): boolean;+export function isPlainObject(d: any): boolean;+export function numberSort(a: any, b: any): any;+export function unique(values: any[]): any[];export function getSortingFunction(fieldType: string): numberSort | undefined;export function preciseRound(num: number, decimals: number): string;export function parseFieldValue(value: any, type: string): string;-export function getSampleData(- data: any[],- sampleSize?: number,- getValue?: any-): any[];-export function findMapBounds(layers: Layer[]): Bounds | null;\ No newline at end of file+export function getSampleData(data: any[], sampleSize?: number, getValue?: any): any[];+export function findMapBounds(layers: Layer[]): Bounds | null;+function formatter(v: any): any;+export function getFormatter(format: any, field?: Field): formatter;+export function defaultFormatter(v: any): string;\ No newline at end of filediff --git a/src/utils/data-utils.js b/src/utils/data-utils.jsindex 2db1231f6..b1e852cfd 100644--- a/src/utils/data-utils.js+++ b/src/utils/data-utils.js@@ -144,6 +144,13 @@ export function notNullorUndefined(d) {return d !== undefined && d !== null;}+/**+ * Whether d is a number, this filtered out NaN as well+ * @type {typeof import('./data-utils').notNullorUndefined}+ */+export function isNumber(d) {+ return Number.isFinite(d);+}/*** whether null or undefined*/@@ -240,13 +247,20 @@ export function roundValToStep(minValue, step, val) {const identity = d => d;+/**+ * Get the value format based on field and format options+ * Used in render tooltip value+ * @type {typeof import('./data-utils').defaultFormatter}+ */+export const defaultFormatter = v => (notNullorUndefined(v) ? String(v) : '');+export const FIELD_DISPLAY_FORMAT = {- [ALL_FIELD_TYPES.string]: identity,- [ALL_FIELD_TYPES.timestamp]: identity,- [ALL_FIELD_TYPES.integer]: identity,- [ALL_FIELD_TYPES.real]: identity,- [ALL_FIELD_TYPES.boolean]: d => String(d),- [ALL_FIELD_TYPES.date]: identity,+ [ALL_FIELD_TYPES.string]: defaultFormatter,+ [ALL_FIELD_TYPES.timestamp]: defaultFormatter,+ [ALL_FIELD_TYPES.integer]: defaultFormatter,+ [ALL_FIELD_TYPES.real]: defaultFormatter,+ [ALL_FIELD_TYPES.boolean]: defaultFormatter,+ [ALL_FIELD_TYPES.date]: defaultFormatter,[ALL_FIELD_TYPES.geojson]: d =>typeof d === 'string'? d@@ -292,8 +306,14 @@ export function findFirstNoneEmpty(data, count = 1, getValue = identity) {return found;}+/**+ * Get the value format based on field and format options+ * Used in render tooltip value+ * @type {typeof import('./data-utils').getFormatter}+ * @param format+ * @param field+ */export function getFormatter(format, field) {- const defaultFormatter = v => v;if (!format) {return defaultFormatter;}@@ -310,7 +330,7 @@ export function getFormatter(format, field) {export function applyDefaultFormat(tooltipFormat) {if (!tooltipFormat || !tooltipFormat.format) {- return v => v;+ return defaultFormatter;}switch (tooltipFormat.type) {@@ -322,7 +342,7 @@ export function applyDefaultFormat(tooltipFormat) {case TOOLTIP_FORMAT_TYPES.PERCENTAGE:return v => `${d3Format(TOOLTIP_FORMATS.DECIMAL_DECIMAL_FIXED_2.format)(v)}%`;default:- return v => v;+ return defaultFormatter;}}diff --git a/src/utils/interaction-utils.d.ts b/src/utils/interaction-utils.d.tsindex d7fceb469..7352e495a 100644--- a/src/utils/interaction-utils.d.ts+++ b/src/utils/interaction-utils.d.ts@@ -1,6 +1,24 @@-import {InteractionConfig, Field} from '../reducers/vis-state-updaters'+import {InteractionConfig, Field, TooltipField, CompareType} from '../reducers/vis-state-updaters';export function getDefaultInteraction(): InteractionConfig;-export function findFieldsToShow(p: {fields: Field[], id: string}): {- [key: string]: string[]-}+export function findFieldsToShow(p: {+ fields: Field[];+ id: string;+}): {+ [key: string]: string[];+};++export function getTooltipDisplayDeltaValue(args: {+ item: TooltipField;+ field: Field;+ data: any[];+ fieldIdx: number;+ primaryData: any[];+ compareType: CompareType;+}): string | null;+export function getTooltipDisplayValue(args: {+ item: TooltipField;+ field: Field;+ data: any[];+ fieldIdx: string;+}): string;diff --git a/src/utils/interaction-utils.js b/src/utils/interaction-utils.jsindex 512f61d30..27838916c 100644--- a/src/utils/interaction-utils.js+++ b/src/utils/interaction-utils.js@@ -24,7 +24,15 @@ import {ALL_FIELD_TYPES,TRIP_POINT_FIELDS} from 'constants/default-settings';+import {+ parseFieldValue,+ getFormatter,+ isNumber,+ defaultFormatter,+ notNullorUndefined+} from 'utils/data-utils';import {Messages, Crosshairs, CursorClick, Pin} from 'components/common/icons/index';+import {TOOLTIP_FORMATS, TOOLTIP_KEY, COMPARE_TYPES} from 'constants/tooltip';/*** @type {typeof import('./interaction-utils').getDefaultInteraction}@@ -37,7 +45,9 @@ export function getDefaultInteraction() {enabled: true,iconComponent: Messages,config: {- fieldsToShow: {}+ fieldsToShow: {},+ compareMode: false,+ compareType: COMPARE_TYPES.ABSOLUTE}},geocoder: {@@ -113,3 +123,59 @@ function autoFindTooltipFields(fields) {function _mergeFieldPairs(pairs) {return pairs.reduce((prev, pair) => [...prev, ...pair], []);}++/**+ * @type {typeof import('./interaction-utils').getTooltipDisplayDeltaValue}+ */+export function getTooltipDisplayDeltaValue({+ primaryData,+ field,+ compareType,+ data,+ fieldIdx,+ item+}) {+ let displayDeltaValue = null;++ if (+ primaryData &&+ // comparison mode only works for numeric field+ (field.type === ALL_FIELD_TYPES.integer || field.type === ALL_FIELD_TYPES.real)+ ) {+ const baseDp = primaryData[fieldIdx];+ const dp = data[fieldIdx];+ if (isNumber(baseDp) && isNumber(dp)) {+ const deltaValue = compareType === COMPARE_TYPES.RELATIVE ? dp / baseDp - 1 : dp - baseDp;+ const deltaFormat =+ compareType === COMPARE_TYPES.RELATIVE+ ? TOOLTIP_FORMATS.DECIMAL_PERCENT_FULL_2[TOOLTIP_KEY]+ : (item.format || TOOLTIP_FORMATS.DECIMAL_DECIMAL_FIXED_3[TOOLTIP_KEY]);++ displayDeltaValue = getFormatter(deltaFormat)(deltaValue);++ // safely cast string+ displayDeltaValue = defaultFormatter(displayDeltaValue);+ const deltaFirstChar = displayDeltaValue.charAt(0);+ if (deltaFirstChar !== '+' && deltaFirstChar !== '-') {+ displayDeltaValue = `+${displayDeltaValue}`;+ }+ } else {+ displayDeltaValue = '-';+ }+ }++ return displayDeltaValue;+}++/**+ * @type {typeof import('./interaction-utils').getTooltipDisplayValue}+ */+export function getTooltipDisplayValue({item, field, data, fieldIdx}) {+ if (!notNullorUndefined(data[fieldIdx])) {+ return '';+ }++ return item.format+ ? getFormatter(item.format, field)(data[fieldIdx])+ : parseFieldValue(data[fieldIdx], field.type);+}diff --git a/src/utils/layer-utils.d.ts b/src/utils/layer-utils.d.tsnew file mode 100644index 000000000..0601d9b01--- /dev/null+++ b/src/utils/layer-utils.d.ts@@ -0,0 +1,31 @@+import {Layer, LayerClasses} from 'layers';+import {VisState, Dataset, InteractionConfig, Tooltip, TooltipField} from 'reducers/vis-state-updaters';++export function calculateLayerData(+ layer: Layer,+ state: VisState,+ oldLayerData?: any+): {+ layerData: any;+ layer: Layer;+};++export type LayersToRender = {+ [layerId: string]: boolean;+};++export type LayerHoverProp = {+ data: any[];+ fields: Field[];+ fieldsToShow: TooltipField[];+ layer: Layer;+};++export function findDefaultLayer(dataset: Dataset, layerClasses: LayerClasses): Layer[];+export function getLayerHoverProp(arg: {+ interactionConfig: VisState['interactionConfig'];+ hoverInfo: VisState['hoverInfo'];+ layers: VisState['layers'];+ layersToRender: LayersToRender;+ datasets: VisState['datasets'];+}): LayerHoverProp | null;diff --git a/src/utils/layer-utils/layer-utils.js b/src/utils/layer-utils.jssimilarity index 73%rename from src/utils/layer-utils/layer-utils.jsrename to src/utils/layer-utils.jsindex 8f31efb2a..6371ba27a 100644--- a/src/utils/layer-utils/layer-utils.js+++ b/src/utils/layer-utils.js@@ -68,3 +68,42 @@ export function calculateLayerData(layer, state, oldLayerData) {const layerData = layer.formatLayerData(state.datasets, oldLayerData);return {layerData, layer};}++/**+ * Calculate props passed to LayerHoverInfo+ * @type {typeof import('./layer-utils').getLayerHoverProp}+ */+export function getLayerHoverProp({+ interactionConfig,+ hoverInfo,+ layers,+ layersToRender,+ datasets+}) {+ if (interactionConfig.tooltip.enabled && hoverInfo && hoverInfo.picked) {+ // if anything hovered+ const {object, layer: overlay} = hoverInfo;++ // deckgl layer to kepler-gl layer+ const layer = layers[overlay.props.idx];++ if (layer.getHoverData && layersToRender[layer.id]) {+ // if layer is visible and have hovered data+ const {+ config: {dataId}+ } = layer;+ const {allData, fields} = datasets[dataId];+ const data = layer.getHoverData(object, allData);+ const fieldsToShow = interactionConfig.tooltip.config.fieldsToShow[dataId];++ return {+ data,+ fields,+ fieldsToShow,+ layer+ };+ }+ }++ return null;+}diff --git a/src/utils/layer-utils/layer-utils.d.ts b/src/utils/layer-utils/layer-utils.d.tsdeleted file mode 100644index 28a32e88b..000000000--- a/src/utils/layer-utils/layer-utils.d.ts+++ /dev/null@@ -1,19 +0,0 @@-import {Layer, LayerClasses} from 'layers';-import {VisState, Dataset} from 'reducers/vis-state-updaters';--export function calculateLayerData(- layer: Layer,- state: VisState,- oldLayerData?: any-): {- layerData: any;- layer: Layer;-};-type FoundLayerProp = {- type: string; dataId: string-};--export function findDefaultLayer(- dataset: Dataset,- layerClasses: LayerClasses-): Layer[]\ No newline at end of filediff --git a/test/browser/components/map/index.js b/test/browser/components/map/index.jsindex 95903416b..fa9211008 100644--- a/test/browser/components/map/index.js+++ b/test/browser/components/map/index.js@@ -20,3 +20,4 @@import './map-legend-test';import './map-control-test';+import './map-popover-test';diff --git a/test/browser/components/map/map-popover-test.js b/test/browser/components/map/map-popover-test.jsnew file mode 100644index 000000000..8e0ce6e64--- /dev/null+++ b/test/browser/components/map/map-popover-test.js@@ -0,0 +1,56 @@+// Copyright (c) 2020 Uber Technologies, Inc.+//+// Permission is hereby granted, free of charge, to any person obtaining a copy+// of this software and associated documentation files (the "Software"), to deal+// in the Software without restriction, including without limitation the rights+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell+// copies of the Software, and to permit persons to whom the Software is+// furnished to do so, subject to the following conditions:+//+// The above copyright notice and this permission notice shall be included in+// all copies or substantial portions of the Software.+//+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN+// THE SOFTWARE.++import React from 'react';+import sinon from 'sinon';+import test from 'tape';+import {Pin} from 'components/common/icons';+import {IntlWrapper, mountWithTheme} from 'test/helpers/component-utils';+import MapPopoverFactory from 'components/map/map-popover';+test('Map Popover - render', t => {+ const LayerHoverInfo = () => <div className="layer-hover-info" />;+ const CoordinateInfo = () => <div className="coordingate-hover-info" />;+ const MapPopover = MapPopoverFactory(LayerHoverInfo, CoordinateInfo);+ let wrapper;+ const onClose = sinon.spy();+ t.doesNotThrow(() => {+ wrapper = mountWithTheme(+ <IntlWrapper>+ <MapPopover+ mapW={400}+ mapH={300}+ onClose={onClose}+ coordinate={[0, 0]}+ layerHoverProp={{}}+ isBase={true}+ frozen={true}+ />+ </IntlWrapper>+ );+ }, 'Should render');++ t.equal(wrapper.find(MapPopover).length, 1, 'Should display 1 MapPopover');+ t.equal(wrapper.find('.coordingate-hover-info').length, 1, 'Should display 1 coordinates');+ t.equal(wrapper.find('.layer-hover-info').length, 1, 'Should display 1 layer info');+ t.equal(wrapper.find(Pin).length, 1, 'Should display 1 pin');+ t.equal(wrapper.find('.primary-label').length, 1, 'Should display 1 primary label');++ t.end();+});diff --git a/test/browser/components/modals/data-table-modal-test.js b/test/browser/components/modals/data-table-modal-test.jsindex a116b0741..f38aca946 100644--- a/test/browser/components/modals/data-table-modal-test.js+++ b/test/browser/components/modals/data-table-modal-test.js@@ -477,7 +477,7 @@ test('Components -> cellSize -> renderedSize', t => {const expected = {_geojson: {row: 400, header: 91},- 'income level of people over 65': {row: 117, header: 150},+ 'income level of people over 65': {row: 75, header: 150},engagement: {row: 117, header: 110}};diff --git a/test/fixtures/state-saved-v0.js b/test/fixtures/state-saved-v0.jsindex 8921f1df5..2181b2c09 100644--- a/test/fixtures/state-saved-v0.js+++ b/test/fixtures/state-saved-v0.js@@ -1468,6 +1468,8 @@ export const mergedInteractions = {...defaultInteraction.tooltip,enabled: true,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {'9h10t7fyb': [{diff --git a/test/fixtures/state-saved-v1-1.js b/test/fixtures/state-saved-v1-1.jsindex 0971fc624..a742a5437 100644--- a/test/fixtures/state-saved-v1-1.js+++ b/test/fixtures/state-saved-v1-1.js@@ -2773,6 +2773,8 @@ export const mergedInteraction = {...defaultInteraction.tooltip,enabled: false,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {a5ybmwl2d: [{diff --git a/test/helpers/mock-state.js b/test/helpers/mock-state.jsindex a31046d40..79d21067b 100644--- a/test/helpers/mock-state.js+++ b/test/helpers/mock-state.js@@ -41,6 +41,7 @@ import {} from 'test/fixtures/test-trip-data';import tripGeojson, {tripDataInfo} from 'test/fixtures/trip-geojson';import {processGeojson} from 'processors/data-processor';+import {COMPARE_TYPES} from 'constants/tooltip';const geojsonFields = cloneDeep(fields);const geojsonRows = cloneDeep(rows);@@ -382,9 +383,18 @@ function mockStateWithTooltipFormat() {...oldConfig,config: {...oldConfig.config,+ compareMode: true,+ compareType: COMPARE_TYPES.RELATIVE,fieldsToShow: {...oldConfig.config.fieldsToShow,- [testCsvDataId]: [{name: 'gps_data.utc_timestamp', format: 'LL'}]+ [testCsvDataId]: [{name: 'gps_data.utc_timestamp', format: 'LL'}],+ [testGeoJsonDataId]: [+ {name: 'OBJECTID', format: null},+ {name: 'ZIP_CODE', format: null},+ {name: 'ID', format: null},+ {name: 'TRIPS', format: '.3f'},+ {name: 'RATE', format: null}+ ]}}};diff --git a/test/node/reducers/composer-state-test.js b/test/node/reducers/composer-state-test.jsindex ef98dd8d2..da8f88ea4 100644--- a/test/node/reducers/composer-state-test.js+++ b/test/node/reducers/composer-state-test.js@@ -230,6 +230,8 @@ test('#composerStateReducer - addDataToMapUpdater: keepExistingConfig', t => {tooltip: {...oldInteractionConfig.tooltip,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {...oldInteractionConfig.tooltip.config.fieldsToShow,[hexDataId]: [diff --git a/test/node/reducers/vis-state-merger-test.js b/test/node/reducers/vis-state-merger-test.jsindex 053ae091f..e462a2529 100644--- a/test/node/reducers/vis-state-merger-test.js+++ b/test/node/reducers/vis-state-merger-test.js@@ -652,6 +652,8 @@ test('VisStateMerger.v0 -> mergeInteractions -> toWorkingState', t => {...defaultInteraction.tooltip,enabled: true,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {[testCsvDataId]: [{@@ -781,7 +783,9 @@ test('VisStateMerger.v1 -> mergeInteractions -> toEmptyState', t => {...defaultInteraction.tooltip,enabled: false,config: {- fieldsToShow: {}+ fieldsToShow: {},+ compareMode: false,+ compareType: 'absolute'}},brush: {@@ -889,6 +893,8 @@ test('VisStateMerger.v1 -> mergeInteractions -> toWorkingState', t => {...defaultInteraction.tooltip,enabled: false,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {[testCsvDataId]: [{@@ -969,6 +975,8 @@ test('VisStateMerger.v1 -> mergeInteractions -> toWorkingState', t => {...defaultInteraction.tooltip,enabled: false,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {[testCsvDataId]: [{@@ -1108,6 +1116,8 @@ test('VisStateMerger.v1 -> mergeInteractions -> coordinate', t => {...defaultInteraction.tooltip,enabled: false,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {a5ybmwl2d: [{diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.jsindex 0892e8336..41b4ee0be 100644--- a/test/node/reducers/vis-state-test.js+++ b/test/node/reducers/vis-state-test.js@@ -2419,6 +2419,8 @@ test('#visStateReducer -> REMOVE_DATASET w filter and layer', t => {enabled: true,iconComponent: oldState.interactionConfig.tooltip.iconComponent,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {[testGeoJsonDataId]: [{@@ -2652,6 +2654,8 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_DATASET', t => {enabled: true,iconComponent: oldState.interactionConfig.tooltip.iconComponent,config: {+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {[testCsvDataId]: [{diff --git a/test/node/schemas/vis-state-schema-test.js b/test/node/schemas/vis-state-schema-test.jsindex 3d1f7d03d..949e31dd4 100644--- a/test/node/schemas/vis-state-schema-test.js+++ b/test/node/schemas/vis-state-schema-test.js@@ -131,6 +131,8 @@ test('#visStateSchema -> v1 -> save load interaction', t => {const expectedSaved = {tooltip: {enabled: true,+ compareMode: false,+ compareType: 'absolute',fieldsToShow: {[testCsvDataId]: [{@@ -207,6 +209,8 @@ test('#visStateSchema -> v1 -> save load interaction -> tooltip format', t => {const expectedSaved = {tooltip: {enabled: true,+ compareMode: true,+ compareType: 'relative',fieldsToShow: {[testCsvDataId]: [{name: 'gps_data.utc_timestamp', format: 'LL'}],[testGeoJsonDataId]: [@@ -224,7 +228,7 @@ test('#visStateSchema -> v1 -> save load interaction -> tooltip format', t => {},{name: 'TRIPS',- format: null+ format: '.3f'},{name: 'RATE',diff --git a/test/node/utils/interaction-utils-test.js b/test/node/utils/interaction-utils-test.jsindex 7c038e280..5f49c6151 100644--- a/test/node/utils/interaction-utils-test.js+++ b/test/node/utils/interaction-utils-test.js@@ -19,8 +19,14 @@// THE SOFTWARE.import test from 'tape';-import {findFieldsToShow} from 'utils/interaction-utils';+import {+ findFieldsToShow,+ getTooltipDisplayValue,+ getTooltipDisplayDeltaValue+} from 'utils/interaction-utils';import {DEFAULT_TOOLTIP_FIELDS} from 'constants/default-settings';+import {StateWTooltipFormat, testGeoJsonDataId} from 'test/helpers/mock-state';+import {COMPARE_TYPES} from 'constants/tooltip';const fields = [{@@ -131,3 +137,122 @@ test('interactionUtil -> autoFindTooltipFields', t => {t.end();});++test('interactionUtil -> getTooltipDisplayDeltaValue', t => {+ const tooltipConfig = StateWTooltipFormat.visState.interactionConfig.tooltip.config;+ const dataset = StateWTooltipFormat.visState.datasets[testGeoJsonDataId];+ const testFieldIdx = dataset.fields.findIndex(f => f.name === 'TRIPS');+ const item = tooltipConfig.fieldsToShow[testGeoJsonDataId].find(fs => fs.name === 'TRIPS');++ const TEST_CASES = [+ {+ input: {+ primaryData: dataset.allData[0],+ field: dataset.fields[testFieldIdx],+ compareType: COMPARE_TYPES.ABSOLUTE,+ data: dataset.allData[1],+ fieldIdx: testFieldIdx,+ item+ },+ output: '-7.000',+ message: 'should display absolute delta value'+ },+ {+ input: {+ primaryData: dataset.allData[0],+ field: dataset.fields[testFieldIdx],+ compareType: COMPARE_TYPES.RELATIVE,+ data: dataset.allData[1],+ fieldIdx: testFieldIdx,+ item+ },+ output: '-63.64%',+ message: 'should display relative delta value'+ },+ {+ input: {+ primaryData: dataset.allData[3],+ field: dataset.fields[testFieldIdx],+ compareType: COMPARE_TYPES.ABSOLUTE,+ data: dataset.allData[1],+ fieldIdx: testFieldIdx,+ item+ },+ output: '-',+ message: 'should display - when primary is null'+ },+ {+ input: {+ primaryData: dataset.allData[0],+ field: dataset.fields[testFieldIdx],+ compareType: COMPARE_TYPES.ABSOLUTE,+ data: dataset.allData[3],+ fieldIdx: testFieldIdx,+ item+ },+ output: '-',+ message: 'should display - when data is null'+ },+ {+ input: {+ primaryData: dataset.allData[4],+ field: dataset.fields[testFieldIdx],+ compareType: COMPARE_TYPES.ABSOLUTE,+ data: dataset.allData[3],+ fieldIdx: testFieldIdx,+ item+ },+ output: '-',+ message: 'should display - when both are null'+ }+ ];++ TEST_CASES.forEach(tc => {+ t.equal(getTooltipDisplayDeltaValue(tc.input), tc.output, tc.message);+ });++ t.end();+});++test('interactionUtil -> getTooltipDisplayValue', t => {+ const tooltipConfig = StateWTooltipFormat.visState.interactionConfig.tooltip.config;+ const dataset = StateWTooltipFormat.visState.datasets[testGeoJsonDataId];+ const items = tooltipConfig.fieldsToShow[testGeoJsonDataId];++ const TEST_CASES = [+ {+ input: items[0], // OBJECTID+ output: ['1', '2', '3', '4', '5'],+ message: `should display correct tooltip value for ${items[0].name}`+ },+ {+ input: items[3], // ID+ output: ['11.000', '4.000', '20.000', '', ''],+ message: `should display correct tooltip value for ${items[3].name}`+ },+ {+ input: {name: 'OBJ', format: null}, // ID+ output: ['{"id":1}', '{"id":2}', '{"id":3}', '{"id":4}', '{"id":5}'],+ message: 'should display correct tooltip value for OBJ'+ }+ ];++ TEST_CASES.forEach(tc => {+ const field = dataset.fields.find(f => f.name === tc.input.name);+ const fieldIdx = dataset.fields.findIndex(f => f.name === tc.input.name);++ t.deepEqual(+ dataset.allData.map(data =>+ getTooltipDisplayValue({+ field,+ data,+ fieldIdx,+ item: tc.input+ })+ ),+ tc.output,+ tc.message+ );+ });+ t.end();+});diff --git a/test/node/utils/layer-utils-test.js b/test/node/utils/layer-utils-test.jsindex 96be72e2f..08c0ee7a5 100644--- a/test/node/utils/layer-utils-test.js+++ b/test/node/utils/layer-utils-test.js@@ -19,7 +19,7 @@// THE SOFTWARE.import test from 'tape';-import {findDefaultLayer} from 'utils/layer-utils/layer-utils';+import {findDefaultLayer} from 'utils/layer-utils';import {findPointFieldPairs, createNewDataEntry} from 'utils/dataset-utils';import {processCsvData, processGeojson} from 'processors/data-processor';import {GEOJSON_FIELDS} from 'constants/default-settings';