Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[feat] Adding setAnimationConfig action (#2887)
Igor Dykhta0ad53723ac44
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.tsindex aefd4cca5..713459810 100644--- a/src/actions/src/action-types.ts+++ b/src/actions/src/action-types.ts@@ -77,6 +77,7 @@ export const ActionTypes = {TOGGLE_FILTER_ANIMATION: `${ACTION_PREFIX}TOGGLE_FILTER_ANIMATION`,UPDATE_FILTER_ANIMATION_SPEED: `${ACTION_PREFIX}UPDATE_FILTER_ANIMATION_SPEED`,PLAY_ANIMATION: `${ACTION_PREFIX}PLAY_ANIMATION`,+ SET_ANIMATION_CONFIG: `${ACTION_PREFIX}SET_ANIMATION_CONFIG`,SET_LAYER_ANIMATION_TIME: `${ACTION_PREFIX}SET_LAYER_ANIMATION_TIME`,SET_LAYER_ANIMATION_TIME_CONFIG: `${ACTION_PREFIX}SET_LAYER_ANIMATION_TIME_CONFIG`,UPDATE_ANIMATION_SPEED: `${ACTION_PREFIX}UPDATE_ANIMATION_SPEED`,diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.tsindex 5e65f6972..c820437bb 100644--- a/src/actions/src/vis-state-actions.ts+++ b/src/actions/src/vis-state-actions.ts@@ -22,7 +22,9 @@ import {ParsedConfig,ParsedLayer,EffectPropsPartial,- SyncTimelineMode+ SyncTimelineMode,+ AnimationConfig,+ FilterAnimationConfig} from '@kepler.gl/types';import {createAction} from '@reduxjs/toolkit';@@ -979,6 +981,23 @@ export function updateFilterAnimationSpeed(};}+export type SetAnimationConfigUpdaterAction = {+ config: AnimationConfig | FilterAnimationConfig;+};+/**+ * Set animation config: works with both layer animation and filter animation+ * @param config+ * @returns action+ */+export function setAnimationConfig(+ config: AnimationConfig | FilterAnimationConfig+): Merge<SetAnimationConfigUpdaterAction, {type: typeof ActionTypes.SET_ANIMATION_CONFIG}> {+ return {+ type: ActionTypes.SET_ANIMATION_CONFIG,+ config+ };+}+export type SetLayerAnimationTimeUpdaterAction = {value: number | null;};diff --git a/src/components/src/common/animation-control/animation-control.tsx b/src/components/src/common/animation-control/animation-control.tsxindex e72d55c05..34ecf4997 100644--- a/src/components/src/common/animation-control/animation-control.tsx+++ b/src/components/src/common/animation-control/animation-control.tsx@@ -6,7 +6,7 @@ import styled from 'styled-components';import classnames from 'classnames';import {media} from '@kepler.gl/styles';-import {Timeline} from '@kepler.gl/types';+import {Timeline, Filter} from '@kepler.gl/types';import TimelineSliderFactory from '../timeline-slider';import PlaybackControlsFactory from './playback-controls';@@ -68,6 +68,7 @@ const AnimationWidgetInner = styled.div`const TIMELINE_PLAYBACK_STYLE = {flex: 1};export type AnimationControlProps = {+ filter?: Filter;timeline?: Timeline;isAnimatable?: boolean;isAnimating?: boolean;@@ -95,6 +96,7 @@ function AnimationControlFactory(TimelineSlider: ReturnType<typeof TimelineSliderFactory>) {const AnimationControl: React.FC<AnimationControlProps> = ({+ filter,className,style,isAnimatable,@@ -135,6 +137,7 @@ function AnimationControlFactory({showControls ? (<PlaybackControlsclassName="animation-control-playpause"+ filter={filter}isAnimatable={isAnimatable}startAnimation={toggleAnimation}isAnimating={isAnimating}diff --git a/src/components/src/common/animation-control/playback-controls.tsx b/src/components/src/common/animation-control/playback-controls.tsxindex 334acb5cf..4c07370cf 100644--- a/src/components/src/common/animation-control/playback-controls.tsx+++ b/src/components/src/common/animation-control/playback-controls.tsx@@ -6,6 +6,7 @@ import styled from 'styled-components';import classnames from 'classnames';import {Reset, Play, Pause, Save, Rocket, AnchorWindow, FreeWindow} from '../icons';import {ANIMATION_WINDOW} from '@kepler.gl/constants';+import {Filter} from '@kepler.gl/types';import AnimationSpeedSliderFactory from './animation-speed-slider';import WindowActionControlFactory from './window-action-control';import AnimationWindowControlFactory, {AnimationItem} from './animation-window-control';@@ -58,6 +59,7 @@ const DEFAULT_ANIMATE_ITEMS = {}};export interface PlaybackControlsProps {+ filter?: Filter;isAnimatable?: boolean;isAnimating?: boolean;width?: number;@@ -102,6 +104,7 @@ function PlaybackControlsFactory(// eslint-disable-next-line complexityconst PlaybackControls: React.FC<PlaybackControlsProps> = ({+ filter,isAnimatable,isAnimating = true,width,@@ -154,6 +157,7 @@ function PlaybackControlsFactory(animationItems={animationItems}animationWindow={animationWindow}buttonHeight={buttonHeight}+ filter={filter}setFilterAnimationWindow={setFilterAnimationWindow}updateAnimationSpeed={updateAnimationSpeed}isAnimating={isAnimating}diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.tsindex 6c628aea0..56ed15ed4 100644--- a/src/reducers/src/vis-state-updaters.ts+++ b/src/reducers/src/vis-state-updaters.ts@@ -41,7 +41,8 @@ import {setFilter,processFileContent,fitBounds as fitMapBounds,- toggleLayerForMap+ toggleLayerForMap,+ applyFilterConfig} from '@kepler.gl/actions';// Utils@@ -69,7 +70,8 @@ import {set,updateFilterPlot,removeFilterPlot,- isLayerAnimatable+ isLayerAnimatable,+ isSideFilter} from '@kepler.gl/utils';import {generateHashId, toArray} from '@kepler.gl/common-utils';// Mergers@@ -117,6 +119,7 @@ import {Filter,InteractionConfig,AnimationConfig,+ FilterAnimationConfig,Editor,Field,TimeRangeFilter@@ -1529,6 +1532,35 @@ export const toggleFilterAnimationUpdater = (filters: state.filters.map((f, i) => (i === action.idx ? {...f, isAnimating: !f.isAnimating} : f))});+export function isFilterAnimationConfig(config: AnimationConfig | FilterAnimationConfig): boolean {+ return 'dataId' in config && 'animationWindow' in config;+}++export function setAnimationConfigUpdater(+ state: VisState,+ action: VisStateActions.SetAnimationConfigUpdaterAction+): VisState {+ const {config} = action;+ if (isFilterAnimationConfig(config)) {+ // Find filter used for animation+ // Assuming there's only one filter used for animation, see setFilterViewUpdater+ const filter = state.filters.find(f => !isSideFilter(f));+ if (!filter) {+ return state;+ }+ const newFilter = {...filter, ...config};+ return applyFilterConfigUpdater(state, applyFilterConfig(filter.id, newFilter));+ } else {+ return {+ ...state,+ animationConfig: {+ ...state.animationConfig,+ ...config+ }+ };+ }+}+/*** @memberof visStateUpdaters* @publicdiff --git a/src/reducers/src/vis-state.ts b/src/reducers/src/vis-state.tsindex c2e521674..f74800f10 100644--- a/src/reducers/src/vis-state.ts+++ b/src/reducers/src/vis-state.ts@@ -95,6 +95,8 @@ const actionHandler = {[ActionTypes.UPDATE_FILTER_ANIMATION_SPEED]: visStateUpdaters.updateFilterAnimationSpeedUpdater,+ [ActionTypes.SET_ANIMATION_CONFIG]: visStateUpdaters.setAnimationConfigUpdater,+[ActionTypes.SET_LAYER_ANIMATION_TIME]: visStateUpdaters.setLayerAnimationTimeUpdater,[ActionTypes.UPDATE_LAYER_ANIMATION_SPEED]: visStateUpdaters.updateLayerAnimationSpeedUpdater,diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.tsindex 4e68bbb89..2a3338b6c 100644--- a/src/types/reducers.d.ts+++ b/src/types/reducers.d.ts@@ -260,6 +260,17 @@ export type AnimationConfig = {hideControl?: boolean;};+export type FilterAnimationConfig = Pick<+ TimeRangeFilter,+ | 'dataId'+ | 'value'+ | 'animationWindow'+ | 'speed'+ | 'syncedWithLayerTimeline'+ | 'syncTimelineMode'+ | 'timezone'+>;+export type Timeline = {domain: [number, number] | null;value: number | [number, number];