Skip to content

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

feat: add JSON editors for layer, filter, effect, viewport, and animation (#3744)

Igor Dykhta59048d02359f
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.ts
index 662ac2d3b..e539cb671 100644
--- a/src/actions/src/action-types.ts
+++ b/src/actions/src/action-types.ts
@@ -136,6 +136,7 @@ export const ActionTypes = {
// mapState
UPDATE_MAP: `${ACTION_PREFIX}UPDATE_MAP`,
+ APPLY_MAP_STATE: `${ACTION_PREFIX}APPLY_MAP_STATE`,
FIT_BOUNDS: `${ACTION_PREFIX}FIT_BOUNDS`,
TOGGLE_PERSPECTIVE: `${ACTION_PREFIX}TOGGLE_PERSPECTIVE`,
TOGGLE_FULLSCREEN: `${ACTION_PREFIX}TOGGLE_FULLSCREEN`,
diff --git a/src/actions/src/map-state-actions.ts b/src/actions/src/map-state-actions.ts
index 027d60837..968976732 100644
--- a/src/actions/src/map-state-actions.ts
+++ b/src/actions/src/map-state-actions.ts
@@ -3,7 +3,7 @@
import {createAction} from '@reduxjs/toolkit';
import {default as ActionTypes} from './action-types';
-import {Bounds, Merge, Viewport, ViewportPadding} from '@kepler.gl/types';
+import {Bounds, MapState, Merge, Viewport, ViewportPadding} from '@kepler.gl/types';
import {MapSplitMode, MapViewMode, GlobeConfig} from '@kepler.gl/constants';
export type TogglePerspectiveUpdaterAction = void;
@@ -80,6 +80,29 @@ export const updateMap: (
})
);
+export type ApplyMapStateUpdaterAction = {
+ payload: Partial<MapState>;
+ meta?: {mapIndex?: number};
+};
+/**
+ * Apply a partial map state, as used by the viewport JSON editor.
+ * Width and height of the current viewport are preserved.
+ * @memberof mapStateActions
+ * @param mapState - Partial map state from saved JSON
+ * @param mapIndex - Split-map pane to apply camera fields to when viewports are unsynced
+ * @public
+ */
+export const applyMapState: (
+ mapState: Partial<MapState>,
+ mapIndex?: number
+) => Merge<ApplyMapStateUpdaterAction, {type: typeof ActionTypes.APPLY_MAP_STATE}> = createAction(
+ ActionTypes.APPLY_MAP_STATE,
+ (mapState: Partial<MapState>, mapIndex?: number) => ({
+ payload: mapState,
+ meta: {mapIndex}
+ })
+);
+
export type ToggleSplitMapUpdaterAction = {
payload: number;
};
diff --git a/src/components/src/common/animation-control/animation-json-editor.tsx b/src/components/src/common/animation-control/animation-json-editor.tsx
new file mode 100644
index 000000000..bedd60ec1
--- /dev/null
+++ b/src/components/src/common/animation-control/animation-json-editor.tsx
@@ -0,0 +1,205 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useCallback, useEffect, useMemo, useRef, useState} from 'react';
+import styled from 'styled-components';
+import classnames from 'classnames';
+import {applyFilterConfig, setAnimationConfig} from '@kepler.gl/actions';
+import {FILTER_TYPES} from '@kepler.gl/constants';
+import {visStateLens} from '@kepler.gl/reducers';
+import {VisState} from '@kepler.gl/schemas';
+import {AnimationConfig, Filter} from '@kepler.gl/types';
+import {FormattedMessage} from '@kepler.gl/localization';
+
+import {CodeAlt} from '../icons';
+import IconButton from '../icon-button';
+import TippyTooltip from '../tippy-tooltip';
+import {withState} from '../../injector';
+import JsonEditor from '../json-editor';
+import {
+ animationConfigToJson,
+ applyStatus,
+ isJsonEditorEnabled,
+ errorStatus,
+ jsonToAnimationConfig,
+ jsonToFilterConfig,
+ JsonEditorStatus,
+ useDebounce
+} from '../json-editor-utils';
+
+const StyledPopover = styled.div`
+ position: absolute;
+ bottom: 40px;
+ right: 0;
+ z-index: 1000;
+ width: 360px;
+ padding: 0 12px 12px;
+ pointer-events: auto;
+ background-color: ${props => props.theme.sidePanelBg || props.theme.panelBackground};
+ border: 1px solid ${props => props.theme.panelBorderColor || props.theme.panelBackgroundHover};
+ box-shadow: ${props => props.theme.panelBoxShadow};
+`;
+
+const StyledHeader = styled.div`
+ display: flex;
+ align-items: center;
+ justify-content: space-between;
+ padding: 10px 0 0;
+ color: ${props => props.theme.titleTextColor || props.theme.textColor};
+ font-size: 12px;
+ letter-spacing: 0.4px;
+`;
+
+const StyledControl = styled.div`
+ position: relative;
+`;
+
+export type AnimationJsonEditorControlProps = {
+ filter?: Filter;
+ btnStyle?: Record<string, boolean>;
+ buttonHeight?: string;
+ showAnimationWindowControl?: boolean;
+};
+
+export type AnimationJsonEditorProps = {
+ filterId?: string;
+ visState?: VisState;
+ applyFilterConfig?: typeof applyFilterConfig;
+ setAnimationConfig?: typeof setAnimationConfig;
+ onClose: () => void;
+};
+
+function AnimationJsonEditorFactory() {
+ const AnimationJsonEditor: React.FC<AnimationJsonEditorProps> = ({
+ filterId,
+ visState,
+ applyFilterConfig: applyFilterConfigAction,
+ setAnimationConfig: setAnimationConfigAction,
+ onClose
+ }) => {
+ const config = useMemo(() => {
+ if (!visState) {
+ return undefined;
+ }
+ if (filterId) {
+ return visState.filters.find(item => item.id === filterId);
+ }
+ return visState.animationConfig;
+ }, [filterId, visState]);
+
+ const jsonText = useMemo(
+ () => animationConfigToJson(config, visState?.schema),
+ [config, visState?.schema]
+ );
+ const debouncedJsonText = useDebounce(jsonText, 300);
+ const popoverRef = useRef<HTMLDivElement>(null);
+
+ // Keep wheel / drag on the overlay; the parent timeline listens for wheel on a container
+ // that includes this popover and would otherwise zoom the chart instead of scrolling JSON.
+ useEffect(() => {
+ const node = popoverRef.current;
+ if (!node) {
+ return undefined;
+ }
+ const stop = (event: Event) => {
+ event.stopPropagation();
+ };
+ node.addEventListener('wheel', stop, {passive: false});
+ node.addEventListener('mousedown', stop);
+ return () => {
+ node.removeEventListener('wheel', stop);
+ node.removeEventListener('mousedown', stop);
+ };
+ }, []);
+
+ const handleApply = useCallback(
+ (text: string): JsonEditorStatus => {
+ try {
+ if (filterId) {
+ const filter = visState?.filters.find(item => item.id === filterId);
+ if (!applyFilterConfigAction || !filter) {
+ return applyStatus(false);
+ }
+ applyFilterConfigAction(filterId, jsonToFilterConfig(text, filter));
+ return applyStatus(true);
+ }
+ if (!setAnimationConfigAction) {
+ return applyStatus(false);
+ }
+ setAnimationConfigAction(jsonToAnimationConfig(text) as AnimationConfig);
+ return applyStatus(true);
+ } catch (error) {
+ return errorStatus(error);
+ }
+ },
+ [applyFilterConfigAction, filterId, setAnimationConfigAction, visState]
+ );
+
+ return (
+ <StyledPopover ref={popoverRef} className="animation-json-editor">
+ <StyledHeader>
+ <FormattedMessage id="tooltip.editAnimationJson" defaultMessage="Edit animation JSON" />
+ </StyledHeader>
+ <JsonEditor
+ jsonText={debouncedJsonText}
+ onApply={handleApply}
+ onClose={onClose}
+ height={220}
+ />
+ </StyledPopover>
+ );
+ };
+
+ return withState([visStateLens], () => ({}), {applyFilterConfig, setAnimationConfig})(
+ AnimationJsonEditor
+ ) as React.FC<AnimationJsonEditorProps>;
+}
+
+AnimationJsonEditorControlFactory.deps = [AnimationJsonEditorFactory];
+
+function AnimationJsonEditorControlFactory(
+ AnimationJsonEditor: ReturnType<typeof AnimationJsonEditorFactory>
+) {
+ const AnimationJsonEditorControl: React.FC<AnimationJsonEditorControlProps> = ({
+ filter,
+ btnStyle = {},
+ buttonHeight = '16px',
+ showAnimationWindowControl
+ }) => {
+ const [isOpen, setIsOpen] = useState(false);
+ const handleToggle = useCallback(() => setIsOpen(open => !open), []);
+ const handleClose = useCallback(() => setIsOpen(false), []);
+
+ if (!isJsonEditorEnabled('animation') || showAnimationWindowControl) {
+ return null;
+ }
+
+ const filterId = filter?.type === FILTER_TYPES.timeRange ? filter.id : undefined;
+
+ return (
+ <StyledControl className="animation-json-editor-control">
+ <TippyTooltip
+ placement="top"
+ delay={[500, 0]}
+ render={() => <FormattedMessage id="tooltip.editAnimationJson" />}
+ >
+ <IconButton
+ className={classnames('playback-control-button animation-json-control-button', {
+ active: isOpen
+ })}
+ {...btnStyle}
+ onClick={handleToggle}
+ >
+ <CodeAlt height={buttonHeight} />
+ </IconButton>
+ </TippyTooltip>
+ {isOpen ? <AnimationJsonEditor filterId={filterId} onClose={handleClose} /> : null}
+ </StyledControl>
+ );
+ };
+
+ return AnimationJsonEditorControl;
+}
+
+export default AnimationJsonEditorControlFactory;
+export {AnimationJsonEditorFactory};
diff --git a/src/components/src/common/animation-control/playback-controls.tsx b/src/components/src/common/animation-control/playback-controls.tsx
index 6912b56f9..205d110d7 100644
--- a/src/components/src/common/animation-control/playback-controls.tsx
+++ b/src/components/src/common/animation-control/playback-controls.tsx
@@ -14,6 +14,7 @@ import ResetControlFactory from './reset-control';
import PlayControlFactory from './play-control';
import SpeedControlFactory from './speed-control';
import ExportVideoControlFactory from './export-video-control';
+import AnimationJsonEditorControlFactory from './animation-json-editor';
import {BaseComponentProps} from '../../types';
const DEFAULT_BUTTON_HEIGHT = '20px';
@@ -91,7 +92,8 @@ PlaybackControlsFactory.deps = [
AnimationWindowControlFactory,
ResetControlFactory,
PlayControlFactory,
- ExportVideoControlFactory
+ ExportVideoControlFactory,
+ AnimationJsonEditorControlFactory
];
function PlaybackControlsFactory(
@@ -100,7 +102,8 @@ function PlaybackControlsFactory(
AnimationWindowControl,
ResetControl,
PlayControl,
- ExportVideoControl
+ ExportVideoControl,
+ AnimationJsonEditorControl
) {
const PLAYBACK_CONTROLS_DEFAULT_ACTION_COMPONENTS = [
PlayControl,
@@ -108,7 +111,8 @@ function PlaybackControlsFactory(
ResetControl,
WindowActionControl,
AnimationWindowControl,
- ExportVideoControl
+ ExportVideoControl,
+ AnimationJsonEditorControl
];
// eslint-disable-next-line complexity
diff --git a/src/components/src/common/json-editor-utils.ts b/src/components/src/common/json-editor-utils.ts
new file mode 100644
index 000000000..800db04f0
--- /dev/null
+++ b/src/components/src/common/json-editor-utils.ts
@@ -0,0 +1,202 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {useEffect, useState} from 'react';
+
+import {
+ isSavedLayerConfigV1,
+ parseLayerConfig,
+ serializeEffect,
+ serializeFilter,
+ validateLayerWithData
+} from '@kepler.gl/reducers';
+import KeplerGlSchema, {CURRENT_VERSION, KeplerGLSchemaClass} from '@kepler.gl/schemas';
+import {Layer, LayerClassesType} from '@kepler.gl/layers';
+import {Datasets} from '@kepler.gl/table';
+import {AnimationConfig, Effect, Filter, MapState, ParsedLayer} from '@kepler.gl/types';
+import {getApplicationConfig} from '@kepler.gl/utils';
+
+export type JsonEditorStatus = {
+ status: 'success' | 'error';
+ message?: string;
+};
+
+export type JsonEditorSection = 'layer' | 'filter' | 'effect' | 'viewport' | 'animation';
+
+const JSON_EDITOR_FLAGS: Record<
+ JsonEditorSection,
+ | 'enableLayerJsonEditor'
+ | 'enableFilterJsonEditor'
+ | 'enableEffectJsonEditor'
+ | 'enableViewportJsonEditor'
+ | 'enableAnimationJsonEditor'
+> = {
+ layer: 'enableLayerJsonEditor',
+ filter: 'enableFilterJsonEditor',
+ effect: 'enableEffectJsonEditor',
+ viewport: 'enableViewportJsonEditor',
+ animation: 'enableAnimationJsonEditor'
+};
+
+export function isJsonEditorEnabled(section: JsonEditorSection): boolean {
+ const config = getApplicationConfig();
+ return Boolean(config.enableJsonEditors && config[JSON_EDITOR_FLAGS[section]]);
+}
+
+export function stringifyJson(value: unknown): string {
+ return JSON.stringify(value ?? {}, null, 2);
+}
+
+export function parseJsonObject(text: string): Record<string, unknown> {
+ const parsed = JSON.parse(text);
+ if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
+ throw new Error('JSON must be an object');
+ }
+ return parsed as Record<string, unknown>;
+}
+
+export function formatJsonText(text: string): string {
+ return stringifyJson(parseJsonObject(text));
+}
+
+export function applyStatus(ok: boolean, message?: string): JsonEditorStatus {
+ return {
+ status: ok ? 'success' : 'error',
+ // Omit the default copy so JsonEditor can render the localized fallback.
+ message
+ };
+}
+
+export function errorStatus(error: unknown): JsonEditorStatus {
+ const message = error instanceof Error ? error.message : String(error);
+ return {status: 'error', message: `Couldn't apply config: ${message}`};
+}
+
+export function useDebounce<T>(value: T, delay = 300): T {
+ const [debounced, setDebounced] = useState(value);
+ useEffect(() => {
+ const timeout = setTimeout(() => setDebounced(value), delay);
+ return () => clearTimeout(timeout);
+ }, [value, delay]);
+ return debounced;
+}
+
+export function layerToJson(layer: Layer, schema: KeplerGLSchemaClass): string {
+ const saved = schema.getConfigToSave({
+ visState: {layers: [layer], layerOrder: [layer.id]}
+ });
+ return stringifyJson(saved?.config?.visState?.layers?.[0] ?? {});
+}
+
+export function parseAndValidateLayerConfig(
+ text: string,
+ datasets: Datasets,
+ layerClasses: LayerClassesType,
+ schema: KeplerGLSchemaClass
+): ParsedLayer {
+ const nextConfigJson = parseJsonObject(text) as unknown as ParsedLayer;
+ const parsedConfig = isSavedLayerConfigV1(nextConfigJson)
+ ? parseLayerConfig(schema, nextConfigJson)
+ : nextConfigJson;
+ if (!parsedConfig) {
+ throw new Error('Invalid layer config');
+ }
+ const dataId = parsedConfig.config?.dataId ?? nextConfigJson.config?.dataId;
+ const dataset = dataId ? datasets[dataId] : undefined;
+ if (!dataset) {
+ throw new Error(`Dataset "${dataId ?? ''}" not found`);
+ }
+ validateLayerWithData(dataset, parsedConfig, layerClasses, {throwOnError: true});
+ return nextConfigJson;
+}
+
+export function filterToJson(filter: Filter, schema: KeplerGLSchemaClass): string {
+ return stringifyJson(serializeFilter(filter, schema) ?? {});
+}
+
+export function jsonToFilterConfig(text: string, filter: Filter): Filter {
+ return {
+ ...filter,
+ ...parseJsonObject(text),
+ // Identity fields are not rebuilt by applyFilterConfigUpdater; changing them
+ // can nest dataId (["id"] -> [["id"]]) or leave an incompatible filter subtype.
+ id: filter.id,
+ type: filter.type,
+ dataId: filter.dataId
+ } as Filter;
+}
+
+export function effectToJson(effect: Effect, schema: KeplerGLSchemaClass): string {
+ return stringifyJson(
+ serializeEffect(effect, schema) ?? {
+ id: effect.id,
+ type: effect.type,
+ isEnabled: effect.isEnabled,
+ parameters: effect.parameters
+ }
+ );
+}
+
+export function jsonToEffectProps(text: string, effect: Effect): Record<string, unknown> {
+ const parsed = parseJsonObject(text);
+ // deckEffect is runtime-only and can contain circular references
+ delete parsed.deckEffect;
+ // Changing type via setProps leaves the old deckEffect and parameter validator.
+ parsed.id = effect.id;
+ parsed.type = effect.type;
+ return parsed;
+}
+
+export function mapStateToJson(mapState: MapState): string {
+ const saved = KeplerGlSchema.getConfigToSave({mapState});
+ return stringifyJson(saved.config?.mapState ?? {});
+}
+
+export function jsonToMapState(text: string): Partial<MapState> {
+ const parsed = parseJsonObject(text);
+ const loaded = KeplerGlSchema.parseSavedConfig({
+ version: CURRENT_VERSION,
+ config: {mapState: parsed}
+ });
+ return (loaded?.mapState ?? parsed) as Partial<MapState>;
+}
+
+const ANIMATION_CONFIG_KEYS: (keyof AnimationConfig)[] = [
+ 'domain',
+ 'currentTime',
+ 'speed',
+ 'duration',
+ 'isAnimating',
+ 'timeSteps',
+ 'defaultTimeFormat',
+ 'timeFormat',
+ 'timezone',
+ 'hideControl'
+];
+
+function isFilterConfig(config: AnimationConfig | Filter): config is Filter {
+ return 'type' in config && 'dataId' in config;
+}
+
+export function animationConfigToJson(
+ config: AnimationConfig | Filter | undefined,
+ schema?: KeplerGLSchemaClass
+): string {
+ if (!config) {
+ return '{}';
+ }
+ if (isFilterConfig(config)) {
+ return schema ? filterToJson(config, schema) : stringifyJson({});
+ }
+ const picked: Partial<AnimationConfig> = {};
+ ANIMATION_CONFIG_KEYS.forEach(key => {
+ if (config[key] !== undefined) {
+ picked[key] = config[key] as never;
+ }
+ });
+ return stringifyJson(picked);
+}
+
+export function jsonToAnimationConfig(text: string): AnimationConfig | Filter {
+ return parseJsonObject(text) as unknown as AnimationConfig | Filter;
+}
diff --git a/src/components/src/common/json-editor.tsx b/src/components/src/common/json-editor.tsx
new file mode 100644
index 000000000..dd6fa31d7
--- /dev/null
+++ b/src/components/src/common/json-editor.tsx
@@ -0,0 +1,297 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useCallback, useEffect, useRef, useState} from 'react';
+import {useIntl} from 'react-intl';
+import {FormattedMessage} from '@kepler.gl/localization';
+import styled from 'styled-components';
+
+import {Button} from './styled-components';
+import {Checkmark, Close, Copy, Warning} from './icons';
+import {formatJsonText, JsonEditorStatus} from './json-editor-utils';
+
+export type JsonEditorProps = {
+ jsonText: string;
+ onApply?: (value: string) => JsonEditorStatus | null;
+ onReset?: () => void;
+ onClose?: (event?: React.MouseEvent) => void;
+ isReadOnly?: boolean;
+ height?: number;
+ className?: string;
+};
+
+const StyledEditorPanel = styled.div`
+ display: flex;
+ flex-direction: column;
+ flex-grow: 1;
+ min-height: 0;
+ width: 100%;
+`;
+
+const StyledEditorHeader = styled.div`
+ display: flex;
+ align-items: center;
+ gap: 8px;
+ padding: 8px 0;
+ .spacer {
+ flex-grow: 1;
+ }
+ .json-editor-icon-button {
+ display: flex;
+ border: none;
+ background: transparent;
+ cursor: pointer;
+ padding: 0;
+ color: ${props => props.theme.subtextColor};
+ &:hover {
+ color: ${props => props.theme.textColorHl};
+ }
+ }
+`;
+
+const StyledEditorBody = styled.div`
+ position: relative;
+ display: flex;
+ flex-direction: column;
+ flex-grow: 1;
+ min-height: 0;
+`;
+
+const StyledTextArea = styled.textarea`
+ width: 100%;
+ flex-grow: 1;
+ min-height: 180px;
+ resize: vertical;
+ box-sizing: border-box;
+ font-family: ${props => props.theme.fontFamily};
+ font-size: 11px;
+ line-height: 1.4;
+ padding: 8px;
+ color: ${props => props.theme.inputColor};
+ background-color: ${props => props.theme.inputBgd};
+ border: 1px solid ${props => props.theme.inputBgdHover || props.theme.panelBackgroundHover};
+ border-radius: 2px;
+ overflow-y: auto;
+ outline: none;
+ &:focus {
+ border-color: ${props => props.theme.activeColor};
+ }
+`;
+
+const StyledEditorStatus = styled.div<{status?: string}>`
+ position: absolute;
+ top: 0;
+ left: 0;
+ right: 0;
+ background-color: ${props => props.theme.panelBackground};
+ padding: 6px 8px;
+ color: ${props =>
+ props.status === 'success'
+ ? props.theme.notificationColors?.success || '#47B275'
+ : props.theme.errorColor};
+ display: flex;
+ align-items: center;
+ gap: 6px;
+ font-size: 11px;
+ z-index: 1;
+`;
+
+function JsonEditor({
+ jsonText,
+ onApply,
+ onReset,
+ onClose,
+ isReadOnly = false,
+ height = 240,
+ className
+}: JsonEditorProps) {
+ const intl = useIntl();
+ const [internalText, setInternalText] = useState(jsonText);
+ const [status, setStatus] = useState<JsonEditorStatus | null>(null);
+ const [parseError, setParseError] = useState<string | null>(null);
+ const textAreaRef = useRef<HTMLTextAreaElement>(null);
+ const isDirtyRef = useRef(false);
+
+ const touched = internalText !== jsonText;
+ const canApply = Boolean(touched && !parseError && !isReadOnly && onApply);
+
+ useEffect(() => {
+ if (isDirtyRef.current) {
+ return;
+ }
+ setInternalText(jsonText);
+ setParseError(null);
+ }, [jsonText]);
+
+ useEffect(() => {
+ if (!status) {
+ return undefined;
+ }
+ const timeout = setTimeout(() => setStatus(null), 5000);
+ return () => clearTimeout(timeout);
+ }, [status]);
+
+ const handleChange = useCallback((event: React.ChangeEvent<HTMLTextAreaElement>) => {
+ const next = event.target.value;
+ isDirtyRef.current = true;
+ setInternalText(next);
+ try {
+ JSON.parse(next);
+ setParseError(null);
+ } catch (error) {
+ setParseError(error instanceof Error ? error.message : 'Invalid JSON');
+ }
+ }, []);
+
+ const handleApply = useCallback(() => {
+ if (!canApply || !onApply) {
+ return;
+ }
+ const result = onApply(internalText);
+ setStatus(result);
+ if (result?.status === 'success') {
+ isDirtyRef.current = false;
+ }
+ }, [canApply, internalText, onApply]);
+
+ const handleReset = useCallback(() => {
+ isDirtyRef.current = false;
+ setInternalText(jsonText);
+ setParseError(null);
+ setStatus(null);
+ onReset?.();
+ }, [jsonText, onReset]);
+
+ const handleFormat = useCallback(() => {
+ try {
+ setInternalText(formatJsonText(internalText));
+ setParseError(null);
+ } catch (error) {
+ setParseError(error instanceof Error ? error.message : 'Invalid JSON');
+ }
+ }, [internalText]);
+
+ const handleCopy = useCallback(async () => {
+ try {
+ await navigator.clipboard?.writeText(internalText);
+ } catch {
+ // clipboard can fail in insecure contexts; ignore
+ }
+ }, [internalText]);
+
+ const handleKeyDown = useCallback(
+ (event: React.KeyboardEvent<HTMLTextAreaElement>) => {
+ if ((event.metaKey || event.ctrlKey) && event.key === 's') {
+ event.preventDefault();
+ handleApply();
+ }
+ },
+ [handleApply]
+ );
+
+ return (
+ <StyledEditorPanel className={className} data-testid="json-editor">
+ <StyledEditorHeader>
+ <div className="spacer" />
+ <button
+ type="button"
+ className="json-editor-icon-button"
+ onClick={handleCopy}
+ aria-label="Copy JSON"
+ title="Copy JSON"
+ >
+ <Copy height="14px" />
+ </button>
+ {onClose ? (
+ <button
+ type="button"
+ className="json-editor-icon-button"
+ onClick={onClose}
+ aria-label="Close"
+ title="Close"
+ data-testid="json-editor-close"
+ >
+ <Close height="14px" />
+ </button>
+ ) : null}
+ {touched ? (
+ <Button
+ secondary
+ small
+ width="60px"
+ onClick={handleReset}
+ data-testid="json-editor-reset"
+ >
+ <FormattedMessage id="jsonEditor.reset" defaultMessage="Reset" />
+ </Button>
+ ) : null}
+ {!isReadOnly ? (
+ <>
+ <Button
+ secondary
+ small
+ width="60px"
+ disabled={Boolean(parseError)}
+ onClick={handleFormat}
+ data-testid="json-editor-format"
+ >
+ <FormattedMessage id="jsonEditor.format" defaultMessage="Format" />
+ </Button>
+ <Button
+ small
+ width="60px"
+ disabled={!canApply}
+ onClick={handleApply}
+ data-testid="json-editor-apply"
+ >
+ <FormattedMessage id="jsonEditor.apply" defaultMessage="Apply" />
+ </Button>
+ </>
+ ) : null}
+ </StyledEditorHeader>
+ <StyledEditorBody>
+ <StyledTextArea
+ ref={textAreaRef}
+ value={internalText}
+ onChange={handleChange}
+ onKeyDown={handleKeyDown}
+ readOnly={isReadOnly}
+ spellCheck={false}
+ autoComplete="off"
+ autoCorrect="off"
+ autoCapitalize="off"
+ aria-label={intl.formatMessage({
+ id: 'jsonEditor.textarea',
+ defaultMessage: 'JSON configuration'
+ })}
+ style={{height}}
+ />
+ {parseError ? (
+ <StyledEditorStatus status="error">
+ <Warning height="14px" />
+ {parseError}
+ </StyledEditorStatus>
+ ) : null}
+ {status ? (
+ <StyledEditorStatus status={status.status}>
+ {status.status === 'success' ? <Checkmark height="14px" /> : <Warning height="14px" />}
+ {status.message ?? (
+ <FormattedMessage
+ id={
+ status.status === 'success'
+ ? 'jsonEditor.configApplied'
+ : 'jsonEditor.applyFailed'
+ }
+ defaultMessage={
+ status.status === 'success' ? 'Config applied' : "Couldn't apply config"
+ }
+ />
+ )}
+ </StyledEditorStatus>
+ ) : null}
+ </StyledEditorBody>
+ </StyledEditorPanel>
+ );
+}
+
+export default JsonEditor;
diff --git a/src/components/src/common/time-range-slider.tsx b/src/components/src/common/time-range-slider.tsx
index 6ca2c5bc8..5ecc4a7ef 100644
--- a/src/components/src/common/time-range-slider.tsx
+++ b/src/components/src/common/time-range-slider.tsx
@@ -9,7 +9,7 @@ import RangeSliderFactory from './range-slider';
import TimeSliderMarkerFactory from './time-slider-marker';
import PlaybackControlsFactory from './animation-control/playback-controls';
import TimeRangeSliderTimeTitleFactory from './time-range-slider-time-title';
-import {LineChart, Timeline, AnimationConfig, TimeBins} from '@kepler.gl/types';
+import {LineChart, Timeline, AnimationConfig, TimeBins, Filter} from '@kepler.gl/types';
import {ActionHandler, setFilterPlot} from '@kepler.gl/actions';
import AnimationControlFactory from './animation-control/animation-control';
import {BaseComponentProps} from '../types';
@@ -45,6 +45,7 @@ type TimeRangeSliderProps = {
timeline: Timeline;
invertTrendColor?: boolean;
animationConfig?: AnimationConfig;
+ filter?: Filter;
};
export type StyledSliderContainerProps = BaseComponentProps & {
@@ -120,7 +121,8 @@ export default function TimeRangeSliderFactory(
exportAnimation,
onChange,
setFilterPlot,
- timeline
+ timeline,
+ filter
} = props;
const throttledOnchange = useMemo(() => throttle(onChange, 20), [onChange]);
@@ -185,6 +187,7 @@ export default function TimeRangeSliderFactory(
exportAnimation={exportAnimation}
showTimeDisplay={false}
timeline={timeline}
+ filter={filter}
/>
)}
{isEnlarged && !isMinified ? (
@@ -200,6 +203,7 @@ export default function TimeRangeSliderFactory(
exportAnimation={exportAnimation}
isAnimating={isAnimating}
startAnimation={toggleAnimation}
+ filter={filter}
/>
) : null}
</StyledSliderContainer>
diff --git a/src/components/src/effects/effect-json-editor.tsx b/src/components/src/effects/effect-json-editor.tsx
new file mode 100644
index 000000000..6074d48c6
--- /dev/null
+++ b/src/components/src/effects/effect-json-editor.tsx
@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useCallback, useMemo} from 'react';
+import {updateEffect} from '@kepler.gl/actions';
+import {visStateLens} from '@kepler.gl/reducers';
+import {VisState} from '@kepler.gl/schemas';
+import {Effect, EffectPropsPartial} from '@kepler.gl/types';
+
+import {withState} from '../injector';
+import JsonEditor from '../common/json-editor';
+import {
+ applyStatus,
+ effectToJson,
+ errorStatus,
+ jsonToEffectProps,
+ JsonEditorStatus,
+ useDebounce
+} from '../common/json-editor-utils';
+
+export type EffectJsonEditorProps = {
+ effect: Effect;
+ visState?: VisState;
+ updateEffect?: typeof updateEffect;
+ onClose?: (event?: React.MouseEvent) => void;
+};
+
+function EffectJsonEditorFactory() {
+ const EffectJsonEditor: React.FC<EffectJsonEditorProps> = ({
+ effect,
+ visState,
+ updateEffect: updateEffectAction,
+ onClose
+ }) => {
+ const jsonText = useMemo(
+ () => (visState?.schema ? effectToJson(effect, visState.schema) : '{}'),
+ [effect, effect.id, effect.type, effect.isEnabled, effect.parameters, visState?.schema]
+ );
+ const debouncedJsonText = useDebounce(jsonText, 300);
+
+ const handleApply = useCallback(
+ (text: string): JsonEditorStatus => {
+ try {
+ if (!updateEffectAction) {
+ return applyStatus(false);
+ }
+ updateEffectAction(effect.id, jsonToEffectProps(text, effect) as EffectPropsPartial);
+ return applyStatus(true);
+ } catch (error) {
+ return errorStatus(error);
+ }
+ },
+ [effect, updateEffectAction]
+ );
+
+ return (
+ <JsonEditor
+ jsonText={debouncedJsonText}
+ onApply={handleApply}
+ onClose={onClose}
+ height={260}
+ />
+ );
+ };
+
+ return withState([visStateLens], () => ({}), {updateEffect})(
+ EffectJsonEditor
+ ) as React.FC<EffectJsonEditorProps>;
+}
+
+export default EffectJsonEditorFactory;
diff --git a/src/components/src/effects/effect-panel-header.tsx b/src/components/src/effects/effect-panel-header.tsx
index 4ee743718..8f56d7db5 100644
--- a/src/components/src/effects/effect-panel-header.tsx
+++ b/src/components/src/effects/effect-panel-header.tsx
@@ -40,6 +40,7 @@ import {
HexagonalPixelateEffectIcon,
DistanceFogEffectIcon,
SurfaceFogEffectIcon,
+ CodeAlt,
BaseProps
} from '../common/icons';
import {StyledPanelHeader, Tooltip} from '../common/styled-components';
@@ -75,12 +76,15 @@ export type EffectPanelHeaderProps = {
onToggleEnabled: () => void;
onRemoveEffect: () => void;
onToggleEnableConfig: () => void;
+ onToggleJsonEditor?: () => void;
+ showJsonEditor?: boolean;
actionIcons?: {
remove: React.ComponentType<Partial<BaseProps>>;
visible: React.ComponentType<Partial<BaseProps>>;
hidden: React.ComponentType<Partial<BaseProps>>;
enableConfig: React.ComponentType<Partial<BaseProps>>;
disableConfig: React.ComponentType<Partial<BaseProps>>;
+ json?: React.ComponentType<Partial<BaseProps>>;
};
actionItems?: ActionItem[];
};
@@ -94,7 +98,8 @@ const defaultActionIcons = {
visible: EyeSeen,
hidden: EyeUnseen,
enableConfig: ArrowDown,
- disableConfig: ArrowUp
+ disableConfig: ArrowUp,
+ json: CodeAlt
};
const defaultEffectIcons = {
@@ -207,6 +212,9 @@ export function EffectPanelHeaderActionSectionFactory(
onToggleEnabled,
onRemoveEffect,
onToggleEnableConfig,
+ onToggleJsonEditor,
+ isJsonEditorActive,
+ showJsonEditor,
actionItems,
actionIcons = defaultActionIcons
} = props;
@@ -222,6 +230,17 @@ export function EffectPanelHeaderActionSectionFactory(
onClick: onRemoveEffect,
icon: actionIcons.remove
},
+ ...(showJsonEditor && onToggleJsonEditor
+ ? [
+ {
+ key: 'edit-json',
+ isHidden: true,
+ tooltip: 'tooltip.editEffectJson',
+ onClick: onToggleJsonEditor,
+ icon: actionIcons.json || CodeAlt
+ }
+ ]
+ : []),
{
key: 'visibility-toggle',
tooltip: isEnabled ? 'tooltip.disableEffect' : 'tooltip.enabledEffect',
@@ -241,9 +260,12 @@ export function EffectPanelHeaderActionSectionFactory(
actionIcons,
isEnabled,
isConfigActive,
+ isJsonEditorActive,
+ showJsonEditor,
onRemoveEffect,
onToggleEnabled,
- onToggleEnableConfig
+ onToggleEnableConfig,
+ onToggleJsonEditor
]
);
diff --git a/src/components/src/effects/effect-panel.tsx b/src/components/src/effects/effect-panel.tsx
index d601cdfa2..cda2d5860 100644
--- a/src/components/src/effects/effect-panel.tsx
+++ b/src/components/src/effects/effect-panel.tsx
@@ -11,6 +11,8 @@ import {Effect} from '@kepler.gl/types';
import EffectPanelHeaderFactory from './effect-panel-header';
import EffectConfiguratorFactory from './effect-configurator';
+import EffectJsonEditorFactory from './effect-json-editor';
+import {isJsonEditorEnabled} from '../common/json-editor-utils';
export type EffectPanelProps = {
className: string;
@@ -39,11 +41,16 @@ const PanelWrapper = styled.div<PanelWrapperProps>`
margin: 3px 16px;
`;
-EffectPanelFactory.deps = [EffectPanelHeaderFactory, EffectConfiguratorFactory];
+EffectPanelFactory.deps = [
+ EffectPanelHeaderFactory,
+ EffectConfiguratorFactory,
+ EffectJsonEditorFactory
+];
function EffectPanelFactory(
EffectPanelHeader: ReturnType<typeof EffectPanelHeaderFactory>,
- EffectConfigurator: ReturnType<typeof EffectConfiguratorFactory>
+ EffectConfigurator: ReturnType<typeof EffectConfiguratorFactory>,
+ EffectJsonEditor: ReturnType<typeof EffectJsonEditorFactory>
): ComponentType<EffectPanelProps> {
const EffectPanel: React.FC<EffectPanelProps> = ({
className,
@@ -88,6 +95,25 @@ function EffectPanelFactory(
[updateEffectAction]
);
+ const toggleJsonEditor = useCallback(
+ (event?: React.MouseEvent) => {
+ event?.stopPropagation();
+ updateEffectAction(effect.id, {
+ ...(!effect.isConfigActive ? {isConfigActive: true} : {}),
+ isJsonEditorActive: !effect.isJsonEditorActive
+ });
+ },
+ [updateEffectAction, effect.id, effect.isConfigActive, effect.isJsonEditorActive]
+ );
+
+ const closeJsonEditor = useCallback(
+ (event?: React.MouseEvent) => {
+ event?.stopPropagation();
+ updateEffectAction(effect.id, {isJsonEditorActive: false});
+ },
+ [updateEffectAction, effect.id]
+ );
+
const {id, type, isConfigActive, isJsonEditorActive, isEnabled} = effect;
const sortingAllowed = type !== LIGHT_AND_SHADOW_EFFECT.type;
@@ -109,17 +135,22 @@ function EffectPanelFactory(
onToggleEnabled={toggleEnabled}
onRemoveEffect={handleRemoveEffect}
onToggleEnableConfig={toggleConfigActive}
+ onToggleJsonEditor={toggleJsonEditor}
+ showJsonEditor={isJsonEditorEnabled('effect')}
isDragNDropEnabled={isDraggable && sortingAllowed}
listeners={listeners}
showSortHandle={type !== LIGHT_AND_SHADOW_EFFECT.type}
/>
- {isConfigActive && (
- <EffectConfigurator
- key={`effect-configurator-${id}`}
- effect={effect}
- updateEffectConfig={handleUpdateEffectConfig}
- />
- )}
+ {isConfigActive &&
+ (isJsonEditorActive ? (
+ <EffectJsonEditor effect={effect} onClose={closeJsonEditor} />
+ ) : (
+ <EffectConfigurator
+ key={`effect-configurator-${id}`}
+ effect={effect}
+ updateEffectConfig={handleUpdateEffectConfig}
+ />
+ ))}
</PanelWrapper>
);
};
diff --git a/src/components/src/filters/time-widget.tsx b/src/components/src/filters/time-widget.tsx
index e2e55c005..f8779a537 100644
--- a/src/components/src/filters/time-widget.tsx
+++ b/src/components/src/filters/time-widget.tsx
@@ -291,6 +291,17 @@ function TimeWidgetFactory(
if (isMinified || !sliderDomain) {
return;
}
+ // Overlays such as the animation JSON editor sit inside this container.
+ // Don't steal their scroll / pointer input for timeline zoom.
+ const target = event.target;
+ if (
+ target instanceof Element &&
+ target.closest(
+ 'textarea, input, select, [data-testid="json-editor"], .animation-json-editor'
+ )
+ ) {
+ return;
+ }
const isPinch = event.ctrlKey || event.metaKey || Math.abs(event.deltaZ || 0) > 0;
const zoomFn = isPinch ? throttledTimelineZoom : throttledWindowZoom;
if (!zoomFn) {
diff --git a/src/components/src/index.ts b/src/components/src/index.ts
index e9e200873..3568aa5dc 100644
--- a/src/components/src/index.ts
+++ b/src/components/src/index.ts
@@ -102,6 +102,7 @@ export {
getVisConfiguratorProps
} from './side-panel/layer-panel/layer-configurator';
export {default as LayerPanelFactory} from './side-panel/layer-panel/layer-panel';
+export {default as LayerJsonEditorFactory} from './side-panel/layer-panel/layer-json-editor';
export {default as SingleColorPalette} from './side-panel/layer-panel/single-color-palette';
export {default as TextLabelPanelFactory} from './side-panel/layer-panel/text-label-panel';
export {default as ScenegraphModelSelectorFactory} from './side-panel/layer-panel/scenegraph-model-selector';
@@ -160,6 +161,7 @@ export {default as LayerHoverInfoFactory} from './map/layer-hover-info';
export {default as LazyTippy} from './map/lazy-tippy';
export {default as LocalePanelFactory} from './map/locale-panel';
export {default as ThemeToggleButtonFactory} from './map/theme-toggle-button';
+export {default as ViewportJsonEditorControlFactory} from './map/viewport-json-editor';
export {default as MapControlFactory} from './map/map-control';
export {default as MapNavigationControlFactory} from './map/map-navigation-control';
export {default as MapScaleFactory} from './map/map-scale';
@@ -224,6 +226,10 @@ export {default as ResetControlFactory} from './common/animation-control/reset-c
export {default as SpeedControlFactory} from './common/animation-control/speed-control';
export {default as ExportVideoControlFactory} from './common/animation-control/export-video-control';
export {default as WindowActionControlFactory} from './common/animation-control/window-action-control';
+export {
+ default as AnimationJsonEditorControlFactory,
+ AnimationJsonEditorFactory
+} from './common/animation-control/animation-json-editor';
export {default as HistogramPlotFactory, HISTOGRAM_MASK_MODE} from './common/histogram-plot';
export type {HistogramPlotProps} from './common/histogram-plot';
@@ -283,6 +289,8 @@ export * from './injector';
// Common Components
export {default as ActionPanel, ActionPanelItem} from './common/action-panel';
+export {default as JsonEditor} from './common/json-editor';
+export * from './common/json-editor-utils';
export {default as Checkbox} from './common/checkbox';
export {
default as ColorLegendFactory,
@@ -356,6 +364,7 @@ export {default as CustomPaletteFactory} from './side-panel/layer-panel/custom-p
// side pane components
export {default as StyledDropdownSelect} from './common/item-selector/item-selector';
export {default as FilterPanelHeaderFactory} from './side-panel/filter-panel/filter-panel-header';
+export {default as FilterJsonEditorFactory} from './side-panel/filter-panel/filter-json-editor';
export {default as ColumnSelectorFactory} from './side-panel/layer-panel/column-selector';
export {
ConfigGroupCollapsibleContent,
@@ -373,6 +382,7 @@ export {default as LayerTypeDropdownListFactory} from './side-panel/layer-panel/
export {default as LayerTypeSelectorFactory} from './side-panel/layer-panel/layer-type-selector';
export {default as EffectConfiguratorFactory} from './effects/effect-configurator';
+export {default as EffectJsonEditorFactory} from './effects/effect-json-editor';
export {default as SurfaceFogElevationSectionFactory} from './effects/surface-fog-section';
export {default as EffectListFactory} from './effects/effect-list';
export {default as EffectManagerFactory} from './effects/effect-manager';
diff --git a/src/components/src/map/map-control.tsx b/src/components/src/map/map-control.tsx
index b2e1ad77a..122932e34 100644
--- a/src/components/src/map/map-control.tsx
+++ b/src/components/src/map/map-control.tsx
@@ -21,6 +21,7 @@ import {getApplicationConfig} from '@kepler.gl/utils';
import {MapViewMode} from '@kepler.gl/constants';
import AnnotationControlFactory from './annotations/annotation-control';
+import ViewportJsonEditorControlFactory from './viewport-json-editor';
interface StyledMapControlProps {
$top?: number;
@@ -106,7 +107,8 @@ MapControlFactory.deps = [
LocalePanelFactory,
ThemeToggleButtonFactory,
AnnotationControlFactory,
- MapNavigationControlFactory
+ MapNavigationControlFactory,
+ ViewportJsonEditorControlFactory
];
function MapControlFactory(
@@ -117,7 +119,8 @@ function MapControlFactory(
LocalePanel: ReturnType<typeof LocalePanelFactory>,
ThemeToggleButton: ReturnType<typeof ThemeToggleButtonFactory>,
AnnotationControl: ReturnType<typeof AnnotationControlFactory>,
- MapNavigationControl: ReturnType<typeof MapNavigationControlFactory>
+ MapNavigationControl: ReturnType<typeof MapNavigationControlFactory>,
+ ViewportJsonEditorControl: ReturnType<typeof ViewportJsonEditorControlFactory>
) {
const DEFAULT_ACTIONS = [
SplitMapButton,
@@ -126,6 +129,7 @@ function MapControlFactory(
AnnotationControl,
LocalePanel,
ThemeToggleButton,
+ ViewportJsonEditorControl,
MapLegendPanel
];
diff --git a/src/components/src/map/viewport-json-editor.tsx b/src/components/src/map/viewport-json-editor.tsx
new file mode 100644
index 000000000..03669341e
--- /dev/null
+++ b/src/components/src/map/viewport-json-editor.tsx
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useCallback} from 'react';
+import classnames from 'classnames';
+import {applyMapState} from '@kepler.gl/actions';
+import {MapControls, MapState} from '@kepler.gl/types';
+
+import {CodeAlt} from '../common/icons';
+import {MapControlButton} from '../common/styled-components';
+import {withState} from '../injector';
+import JsonEditor from '../common/json-editor';
+import {
+ applyStatus,
+ isJsonEditorEnabled,
+ errorStatus,
+ jsonToMapState,
+ JsonEditorStatus,
+ mapStateToJson,
+ useDebounce
+} from '../common/json-editor-utils';
+import MapControlPanelFactory from './map-control-panel';
+import MapControlTooltipFactory from './map-control-tooltip';
+
+export type ViewportJsonEditorControlProps = {
+ mapControls: MapControls;
+ onToggleMapControl: (control: string) => void;
+ mapState?: MapState;
+ mapIndex?: number;
+ applyMapState?: typeof applyMapState;
+ className?: string;
+};
+
+ViewportJsonEditorControlFactory.deps = [MapControlTooltipFactory, MapControlPanelFactory];
+
+function ViewportJsonEditorControlFactory(
+ MapControlTooltip: ReturnType<typeof MapControlTooltipFactory>,
+ MapControlPanel: ReturnType<typeof MapControlPanelFactory>
+) {
+ type ViewportJsonEditorProps = {
+ mapState?: MapState;
+ mapIndex?: number;
+ applyMapState?: typeof applyMapState;
+ onClose?: (event?: React.MouseEvent) => void;
+ };
+
+ const ViewportJsonEditor: React.FC<ViewportJsonEditorProps> = ({
+ mapState,
+ mapIndex = 0,
+ applyMapState: applyMapStateAction,
+ onClose
+ }) => {
+ const jsonText = mapState ? mapStateToJson(mapState) : '{}';
+ const debouncedJsonText = useDebounce(jsonText, 300);
+
+ const handleApply = useCallback(
+ (text: string): JsonEditorStatus => {
+ try {
+ if (!applyMapStateAction) {
+ return applyStatus(false);
+ }
+ applyMapStateAction(jsonToMapState(text), mapIndex);
+ return applyStatus(true);
+ } catch (error) {
+ return errorStatus(error);
+ }
+ },
+ [applyMapStateAction, mapIndex]
+ );
+
+ return (
+ <JsonEditor
+ jsonText={debouncedJsonText}
+ onApply={handleApply}
+ onClose={onClose}
+ height={280}
+ />
+ );
+ };
+
+ const ConnectedViewportJsonEditor = withState([], () => ({}), {applyMapState})(
+ ViewportJsonEditor
+ ) as React.FC<ViewportJsonEditorProps>;
+
+ const ViewportJsonEditorControl: React.FC<ViewportJsonEditorControlProps> = ({
+ mapControls,
+ onToggleMapControl,
+ mapState,
+ mapIndex = 0,
+ className
+ }) => {
+ const onClick = useCallback(
+ event => {
+ event.preventDefault();
+ onToggleMapControl('viewportJson');
+ },
+ [onToggleMapControl]
+ );
+
+ const showControl = isJsonEditorEnabled('viewport') && mapControls?.viewportJson?.show;
+ if (!showControl) {
+ return null;
+ }
+
+ const isActive = Boolean(mapControls.viewportJson?.active);
+
+ return (
+ <div
+ className={classnames('viewport-json-editor-controls', className)}
+ style={{position: 'relative'}}
+ >
+ {isActive ? (
+ <MapControlPanel
+ header="tooltip.editViewportJson"
+ onClick={onClick}
+ pinnable={false}
+ disableClose={false}
+ >
+ <ConnectedViewportJsonEditor
+ mapState={mapState}
+ mapIndex={mapIndex}
+ onClose={onClick}
+ />
+ </MapControlPanel>
+ ) : null}
+ <MapControlTooltip id="show-viewport-json-editor" message="tooltip.editViewportJson">
+ <MapControlButton
+ className={classnames('map-control-button', 'viewport-json', {isActive})}
+ onClick={onClick}
+ active={isActive}
+ >
+ <CodeAlt height="16px" />
+ </MapControlButton>
+ </MapControlTooltip>
+ </div>
+ );
+ };
+
+ ViewportJsonEditorControl.displayName = 'ViewportJsonEditorControl';
+ return ViewportJsonEditorControl;
+}
+
+export default ViewportJsonEditorControlFactory;
diff --git a/src/components/src/side-panel/filter-panel/filter-json-editor.tsx b/src/components/src/side-panel/filter-panel/filter-json-editor.tsx
new file mode 100644
index 000000000..b8ec907e5
--- /dev/null
+++ b/src/components/src/side-panel/filter-panel/filter-json-editor.tsx
@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useCallback, useMemo} from 'react';
+import styled from 'styled-components';
+import {applyFilterConfig} from '@kepler.gl/actions';
+import {visStateLens} from '@kepler.gl/reducers';
+import {VisState} from '@kepler.gl/schemas';
+import {Filter} from '@kepler.gl/types';
+
+import {withState} from '../../injector';
+import JsonEditor from '../../common/json-editor';
+import {
+ applyStatus,
+ errorStatus,
+ filterToJson,
+ jsonToFilterConfig,
+ JsonEditorStatus,
+ useDebounce
+} from '../../common/json-editor-utils';
+
+const StyledFilterJsonEditor = styled.div`
+ padding: 8px 12px 12px;
+ background-color: ${props => props.theme.panelBackground};
+`;
+
+export type FilterJsonEditorProps = {
+ filter: Filter;
+ visState?: VisState;
+ applyFilterConfig?: typeof applyFilterConfig;
+ onClose?: (event?: React.MouseEvent) => void;
+};
+
+function FilterJsonEditorFactory() {
+ const FilterJsonEditor: React.FC<FilterJsonEditorProps> = ({
+ filter,
+ visState,
+ applyFilterConfig: applyFilterConfigAction,
+ onClose
+ }) => {
+ const jsonText = useMemo(
+ () => (visState?.schema ? filterToJson(filter, visState.schema) : '{}'),
+ [filter, visState?.schema]
+ );
+ const debouncedJsonText = useDebounce(jsonText, 300);
+
+ const handleApply = useCallback(
+ (text: string): JsonEditorStatus => {
+ try {
+ if (!applyFilterConfigAction) {
+ return applyStatus(false);
+ }
+ applyFilterConfigAction(filter.id, jsonToFilterConfig(text, filter));
+ return applyStatus(true);
+ } catch (error) {
+ return errorStatus(error);
+ }
+ },
+ [applyFilterConfigAction, filter]
+ );
+
+ return (
+ <StyledFilterJsonEditor className="filter-json-editor">
+ <JsonEditor
+ jsonText={debouncedJsonText}
+ onApply={handleApply}
+ onClose={onClose}
+ height={220}
+ />
+ </StyledFilterJsonEditor>
+ );
+ };
+
+ return withState([visStateLens], () => ({}), {applyFilterConfig})(
+ FilterJsonEditor
+ ) as React.FC<FilterJsonEditorProps>;
+}
+
+export default FilterJsonEditorFactory;
diff --git a/src/components/src/side-panel/filter-panel/filter-panel-header.tsx b/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
index 606f11543..1c3ae3973 100644
--- a/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
+++ b/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
@@ -1,15 +1,18 @@
// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project
-import React, {ComponentType, useMemo} from 'react';
+import React, {ComponentType, useCallback, useMemo, useState} from 'react';
import styled from 'styled-components';
import classnames from 'classnames';
+import {PanelHeaderActionIcon} from '../../side-panel/panel-header-action';
import PanelHeaderActionFactory from '../../side-panel/panel-header-action';
-import {Trash} from '../../common/icons';
+import {CodeAlt, Trash} from '../../common/icons';
import {createLinearGradient} from '@kepler.gl/utils';
import {StyledPanelHeader, StyledPanelHeaderProps} from '../../common/styled-components';
import {RGBColor, Filter, Field} from '@kepler.gl/types';
import {KeplerTable} from '@kepler.gl/table';
+import FilterJsonEditorFactory from './filter-json-editor';
+import {isJsonEditorEnabled} from '../../common/json-editor-utils';
interface StyledFilterHeaderProps extends StyledPanelHeaderProps {
$labelRCGColorValues: RGBColor[];
@@ -37,32 +40,40 @@ const StyledChildrenContainer = styled.div`
overflow: hidden;
`;
+export type FilterPanelHeaderActionItem = {
+ key: string;
+ tooltip: string;
+ onClick: (event?: React.MouseEvent) => void;
+ icon: PanelHeaderActionIcon;
+ tooltipType?: 'error' | 'dark' | 'success' | 'warning';
+ hoverColor?: string;
+ active?: boolean;
+};
+
export type FilterPanelHeaderProps = {
className?: string;
datasets: KeplerTable[];
filter: Filter;
removeFilter: () => void;
- actionItems?: {
- key: string;
- tooltip: string;
- onClick: () => void;
- icon: React.ElementType;
- }[];
+ actionItems?: FilterPanelHeaderActionItem[];
actionIcons?: {
delete: ComponentType;
+ json?: ComponentType;
};
allAvailableFields?: Field[];
idx?: number;
children: React.ReactNode;
};
-FilterPanelHeaderFactory.deps = [PanelHeaderActionFactory];
+FilterPanelHeaderFactory.deps = [PanelHeaderActionFactory, FilterJsonEditorFactory];
function FilterPanelHeaderFactory(
- PanelHeaderAction: ReturnType<typeof PanelHeaderActionFactory>
+ PanelHeaderAction: ReturnType<typeof PanelHeaderActionFactory>,
+ FilterJsonEditor: ReturnType<typeof FilterJsonEditorFactory>
): React.ComponentType<FilterPanelHeaderProps> {
const defaultActionIcons = {
- delete: Trash
+ delete: Trash,
+ json: CodeAlt
};
const FilterPanelHeader: React.FC<FilterPanelHeaderProps> = ({
children,
@@ -73,36 +84,71 @@ function FilterPanelHeaderFactory(
actionItems,
actionIcons = defaultActionIcons
}: FilterPanelHeaderProps) => {
- const items = useMemo(
- () =>
- actionItems ?? [
- {
- key: 'delete',
- tooltip: 'tooltip.delete',
- onClick: removeFilter,
- icon: actionIcons.delete
- }
- ],
- [removeFilter, actionIcons, actionItems]
- );
+ const [isJsonEditorActive, setIsJsonEditorActive] = useState(false);
+ const showJsonEditor = isJsonEditorEnabled('filter');
+ const toggleJsonEditor = useCallback((event?: React.MouseEvent) => {
+ event?.stopPropagation();
+ setIsJsonEditorActive(active => !active);
+ }, []);
+ const closeJsonEditor = useCallback((event?: React.MouseEvent) => {
+ event?.stopPropagation();
+ setIsJsonEditorActive(false);
+ }, []);
+
+ const items: FilterPanelHeaderActionItem[] = useMemo(() => {
+ const baseItems: FilterPanelHeaderActionItem[] = actionItems ?? [
+ {
+ key: 'delete',
+ tooltip: 'tooltip.delete',
+ onClick: removeFilter,
+ icon: actionIcons.delete as PanelHeaderActionIcon,
+ tooltipType: 'error',
+ hoverColor: 'errorColor'
+ }
+ ];
+ if (!showJsonEditor) {
+ return baseItems;
+ }
+ return [
+ {
+ key: 'json',
+ tooltip: 'tooltip.editFilterJson',
+ onClick: toggleJsonEditor,
+ icon: (actionIcons.json || CodeAlt) as PanelHeaderActionIcon,
+ active: isJsonEditorActive
+ },
+ ...baseItems
+ ];
+ }, [
+ removeFilter,
+ actionIcons,
+ actionItems,
+ showJsonEditor,
+ toggleJsonEditor,
+ isJsonEditorActive
+ ]);
return (
- <StyledFilterHeader
- className={classnames('filter-panel__header', className)}
- $labelRCGColorValues={datasets.map((d: KeplerTable) => d.color)}
- >
- <StyledChildrenContainer>{children}</StyledChildrenContainer>
- {items.map(item => (
- <PanelHeaderAction
- key={item.key}
- id={filter.id}
- tooltip={item.tooltip}
- tooltipType="error"
- onClick={item.onClick}
- hoverColor={'errorColor'}
- IconComponent={item.icon}
- />
- ))}
- </StyledFilterHeader>
+ <>
+ <StyledFilterHeader
+ className={classnames('filter-panel__header', className)}
+ $labelRCGColorValues={datasets.map((d: KeplerTable) => d.color)}
+ >
+ <StyledChildrenContainer>{children}</StyledChildrenContainer>
+ {items.map(item => (
+ <PanelHeaderAction
+ key={item.key}
+ id={filter.id}
+ tooltip={item.tooltip}
+ tooltipType={item.tooltipType}
+ onClick={item.onClick}
+ hoverColor={item.hoverColor}
+ IconComponent={item.icon}
+ active={item.active}
+ />
+ ))}
+ </StyledFilterHeader>
+ {isJsonEditorActive ? <FilterJsonEditor filter={filter} onClose={closeJsonEditor} /> : null}
+ </>
);
};
diff --git a/src/components/src/side-panel/layer-panel/layer-json-editor.tsx b/src/components/src/side-panel/layer-panel/layer-json-editor.tsx
new file mode 100644
index 000000000..5706ec1a1
--- /dev/null
+++ b/src/components/src/side-panel/layer-panel/layer-json-editor.tsx
@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useCallback, useMemo} from 'react';
+import {applyLayerConfig} from '@kepler.gl/actions';
+import {Layer} from '@kepler.gl/layers';
+import {visStateLens} from '@kepler.gl/reducers';
+import {VisState} from '@kepler.gl/schemas';
+
+import {withState} from '../../injector';
+import JsonEditor from '../../common/json-editor';
+import {
+ applyStatus,
+ errorStatus,
+ JsonEditorStatus,
+ layerToJson,
+ parseAndValidateLayerConfig,
+ useDebounce
+} from '../../common/json-editor-utils';
+
+export type LayerJsonEditorProps = {
+ layer: Layer;
+ visState?: VisState;
+ applyLayerConfig?: typeof applyLayerConfig;
+ onClose?: (event?: React.MouseEvent) => void;
+};
+
+function LayerJsonEditorFactory() {
+ const LayerJsonEditor: React.FC<LayerJsonEditorProps> = ({
+ layer,
+ visState,
+ applyLayerConfig: applyLayerConfigAction,
+ onClose
+ }) => {
+ const jsonText = useMemo(
+ () => (visState?.schema ? layerToJson(layer, visState.schema) : '{}'),
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ [layer, layer.config, visState?.schema]
+ );
+ const debouncedJsonText = useDebounce(jsonText, 300);
+
+ const handleApply = useCallback(
+ (text: string): JsonEditorStatus => {
+ try {
+ if (!visState || !applyLayerConfigAction) {
+ return applyStatus(false);
+ }
+ const parsed = parseAndValidateLayerConfig(
+ text,
+ visState.datasets,
+ visState.layerClasses,
+ visState.schema
+ );
+ const layerIndex = visState.layers.findIndex(item => item.id === layer.id);
+ applyLayerConfigAction(layer.id, parsed, layerIndex >= 0 ? layerIndex : undefined);
+ return applyStatus(true);
+ } catch (error) {
+ return errorStatus(error);
+ }
+ },
+ [applyLayerConfigAction, layer.id, visState]
+ );
+
+ return (
+ <JsonEditor
+ jsonText={debouncedJsonText}
+ onApply={handleApply}
+ onClose={onClose}
+ height={280}
+ />
+ );
+ };
+
+ return withState([visStateLens], () => ({}), {applyLayerConfig})(
+ LayerJsonEditor
+ ) as React.FC<LayerJsonEditorProps>;
+}
+
+export default LayerJsonEditorFactory;
diff --git a/src/components/src/side-panel/layer-panel/layer-panel-header.tsx b/src/components/src/side-panel/layer-panel/layer-panel-header.tsx
index 8789ffba0..ed9fe7868 100644
--- a/src/components/src/side-panel/layer-panel/layer-panel-header.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-panel-header.tsx
@@ -21,7 +21,8 @@ import {
VertDots,
WarningSign,
Reset,
- ZoomIn
+ ZoomIn,
+ CodeAlt
} from '../../common/icons';
import {InlineInput, StyledPanelHeader} from '../../common/styled-components';
@@ -58,7 +59,10 @@ export type LayerPanelHeaderProps = {
onZoomToLayer: MouseEventHandler;
onDuplicateLayer: MouseEventHandler;
onResetIsValid: MouseEventHandler;
+ onToggleJsonEditor?: MouseEventHandler;
isConfigActive: boolean;
+ isJsonEditorActive?: boolean;
+ showJsonEditor?: boolean;
showRemoveLayer?: boolean;
label?: string;
layerType?: string | null;
@@ -75,6 +79,7 @@ export type LayerPanelHeaderProps = {
resetIsValid: ComponentType<Partial<BaseProps>>;
duplicate: ComponentType<Partial<BaseProps>>;
crosshairs: ComponentType<Partial<BaseProps>>;
+ json?: ComponentType<Partial<BaseProps>>;
};
listeners?: React.ElementType;
};
@@ -279,6 +284,9 @@ export function LayerPanelHeaderActionSectionFactory(
onDuplicateLayer,
onRemoveLayer,
onZoomToLayer,
+ onToggleJsonEditor,
+ isJsonEditorActive,
+ showJsonEditor,
showRemoveLayer = true,
isEditingLabel,
actionIcons: customActionIcons
@@ -314,6 +322,16 @@ export function LayerPanelHeaderActionSectionFactory(
onClick={onZoomToLayer}
IconComponent={actionIcons.crosshairs}
/>
+ {showJsonEditor && onToggleJsonEditor ? (
+ <PanelHeaderAction
+ className="layer__json-editor"
+ id={layerId}
+ tooltip={'tooltip.editLayerJson'}
+ onClick={onToggleJsonEditor}
+ IconComponent={actionIcons.json || CodeAlt}
+ active={isJsonEditorActive}
+ />
+ ) : null}
</StyledPanelHeaderHiddenActions>
{isValid ? (
<PanelHeaderAction
@@ -386,7 +404,8 @@ const defaultActionIcons = {
),
duplicate: props => <Copy {...props} height="14px" />,
resetIsValid: Reset,
- crosshairs: props => <ZoomIn {...props} height="14px" />
+ crosshairs: props => <ZoomIn {...props} height="14px" />,
+ json: props => <CodeAlt {...props} height="14px" />
};
LayerPanelHeaderFactory.deps = [LayerTitleSectionFactory, LayerPanelHeaderActionSectionFactory];
diff --git a/src/components/src/side-panel/layer-panel/layer-panel.tsx b/src/components/src/side-panel/layer-panel/layer-panel.tsx
index c4fb0fada..d27e59413 100644
--- a/src/components/src/side-panel/layer-panel/layer-panel.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-panel.tsx
@@ -18,6 +18,8 @@ import {Datasets} from '@kepler.gl/table';
import {ColorUI, LayerVisConfig, MapState, NestedPartial, SplitMap} from '@kepler.gl/types';
import LayerConfiguratorFactory from './layer-configurator';
import LayerPanelHeaderFactory from './layer-panel-header';
+import LayerJsonEditorFactory from './layer-json-editor';
+import {isJsonEditorEnabled} from '../../common/json-editor-utils';
type LayerPanelProps = {
className?: string;
@@ -62,13 +64,19 @@ const PanelWrapper = styled.div`
}
`;
-LayerPanelFactory.deps = [LayerConfiguratorFactory, LayerPanelHeaderFactory];
+LayerPanelFactory.deps = [
+ LayerConfiguratorFactory,
+ LayerPanelHeaderFactory,
+ LayerJsonEditorFactory
+];
function LayerPanelFactory(
LayerConfigurator: ReturnType<typeof LayerConfiguratorFactory>,
- LayerPanelHeader: ReturnType<typeof LayerPanelHeaderFactory>
+ LayerPanelHeader: ReturnType<typeof LayerPanelHeaderFactory>,
+ LayerJsonEditor: ReturnType<typeof LayerJsonEditorFactory>
): React.ComponentType<LayerPanelProps> {
- class LayerPanel extends Component<LayerPanelProps> {
+ class LayerPanel extends Component<LayerPanelProps, {isJsonEditorActive: boolean}> {
+ state = {isJsonEditorActive: false};
updateLayerConfig = (newProp: Partial<LayerBaseConfig>) => {
this.props.layerConfigChange(this.props.layer, newProp);
};
@@ -139,6 +147,20 @@ function LayerPanelFactory(
this.props.duplicateLayer(this.props.layer.id);
};
+ _toggleJsonEditor: MouseEventHandler = e => {
+ e?.stopPropagation();
+ const next = !this.state.isJsonEditorActive;
+ this.setState({isJsonEditorActive: next});
+ if (next && !this.props.layer.config.isConfigActive) {
+ this.updateLayerConfig({isConfigActive: true});
+ }
+ };
+
+ _closeJsonEditor = (e?: React.MouseEvent) => {
+ e?.stopPropagation();
+ this.setState({isJsonEditorActive: false});
+ };
+
render() {
const {layer, datasets, isDraggable, layerTypeOptions, listeners, splitMap, mapState} =
this.props;
@@ -181,23 +203,29 @@ function LayerPanelFactory(
onRemoveLayer={this._removeLayer}
onZoomToLayer={this._zoomToLayer}
onDuplicateLayer={this._duplicateLayer}
+ onToggleJsonEditor={this._toggleJsonEditor}
+ isJsonEditorActive={this.state.isJsonEditorActive}
+ showJsonEditor={isJsonEditorEnabled('layer')}
isDragNDropEnabled={isDraggable}
listeners={listeners}
/>
- {isConfigActive && (
- <LayerConfigurator
- layer={layer}
- datasets={datasets}
- layerTypeOptions={layerTypeOptions}
- openModal={this.props.openModal}
- updateLayerColorUI={this.updateLayerColorUI}
- updateLayerConfig={this.updateLayerConfig}
- updateLayerVisualChannelConfig={this.updateLayerVisualChannelConfig}
- updateLayerType={this.updateLayerType}
- updateLayerTextLabel={this.updateLayerTextLabel}
- updateLayerVisConfig={this.updateLayerVisConfig}
- />
- )}
+ {isConfigActive &&
+ (this.state.isJsonEditorActive ? (
+ <LayerJsonEditor layer={layer} onClose={this._closeJsonEditor} />
+ ) : (
+ <LayerConfigurator
+ layer={layer}
+ datasets={datasets}
+ layerTypeOptions={layerTypeOptions}
+ openModal={this.props.openModal}
+ updateLayerColorUI={this.updateLayerColorUI}
+ updateLayerConfig={this.updateLayerConfig}
+ updateLayerVisualChannelConfig={this.updateLayerVisualChannelConfig}
+ updateLayerType={this.updateLayerType}
+ updateLayerTextLabel={this.updateLayerTextLabel}
+ updateLayerVisConfig={this.updateLayerVisConfig}
+ />
+ ))}
</PanelWrapper>
);
}
diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.ts
index ff4670d41..73d594265 100644
--- a/src/constants/src/default-settings.ts
+++ b/src/constants/src/default-settings.ts
@@ -1364,7 +1364,8 @@ export const MAP_CONTROLS = keyMirror({
mapLocale: null,
mapTheme: null,
effect: null,
- annotation: null
+ annotation: null,
+ viewportJson: null
});
export enum MapViewMode {
diff --git a/src/localization/src/translations/ca.ts b/src/localization/src/translations/ca.ts
index c8ac6144a..b52e5ee3c 100644
--- a/src/localization/src/translations/ca.ts
+++ b/src/localization/src/translations/ca.ts
@@ -388,7 +388,12 @@ export default {
annotationSettings: "Configuració de l'anotació",
removeEffect: "Elimina l'efecte",
disableEffect: "Desactiva l'efecte",
- effectSettings: "Configuració de l'efecte"
+ effectSettings: "Configuració de l'efecte",
+ editLayerJson: 'Edita JSON de la capa',
+ editFilterJson: 'Edita JSON del filtre',
+ editEffectJson: "Edita JSON de l'efecte",
+ editViewportJson: 'Edita JSON de la vista',
+ editAnimationJson: "Edita JSON de l'animació"
},
toolbar: {
exportImage: 'Exporta imatge',
diff --git a/src/localization/src/translations/cn.ts b/src/localization/src/translations/cn.ts
index 4b0892d27..31dc4bbad 100644
--- a/src/localization/src/translations/cn.ts
+++ b/src/localization/src/translations/cn.ts
@@ -373,7 +373,12 @@ export default {
annotationSettings: '注释设置',
removeEffect: '移除效果',
disableEffect: '禁用效果',
- effectSettings: '效果设置'
+ effectSettings: '效果设置',
+ editLayerJson: '编辑图层 JSON',
+ editFilterJson: '编辑筛选器 JSON',
+ editEffectJson: '编辑效果 JSON',
+ editViewportJson: '编辑视口 JSON',
+ editAnimationJson: '编辑动画 JSON'
},
toolbar: {
exportImage: '导出图片',
diff --git a/src/localization/src/translations/en.ts b/src/localization/src/translations/en.ts
index 1ab9baf84..8f9aa13b2 100644
--- a/src/localization/src/translations/en.ts
+++ b/src/localization/src/translations/en.ts
@@ -477,7 +477,12 @@ export default {
annotationSettings: 'Annotation settings',
removeEffect: 'Remove effect',
disableEffect: 'Disable effect',
- effectSettings: 'Effect settings'
+ effectSettings: 'Effect settings',
+ editLayerJson: 'Edit layer JSON',
+ editFilterJson: 'Edit filter JSON',
+ editEffectJson: 'Edit effect JSON',
+ editViewportJson: 'Edit viewport JSON',
+ editAnimationJson: 'Edit animation JSON'
},
toolbar: {
exportImage: 'Export Image',
@@ -946,5 +951,13 @@ ${'```'}
count: 'Count'
}
}
+ },
+ jsonEditor: {
+ apply: 'Apply',
+ format: 'Format',
+ reset: 'Reset',
+ configApplied: 'Config applied',
+ applyFailed: "Couldn't apply config",
+ textarea: 'JSON configuration'
}
};
diff --git a/src/localization/src/translations/es.ts b/src/localization/src/translations/es.ts
index b9f5c6a23..7b5e7c521 100644
--- a/src/localization/src/translations/es.ts
+++ b/src/localization/src/translations/es.ts
@@ -389,7 +389,12 @@ export default {
annotationSettings: 'Configuración de anotación',
removeEffect: 'Eliminar efecto',
disableEffect: 'Desactivar efecto',
- effectSettings: 'Configuración de efecto'
+ effectSettings: 'Configuración de efecto',
+ editLayerJson: 'Editar JSON de la capa',
+ editFilterJson: 'Editar JSON del filtro',
+ editEffectJson: 'Editar JSON del efecto',
+ editViewportJson: 'Editar JSON de la vista',
+ editAnimationJson: 'Editar JSON de la animación'
},
toolbar: {
exportImage: 'Exportar imagen',
diff --git a/src/localization/src/translations/fi.ts b/src/localization/src/translations/fi.ts
index 222f7d55f..57a6e3c16 100644
--- a/src/localization/src/translations/fi.ts
+++ b/src/localization/src/translations/fi.ts
@@ -386,6 +386,11 @@ export default {
removeEffect: 'Poista efekti',
disableEffect: 'Poista efekti käytöstä',
effectSettings: 'Efektiasetukset',
+ editLayerJson: 'Muokkaa tason JSON-määritystä',
+ editFilterJson: 'Muokkaa suodattimen JSON-määritystä',
+ editEffectJson: 'Muokkaa efektin JSON-määritystä',
+ editViewportJson: 'Muokkaa näkymän JSON-määritystä',
+ editAnimationJson: 'Muokkaa animaation JSON-määritystä',
timeLayerSync: 'Linkitä tason aikajanaan',
timeLayerUnsync: 'Poista linkitys tason aikajanasta'
},
diff --git a/src/localization/src/translations/ja.ts b/src/localization/src/translations/ja.ts
index 3dbb90f30..ed165ae6d 100644
--- a/src/localization/src/translations/ja.ts
+++ b/src/localization/src/translations/ja.ts
@@ -384,6 +384,11 @@ export default {
removeEffect: 'エフェクトを削除',
disableEffect: 'エフェクトを無効化',
effectSettings: 'エフェクト設定',
+ editLayerJson: 'レイヤーJSONを編集',
+ editFilterJson: 'フィルターJSONを編集',
+ editEffectJson: 'エフェクトJSONを編集',
+ editViewportJson: 'ビューポートJSONを編集',
+ editAnimationJson: 'アニメーションJSONを編集',
timeLayerSync: 'レイヤタイムラインにリンク',
timeLayerUnsync: 'レイヤタイムラインのリンクを解除'
},
diff --git a/src/localization/src/translations/pt.ts b/src/localization/src/translations/pt.ts
index d4bc0a0c5..036a7ec69 100644
--- a/src/localization/src/translations/pt.ts
+++ b/src/localization/src/translations/pt.ts
@@ -389,7 +389,12 @@ export default {
annotationSettings: 'Configurações da anotação',
removeEffect: 'Remover efeito',
disableEffect: 'Desativar efeito',
- effectSettings: 'Configurações de efeito'
+ effectSettings: 'Configurações de efeito',
+ editLayerJson: 'Editar JSON da camada',
+ editFilterJson: 'Editar JSON do filtro',
+ editEffectJson: 'Editar JSON do efeito',
+ editViewportJson: 'Editar JSON da viewport',
+ editAnimationJson: 'Editar JSON da animação'
},
toolbar: {
exportImage: 'Exportar Imagem',
diff --git a/src/localization/src/translations/ru.ts b/src/localization/src/translations/ru.ts
index 837b85ed1..6b2189938 100644
--- a/src/localization/src/translations/ru.ts
+++ b/src/localization/src/translations/ru.ts
@@ -387,6 +387,11 @@ export default {
removeEffect: 'Удалить эффект',
disableEffect: 'Отключить эффект',
effectSettings: 'Настройки эффекта',
+ editLayerJson: 'Редактировать JSON слоя',
+ editFilterJson: 'Редактировать JSON фильтра',
+ editEffectJson: 'Редактировать JSON эффекта',
+ editViewportJson: 'Редактировать JSON вида',
+ editAnimationJson: 'Редактировать JSON анимации',
timeLayerSync: 'Привязать к временной шкале слоя',
timeLayerUnsync: 'Отвязать от временной шкалы слоя'
},
diff --git a/src/reducers/src/map-state-updaters.ts b/src/reducers/src/map-state-updaters.ts
index ab183f18f..d1ee05ee4 100644
--- a/src/reducers/src/map-state-updaters.ts
+++ b/src/reducers/src/map-state-updaters.ts
@@ -176,6 +176,66 @@ export const updateMapUpdater = (
};
};
+/**
+ * Apply a partial map state from the viewport JSON editor.
+ * Preserves current width/height so saved JSON cannot resize the map container,
+ * including nested split-map viewports. When viewports are unsynced, camera
+ * fields are applied to the opened map pane (`mapIndex`), matching `updateMap`.
+ * @memberof mapStateUpdaters
+ * @public
+ */
+const APPLY_MAP_STATE_VIEWPORT_KEYS: (keyof Viewport)[] = [
+ 'latitude',
+ 'longitude',
+ 'zoom',
+ 'pitch',
+ 'bearing',
+ 'dragRotate',
+ 'minZoom',
+ 'maxZoom',
+ 'maxPitch'
+];
+
+export const applyMapStateUpdater = (
+ state: MapState,
+ action: MapStateActions.ApplyMapStateUpdaterAction
+): MapState => {
+ const next = action.payload || {};
+ const mapIndex = action.meta?.mapIndex ?? 0;
+ const {width, height} = state;
+
+ const nextConfig: Partial<MapState> = {...next};
+ delete nextConfig.width;
+ delete nextConfig.height;
+ if (Array.isArray(next.splitMapViewports)) {
+ nextConfig.splitMapViewports = next.splitMapViewports.map((viewport, i) => ({
+ ...viewport,
+ width: state.splitMapViewports[i]?.width ?? width,
+ height: state.splitMapViewports[i]?.height ?? height
+ }));
+ }
+
+ const mergedState = deepmerge<MapState>(state, nextConfig, {
+ arrayMerge: (_destinationArray, sourceArray) => sourceArray
+ });
+ const applied = validateViewPort({
+ ...mergedState,
+ width,
+ height
+ });
+
+ if (!state.isViewportSynced && state.splitMapViewports.length) {
+ const viewport = pick(next, APPLY_MAP_STATE_VIEWPORT_KEYS);
+ if (Object.keys(viewport).length) {
+ return updateMapUpdater(applied, {
+ payload: {viewport, mapIndex}
+ } as MapStateActions.UpdateMapUpdaterAction);
+ }
+ }
+
+ return applied;
+};
+
/**
* Fit map viewport to bounds
* @memberof mapStateUpdaters
diff --git a/src/reducers/src/map-state.ts b/src/reducers/src/map-state.ts
index 6fc8cba09..daf3cc0d5 100644
--- a/src/reducers/src/map-state.ts
+++ b/src/reducers/src/map-state.ts
@@ -11,6 +11,7 @@ import * as mapStateUpdaters from './map-state-updaters';
*/
const actionHandler = {
[ActionTypes.UPDATE_MAP]: mapStateUpdaters.updateMapUpdater,
+ [ActionTypes.APPLY_MAP_STATE]: mapStateUpdaters.applyMapStateUpdater,
[ActionTypes.FIT_BOUNDS]: mapStateUpdaters.fitBoundsUpdater,
[ActionTypes.TOGGLE_PERSPECTIVE]: mapStateUpdaters.togglePerspectiveUpdater,
[ActionTypes.RECEIVE_MAP_CONFIG]: mapStateUpdaters.receiveMapConfigUpdater,
diff --git a/src/reducers/src/ui-state-updaters.ts b/src/reducers/src/ui-state-updaters.ts
index 53c81fe1f..d4019c33a 100644
--- a/src/reducers/src/ui-state-updaters.ts
+++ b/src/reducers/src/ui-state-updaters.ts
@@ -110,6 +110,7 @@ const DEFAULT_MAP_LEGEND_CONTROL = {
* @property mapDraw Default: `{show: true, active: false}`
* @property mapLocale Default: `{show: true, active: false}`
* @property mapTheme Default: `{show: true, active: false}`
+ * @property viewportJson Default: `{show: true, active: false}`
* @public
*/
export const DEFAULT_MAP_CONTROLS: MapControls = (
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index fd548cdd2..eb26e3165 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -144,6 +144,7 @@ import {isValidMerger, mergeStateFromMergers} from './merger-handler';
import {
VIS_STATE_MERGERS,
createLayerFromConfig,
+ isSavedLayerConfigV1,
parseLayerConfig,
serializeFilter,
serializeLayer,
@@ -489,9 +490,11 @@ export function applyLayerConfigUpdater(
action: VisStateActions.ApplyLayerConfigUpdaterAction
): VisState {
const {oldLayerId, newLayerConfig, layerIndex} = action;
- const newParsedLayer =
- // will move visualChannels to the config prop
- parseLayerConfig(state.schema, newLayerConfig);
+ // Saved configs have a visualChannels sibling; parsed/editor JSON folds those
+ // fields into config. Re-parsing the latter drops colorField and resets the scale.
+ const newParsedLayer = isSavedLayerConfigV1(newLayerConfig)
+ ? parseLayerConfig(state.schema, newLayerConfig)
+ : newLayerConfig;
const oldLayer = state.layers.find(l => l.id === oldLayerId);
if (!oldLayer || !newParsedLayer) {
return state;
diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.ts
index 1a7f45099..322efac32 100644
--- a/src/types/reducers.d.ts
+++ b/src/types/reducers.d.ts
@@ -539,6 +539,7 @@ export type MapControls = {
mapTheme?: MapControlItem;
effect?: MapControlItem;
annotation?: MapControlItem;
+ viewportJson?: MapControlItem;
sqlPanel?: MapControlItem;
aiAssistant?: MapControlItem;
[key: string]: MapControlItem | MapControlMapLegend | undefined;
diff --git a/src/utils/src/application-config.ts b/src/utils/src/application-config.ts
index e68bbc3f7..7ead52918 100644
--- a/src/utils/src/application-config.ts
+++ b/src/utils/src/application-config.ts
@@ -220,6 +220,38 @@ export type KeplerApplicationConfig = {
/** Whether to show column statistics in the data table modal. Enabled by default. */
enableColumnStats?: boolean;
+ /**
+ * Master switch for power-user JSON editors. When false, every section editor is hidden.
+ * Defaults to true; each section also has its own flag.
+ *
+ * @example
+ * ```
+ * initApplicationConfig({
+ * enableViewportJsonEditor: true,
+ * enableLayerJsonEditor: false
+ * });
+ * ```
+ */
+ enableJsonEditors?: boolean;
+
+ /** Layer panel `{ }` JSON editor. Enabled by default. */
+ enableLayerJsonEditor?: boolean;
+
+ /** Filter panel `{ }` JSON editor. Enabled by default. */
+ enableFilterJsonEditor?: boolean;
+
+ /** Effect panel `{ }` JSON editor. Enabled by default. */
+ enableEffectJsonEditor?: boolean;
+
+ /**
+ * Viewport JSON editor map-control button. Disabled by default because it adds an extra
+ * map control.
+ */
+ enableViewportJsonEditor?: boolean;
+
+ /** Animation / time-filter playback `{ }` JSON editor. Enabled by default. */
+ enableAnimationJsonEditor?: boolean;
+
/**
* Show a format dropdown next to the remote dataset URL field (Auto / CSV / GeoJSON / JSON / Arrow / Parquet).
* Useful for extensionless URLs such as Azure SAS blobs. Disabled by default.
@@ -387,6 +419,13 @@ const DEFAULT_APPLICATION_CONFIG: Required<KeplerApplicationConfig> = {
enableColumnStats: true,
+ enableJsonEditors: true,
+ enableLayerJsonEditor: true,
+ enableFilterJsonEditor: true,
+ enableEffectJsonEditor: true,
+ enableViewportJsonEditor: false,
+ enableAnimationJsonEditor: true,
+
enableRemoteFileFormatSelector: false,
acceptedFileFormats: null,
diff --git a/test/browser/components/common/index.js b/test/browser/components/common/index.js
index df5a35585..14032dc50 100644
--- a/test/browser/components/common/index.js
+++ b/test/browser/components/common/index.js
@@ -8,3 +8,4 @@ import './item-selector-test';
import './range-plot-test';
import './animation-control-test';
import './column-stats-chart-test';
+import './json-editor-test';
diff --git a/test/browser/components/common/json-editor-test.js b/test/browser/components/common/json-editor-test.js
new file mode 100644
index 000000000..0262c5137
--- /dev/null
+++ b/test/browser/components/common/json-editor-test.js
@@ -0,0 +1,195 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React from 'react';
+import test from 'tape';
+import sinon from 'sinon';
+
+import {IntlWrapper, mountWithTheme} from 'test/helpers/component-utils';
+import {
+ JsonEditor,
+ isJsonEditorEnabled,
+ jsonToEffectProps,
+ jsonToFilterConfig
+} from '@kepler.gl/components';
+import {initApplicationConfig} from '@kepler.gl/utils';
+
+test('Components -> JsonEditor -> apply valid JSON', t => {
+ const onApply = sinon.stub().returns({status: 'success', message: 'Config applied'});
+ let wrapper;
+
+ t.doesNotThrow(() => {
+ wrapper = mountWithTheme(
+ <IntlWrapper>
+ <JsonEditor jsonText={'{\n "zoom": 9\n}'} onApply={onApply} />
+ </IntlWrapper>
+ );
+ }, 'JsonEditor should mount');
+
+ t.equal(
+ wrapper.find('[data-testid="json-editor"]').hostNodes().length,
+ 1,
+ 'should render json editor'
+ );
+ t.equal(wrapper.find('textarea').length, 1, 'should render textarea');
+
+ wrapper.find('textarea').simulate('change', {target: {value: '{\n "zoom": 12\n}'}});
+ wrapper.find('[data-testid="json-editor-apply"]').hostNodes().simulate('click');
+
+ t.ok(onApply.calledOnce, 'should call onApply');
+ t.equal(onApply.args[0][0], '{\n "zoom": 12\n}', 'should pass edited JSON');
+
+ t.end();
+});
+
+test('Components -> JsonEditor -> close button', t => {
+ const onClose = sinon.spy();
+ let wrapper;
+
+ t.doesNotThrow(() => {
+ wrapper = mountWithTheme(
+ <IntlWrapper>
+ <JsonEditor jsonText={'{\n "zoom": 9\n}'} onClose={onClose} />
+ </IntlWrapper>
+ );
+ }, 'JsonEditor should mount with close button');
+
+ t.equal(
+ wrapper.find('[data-testid="json-editor-close"]').hostNodes().length,
+ 1,
+ 'should render close button'
+ );
+
+ wrapper.find('[data-testid="json-editor-close"]').hostNodes().simulate('click');
+ t.ok(onClose.calledOnce, 'should call onClose');
+
+ t.end();
+});
+
+test('Components -> JsonEditor -> reset restores original JSON', t => {
+ const onReset = sinon.spy();
+ let wrapper;
+
+ t.doesNotThrow(() => {
+ wrapper = mountWithTheme(
+ <IntlWrapper>
+ <JsonEditor jsonText={'{\n "zoom": 9\n}'} onReset={onReset} />
+ </IntlWrapper>
+ );
+ }, 'JsonEditor should mount');
+
+ t.equal(
+ wrapper.find('[data-testid="json-editor-reset"]').hostNodes().length,
+ 0,
+ 'should hide reset until the JSON is edited'
+ );
+
+ wrapper.find('textarea').simulate('change', {target: {value: '{\n "zoom": 12\n}'}});
+ t.equal(
+ wrapper.find('[data-testid="json-editor-reset"]').hostNodes().length,
+ 1,
+ 'should show reset after edit'
+ );
+
+ wrapper.find('[data-testid="json-editor-reset"]').hostNodes().simulate('click');
+ t.ok(onReset.calledOnce, 'should call onReset');
+ t.equal(
+ wrapper.find('textarea').hostNodes().prop('value'),
+ '{\n "zoom": 9\n}',
+ 'should restore original JSON'
+ );
+ t.equal(
+ wrapper.find('[data-testid="json-editor-reset"]').hostNodes().length,
+ 0,
+ 'should hide reset after restore'
+ );
+
+ t.end();
+});
+
+test('Components -> JsonEditor -> textarea has accessible name', t => {
+ const wrapper = mountWithTheme(
+ <IntlWrapper>
+ <JsonEditor jsonText={'{\n "zoom": 9\n}'} />
+ </IntlWrapper>
+ );
+
+ t.equal(
+ wrapper.find('textarea').prop('aria-label'),
+ 'JSON configuration',
+ 'should label the textarea'
+ );
+ t.end();
+});
+
+test('Components -> JsonEditor -> section flags', t => {
+ t.ok(isJsonEditorEnabled('layer'), 'layer JSON editor is enabled by default');
+ t.ok(isJsonEditorEnabled('filter'), 'filter JSON editor is enabled by default');
+ t.ok(isJsonEditorEnabled('effect'), 'effect JSON editor is enabled by default');
+ t.ok(isJsonEditorEnabled('animation'), 'animation JSON editor is enabled by default');
+ t.notOk(isJsonEditorEnabled('viewport'), 'viewport JSON editor is disabled by default');
+
+ initApplicationConfig({enableLayerJsonEditor: false, enableViewportJsonEditor: true});
+ t.notOk(isJsonEditorEnabled('layer'), 'layer JSON editor can be disabled');
+ t.ok(isJsonEditorEnabled('viewport'), 'viewport JSON editor can be enabled');
+ t.ok(isJsonEditorEnabled('filter'), 'other section flags stay unchanged');
+
+ initApplicationConfig({enableJsonEditors: false});
+ t.notOk(isJsonEditorEnabled('viewport'), 'master switch hides enabled sections');
+ t.notOk(isJsonEditorEnabled('filter'), 'master switch hides default sections');
+
+ initApplicationConfig({
+ enableJsonEditors: true,
+ enableLayerJsonEditor: true,
+ enableViewportJsonEditor: false
+ });
+ t.end();
+});
+
+test('Components -> JsonEditor -> jsonToFilterConfig keeps identity fields', t => {
+ const filter = {
+ id: 'filter-1',
+ type: 'range',
+ dataId: ['dataset-a'],
+ name: ['value'],
+ value: [0, 10]
+ };
+
+ const next = jsonToFilterConfig(
+ JSON.stringify({
+ id: 'filter-2',
+ type: 'timeRange',
+ dataId: ['dataset-b'],
+ value: [1, 5]
+ }),
+ filter
+ );
+
+ t.equal(next.id, 'filter-1', 'should keep filter id');
+ t.equal(next.type, 'range', 'should keep filter type');
+ t.deepEqual(next.dataId, ['dataset-a'], 'should keep filter dataId');
+ t.deepEqual(next.value, [1, 5], 'should apply other edited fields');
+ t.end();
+});
+
+test('Components -> JsonEditor -> jsonToEffectProps keeps id and type', t => {
+ const effect = {id: 'e_ink', type: 'ink', isEnabled: true, parameters: {strength: 0.25}};
+
+ const next = jsonToEffectProps(
+ JSON.stringify({
+ id: 'e_other',
+ type: 'sepia',
+ isEnabled: false,
+ parameters: {strength: 0.8},
+ deckEffect: {circular: true}
+ }),
+ effect
+ );
+
+ t.equal(next.id, 'e_ink', 'should keep effect id');
+ t.equal(next.type, 'ink', 'should keep effect type');
+ t.equal(next.isEnabled, false, 'should apply other edited fields');
+ t.deepEqual(next.parameters, {strength: 0.8}, 'should apply parameters');
+ t.notOk('deckEffect' in next, 'should drop runtime deckEffect');
+ t.end();
+});
diff --git a/test/browser/components/map/map-control-test.js b/test/browser/components/map/map-control-test.js
index a8739164d..ba47a393d 100644
--- a/test/browser/components/map/map-control-test.js
+++ b/test/browser/components/map/map-control-test.js
@@ -32,6 +32,7 @@ import {
StateWSplitMaps,
StateWFiles
} from '../../../helpers/mock-state';
+import {initApplicationConfig} from '@kepler.gl/utils';
const {Cube3d, Split, Legend, DrawPolygon, Delete} = Icons;
const MapControl = appInjector.get(MapControlFactory);
@@ -79,7 +80,49 @@ test('MapControlFactory - display all options', t => {
</MapViewStateContextProvider>
</IntlWrapper>
);
- t.equal($.find('.map-control-action').length, 8, 'Should show 8 action panels');
+ t.equal($.find('.map-control-action').length, 9, 'Should show 9 action panels');
+ t.end();
+});
+
+test('MapControlFactory - viewport JSON control', t => {
+ initApplicationConfig({enableViewportJsonEditor: true});
+ const $ = mountWithTheme(
+ <IntlWrapper>
+ <MapViewStateContextProvider mapState={{latitude: 0, longitude: 0, zoom: 1}}>
+ <MapControl
+ mapControls={{
+ splitMap: {show: true},
+ visibleLayers: {show: true},
+ toggle3d: {show: true},
+ mapLegend: {show: true},
+ mapDraw: {show: true},
+ mapLocale: {show: true},
+ effect: {show: true},
+ viewportJson: {show: true}
+ }}
+ datasets={{}}
+ layers={[]}
+ locale={'en'}
+ layersToRender={{}}
+ dragRotate={true}
+ mapIndex={0}
+ onToggleSplitMap={() => {}}
+ onTogglePerspective={() => {}}
+ onToggleMapControl={() => {}}
+ onSetEditorMode={() => {}}
+ onToggleEditorVisibility={() => {}}
+ onSetLocale={() => {}}
+ />
+ </MapViewStateContextProvider>
+ </IntlWrapper>
+ );
+
+ t.equal(
+ $.find('.viewport-json-editor-controls').hostNodes().length,
+ 1,
+ 'Should show the viewport JSON control when enabled'
+ );
+ initApplicationConfig({enableViewportJsonEditor: false});
t.end();
});
@@ -129,7 +172,7 @@ test('MapControlFactory - display options', t => {
)
});
- // 6 control buttons as legend is opened automatically in split map mode
+ // legend is opened automatically in split map mode
t.equal(wrapper.find(MapControlButton).length, 6, 'Should show 6 MapControlButton');
t.equal(wrapper.find(Split).length, 0, 'Should show 0 split map split button');
t.equal(wrapper.find(Delete).length, 1, 'Should show 1 split map delete button');
diff --git a/test/node/reducers/map-state-test.js b/test/node/reducers/map-state-test.js
index 7e6b41b56..f9f7d89af 100644
--- a/test/node/reducers/map-state-test.js
+++ b/test/node/reducers/map-state-test.js
@@ -13,7 +13,8 @@ import {
setMapSplitMode,
setSwipeComparePercentage,
setMapViewMode,
- globeConfigChange
+ globeConfigChange,
+ applyMapState
} from '@kepler.gl/actions';
import {
@@ -70,6 +71,106 @@ test('#mapStateReducer -> UPDATE_MAP', t => {
t.end();
});
+test('#mapStateReducer -> APPLY_MAP_STATE', t => {
+ const next = reducer(
+ undefined,
+ applyMapState({
+ latitude: 40.7128,
+ longitude: -74.006,
+ zoom: 11,
+ pitch: 30,
+ width: 10,
+ height: 10
+ })
+ );
+
+ t.equal(next.latitude, 40.7128, 'should apply latitude from JSON');
+ t.equal(next.longitude, -74.006, 'should apply longitude from JSON');
+ t.equal(next.zoom, 11, 'should apply zoom from JSON');
+ t.equal(next.pitch, 30, 'should apply pitch from JSON');
+ t.equal(next.width, INITIAL_MAP_STATE.width, 'should preserve current width');
+ t.equal(next.height, INITIAL_MAP_STATE.height, 'should preserve current height');
+
+ t.end();
+});
+
+test('#mapStateReducer -> APPLY_MAP_STATE split viewports', t => {
+ let splitState = reducer(INITIAL_MAP_STATE, toggleSplitMap());
+ splitState = reducer(splitState, toggleSplitMapViewport({isViewportSynced: false}));
+ splitState = reducer(
+ splitState,
+ updateMap({latitude: 10, longitude: 20, zoom: 4, width: 400, height: 300}, 0)
+ );
+ splitState = reducer(
+ splitState,
+ updateMap({latitude: 30, longitude: 40, zoom: 6, width: 400, height: 300}, 1)
+ );
+
+ const leftSize = {
+ width: splitState.splitMapViewports[0].width,
+ height: splitState.splitMapViewports[0].height
+ };
+ const rightSize = {
+ width: splitState.splitMapViewports[1].width,
+ height: splitState.splitMapViewports[1].height
+ };
+
+ const afterSizes = reducer(
+ splitState,
+ applyMapState({
+ splitMapViewports: [
+ {...splitState.splitMapViewports[0], width: 1, height: 2},
+ {...splitState.splitMapViewports[1], width: 3, height: 4}
+ ]
+ })
+ );
+
+ t.deepEqual(
+ {
+ width: afterSizes.splitMapViewports[0].width,
+ height: afterSizes.splitMapViewports[0].height
+ },
+ leftSize,
+ 'should preserve left split viewport dimensions'
+ );
+ t.deepEqual(
+ {
+ width: afterSizes.splitMapViewports[1].width,
+ height: afterSizes.splitMapViewports[1].height
+ },
+ rightSize,
+ 'should preserve right split viewport dimensions'
+ );
+
+ const afterRight = reducer(
+ splitState,
+ applyMapState({latitude: 51.5, longitude: -0.1, zoom: 8}, 1)
+ );
+
+ t.equal(
+ afterRight.splitMapViewports[1].latitude,
+ 51.5,
+ 'should update the targeted split viewport'
+ );
+ t.equal(
+ afterRight.splitMapViewports[1].longitude,
+ -0.1,
+ 'should update the targeted split viewport longitude'
+ );
+ t.equal(
+ afterRight.splitMapViewports[1].zoom,
+ 8,
+ 'should update the targeted split viewport zoom'
+ );
+ t.equal(
+ afterRight.splitMapViewports[0].latitude,
+ splitState.splitMapViewports[0].latitude,
+ 'should not move the other split viewport'
+ );
+
+ t.end();
+});
+
// eslint-disable-next-line max-statements
test('#mapStateReducer -> UPDATE_MAP - minZoom/maxZoom', t => {
let mapUpdate = {
diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.js
index eeffe4b4a..88894d7bf 100644
--- a/test/node/reducers/vis-state-test.js
+++ b/test/node/reducers/vis-state-test.js
@@ -7677,6 +7677,41 @@ test('VisStateUpdater -> applyLayerConfig', t => {
);
t.equal(getUpdatedLayerJson(nextState).type, '3D', 'should change layer type');
+ nextState = reducer(
+ initialState,
+ VisStateActions.applyLayerConfig(
+ oldLayerId,
+ transformConfig(layer => {
+ layer.visualChannels.colorField = {name: 'gps_data.lat', type: 'real'};
+ layer.visualChannels.colorScale = 'quantile';
+ return layer;
+ })
+ )
+ );
+ t.equal(
+ getUpdatedLayerJson(nextState).visualChannels.colorField?.name,
+ 'gps_data.lat',
+ 'should set colorField'
+ );
+
+ const parsedLayer = serializeLayer(nextState.layers[oldLayerIndex], schema);
+ const parsedWithRadius = CloneDeep(parsedLayer);
+ parsedWithRadius.config.visConfig.radius = 25;
+ const afterParsedRadius = reducer(
+ nextState,
+ VisStateActions.applyLayerConfig(oldLayerId, parsedWithRadius)
+ );
+ t.equal(
+ getUpdatedLayerJson(afterParsedRadius).visualChannels.colorField?.name,
+ 'gps_data.lat',
+ 'parsed-format radius change should keep colorField'
+ );
+ t.equal(
+ getUpdatedLayerJson(afterParsedRadius).config.visConfig.radius,
+ 25,
+ 'parsed-format radius change should update radius'
+ );
+
t.end();
});