Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[Bug] Fix icon layer instructions (#131)

Shan Heba4bbd79b72f
diff --git a/.prettierrc b/.prettierrc
index 7f5dba435..7c721411d 100644
--- a/.prettierrc
+++ b/.prettierrc
@@ -1,4 +1,6 @@
{
"bracketSpacing": false,
- "singleQuote": true
+ "singleQuote": true,
+ "trailingComma": "none",
+ "semi": true
}
diff --git a/examples/demo-app/src/app.js b/examples/demo-app/src/app.js
index cd558d9a3..638cb62d9 100644
--- a/examples/demo-app/src/app.js
+++ b/examples/demo-app/src/app.js
@@ -68,7 +68,7 @@ class App extends Component {
};
componentWillMount() {
- // if we pass an id as part f the url
+ // if we pass an id as part of the url
// we ry to fetch along map configurations
const {params: {id: sampleMapId} = {}} = this.props;
this.props.dispatch(loadSampleConfigurations(sampleMapId));
diff --git a/jsconfig.json b/jsconfig.json
new file mode 100644
index 000000000..4dada2dd1
--- /dev/null
+++ b/jsconfig.json
@@ -0,0 +1,5 @@
+{
+ "compilerOptions": {
+ "baseUrl": "./src"
+ }
+}
\ No newline at end of file
diff --git a/src/components/common/modal.js b/src/components/common/modal.js
index b9eb2f6d9..1f2e2de0c 100644
--- a/src/components/common/modal.js
+++ b/src/components/common/modal.js
@@ -199,6 +199,10 @@ const StyledModal = styled(ModalDialog)`
left: 0;
z-index: 10000;
transition: ${props => props.theme.transition};
+
+ :focus {
+ outline: 0
+ }
`;
export default StyledModal;
diff --git a/src/components/common/styled-components.js b/src/components/common/styled-components.js
index ae2a20770..aca911394 100644
--- a/src/components/common/styled-components.js
+++ b/src/components/common/styled-components.js
@@ -182,13 +182,23 @@ export const Button = styled.div.attrs({
: props.link ? props.theme.linkBtnColor : props.theme.primaryBtnColor};
cursor: pointer;
display: inline-flex;
- font-size: ${props => (props.large ? '14px' : '11px')};
+ font-size: ${props =>
+ props.large ?
+ '14px'
+ : props.small
+ ? '10px'
+ : '11px'};
font-weight: 500;
justify-content: center;
letter-spacing: 0.3px;
line-height: 14px;
outline: 0;
- padding: ${props => (props.large ? '14px 32px' : '9px 12px')};
+ padding: ${props =>
+ props.large ?
+ '14px 32px'
+ : props.small
+ ? '6px 9px'
+ : '9px 12px'};
text-align: center;
transition: ${props => props.theme.transition};
vertical-align: middle;
@@ -294,7 +304,7 @@ export const DatasetSquare = styled.div`
export const Table = styled.table`
width: 100%;
border-spacing: 0;
-
+
thead {
tr th {
background: ${props => props.theme.panelBackgroundLT};
@@ -303,7 +313,7 @@ export const Table = styled.table`
text-align: start;
}
}
-
+
tbody {
tr td {
border-bottom: ${props => props.theme.panelBorderLT};
diff --git a/src/components/index.js b/src/components/index.js
index ff9560986..40a553cd3 100644
--- a/src/components/index.js
+++ b/src/components/index.js
@@ -36,7 +36,6 @@ export {default as MapControlFactory} from './map/map-control';
// // modal container factories
export {default as DeleteDatasetModalFactory} from './modals/delete-data-modal';
-export {default as IconInfoModalFactory} from './modals/icon-info-modal';
export {default as DataTableModalFactory} from './modals/data-table-modal';
export {default as LoadDataModalFactory} from './modals/load-data-modal';
diff --git a/src/components/modal-container.js b/src/components/modal-container.js
index 0281d7e6c..13bca67b9 100644
--- a/src/components/modal-container.js
+++ b/src/components/modal-container.js
@@ -30,7 +30,6 @@ import KeplerGlSchema from 'schemas';
import {downloadFile, dataURItoBlob} from 'utils/export-image-utils';
// modals
import DeleteDatasetModalFactory from './modals/delete-data-modal';
-import IconInfoModalFactory from './modals/icon-info-modal';
import DataTableModalFactory from './modals/data-table-modal';
import LoadDataModalFactory from './modals/load-data-modal';
import ExportImageModalFactory from './modals/export-image-modal';
@@ -69,7 +68,6 @@ const LoadDataModalStyle = css`
ModalContainerFactory.deps = [
DeleteDatasetModalFactory,
- IconInfoModalFactory,
DataTableModalFactory,
LoadDataModalFactory,
ExportImageModalFactory,
@@ -80,7 +78,6 @@ ModalContainerFactory.deps = [
export default function ModalContainerFactory(
DeleteDatasetModal,
- IconInfoModal,
DataTableModal,
LoadDataModal,
ExportImageModal,
@@ -159,7 +156,7 @@ export default function ModalContainerFactory(
this._downloadFile(csv, type, `${filename}_${label}.csv`);
break;
}
- // TODO: support more different data type later.
+ // TODO: support more file types.
default:
break;
}
@@ -202,168 +199,171 @@ export default function ModalContainerFactory(
let template = null;
let modalProps = {};
- switch (currentModal) {
- case 'iconInfo':
- template = <IconInfoModal />;
- modalProps.title = 'How to draw icons';
- break;
-
- case DATA_TABLE_ID:
- template = (
- <DataTableModal
- width={containerW * 0.9}
- height={containerH * 0.85}
- datasets={datasets}
- dataId={editingDataset}
- showDatasetTable={visStateActions.showDatasetTable}
- />
- );
- modalProps.cssStyle = DataTableModalStyle;
- break;
- case DELETE_DATA_ID:
- // validate options
- if (datasetKeyToRemove && datasets && datasets[datasetKeyToRemove]) {
+ if (currentModal && currentModal.id &&
+ currentModal.template) {
+ // if currentMdoal template is already provided
+ // TODO: need to check whether template is valid
+ template = (<currentModal.template/>);
+ modalProps = currentModal.modalProps;
+ } else {
+ switch (currentModal) {
+ case DATA_TABLE_ID:
template = (
- <DeleteDatasetModal
- dataset={datasets[datasetKeyToRemove]}
- layers={layers}
+ <DataTableModal
+ width={containerW * 0.9}
+ height={containerH * 0.85}
+ datasets={datasets}
+ dataId={editingDataset}
+ showDatasetTable={visStateActions.showDatasetTable}
/>
);
+ modalProps.cssStyle = DataTableModalStyle;
+ break;
+ case DELETE_DATA_ID:
+ // validate options
+ if (datasetKeyToRemove && datasets && datasets[datasetKeyToRemove]) {
+ template = (
+ <DeleteDatasetModal
+ dataset={datasets[datasetKeyToRemove]}
+ layers={layers}
+ />
+ );
+
+ modalProps = {
+ title: 'Delete Dataset',
+ cssStyle: DeleteDatasetModalStyled,
+ footer: true,
+ onConfirm: () => this._deleteDataset(datasetKeyToRemove),
+ onCancel: this._closeModal,
+ confirmButton: {
+ negative: true,
+ large: true,
+ children: 'Delete'
+ }
+ };
+ }
+ break; // in case we add a new case after this one
+ case ADD_DATA_ID:
+ template = (
+ <LoadDataModal
+ onClose={this._closeModal}
+ onFileUpload={this._onFileUpload}
+ />
+ );
+ modalProps = {
+ title: 'Add Data To Map',
+ cssStyle: LoadDataModalStyle,
+ footer: false,
+ onConfirm: this._closeModal
+ };
+ break;
+ case EXPORT_IMAGE_ID:
+ const { ratio, legend, resolution, exporting, imageDataUri } = uiState.exportImage;
+ template = (
+ <ExportImageModal
+ width={containerW}
+ height={containerH}
+ legend={legend}
+ ratio={ratio}
+ resolution={resolution}
+ exporting={exporting}
+ imageDataUri={imageDataUri}
+ onChangeRatio={this.props.uiStateActions.setRatio}
+ onChangeResolution={this.props.uiStateActions.setResolution}
+ onToggleLegend={this.props.uiStateActions.toggleLegend}
+ />
+ );
modalProps = {
- title: 'Delete Dataset',
- cssStyle: DeleteDatasetModalStyled,
+ close: false,
+ title: 'Export Image',
footer: true,
- onConfirm: () => this._deleteDataset(datasetKeyToRemove),
onCancel: this._closeModal,
+ onConfirm: this._onExportImage,
confirmButton: {
- negative: true,
large: true,
- children: 'Delete'
+ disabled: exporting,
+ children: 'Download'
}
};
- }
- break; // in case we add a new case after this one
- case ADD_DATA_ID:
- template = (
- <LoadDataModal
- onClose={this._closeModal}
- onFileUpload={this._onFileUpload}
- />
- );
- modalProps = {
- title: 'Add Data To Map',
- cssStyle: LoadDataModalStyle,
- footer: false,
- onConfirm: this._closeModal
- };
- break;
-
- case EXPORT_IMAGE_ID:
- const {ratio, legend, resolution, exporting, imageDataUri} = uiState.exportImage;
- template = (
- <ExportImageModal
- width={containerW}
- height={containerH}
- legend={legend}
- ratio={ratio}
- resolution={resolution}
- exporting={exporting}
- imageDataUri={imageDataUri}
- onChangeRatio={this.props.uiStateActions.setRatio}
- onChangeResolution={this.props.uiStateActions.setResolution}
- onToggleLegend={this.props.uiStateActions.toggleLegend}
- />
- );
- modalProps = {
- close: false,
- title: 'Export Image',
- footer: true,
- onCancel: this._closeModal,
- onConfirm: this._onExportImage,
- confirmButton: {
- large: true,
- disabled: exporting,
- children: 'Download'
- }
- };
- break;
-
- case EXPORT_DATA_ID:
-
- template = (
- <ExportDataModal
- {...uiState.exportData}
- datasets={datasets}
- onClose={this._closeModal}
- onChangeExportDataType={this.props.uiStateActions.setExportDataType}
- onChangeExportSelectedDataset={this.props.uiStateActions.setExportSelectedDataset}
- onChangeExportFiltered={this.props.uiStateActions.setExportFiltered}
- />
- );
- modalProps = {
- close: false,
- title: 'Export Data',
- footer: true,
- onCancel: this._closeModal,
- onConfirm: this._onExportData,
- confirmButton: {
- large: true,
- children: 'Export'
- }
- };
- break;
-
- case EXPORT_CONFIG_ID:
- const keplerGlConfig = KeplerGlSchema.getConfigToSave(
- {mapStyle, visState, mapState, uiState}
- );
- template = (
- <ExportConfigModal
- config={keplerGlConfig}
- data={uiState.exportData.data}
- onClose={this._closeModal}
- onChangeExportData={this.props.uiStateActions.setExportData}
- />
- );
- modalProps = {
- close: false,
- title: 'Export Config',
- footer: true,
- onCancel: this._closeModal,
- onConfirm: this._onExportConfig,
- confirmButton: {
- large: true,
- children: 'Export'
- }
- };
- break;
-
- case ADD_MAP_STYLE_ID:
- template = (
- <AddMapStyleModal
- mapboxApiAccessToken={this.props.mapboxApiAccessToken}
- mapState={this.props.mapState}
- inputStyle={mapStyle.inputStyle}
- inputMapStyle={this.props.mapStyleActions.inputMapStyle}
- loadCustomMapStyle={this.props.mapStyleActions.loadCustomMapStyle}
- />
- );
- modalProps = {
- close: false,
- title: 'Add Custom Mapbox Style',
- footer: true,
- onCancel: this._closeModal,
- onConfirm: this._onAddCustomMapStyle,
- confirmButton: {
- large: true,
- disabled: !mapStyle.inputStyle.style,
- children: 'Add Style'
- }
- };
- break;
- default:
- break;
+ break;
+
+ case EXPORT_DATA_ID:
+
+ template = (
+ <ExportDataModal
+ {...uiState.exportData}
+ datasets={datasets}
+ onClose={this._closeModal}
+ onChangeExportDataType={this.props.uiStateActions.setExportDataType}
+ onChangeExportSelectedDataset={this.props.uiStateActions.setExportSelectedDataset}
+ onChangeExportFiltered={this.props.uiStateActions.setExportFiltered}
+ />
+ );
+ modalProps = {
+ close: false,
+ title: 'Export Data',
+ footer: true,
+ onCancel: this._closeModal,
+ onConfirm: this._onExportData,
+ confirmButton: {
+ large: true,
+ children: 'Export'
+ }
+ };
+ break;
+
+ case EXPORT_CONFIG_ID:
+ const keplerGlConfig = KeplerGlSchema.getConfigToSave(
+ { mapStyle, visState, mapState, uiState }
+ );
+ template = (
+ <ExportConfigModal
+ config={keplerGlConfig}
+ data={uiState.exportData.data}
+ onClose={this._closeModal}
+ onChangeExportData={this.props.uiStateActions.setExportData}
+ />
+ );
+ modalProps = {
+ close: false,
+ title: 'Export Config',
+ footer: true,
+ onCancel: this._closeModal,
+ onConfirm: this._onExportConfig,
+ confirmButton: {
+ large: true,
+ children: 'Export'
+ }
+ };
+ break;
+
+ case ADD_MAP_STYLE_ID:
+ template = (
+ <AddMapStyleModal
+ mapboxApiAccessToken={this.props.mapboxApiAccessToken}
+ mapState={this.props.mapState}
+ inputStyle={mapStyle.inputStyle}
+ inputMapStyle={this.props.mapStyleActions.inputMapStyle}
+ loadCustomMapStyle={this.props.mapStyleActions.loadCustomMapStyle}
+ />
+ );
+ modalProps = {
+ close: false,
+ title: 'Add Custom Mapbox Style',
+ footer: true,
+ onCancel: this._closeModal,
+ onConfirm: this._onAddCustomMapStyle,
+ confirmButton: {
+ large: true,
+ disabled: !mapStyle.inputStyle.style,
+ children: 'Add Style'
+ }
+ };
+ break;
+ default:
+ break;
+ }
}
return this.props.rootNode ? (
diff --git a/src/components/side-panel/layer-panel/layer-column-config.js b/src/components/side-panel/layer-panel/layer-column-config.js
index cb828ccab..7759fa80b 100644
--- a/src/components/side-panel/layer-panel/layer-column-config.js
+++ b/src/components/side-panel/layer-panel/layer-column-config.js
@@ -21,10 +21,7 @@
import React, {Component} from 'react';
import PropTypes from 'prop-types';
import styled from 'styled-components';
-
-import {LAYER_TYPES} from 'constants/default-settings';
import FieldSelector from 'components/common/field-selector';
-import {Docs} from 'components/common/icons';
import {
PanelLabel,
@@ -41,7 +38,6 @@ export default class LayerColumnConfig extends Component {
layer: PropTypes.object.isRequired,
fields: PropTypes.arrayOf(PropTypes.any).isRequired,
updateLayerConfig: PropTypes.func.isRequired,
- openModal: PropTypes.func.isRequired,
fieldPairs: PropTypes.arrayOf(PropTypes.any)
};
@@ -84,9 +80,6 @@ export default class LayerColumnConfig extends Component {
onSelect={val => this._updateColumn(key, val)}
/>
))}
- {layer.type === LAYER_TYPES.icon && (
- <IconLayerInfo openModal={this.props.openModal} />
- )}
</div>
</SidePanelSection>
</div>
@@ -125,26 +118,3 @@ const ColumnSelector = ({column, label, allFields, onSelect, fieldPairs}) => (
</ColumnSelect>
</ColumnRow>
);
-
-const LayerInstruction = styled.div`
- display: flex;
- justify-content: flex-end;
- color: ${props => props.theme.textColor};
-
- :hover {
- cursor: pointer;
- color: ${props => props.theme.textColorHL};
- }
-`;
-
-const InfoIcon = styled.div`
- margin-right: 4px;
-`;
-
-const IconLayerInfo = ({openModal}) => (
- <LayerInstruction className="layer-config__info"
- onClick={() => openModal('iconInfo')}>
- <InfoIcon><Docs height="16px"/></InfoIcon>
- <PanelLabel>How to draw icon layer</PanelLabel>
- </LayerInstruction>
-);
diff --git a/src/components/side-panel/layer-panel/layer-config-group.js b/src/components/side-panel/layer-panel/layer-config-group.js
index fe0df031c..7fe700de0 100644
--- a/src/components/side-panel/layer-panel/layer-config-group.js
+++ b/src/components/side-panel/layer-panel/layer-config-group.js
@@ -38,6 +38,7 @@ export const StyledLayerConfigGroupLabel = styled.div`
export const StyledLayerConfigGroup = styled.div`
padding-left: 18px;
margin-bottom: 18px;
+
`;
export const StyledConfigGroupHeader = styled.div`
diff --git a/src/components/side-panel/layer-panel/layer-configurator.js b/src/components/side-panel/layer-panel/layer-configurator.js
index a4968a1d7..72bbee779 100644
--- a/src/components/side-panel/layer-panel/layer-configurator.js
+++ b/src/components/side-panel/layer-panel/layer-configurator.js
@@ -23,6 +23,7 @@ import PropTypes from 'prop-types';
import styled from 'styled-components';
import {
+ Button,
PanelLabel,
SidePanelSection
} from 'components/common/styled-components';
@@ -50,6 +51,7 @@ import {
const StyledLayerConfigurator = styled.div.attrs({
className: 'layer-panel__config'
})`
+ position: relative;
margin-top: 12px;
`;
@@ -606,6 +608,7 @@ export default class LayerConfigurator extends Component {
return (
<StyledLayerConfigurator>
+ {layer.layerInfoModal ? <HowToButton onClick={() => this.props.openModal(layer.layerInfoModal)}/> : null}
<LayerConfigGroup label={'basic'}>
{Object.keys(datasets).length > 1 && (
<SourceDataSelector
@@ -627,7 +630,6 @@ export default class LayerConfigurator extends Component {
fieldPairs={fieldPairs}
updateLayerConfig={updateLayerConfig}
updateLayerType={this.props.updateLayerType}
- openModal={this.props.openModal}
/>
</LayerConfigGroup>
{this[renderTemplate] &&
@@ -646,6 +648,18 @@ export default class LayerConfigurator extends Component {
* Componentize config component into pure functional components
*/
+const StyledHowToButton = styled.div`
+ position: absolute;
+ right: 0;
+ top: 0;
+`;
+
+export const HowToButton = ({onClick}) => (
+ <StyledHowToButton>
+ <Button secondary small onClick={onClick}>How to</Button>
+ </StyledHowToButton>
+);
+
export const LayerColorSelector = ({layer, onChange, label}) => (
<SidePanelSection disabled={layer.config.colorField}>
<ColorSelector
diff --git a/src/layers/base-layer.js b/src/layers/base-layer.js
index 52ddd2a94..50e8a3f55 100644
--- a/src/layers/base-layer.js
+++ b/src/layers/base-layer.js
@@ -177,6 +177,21 @@ export default class Layer {
};
}
+ /**
+ * Return a React component for to render layer instructions in a modal
+ * @returns {object} - an object
+ * @example
+ * return {
+ * id: 'iconInfo',
+ * template: IconInfoModal,
+ * modalProps: {
+ * title: 'How to draw icons'
+ * };
+ * }
+ */
+ get layerInfoModal() {
+ return null;
+ }
/*
* Given a dataset, automatically create layers based on it
* and return the props
diff --git a/src/components/modals/icon-info-modal.js b/src/layers/icon-layer/icon-info-modal.js
similarity index 100%
rename from src/components/modals/icon-info-modal.js
rename to src/layers/icon-layer/icon-info-modal.js
diff --git a/src/layers/icon-layer/icon-layer.js b/src/layers/icon-layer/icon-layer.js
index b4deac528..2778b9e5e 100644
--- a/src/layers/icon-layer/icon-layer.js
+++ b/src/layers/icon-layer/icon-layer.js
@@ -20,13 +20,15 @@
import Layer from '../base-layer';
import memoize from 'lodash.memoize';
-import {hexToRgb} from '../../utils/color-utils';
+import {hexToRgb} from 'utils/color-utils';
import {svgIcons as SvgIcons} from './svg-icons.json';
-import SvgIconLayer from '../../deckgl-layers/svg-icon-layer/svg-icon-layer';
-import ScatterplotIconLayer from '../../deckgl-layers/svg-icon-layer/scatterplot-icon-layer';
+import SvgIconLayer from 'deckgl-layers/svg-icon-layer/svg-icon-layer';
+import ScatterplotIconLayer from 'deckgl-layers/svg-icon-layer/scatterplot-icon-layer';
import IconLayerIcon from './icon-layer-icon';
import {ICON_FIELDS} from 'constants/default-settings';
+import IconInfoModalFactory from './icon-info-modal';
+const IconInfoModal = IconInfoModalFactory();
const IconIds = SvgIcons.map(d => d.id);
const SvgIconGeometry = SvgIcons.reduce(
(accu, curr) => ({
@@ -100,6 +102,16 @@ export default class IconLayer extends Layer {
};
}
+ get layerInfoModal() {
+ return {
+ id: 'iconInfo',
+ template: IconInfoModal,
+ modalProps: {
+ title: 'How to draw icons'
+ }
+ };
+ }
+
static findDefaultLayerProps({fieldPairs, fields}) {
if (!fieldPairs.length) {
return [];
diff --git a/website/src/reducers/analytics.js b/website/src/reducers/analytics.js
index 93aeb0157..d4509e3dd 100644
--- a/website/src/reducers/analytics.js
+++ b/website/src/reducers/analytics.js
@@ -25,7 +25,7 @@ import {LOCATION_CHANGE} from 'react-router-redux';
import window from 'global/window';
import {ALL_FIELD_TYPES} from 'kepler.gl/constants';
-const getPayload = ({payload}) => payload;
+const getPayload = ({payload} = {}) => payload;
// Hack, because we don't have a way to access next state
const getFilterType = (store, idx, value) => {