Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Chore] rewrite plot container for perf improvement (#3133)
Shan Heca628b5239e9
diff --git a/examples/get-started-vite/eslint.config.js b/examples/get-started-vite/eslint.config.jsindex 4637975d8..a7008d7a1 100644--- a/examples/get-started-vite/eslint.config.js+++ b/examples/get-started-vite/eslint.config.js@@ -1,31 +1,28 @@// SPDX-License-Identifier: MIT// Copyright contributors to the kepler.gl project-import js from '@eslint/js'-import globals from 'globals'-import reactHooks from 'eslint-plugin-react-hooks'-import reactRefresh from 'eslint-plugin-react-refresh'-import tseslint from 'typescript-eslint'+import js from '@eslint/js';+import globals from 'globals';+import reactHooks from 'eslint-plugin-react-hooks';+import reactRefresh from 'eslint-plugin-react-refresh';+import tseslint from 'typescript-eslint';export default tseslint.config(- { ignores: ['dist'] },+ {ignores: ['dist']},{extends: [js.configs.recommended, ...tseslint.configs.recommended],files: ['**/*.{ts,tsx}'],languageOptions: {ecmaVersion: 2020,- globals: globals.browser,+ globals: globals.browser},plugins: {'react-hooks': reactHooks,- 'react-refresh': reactRefresh,+ 'react-refresh': reactRefresh},rules: {...reactHooks.configs.recommended.rules,- 'react-refresh/only-export-components': [- 'warn',- { allowConstantExport: true },- ],- },- },-)+ 'react-refresh/only-export-components': ['warn', {allowConstantExport: true}]+ }+ }+);diff --git a/examples/get-started-vite/vite.config.ts b/examples/get-started-vite/vite.config.tsindex 7a3418ae5..100813163 100644--- a/examples/get-started-vite/vite.config.ts+++ b/examples/get-started-vite/vite.config.ts@@ -1,113 +1,95 @@// SPDX-License-Identifier: MIT// Copyright contributors to the kepler.gl project-import { defineConfig } from "vite";-import react from "@vitejs/plugin-react";-import wasm from "vite-plugin-wasm";-import { resolve } from "path";+import {defineConfig} from 'vite';+import react from '@vitejs/plugin-react';+import wasm from 'vite-plugin-wasm';+import {resolve} from 'path';// https://vitejs.dev/config/export default defineConfig({plugins: [wasm(), react()],server: {port: 8081,- open: true,+ open: true},build: {- outDir: "dist",+ outDir: 'dist',sourcemap: false,minify: true,rollupOptions: {input: {- main: resolve(__dirname, "index.html"),- },+ main: resolve(__dirname, 'index.html')+ }},- target: "esnext",+ target: 'esnext',commonjsOptions: {include: [/node_modules/],- transformMixedEsModules: true,- },+ transformMixedEsModules: true+ }},define: {- "process.env.NODE_ENV": JSON.stringify(- process.env.NODE_ENV || "production"- ),- "process.env.MapboxAccessToken": JSON.stringify(- process.env.MapboxAccessToken || ""- ),- "process.env.DropboxClientId": JSON.stringify(- process.env.DropboxClientId || ""- ),- "process.env.MapboxExportToken": JSON.stringify(- process.env.MapboxExportToken || ""- ),- "process.env.CartoClientId": JSON.stringify(- process.env.CartoClientId || ""- ),- "process.env.FoursquareClientId": JSON.stringify(- process.env.FoursquareClientId || ""- ),- "process.env.FoursquareDomain": JSON.stringify(- process.env.FoursquareDomain || ""- ),- "process.env.FoursquareAPIURL": JSON.stringify(- process.env.FoursquareAPIURL || ""- ),- "process.env.FoursquareUserMapsURL": JSON.stringify(- process.env.FoursquareUserMapsURL || ""- ),- "process.env.OpenAIToken": JSON.stringify(process.env.OpenAIToken || ""),- "process.env.NODE_DEBUG": JSON.stringify(false),+ 'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'production'),+ 'process.env.MapboxAccessToken': JSON.stringify(process.env.MapboxAccessToken || ''),+ 'process.env.DropboxClientId': JSON.stringify(process.env.DropboxClientId || ''),+ 'process.env.MapboxExportToken': JSON.stringify(process.env.MapboxExportToken || ''),+ 'process.env.CartoClientId': JSON.stringify(process.env.CartoClientId || ''),+ 'process.env.FoursquareClientId': JSON.stringify(process.env.FoursquareClientId || ''),+ 'process.env.FoursquareDomain': JSON.stringify(process.env.FoursquareDomain || ''),+ 'process.env.FoursquareAPIURL': JSON.stringify(process.env.FoursquareAPIURL || ''),+ 'process.env.FoursquareUserMapsURL': JSON.stringify(process.env.FoursquareUserMapsURL || ''),+ 'process.env.OpenAIToken': JSON.stringify(process.env.OpenAIToken || ''),+ 'process.env.NODE_DEBUG': JSON.stringify(false)},resolve: {- dedupe: ["styled-components"],+ dedupe: ['styled-components'],alias: {- "@": resolve(__dirname, "./src"),- },+ '@': resolve(__dirname, './src')+ }},optimizeDeps: {- exclude: ["parquet-wasm", "@loaders.gl/parquet", "apache-arrow"],+ exclude: ['parquet-wasm', '@loaders.gl/parquet', 'apache-arrow'],include: [- "buffer",- "react",- "react-dom",- "react-redux",- "redux",- "styled-components",- "@kepler.gl/components",- "@kepler.gl/reducers",- "@kepler.gl/actions",- "@kepler.gl/constants",- "@kepler.gl/utils",- "@kepler.gl/schemas",- "@kepler.gl/table",- "@kepler.gl/layers",- "@kepler.gl/deckgl-layers",- "@kepler.gl/effects",- "@kepler.gl/styles",- "@kepler.gl/tasks",- "@deck.gl/core",- "@deck.gl/layers",- "@deck.gl/aggregation-layers",- "@deck.gl/geo-layers",- "@deck.gl/mesh-layers",- "@deck.gl/extensions",- "@luma.gl/core",- "@luma.gl/engine",- "@luma.gl/gltools",- "@luma.gl/shadertools",- "@luma.gl/webgl",- "@loaders.gl/core",- "@loaders.gl/gltf",- "@loaders.gl/images",- "@loaders.gl/parquet",- "@math.gl/core",- "@math.gl/web-mercator",- "gl-matrix",- "lodash.uniq",+ 'buffer',+ 'react',+ 'react-dom',+ 'react-redux',+ 'redux',+ 'styled-components',+ '@kepler.gl/components',+ '@kepler.gl/reducers',+ '@kepler.gl/actions',+ '@kepler.gl/constants',+ '@kepler.gl/utils',+ '@kepler.gl/schemas',+ '@kepler.gl/table',+ '@kepler.gl/layers',+ '@kepler.gl/deckgl-layers',+ '@kepler.gl/effects',+ '@kepler.gl/styles',+ '@kepler.gl/tasks',+ '@deck.gl/core',+ '@deck.gl/layers',+ '@deck.gl/aggregation-layers',+ '@deck.gl/geo-layers',+ '@deck.gl/mesh-layers',+ '@deck.gl/extensions',+ '@luma.gl/core',+ '@luma.gl/engine',+ '@luma.gl/gltools',+ '@luma.gl/shadertools',+ '@luma.gl/webgl',+ '@loaders.gl/core',+ '@loaders.gl/gltf',+ '@loaders.gl/images',+ '@loaders.gl/parquet',+ '@math.gl/core',+ '@math.gl/web-mercator',+ 'gl-matrix',+ 'lodash.uniq'],esbuildOptions: {- target: "es2020",- },- },+ target: 'es2020'+ }+ }});diff --git a/src/actions/src/ui-state-actions.ts b/src/actions/src/ui-state-actions.tsindex 39d360c66..25aa093c0 100644--- a/src/actions/src/ui-state-actions.ts+++ b/src/actions/src/ui-state-actions.ts@@ -3,8 +3,7 @@import {createAction} from '@reduxjs/toolkit';import {default as ActionTypes} from './action-types';-import {Merge} from '@kepler.gl/types';-import {ExportImage} from '@kepler.gl/constants';+import {Merge, ExportImage} from '@kepler.gl/types';/** TOGGLE_SIDE_PANEL */export type ToggleSidePanelUpdaterAction = {diff --git a/src/components/src/common/image-preview.tsx b/src/components/src/common/image-preview.tsxindex fbd35cb28..0b30935a0 100644--- a/src/components/src/common/image-preview.tsx+++ b/src/components/src/common/image-preview.tsx@@ -4,7 +4,7 @@import React from 'react';import styled from 'styled-components';import LoadingSpinner from './loading-spinner';-import {ExportImage} from '@kepler.gl/constants';+import {ExportImage} from '@kepler.gl/types';const StyledImagePreview = styled.div.attrs({className: 'image-preview'@@ -14,7 +14,8 @@ const StyledImagePreview = styled.div.attrs({flex-direction: column;flex: 1;justify-content: center;- padding: 30px;+ width: 100%;+ height: 100%;.dimension,.instruction {@@ -26,7 +27,17 @@ const StyledImagePreview = styled.div.attrs({border-radius: 4px;box-shadow: 0 8px 16px 0 rgba(0, 0, 0, 0.18);width: 100%;+ max-width: 400px;position: relative;+ overflow: hidden;+ }++ .preview-image-container {+ position: relative;+ width: 100%;+ height: 0;+ padding-bottom: var(--aspect-ratio);+ max-height: 400px;}.preview-image-placeholder {@@ -35,6 +46,7 @@ const StyledImagePreview = styled.div.attrs({left: 0;width: 100%;height: 100%;+ object-fit: contain;}.preview-image-spinner {@@ -48,13 +60,21 @@ const StyledImagePreview = styled.div.attrs({padding: 12px;color: ${props => props.theme.errorColor};text-align: center;+ position: absolute;+ top: 0;+ left: 0;+ width: 100%;+ height: 100%;+ display: flex;+ align-items: center;+ justify-content: center;}`;interface ImagePreviewProps {exportImage?: ExportImage;width?: number;- showDimension?: false;+ showDimension?: boolean;}/**@@ -63,7 +83,7 @@ interface ImagePreviewProps {* @param {number} [props.width]* @param {boolean} [props.showDimension]*/-const ImagePreview = ({exportImage, width = 400, showDimension = false}: ImagePreviewProps) => {+const ImagePreview = ({exportImage, showDimension = false}: ImagePreviewProps) => {const {error,imageDataUri,@@ -71,30 +91,30 @@ const ImagePreview = ({exportImage, width = 400, showDimension = false}: ImagePrimageSize: {imageW = 0, imageH = 0} = {}} = exportImage || {};- const imageStyle = {- width: `${width}px`,- height: `${(imageH / (imageW || 1)) * width}px`- };+ // Calculate aspect ratio percentage for padding-bottom trick+ const aspectRatio = imageW && imageH ? (imageH / imageW) * 100 : 75; // default to 4:3 if no dimensionsreturn (- <StyledImagePreview>+ <StyledImagePreview style={{'--aspect-ratio': `${aspectRatio}%`} as React.CSSProperties}>{showDimension ? (<div className="dimension">{imageW} pixel x {imageH} pixel</div>) : null}- <div className="preview-image" style={imageStyle}>- {processing ? (- <div className="preview-image-spinner">- <LoadingSpinner />- </div>- ) : error ? (- <div className="preview-image--error">- <span>{error.message || 'Generate map image failed!'}</span>- </div>- ) : (- <img className="preview-image-placeholder" src={imageDataUri} />- )}+ <div className="preview-image">+ <div className="preview-image-container">+ {processing ? (+ <div className="preview-image-spinner">+ <LoadingSpinner />+ </div>+ ) : error ? (+ <div className="preview-image--error">+ <span>{error.message || 'Generate map image failed!'}</span>+ </div>+ ) : (+ <img className="preview-image-placeholder" src={imageDataUri} alt="Map preview" />+ )}+ </div></div></StyledImagePreview>);diff --git a/src/components/src/kepler-gl.tsx b/src/components/src/kepler-gl.tsxindex 06cb99e3a..44d23351d 100644--- a/src/components/src/kepler-gl.tsx+++ b/src/components/src/kepler-gl.tsx@@ -15,7 +15,8 @@ import {DatasetAttribution,OnErrorCallBack,OnSuccessCallBack,- Viewport+ Viewport,+ MapState} from '@kepler.gl/types';import {@@ -139,21 +140,28 @@ export const isViewportDisjointed = props => {);};-export const mapStateSelector = (props: any, index: number): any => {- if (!Number.isFinite(index)) {- // either no index arg or an invalid index was provided- // it is expected to be either 0 or 1 when in split mode- // only use the mapState- return props.mapState;- }-- return isViewportDisjointed(props)- ? // mix together the viewport properties intended for this disjointed <MapContainer> with the other necessary mapState properties- {...props.mapState, ...props.mapState.splitMapViewports[index]}- : // otherwise only use the mapState- props.mapState;+type MapStateProps = {+ mapState: MapState;};+export const mapStateSelector = createSelector(+ [(props: MapStateProps) => props.mapState, (_: MapStateProps, index?: number) => index],+ (mapState: MapState, index?: number): MapState => {+ if (!Number.isFinite(index)) {+ // either no index arg or an invalid index was provided+ // it is expected to be either 0 or 1 when in split mode+ // only use the mapState+ return mapState;+ }++ return isViewportDisjointed({mapState})+ ? // mix together the viewport properties intended for this disjointed <MapContainer> with the other necessary mapState properties+ {...mapState, ...mapState.splitMapViewports[index || 0]}+ : // otherwise only use the mapState+ mapState;+ }+);+export const mapFieldsSelector = (props: KeplerGLProps, index = 0) => ({getMapboxRef: props.getMapboxRef,mapboxApiAccessToken: props.mapboxApiAccessToken,@@ -223,7 +231,13 @@ export const sidePanelSelector = (props: KeplerGLProps, availableProviders, filtexport const plotContainerSelector = (props: KeplerGLProps) => ({width: props.width,height: props.height,- exportImageSetting: props.uiState.exportImage,+ ratio: props.uiState.exportImage.ratio,+ resolution: props.uiState.exportImage.resolution,+ legend: props.uiState.exportImage.legend,+ center: props.uiState.exportImage.center,+ imageSize: props.uiState.exportImage.imageSize,+ escapeXhtmlForWebpack: props.uiState.exportImage.escapeXhtmlForWebpack,+mapFields: mapFieldsSelector(props),addNotification: props.uiStateActions.addNotification,setExportImageSetting: props.uiStateActions.setExportImageSetting,diff --git a/src/components/src/modals/export-image-modal.tsx b/src/components/src/modals/export-image-modal.tsxindex f710bc384..8a7df2149 100644--- a/src/components/src/modals/export-image-modal.tsx+++ b/src/components/src/modals/export-image-modal.tsx@@ -6,12 +6,8 @@ import styled from 'styled-components';import ImagePreview from '../common/image-preview';import {SetExportImageSettingUpdaterAction} from '@kepler.gl/actions';-import {- EXPORT_IMG_RATIO_OPTIONS,- EXPORT_IMG_RESOLUTION_OPTIONS,- ExportImage-} from '@kepler.gl/constants';-+import {EXPORT_IMG_RATIO_OPTIONS, EXPORT_IMG_RESOLUTION_OPTIONS} from '@kepler.gl/constants';+import {ExportImage} from '@kepler.gl/types';import {StyledModalContent, SelectionButton, CheckMark} from '../common/styled-components';import Switch from '../common/switch';import {injectIntl, IntlShape} from 'react-intl';diff --git a/src/components/src/modals/save-map-modal.tsx b/src/components/src/modals/save-map-modal.tsxindex e210e8214..41ffe5d64 100644--- a/src/components/src/modals/save-map-modal.tsx+++ b/src/components/src/modals/save-map-modal.tsx@@ -7,12 +7,7 @@ import ImageModalContainer, {ImageModalContainerProps} from './image-modal-contaimport {FlexContainer} from '../common/flex-container';import StatusPanel, {UploadAnimation} from './status-panel';import {ProviderSelect} from './cloud-components/provider-select';-import {- MAP_THUMBNAIL_DIMENSION,- MAP_INFO_CHARACTER,- ExportImage,- dataTestIds-} from '@kepler.gl/constants';+import {MAP_THUMBNAIL_DIMENSION, MAP_INFO_CHARACTER, dataTestIds} from '@kepler.gl/constants';import {StyledModalContent,@@ -24,7 +19,7 @@ import {} from '../common/styled-components';import ImagePreview from '../common/image-preview';import {FormattedMessage} from '@kepler.gl/localization';-import {MapInfo} from '@kepler.gl/types';+import {MapInfo, ExportImage} from '@kepler.gl/types';import {Provider} from '@kepler.gl/cloud-providers';import {setMapInfo, cleanupExportImage as cleanupExportImageAction} from '@kepler.gl/actions';import {ModalFooter} from '../common/modal';diff --git a/src/components/src/plot-container.tsx b/src/components/src/plot-container.tsxindex 47acab0c3..765ff0aae 100644--- a/src/components/src/plot-container.tsx+++ b/src/components/src/plot-container.tsx@@ -2,8 +2,7 @@// Copyright contributors to the kepler.gl project// libraries-import React, {Component, createRef} from 'react';-import {createSelector} from 'reselect';+import React, {useRef, useEffect, useState, useCallback, useMemo} from 'react';import styled from 'styled-components';import {Map} from 'react-map-gl';import debounce from 'lodash/debounce';@@ -19,8 +18,8 @@ import MapContainerFactory from './map-container';import MapsLayoutFactory from './maps-layout';import {MapViewStateContextProvider} from './map-view-state-context';-import {GEOCODER_LAYER_ID, ExportImage} from '@kepler.gl/constants';-import {Effect, SplitMap} from '@kepler.gl/types';+import {GEOCODER_LAYER_ID} from '@kepler.gl/constants';+import {Effect, SplitMap, ExportImage} from '@kepler.gl/types';import {ActionHandler,addNotification,@@ -72,165 +71,212 @@ const StyledMapContainer = styled.div<StyledMapContainerProps>``;interface PlotContainerProps {- width?: number;- height?: number;- exportImageSetting: ExportImage;- addNotification: ActionHandler<typeof addNotification>;+ // Image export settings+ ratio?: string;+ resolution?: string;+ legend?: boolean;+ center?: boolean;+ imageSize: ExportImage['imageSize'];+ escapeXhtmlForWebpack?: boolean;++ // Map settingsmapFields: ReturnType<typeof mapFieldsSelector>;+ splitMaps?: SplitMap[];++ // CallbackssetExportImageSetting: typeof setExportImageSetting;setExportImageDataUri: typeof setExportImageDataUri;setExportImageError: typeof setExportImageError;- splitMaps?: SplitMap[];- enableErrorNotification?: boolean;-}+ addNotification: ActionHandler<typeof addNotification>;-interface PlotContainerState {- plotEffects: Effect[];+ // Flags+ enableErrorNotification?: boolean;}export default function PlotContainerFactory(MapContainer: ReturnType<typeof MapContainerFactory>,MapsLayout: ReturnType<typeof MapsLayoutFactory>): React.ComponentType<PlotContainerProps> {- class PlotContainer extends Component<PlotContainerProps, PlotContainerState> {- constructor(props) {- super(props);- this._onMapRender = debounce(this._onMapRender, 500);- this._retrieveNewScreenshot = debounce(this._retrieveNewScreenshot, 500);-- this.state = {- plotEffects: this.getEffectsForPlot()- };- }+ function PlotContainer({+ // Image export settings+ ratio,+ resolution,+ legend = false,+ center,+ imageSize,+ escapeXhtmlForWebpack,- private getEffectsForPlot() {- return this.props.mapFields.visState.effects.map(effect => effect.clone());- }+ // Map settings+ mapFields,+ splitMaps = [],- componentDidMount() {- this.props.setExportImageSetting({processing: true});- }+ // Callbacks+ setExportImageSetting,+ setExportImageDataUri,+ setExportImageError,+ addNotification,- componentDidUpdate(prevProps) {- // re-fetch the new screenshot only when ratio legend or resolution changes- const checks = ['ratio', 'resolution', 'legend'];- const shouldRetrieveScreenshot = checks.some(- item => this.props.exportImageSetting[item] !== prevProps.exportImageSetting[item]- );- if (shouldRetrieveScreenshot) {- this.props.setExportImageSetting({processing: true});- this._retrieveNewScreenshot();- }- }+ // Flags+ enableErrorNotification+ }: PlotContainerProps) {+ const plottingAreaRef = useRef<HTMLDivElement>(null);+ const [plotEffects] = useState<Effect[]>(() =>+ mapFields.visState.effects.map(effect => effect.clone())+ );- plottingAreaRef = createRef<HTMLDivElement>();+ const {mapState} = mapFields;- mapStyleSelector = props => props.mapFields.mapStyle;- mapScaleSelector = props => {- const {imageSize} = props.exportImageSetting;- const {mapState} = props.mapFields;+ // Memoize the scale calculation+ const scale = useMemo(() => {if (imageSize.scale) {return imageSize.scale;}- const scale = getScaleFromImageSize(+ const calculatedScale = getScaleFromImageSize(imageSize.imageW,imageSize.imageH,mapState.width * (mapState.isSplit ? 2 : 1),mapState.height);- return scale > 0 ? scale : 1;- };+ return calculatedScale > 0 ? calculatedScale : 1;+ }, [+ imageSize.scale,+ imageSize.imageW,+ imageSize.imageH,+ mapState.width,+ mapState.height,+ mapState.isSplit+ ]);- scaledMapStyleSelector = createSelector(- this.mapStyleSelector,- this.mapScaleSelector,- (mapStyle, scale) => ({+ // Memoize the map style+ const scaledMapStyle = useMemo(() => {+ const mapStyle = mapFields.mapStyle;+ return {...mapStyle,bottomMapStyle: scaleMapStyleByResolution(mapStyle.bottomMapStyle, scale),topMapStyle: scaleMapStyleByResolution(mapStyle.topMapStyle, scale)- })+ };+ }, [mapFields.mapStyle, scale]);++ // Memoize the retrieveNewScreenshot callback+ const debouncedScreenshot = useMemo(+ () =>+ debounce(() => {+ if (plottingAreaRef.current) {+ convertToPng(plottingAreaRef.current, {+ filter: DOM_FILTER_FUNC,+ width: imageSize.imageW,+ height: imageSize.imageH,+ escapeXhtmlForWebpack+ })+ .then(setExportImageDataUri)+ .catch(err => {+ setExportImageError(err);+ if (enableErrorNotification) {+ addNotification(exportImageError({err}));+ }+ });+ }+ }, 500),+ [+ imageSize.imageW,+ imageSize.imageH,+ escapeXhtmlForWebpack,+ setExportImageDataUri,+ setExportImageError,+ enableErrorNotification,+ addNotification+ ]);- _onMapRender = map => {- if (map.isStyleLoaded()) {- this._retrieveNewScreenshot();- }- };-- _retrieveNewScreenshot = () => {- if (this.plottingAreaRef.current) {- const {imageSize, escapeXhtmlForWebpack} = this.props.exportImageSetting;- convertToPng(this.plottingAreaRef.current, {- filter: DOM_FILTER_FUNC,- width: imageSize.imageW,- height: imageSize.imageH,- escapeXhtmlForWebpack- })- .then(this.props.setExportImageDataUri)- .catch(err => {- this.props.setExportImageError(err);- if (this.props.enableErrorNotification) {- this.props.addNotification(exportImageError({err}));- }- });- }- };+ const retrieveNewScreenshot = useCallback(debouncedScreenshot, [debouncedScreenshot]);++ // Memoize the onMapRender callback+ const debouncedMapRender = useMemo(+ () =>+ debounce(map => {+ if (map.isStyleLoaded()) {+ retrieveNewScreenshot();+ }+ }, 500),+ [retrieveNewScreenshot]+ );- render() {- const {exportImageSetting, mapFields, splitMaps = []} = this.props;- const {mapState, visState} = mapFields;- const {layers, layerData} = visState;- const {imageSize, legend} = exportImageSetting;+ const onMapRender = useCallback(debouncedMapRender, [debouncedMapRender]);- const isSplit = splitMaps && splitMaps.length > 1;+ // Initial setup effect+ useEffect(() => {+ setExportImageSetting({processing: true});+ }, [setExportImageSetting]);+ // Screenshot update effect+ useEffect(() => {+ if (ratio !== undefined || resolution !== undefined || legend !== undefined) {+ setExportImageSetting({processing: true});+ retrieveNewScreenshot();+ }+ }, [ratio, resolution, legend, setExportImageSetting, retrieveNewScreenshot]);++ // Memoize size calculations+ const {size, width, height} = useMemo(() => {const size = {- width: imageSize?.imageW || 1,- height: imageSize?.imageH || 1+ width: imageSize.imageW || 1,+ height: imageSize.imageH || 1+ };+ const isSplit = splitMaps.length > 1;+ return {+ size,+ width: size.width / (isSplit ? 2 : 1),+ height: size.height};- const width = size.width / (isSplit ? 2 : 1);- const height = size.height;- const scale = this.mapScaleSelector(this.props);- const newMapState = {+ }, [imageSize.imageW, imageSize.imageH, splitMaps.length]);++ // Memoize map state+ const newMapState = useMemo(() => {+ const baseMapState = {...mapState,width,height,zoom: mapState.zoom + (Math.log2(scale) || 0)};- // center and all layer bounds- if (exportImageSetting.center) {- const renderedLayers = layers.filter(- (layer, idx) => layer.id !== GEOCODER_LAYER_ID && layer.shouldRenderLayer(layerData[idx])+ if (center) {+ const renderedLayers = mapFields.visState.layers.filter(+ (layer, idx) =>+ layer.id !== GEOCODER_LAYER_ID &&+ layer.shouldRenderLayer(mapFields.visState.layerData[idx]));const bounds = findMapBounds(renderedLayers);const centerAndZoom = getCenterAndZoomFromBounds(bounds, {width, height});if (centerAndZoom) {const zoom = Number.isFinite(centerAndZoom.zoom) ? centerAndZoom.zoom : mapState.zoom;-- newMapState.longitude = centerAndZoom.center[0];- newMapState.latitude = centerAndZoom.center[1];- newMapState.zoom = zoom + Number(Math.log2(scale) || 0);+ return {+ ...baseMapState,+ longitude: centerAndZoom.center[0],+ latitude: centerAndZoom.center[1],+ zoom: zoom + Number(Math.log2(scale) || 0)+ };}}- const mapProps = {- ...mapFields,- mapStyle: this.scaledMapStyleSelector(this.props),+ return baseMapState;+ }, [mapState, width, height, scale, center, mapFields.visState]);- // override viewport based on export settings+ // Memoize map props+ const mapProps = useMemo(+ () => ({+ ...mapFields,+ mapStyle: scaledMapStyle,mapState: newMapState,mapControls: {- // override map legend visibilitymapLegend: {- show: legend,+ show: Boolean(legend),active: true}},MapComponent: Map,- onMapRender: this._onMapRender,+ onMapRender,isExport: true,deckGlProps: {...mapFields.deckGlProps,@@ -241,30 +287,33 @@ export default function PlotContainerFactory(},visState: {...mapFields.visState,- // Make sure to use effects not associated with a different WebGL context- effects: this.state.plotEffects+ effects: plotEffects}- };+ }),+ [mapFields, scaledMapStyle, newMapState, legend, onMapRender, plotEffects]+ );- const mapContainers = !isSplit ? (- <MapContainer index={0} primary={true} {...mapProps} />- ) : (- <MapsLayout className="plot-container-maps" mapState={newMapState}>- {splitMaps.map((settings, index) => (- <MapContainer key={index} index={index} primary={index === 1} {...mapProps} />- ))}- </MapsLayout>- );- return (- <StyledPlotContainer className="export-map-instance">- <StyledMapContainer ref={this.plottingAreaRef} width={size.width} height={size.height}>- <MapViewStateContextProvider mapState={newMapState}>- {mapContainers}- </MapViewStateContextProvider>- </StyledMapContainer>- </StyledPlotContainer>- );- }+ const isSplit = splitMaps.length > 1;+ const mapContainers = !isSplit ? (+ <MapContainer index={0} primary={true} {...mapProps} />+ ) : (+ <MapsLayout className="plot-container-maps" mapState={newMapState}>+ {splitMaps.map((settings, index) => (+ <MapContainer key={index} index={index} primary={index === 1} {...mapProps} />+ ))}+ </MapsLayout>+ );++ return (+ <StyledPlotContainer className="export-map-instance">+ <StyledMapContainer ref={plottingAreaRef} width={size.width} height={size.height}>+ <MapViewStateContextProvider mapState={newMapState}>+ {mapContainers}+ </MapViewStateContextProvider>+ </StyledMapContainer>+ </StyledPlotContainer>+ );}- return PlotContainer;++ return React.memo(PlotContainer);}diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.tsindex e0fcddde8..39e1b94ee 100644--- a/src/constants/src/default-settings.ts+++ b/src/constants/src/default-settings.ts@@ -983,28 +983,6 @@ export const EXPORT_IMG_RATIOS = keyMirror({CUSTOM: null});-export type ExportImage = {- ratio: keyof typeof EXPORT_IMG_RATIOS;- resolution: keyof typeof RESOLUTIONS;- legend: boolean;- mapH: number;- mapW: number;- imageSize: {- zoomOffset: number;- scale: number;- imageW: number;- imageH: number;- };- // exporting state- imageDataUri: string;- exporting: boolean;- processing: boolean;- error: Error | false;- escapeXhtmlForWebpack?: boolean;- // This field was not in the .d.ts file- center: boolean;-};-export type ImageRatioOption = {id: keyof typeof EXPORT_IMG_RATIOS;label: string;diff --git a/src/reducers/src/ui-state-updaters.ts b/src/reducers/src/ui-state-updaters.tsindex 299e207ed..7e58def21 100644--- a/src/reducers/src/ui-state-updaters.ts+++ b/src/reducers/src/ui-state-updaters.ts@@ -11,8 +11,7 @@ import {EXPORT_IMG_RATIOS,EXPORT_MAP_FORMATS,RESOLUTIONS,- MAP_CONTROLS,- ExportImage+ MAP_CONTROLS} from '@kepler.gl/constants';import {LOCALE_CODES} from '@kepler.gl/localization';import {createNotification, errorNotification, calculateExportImageSize} from '@kepler.gl/utils';@@ -29,6 +28,7 @@ import {ExportHtml,ExportJson,ExportMap,+ ExportImage,MapControlItem,MapControls,UiState@@ -541,14 +541,19 @@ export const setExportImageSettingUpdater = (export const setExportImageDataUriUpdater = (state: UiState,{payload: dataUri}: UIStateActions.SetExportImageDataUriUpdaterAction-): UiState => ({- ...state,- exportImage: {- ...state.exportImage,- processing: false,- imageDataUri: dataUri+): UiState => {+ if (dataUri === state.exportImage.imageDataUri) {+ return state;}-});+ return {+ ...state,+ exportImage: {+ ...state.exportImage,+ processing: false,+ imageDataUri: dataUri+ }+ };+};/*** @memberof uiStateUpdatersdiff --git a/src/types/reducers.d.ts b/src/types/reducers.d.tsindex b674538b3..8a545e331 100644--- a/src/types/reducers.d.ts+++ b/src/types/reducers.d.ts@@ -387,6 +387,7 @@ export declare type ExportImage = {processing: boolean;error: Error | false;center: boolean;+ escapeXhtmlForWebpack?: boolean;};export type ExportData = {diff --git a/src/utils/src/export-utils.ts b/src/utils/src/export-utils.tsindex 29eb4fa80..7e97dd983 100644--- a/src/utils/src/export-utils.ts+++ b/src/utils/src/export-utils.ts@@ -10,9 +10,9 @@ import {RESOLUTIONS,EXPORT_IMG_RATIOS,FourByThreeRatioOption,- OneXResolutionOption,- ExportImage+ OneXResolutionOption} from '@kepler.gl/constants';+import {ExportImage} from '@kepler.gl/types';import {generateHashId} from '@kepler.gl/common-utils';import domtoimage from './dom-to-image';import {set} from './utils';diff --git a/test/browser/components/modals/export-image-modal-test.js b/test/browser/components/modals/export-image-modal-test.jsindex b4e1a389a..636fcecdc 100644--- a/test/browser/components/modals/export-image-modal-test.js+++ b/test/browser/components/modals/export-image-modal-test.js@@ -105,8 +105,9 @@ test('Components -> ExportImageModal.preview image', t => {...INITIAL_UI_STATE.exportImage,imageDataUri,imageSize: {- imageH: 500,- imageW: 500+ scale: 1,+ imageW: 500,+ imageH: 500}};let wrapper;@@ -126,13 +127,13 @@ test('Components -> ExportImageModal.preview image', t => {t.equal(wrapper.find('.preview-image-placeholder').html(),- '<img class="preview-image-placeholder" src="data:image/png;base64,2i3u">',+ '<img class="preview-image-placeholder" src="data:image/png;base64,2i3u" alt="Map preview">','should render image with src');t.equal(wrapper.find('.preview-image').html(),- '<div class="preview-image" style="width: 400px; height: 400px;"><img class="preview-image-placeholder" src="data:image/png;base64,2i3u"></div>',+ '<div class="preview-image"><div class="preview-image-container"><img class="preview-image-placeholder" src="data:image/png;base64,2i3u" alt="Map preview"></div></div>','should render preview image with src');diff --git a/test/browser/components/plot-container-test.js b/test/browser/components/plot-container-test.jsindex 19edfbfed..52300ad39 100644--- a/test/browser/components/plot-container-test.js+++ b/test/browser/components/plot-container-test.js@@ -32,13 +32,10 @@ test('PlotContainer -> mount', t => {test('PlotContainer -> mount -> imageSize', t => {let wrapper;- const exportImageSetting = {- ...initialProps.exportImageSetting,- imageSize: {- ...initialProps.exportImageSetting.imageSize,- imageW: 800,- imageH: 600- }+ const imageSize = {+ scale: 1,+ imageW: 800,+ imageH: 600};const store = mockStore(initialState);@@ -46,7 +43,15 @@ test('PlotContainer -> mount -> imageSize', t => {wrapper = mountWithTheme(<Provider store={store}><IntlWrapper>- <PlotContainer {...initialProps} exportImageSetting={exportImageSetting} />+ <PlotContainer+ {...initialProps}+ imageSize={imageSize}+ mapFields={initialProps.mapFields}+ setExportImageSetting={() => {}}+ setExportImageDataUri={() => {}}+ setExportImageError={() => {}}+ addNotification={() => {}}+ /></IntlWrapper></Provider>);@@ -58,13 +63,20 @@ test('PlotContainer -> mount -> imageSize', t => {t.equal(map.props.mapState.height, 600, 'should send imageH to mapState');// set center to be true- exportImageSetting.center = true;-t.doesNotThrow(() => {wrapper = mountWithTheme(<Provider store={store}><IntlWrapper>- <PlotContainer {...initialProps} exportImageSetting={exportImageSetting} />+ <PlotContainer+ {...initialProps}+ imageSize={imageSize}+ center={true}+ mapFields={initialProps.mapFields}+ setExportImageSetting={() => {}}+ setExportImageDataUri={() => {}}+ setExportImageError={() => {}}+ addNotification={() => {}}+ /></IntlWrapper></Provider>);