Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Feat] HTML Export: provide read only mode (#709)
Giuseppe Macrìc323c7bc83e0
diff --git a/examples/demo-app/src/reducers/index.js b/examples/demo-app/src/reducers/index.jsindex 1f9dda5ee..00c1585a7 100644--- a/examples/demo-app/src/reducers/index.js+++ b/examples/demo-app/src/reducers/index.js@@ -21,10 +21,10 @@import {combineReducers} from 'redux';import {handleActions} from 'redux-actions';-import keplerGlReducer, {combinedUpdaters} from 'kepler.gl/reducers';+import keplerGlReducer, {combinedUpdaters, uiStateUpdaters} from 'kepler.gl/reducers';import {processGeojson, processCsvData} from 'kepler.gl/processors';import KeplerGlSchema from 'kepler.gl/schemas';-import {EXPORT_MAP_FORMAT} from 'kepler.gl/constants';+import {EXPORT_MAP_FORMATS} from 'kepler.gl/constants';import sharingReducer from './sharing';@@ -84,6 +84,8 @@ export const appReducer = handleActions({})}, initialAppState);+const {DEFAULT_EXPORT_MAP} = uiStateUpdaters;+// combine app reducer and keplerGl reducer// to mimic the reducer state of kepler.gl websiteconst demoReducer = combineReducers({@@ -94,13 +96,10 @@ const demoReducer = combineReducers({// in the exported fileuiState: {exportMap: {- format: EXPORT_MAP_FORMAT.HTML,- [EXPORT_MAP_FORMAT.JSON]: {- hasData: true- },- [EXPORT_MAP_FORMAT.HTML]: {- exportMapboxAccessToken: AUTH_TOKENS.EXPORT_MAPBOX_TOKEN,- userMapboxToken: ''+ ...DEFAULT_EXPORT_MAP,+ [EXPORT_MAP_FORMATS.HTML]: {+ ...DEFAULT_EXPORT_MAP[[EXPORT_MAP_FORMATS.HTML]],+ exportMapboxAccessToken: AUTH_TOKENS.EXPORT_MAPBOX_TOKEN}}}diff --git a/src/actions/ui-state-actions.js b/src/actions/ui-state-actions.jsindex 1a4ad674a..53b84e107 100644--- a/src/actions/ui-state-actions.js+++ b/src/actions/ui-state-actions.js@@ -243,6 +243,15 @@ export const setExportMapFormat = createAction(payload => payload);+/**+ * Set the HTML mode to use to export HTML mode+ * @type {actionCreator}+ */+export const setExportHTMLMapMode = createAction(+ ActionTypes.SET_EXPORT_MAP_HTML_MODE,+ payload => payload+);+/*** This declaration is needed to group actions in docs*/diff --git a/src/components/bottom-widget.js b/src/components/bottom-widget.jsindex db007b633..d0955d46e 100644--- a/src/components/bottom-widget.js+++ b/src/components/bottom-widget.js@@ -46,7 +46,7 @@ export default function BottomWidgetFactory(TimeWidget) {uiState,sidePanelWidth} = props;- const {activeSidePanel} = uiState;+ const {activeSidePanel, readOnly} = uiState;const isOpen = Boolean(activeSidePanel);const enlargedFilterIdx = filters.findIndex(f => f.enlarged);@@ -69,9 +69,10 @@ export default function BottomWidgetFactory(TimeWidget) {isAnyFilterAnimating={isAnyFilterAnimating}enlargedIdx={enlargedFilterIdx}filter={filters[enlargedFilterIdx]}+ readOnly={readOnly}/>);- }+ };BottomWidget.propTypes = propTypes;diff --git a/src/components/filters/time-widget.js b/src/components/filters/time-widget.jsindex 826a367f8..2cea289e4 100644--- a/src/components/filters/time-widget.js+++ b/src/components/filters/time-widget.js@@ -154,7 +154,8 @@ export class TimeWidget extends Component {setFilterPlot,toggleAnimation,updateAnimationSpeed,- width+ width,+ readOnly} = this.props;const {showSpeedControl} = this.state;@@ -202,11 +203,13 @@ export class TimeWidget extends Component {updateAnimationSpeed={(speed) => updateAnimationSpeed(enlargedIdx, speed)}speed={filter.speed}/> : null}</StyledTitle>- <CenterFlexbox>- <IconRoundSmall>- <Close height="12px" onClick={() => enlargeFilter(enlargedIdx)} />- </IconRoundSmall>- </CenterFlexbox>+ {!readOnly ? (+ <CenterFlexbox>+ <IconRoundSmall>+ <Close height="12px" onClick={() => enlargeFilter(enlargedIdx)} />+ </IconRoundSmall>+ </CenterFlexbox>+ ) : null}</TopSectionWrapper><TimeRangeFilterfilter={filter}diff --git a/src/components/modal-container.js b/src/components/modal-container.jsindex fcda36d43..bda7d280b 100644--- a/src/components/modal-container.js+++ b/src/components/modal-container.js@@ -53,7 +53,7 @@ import {EXPORT_MAP_ID,ADD_MAP_STYLE_ID} from 'constants/default-settings';-import {EXPORT_MAP_FORMAT} from '../constants/default-settings';+import {EXPORT_MAP_FORMATS} from '../constants/default-settings';const DataTableModalStyle = css`top: 80px;@@ -181,7 +181,7 @@ export default function ModalContainerFactory(_onExportJSONMap = () => {const {uiState} = this.props;- const {hasData} = uiState.exportMap[EXPORT_MAP_FORMAT.JSON];+ const {hasData} = uiState.exportMap[EXPORT_MAP_FORMATS.JSON];// we pass all props because we avoid to create new variablesconst data = hasData ? KeplerGlSchema.save(this.props)@@ -198,11 +198,12 @@ export default function ModalContainerFactory(_onExportHTMLMap = () => {const {uiState} = this.props;- const {userMapboxToken, exportMapboxAccessToken} = uiState.exportMap[EXPORT_MAP_FORMAT.HTML];+ const {userMapboxToken, exportMapboxAccessToken, mode} = uiState.exportMap[EXPORT_MAP_FORMATS.HTML];const data = {...KeplerGlSchema.save(this.props),- mapboxApiAccessToken: (userMapboxToken || '') !== '' ? userMapboxToken : exportMapboxAccessToken+ mapboxApiAccessToken: (userMapboxToken || '') !== '' ? userMapboxToken : exportMapboxAccessToken,+ mode};this._downloadFile(@@ -219,8 +220,8 @@ export default function ModalContainerFactory(const {format} = uiState.exportMap;const downloader = {- [EXPORT_MAP_FORMAT.HTML]: this._onExportHTMLMap,- [EXPORT_MAP_FORMAT.JSON]: this._onExportJSONMap+ [EXPORT_MAP_FORMATS.HTML]: this._onExportHTMLMap,+ [EXPORT_MAP_FORMATS.JSON]: this._onExportJSONMap}[format];downloader && downloader();@@ -367,6 +368,7 @@ export default function ModalContainerFactory(options={uiState.exportMap}onChangeExportMapFormat={this.props.uiStateActions.setExportMapFormat}onEditUserMapboxAccessToken={this.props.uiStateActions.setUserMapboxAccessToken}+ onChangeExportMapHTMLMode={this.props.uiStateActions.setExportHTMLMapMode}/>);modalProps = {diff --git a/src/components/modals/export-map-modal.js b/src/components/modals/export-map-modal.jsindex 555dada89..cede6aa67 100644--- a/src/components/modals/export-map-modal.js+++ b/src/components/modals/export-map-modal.js@@ -22,7 +22,7 @@ import React from 'react';import PropTypes from 'prop-types';import styled from 'styled-components';import JSONPretty from 'react-json-pretty';-import {GITHUB_EXPORT_HTML_MAP, GITHUB_ADD_DATA_TO_MAP} from 'constants/user-guides';+import {GITHUB_EXPORT_HTML_MAP, GITHUB_ADD_DATA_TO_MAP, GITHUB_EXPORT_HTML_MAP_MODES} from 'constants/user-guides';import {FileType} from 'components/common/icons';import {StyledModalContent,@@ -31,12 +31,15 @@ import {} from 'components/common/styled-components';import {DISCLAIMER,- EXPORT_MAP_FORMAT,+ EXPORT_MAP_FORMATS,EXPORT_MAP_FORMAT_OPTIONS,+ EXPORT_HTML_MAP_MODE_OPTIONS,MAP_CONFIG_DESCRIPTION,TOKEN_MISUSE_WARNING} from 'constants/default-settings';+const NO_OP = () => {};+const StyledInput = styled.input`width: 100%;padding: ${props => props.theme.inputPadding};@@ -79,14 +82,24 @@ const Link = ({children, ...props}) => (</StyledLink>);+const BigStyledType = styled(StyledType)`+ height: unset;+ width: unset;+ img {+ width: 180px;+ height: 120px;+ }+`;+const exportHtmlPropTypes = {options: PropTypes.object,onEditUserMapboxAccessToken: PropTypes.func.isRequired};const ExportHtmlMap = ({- options = {},- onEditUserMapboxAccessToken = () => {}+ onChangeExportMapHTMLMode = NO_OP,+ onEditUserMapboxAccessToken = NO_OP,+ options = {}}) => (<div><StyledExportSection style={{marginTop: INTRA_SECTION_MARGING}}>@@ -120,6 +133,29 @@ const ExportHtmlMap = ({</div></div></ExportMapStyledExportSection>+ <ExportMapStyledExportSection>+ <div className="description">+ <div className="title">+ Map Mode+ </div>+ <div className="subtitle">+ Select the app mode. More <a href={GITHUB_EXPORT_HTML_MAP_MODES}>info</a>+ </div>+ </div>+ <div className="selection">+ {EXPORT_HTML_MAP_MODE_OPTIONS.map(mode =>+ <BigStyledType+ key={mode.id}+ selected={options.mode === mode.id}+ available={mode.available}+ onClick={() => mode.available && onChangeExportMapHTMLMode(mode.id)}+ >+ <img src={mode.url} alt=""/>+ <p>Allow users to {mode.label} the map</p>+ </BigStyledType>+ )}+ </div>+ </ExportMapStyledExportSection></div>);@@ -197,15 +233,18 @@ const propTypes = {mapFormat: PropTypes.string};+const style = {width: '100%'};+const ExportMapModal = ({config = {},- onChangeExportData = () => {},- onChangeExportMapFormat = () => {},- onEditUserMapboxAccessToken = () => {},+ onChangeExportData = NO_OP,+ onChangeExportMapFormat = NO_OP,+ onChangeExportMapHTMLMode = NO_OP,+ onEditUserMapboxAccessToken = NO_OP,options = {}}) => (<StyledModalContent className="export-map-modal">- <div style={{width: '100%'}}>+ <div style={style}><StyledExportSection style={{marginBottom: INTRA_SECTION_MARGING}}><div className="description"><div className="title">@@ -229,13 +268,14 @@ const ExportMapModal = ({</div></StyledExportSection>{{- [EXPORT_MAP_FORMAT.HTML]: (+ [EXPORT_MAP_FORMATS.HTML]: (<ExportHtmlMap- options={options[options.format]}+ onChangeExportMapHTMLMode={onChangeExportMapHTMLMode}onEditUserMapboxAccessToken={onEditUserMapboxAccessToken}+ options={options[options.format]}/>),- [EXPORT_MAP_FORMAT.JSON]: (+ [EXPORT_MAP_FORMATS.JSON]: (<ExportJsonMapconfig={config}onChangeExportData={onChangeExportData}diff --git a/src/constants/action-types.js b/src/constants/action-types.jsindex 960704574..ba3feadf2 100644--- a/src/constants/action-types.js+++ b/src/constants/action-types.js@@ -136,6 +136,7 @@ const ActionTypes = keyMirror({// uiState > export mapSET_EXPORT_MAP_FORMAT: null,SET_USER_MAPBOX_ACCESS_TOKEN: null,+ SET_EXPORT_MAP_HTML_MODE: null,// allINIT: null,diff --git a/src/constants/default-settings.js b/src/constants/default-settings.jsindex e0614e919..be2c8157b 100644--- a/src/constants/default-settings.js+++ b/src/constants/default-settings.js@@ -81,6 +81,7 @@ import {Settings,CursorClick} from 'components/common/icons';+import {getHTMLMapModeTileUrl} from 'utils/utils';export const KEPLER_GL_NAME = 'kepler.gl';@@ -645,19 +646,32 @@ export const EXPORT_DATA_TYPE_OPTIONS = [];// Export map types-export const EXPORT_MAP_FORMAT = keyMirror({+export const EXPORT_MAP_FORMATS = keyMirror({HTML: null,JSON: null});+export const EXPORT_HTML_MAP_MODES = keyMirror({+ READ: null,+ EDIT: null+});+// Export map options-export const EXPORT_MAP_FORMAT_OPTIONS = Object.entries(EXPORT_MAP_FORMAT)+export const EXPORT_MAP_FORMAT_OPTIONS = Object.entries(EXPORT_MAP_FORMATS).map(entry => ({id: entry[0],label: entry[1].toLowerCase(),available: true}));+export const EXPORT_HTML_MAP_MODE_OPTIONS = Object.entries(EXPORT_HTML_MAP_MODES)+ .map(entry => ({+ id: entry[0],+ label: entry[1].toLowerCase(),+ available: true,+ url: getHTMLMapModeTileUrl(entry[1])+ }));+export const DEFAULT_UUID_COUNT = 6;export const DEFAULT_NOTIFICATION_MESSAGE = 'MESSAGE_NOT_PROVIDED';diff --git a/src/constants/index.js b/src/constants/index.jsindex a5f48e1f7..884e47714 100644--- a/src/constants/index.js+++ b/src/constants/index.js@@ -46,7 +46,7 @@ export {DEFAULT_LAYER_GROUPS,DEFAULT_MAP_STYLES,THEME,- EXPORT_MAP_FORMAT,+ EXPORT_MAP_FORMATS,EXPORT_MAP_FORMAT_OPTIONS,EXPORT_DATA_TYPE_OPTIONS,DEFAULT_NOTIFICATION_TYPES,diff --git a/src/constants/user-guides.js b/src/constants/user-guides.jsindex 0e9fcadeb..5bc73a816 100644--- a/src/constants/user-guides.js+++ b/src/constants/user-guides.js@@ -22,3 +22,5 @@ export const GITHUB_EXPORT_HTML_MAP = 'https://github.com/keplergl/kepler.gl/bloexport const GITHUB_ADD_DATA_TO_MAP = 'https://github.com/keplergl/kepler.gl/blob/master/docs/api-reference/actions/actions.md#adddatatomap';export const MAPBOX_ACCESS_TOKEN = 'https://docs.mapbox.com/help/how-mapbox-works/access-tokens/';export const GITHUB_BUG_REPORT = 'https://github.com/keplergl/kepler.gl/issues/new?template=bug_report.md';+// TODO: create new readme section+export const GITHUB_EXPORT_HTML_MAP_MODES = 'https://github.com/keplergl/kepler.gl/blob/master/docs/user-guides/k-save-and-export.md#2save-and-export-current-map';diff --git a/src/reducers/combined-updaters.js b/src/reducers/combined-updaters.jsindex e4953e736..a3141e934 100644--- a/src/reducers/combined-updaters.js+++ b/src/reducers/combined-updaters.js@@ -75,7 +75,6 @@ const combinedUpdaters = null;export const isValidConfig = config => isObject(config) && isObject(config.config) && config.version;export const defaultAddDataToMapOptions = {- readOnly: false,centerMap: true,keepExistingConfig: false};@@ -124,7 +123,7 @@ export const addDataToMapUpdater = (state, {payload}) => {options,config: parsedConfig})- }+ };let bounds;if (options.centerMap) {@@ -155,10 +154,11 @@ export const addDataToMapUpdater = (state, {payload}) => {mergedState = {...mergedState,uiState: {+ ...mergedState.uiState,...toggleModalUpdater(mergedState.uiState, {payload: null}),- readOnly: options.readOnly+ ...(options.hasOwnProperty('readOnLy') ? {readOnly: options.readOnly} : {})}- }+ };return mergedState;};diff --git a/src/reducers/root.js b/src/reducers/root.jsindex 2eb0afea1..e2f7da63c 100644--- a/src/reducers/root.js+++ b/src/reducers/root.js@@ -183,7 +183,7 @@ function decorate(target, savedInitialState = {}) {const targetReducer = provideInitialState(merged);return decorate(targetReducer, merged);- }+ };return target;}diff --git a/src/reducers/ui-state-updaters.js b/src/reducers/ui-state-updaters.jsindex 8364dd5b7..661f13c76 100644--- a/src/reducers/ui-state-updaters.js+++ b/src/reducers/ui-state-updaters.js@@ -24,7 +24,8 @@ import {EXPORT_DATA_TYPE,RATIOS,RESOLUTIONS,- EXPORT_MAP_FORMAT+ EXPORT_MAP_FORMATS,+ EXPORT_HTML_MAP_MODES} from 'constants/default-settings';import {createNotification} from 'utils/notifications-utils';@@ -155,7 +156,8 @@ export const DEFAULT_NOTIFICATIONS = [];*/export const DEFAULT_EXPORT_HTML = {exportMapboxAccessToken: null,- userMapboxToken: ''+ userMapboxToken: '',+ mode: EXPORT_HTML_MAP_MODES.READ};export const DEFAULT_EXPORT_JSON = {@@ -163,9 +165,9 @@ export const DEFAULT_EXPORT_JSON = {};export const DEFAULT_EXPORT_MAP = {- [EXPORT_MAP_FORMAT.HTML]: DEFAULT_EXPORT_HTML,- [EXPORT_MAP_FORMAT.JSON]: DEFAULT_EXPORT_JSON,- format: EXPORT_MAP_FORMAT.HTML+ [EXPORT_MAP_FORMATS.HTML]: DEFAULT_EXPORT_HTML,+ [EXPORT_MAP_FORMATS.JSON]: DEFAULT_EXPORT_JSON,+ format: EXPORT_MAP_FORMATS.HTML};/**@@ -478,9 +480,9 @@ export const setExportDataUpdater = state => ({...state,exportMap: {...state.exportMap,- [EXPORT_MAP_FORMAT.JSON]: {- ...state.exportMap[EXPORT_MAP_FORMAT.JSON],- hasData: !state.exportMap[EXPORT_MAP_FORMAT.JSON].hasData+ [EXPORT_MAP_FORMATS.JSON]: {+ ...state.exportMap[EXPORT_MAP_FORMATS.JSON],+ hasData: !state.exportMap[EXPORT_MAP_FORMATS.JSON].hasData}}});@@ -497,13 +499,19 @@ export const setUserMapboxAccessTokenUpdater = (state, {payload: userMapboxToken...state,exportMap: {...state.exportMap,- [EXPORT_MAP_FORMAT.HTML]: {- ...state.exportMap[EXPORT_MAP_FORMAT.HTML],+ [EXPORT_MAP_FORMATS.HTML]: {+ ...state.exportMap[EXPORT_MAP_FORMATS.HTML],userMapboxToken}}});+/**+ * Sets the export map format+ * @param {Object} state - `uiState`+ * @param {string} format to use to export the map onto+ * @return {Object} nextState+ */export const setExportMapFormat = (state, {payload: format}) => ({...state,exportMap: {@@ -512,6 +520,23 @@ export const setExportMapFormat = (state, {payload: format}) => ({}});+/**+ * Set the export html map mode+ * @param {Object} state - `uiState`+ * @param {string} mode to be set (available modes: EXPORT_HTML_MAP_MODES)+ * @return {{[p: string]: *}}+ */+export const setExportMapHTMLMode = (state, {payload: mode}) => ({+ ...state,+ exportMap: {+ ...state.exportMap,+ [EXPORT_MAP_FORMATS.HTML]: {+ ...state.exportMap[EXPORT_MAP_FORMATS.HTML],+ mode+ }+ }+});+/*** Add a notification to be displayed* @memberof uiStateUpdatersdiff --git a/src/reducers/ui-state.js b/src/reducers/ui-state.jsindex f4c97b870..f9931042f 100644--- a/src/reducers/ui-state.js+++ b/src/reducers/ui-state.js@@ -49,7 +49,8 @@ const actionHandler = {[ActionTypes.SET_EXPORT_FILTERED]: uiStateUpdaters.setExportFilteredUpdater,[ActionTypes.SET_EXPORT_DATA]: uiStateUpdaters.setExportDataUpdater,[ActionTypes.SET_USER_MAPBOX_ACCESS_TOKEN]: uiStateUpdaters.setUserMapboxAccessTokenUpdater,- [ActionTypes.SET_EXPORT_MAP_FORMAT]: uiStateUpdaters.setExportMapFormat+ [ActionTypes.SET_EXPORT_MAP_FORMAT]: uiStateUpdaters.setExportMapFormat,+ [ActionTypes.SET_EXPORT_MAP_HTML_MODE]: uiStateUpdaters.setExportMapHTMLMode};/* Reducer */diff --git a/src/templates/export-map.js b/src/templates/export-map.jsindex 09ec0dd50..4f10bbe26 100644--- a/src/templates/export-map.js+++ b/src/templates/export-map.js@@ -18,7 +18,10 @@// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN// THE SOFTWARE.-import {KEPLER_GL_VERSION} from '../constants/default-settings';+import {+ KEPLER_GL_VERSION,+ EXPORT_HTML_MAP_MODES+} from 'constants/default-settings';/*** This method is used to create an html file which will inlcude kepler and map data@@ -83,7 +86,11 @@ export const exportMapToHTML = (options, version = KEPLER_GL_VERSION) => {const reducers = (function createReducers(redux, keplerGl) {return redux.combineReducers({// mount keplerGl reducer- keplerGl: keplerGl.keplerGlReducer+ keplerGl: keplerGl.keplerGlReducer.initialState({+ uiState: {+ readOnly: ${options.mode === EXPORT_HTML_MAP_MODES.READ}+ }+ })});}(Redux, KeplerGl));diff --git a/src/utils/utils.js b/src/utils/utils.jsindex a063555e7..ccae77a05 100644--- a/src/utils/utils.js+++ b/src/utils/utils.js@@ -69,3 +69,7 @@ export function camelToTitle(str){const breakWord = str.replace( /([A-Z])/g, " $1" );return capitalizeFirstLetter(breakWord);}++export function getHTMLMapModeTileUrl(mode) {+ return `https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/map-${mode.toLowerCase()}-mode.png`+}