Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
feat(layers): add optional soft glow to point layers (#3962)
Igor Dykhta7071e121c93d
diff --git a/docs/user-guides/c-types-of-layers/a-point.md b/docs/user-guides/c-types-of-layers/a-point.mdindex 16454620b..4ad07d309 100644--- a/docs/user-guides/c-types-of-layers/a-point.md+++ b/docs/user-guides/c-types-of-layers/a-point.md@@ -28,9 +28,22 @@ __Layer Attributes__- Font Color- Text Anchor-## Pulse / Ripple+## Visual-Enable **Pulse / Ripple** at the end of the Point layer settings to animate the points. The effect is off by default, with its controls in a collapsed group.+Expand **Visual** at the end of the Point layer settings to configure **Glow** and **Pulse / Ripple**. Both effects are off by default and can be enabled independently. Collapsing Visual keeps the current effects active.++### Glow++Enable **Glow** to add a soft halo around each point.++- **Extent** sets the halo radius, from 1 to 5 times the point's displayed radius. At 1, there is no halo.+- **Strength** sets the halo opacity, from 0 to 1. The halo fades smoothly toward its outer edge.++The halo uses the point's fill color, or its outline color for unfilled points, and follows its radius mapping, opacity, filters, and map or billboard orientation. The ordinary point and its picking area stay unchanged. With **Pulse / Ripple** enabled, the point continues to animate over a static halo. Labels stay still. Glow settings are saved with the map and retained when turned off.++### Pulse / Ripple++Enable **Pulse / Ripple** to animate the points.- **Pulse** smoothly grows and shrinks dots, fading them as they expand.- **Ripple** draws expanding rings that fade out and repeat.diff --git a/src/components/src/side-panel/layer-panel/layer-configurator.tsx b/src/components/src/side-panel/layer-panel/layer-configurator.tsxindex b304e4844..3b8ce565c 100644--- a/src/components/src/side-panel/layer-panel/layer-configurator.tsx+++ b/src/components/src/side-panel/layer-panel/layer-configurator.tsx@@ -145,15 +145,27 @@ const StyledLayerVisualConfigurator = styled.div.attrs({}`;-// Keep this group's keyboard behavior scoped to the optional point effect.-const PulseRippleControls = styled.fieldset`+// Keep keyboard behavior scoped to the optional point effects.+const PointVisualControls = styled(ConfigGroupCollapsibleContent)`+ .layer-config-group.collapsed & {+ visibility: hidden;+ }+`;++const PointEffectControls = styled.fieldset`border: 0;margin: 0;padding: 0;min-width: 0;- .layer-config-group.collapsed & {- visibility: hidden;+ legend {+ width: 100%;+ padding: 0;+ }++ &:disabled > :not(legend) {+ opacity: 0.3;+ pointer-events: none;}`;@@ -677,13 +689,31 @@ export default function LayerConfiguratorFactory(</LayerConfigGroup>) : null}{layer.type === LAYER_TYPES.point ? (- <LayerConfigGroup- {...layer.visConfigSettings.pulseEnabled}- {...visConfiguratorProps}- collapsible- >- <ConfigGroupCollapsibleContent>- <PulseRippleControls disabled={!layer.config.visConfig.pulseEnabled}>+ <LayerConfigGroup label="layerVisConfigs.point.visual" collapsible>+ <PointVisualControls>+ <PointEffectControls disabled={!layer.config.visConfig.glowEnabled}>+ <legend>+ <VisConfigSwitch+ {...layer.visConfigSettings.glowEnabled}+ {...visConfiguratorProps}+ />+ </legend>+ <VisConfigSlider+ {...layer.visConfigSettings.glowExtent}+ {...visConfiguratorProps}+ />+ <VisConfigSlider+ {...layer.visConfigSettings.glowStrength}+ {...visConfiguratorProps}+ />+ </PointEffectControls>+ <PointEffectControls disabled={!layer.config.visConfig.pulseEnabled}>+ <legend>+ <VisConfigSwitch+ {...layer.visConfigSettings.pulseEnabled}+ {...visConfiguratorProps}+ />+ </legend><SidePanelSection><PanelLabel><FormattedMessage id="layerVisConfigs.point.pulseMode" />@@ -707,8 +737,8 @@ export default function LayerConfiguratorFactory({...layer.visConfigSettings.pulseExpansion}{...visConfiguratorProps}/>- </PulseRippleControls>- </ConfigGroupCollapsibleContent>+ </PointEffectControls>+ </PointVisualControls></LayerConfigGroup>) : null}</StyledLayerVisualConfigurator>diff --git a/src/layers/src/point-layer/point-glow-extension.spec.ts b/src/layers/src/point-layer/point-glow-extension.spec.tsnew file mode 100644index 000000000..b4495b3a4--- /dev/null+++ b/src/layers/src/point-layer/point-glow-extension.spec.ts@@ -0,0 +1,54 @@+// SPDX-License-Identifier: MIT+// Copyright contributors to the kepler.gl project++import {Layer} from '@deck.gl/core';+import PointGlowExtension, {getPointGlowUniforms, PointGlowProps} from './point-glow-extension';++describe('Point glow', () => {+ test('missing or nonfinite settings use safe defaults', () => {+ expect(getPointGlowUniforms({})).toEqual({extent: 2, strength: 0.5});+ for (const value of [undefined, NaN, Infinity, -Infinity]) {+ expect(getPointGlowUniforms({glowExtent: value, glowStrength: value})).toEqual({+ extent: 2,+ strength: 0.5+ });+ }+ });++ test('extent and strength are bounded without changing valid settings', () => {+ expect(getPointGlowUniforms({glowExtent: -3, glowStrength: -1})).toEqual({+ extent: 1,+ strength: 0+ });+ expect(getPointGlowUniforms({glowExtent: 100, glowStrength: 100})).toEqual({+ extent: 5,+ strength: 1+ });+ expect(getPointGlowUniforms({glowExtent: 3, glowStrength: 0.7})).toEqual({+ extent: 3,+ strength: 0.7+ });+ });++ test('updates uniforms without scheduling animation, including hidden and empty layers', () => {+ const extension = new PointGlowExtension();+ const setProps = jest.fn();+ const setNeedsRedraw = jest.fn();+ for (const visible of [true, false]) {+ for (const count of [0, 2]) {+ const host = {+ props: {glowExtent: 3, glowStrength: 0.7, visible},+ getModels: () => [{shaderInputs: {setProps}}],+ getNumInstances: () => count,+ setNeedsRedraw+ };+ extension.draw.call(host as unknown as Layer<PointGlowProps>);+ expect(setProps).toHaveBeenLastCalledWith({pointGlow: {extent: 3, strength: 0.7}});+ expect(setNeedsRedraw).not.toHaveBeenCalled();+ }+ }+ expect(() =>+ extension.draw.call({props: {}, getModels: () => []} as unknown as Layer<PointGlowProps>)+ ).not.toThrow();+ });+});diff --git a/src/layers/src/point-layer/point-glow-extension.ts b/src/layers/src/point-layer/point-glow-extension.tsnew file mode 100644index 000000000..3a7896bc3--- /dev/null+++ b/src/layers/src/point-layer/point-glow-extension.ts@@ -0,0 +1,66 @@+// SPDX-License-Identifier: MIT+// Copyright contributors to the kepler.gl project++import {Layer, LayerExtension} from '@deck.gl/core';++export type PointGlowProps = {+ glowExtent?: number;+ glowStrength?: number;+};++const uniformBlock = `\+layout(std140) uniform pointGlowUniforms {+ float extent;+ float strength;+} pointGlow;+`;++const pointGlowUniforms = {+ name: 'pointGlow',+ vs: uniformBlock,+ fs: uniformBlock,+ uniformTypes: {extent: 'f32', strength: 'f32'} as const+};++export function getPointGlowUniforms(props: PointGlowProps) {+ return {+ extent: Number.isFinite(props.glowExtent)+ ? Math.min(5, Math.max(1, props.glowExtent as number))+ : 2,+ strength: Number.isFinite(props.glowStrength)+ ? Math.min(1, Math.max(0, props.glowStrength as number))+ : 0.5+ };+}++/** A static halo drawn behind the ordinary point, including Arrow batch primitives. */+export default class PointGlowExtension extends LayerExtension {+ static extensionName = 'PointGlowExtension';+ static defaultProps = {glowExtent: 2, glowStrength: 0.5};++ getShaders() {+ return {+ modules: [pointGlowUniforms],+ inject: {+ // Expand after ScatterplotLayer applies units, pixel limits and outline width.+ 'vs:DECKGL_FILTER_SIZE': 'size *= pointGlow.extent;',+ 'fs:DECKGL_FILTER_COLOR': `+ float radius = length(geometry.uv);+ float coreRadius = 1.0 / pointGlow.extent;+ if (radius <= coreRadius || pointGlow.extent <= 1.0 || pointGlow.strength <= 0.0) {+ discard;+ }+ float fade = 1.0 - smoothstep(coreRadius, 1.0, radius);+ color.a *= pointGlow.strength * fade * fade;+ `+ }+ };+ }++ draw(this: Layer<PointGlowProps>) {+ const uniforms = getPointGlowUniforms(this.props);+ for (const model of this.getModels()) {+ model.shaderInputs.setProps({pointGlow: uniforms});+ }+ }+}diff --git a/src/layers/src/point-layer/point-layer.ts b/src/layers/src/point-layer/point-layer.tsindex 22d408aa9..a8b3a9c2c 100644--- a/src/layers/src/point-layer/point-layer.ts+++ b/src/layers/src/point-layer/point-layer.ts@@ -21,6 +21,7 @@ import {applyDefaultColorField} from '../layer-color-utils';import {default as KeplerTable} from '@kepler.gl/table';import PointLayerIcon from './point-layer-icon';import PulseRippleExtension from './pulse-ripple-extension';+import PointGlowExtension from './point-glow-extension';import {DatasetType,LAYER_VIS_CONFIGS,@@ -68,6 +69,9 @@ export type PointLayerVisConfigSettings = {strokeColorRange: VisConfigColorRange;radiusRange: VisConfigRange;filled: VisConfigBoolean;+ glowEnabled: VisConfigBoolean;+ glowExtent: VisConfigNumber;+ glowStrength: VisConfigNumber;pulseEnabled: VisConfigBoolean;pulseMode: VisConfigSelection;pulseSpeed: VisConfigNumber;@@ -94,6 +98,9 @@ export type PointLayerVisConfig = {strokeColorRange: ColorRange;radiusRange: [number, number];filled: boolean;+ glowEnabled: boolean;+ glowExtent: number;+ glowStrength: number;pulseEnabled: boolean;pulseMode: 'pulse' | 'ripple';pulseSpeed: number;@@ -175,6 +182,7 @@ const DEFAULT_COLUMN_MODE = COLUMN_MODE_POINTS;const brushingExtension = new BrushingExtension();const arrowCPUFilterExtension = new FilterArrowExtension();const pulseRippleExtension = new PulseRippleExtension();+const pointGlowExtension = new PointGlowExtension();function pushPointPosition(data: any[], pos: number[], index: number, neighbors?: number[]) {if (pos.every(Number.isFinite)) {@@ -198,6 +206,9 @@ export const pointVisConfigs: {strokeColorRange: 'strokeColorRange';radiusRange: 'radiusRange';filled: VisConfigBoolean;+ glowEnabled: VisConfigBoolean;+ glowExtent: VisConfigNumber;+ glowStrength: VisConfigNumber;pulseEnabled: VisConfigBoolean;pulseMode: VisConfigSelection;pulseSpeed: VisConfigNumber;@@ -207,6 +218,31 @@ export const pointVisConfigs: {showNeighborOnHover: 'showNeighborOnHover';showHighlightColor: 'showHighlightColor';} = {+ glowEnabled: {+ type: 'boolean',+ defaultValue: false,+ label: 'layerVisConfigs.point.glow',+ property: 'glowEnabled'+ } as VisConfigBoolean,+ glowExtent: {+ type: 'number',+ defaultValue: 2,+ label: 'layerVisConfigs.point.glowExtent',+ description: 'layerVisConfigs.point.glowExtentDescription',+ property: 'glowExtent',+ isRanged: false,+ range: [1, 5],+ step: 0.1+ } as VisConfigNumber,+ glowStrength: {+ type: 'number',+ defaultValue: 0.5,+ label: 'layerVisConfigs.point.glowStrength',+ property: 'glowStrength',+ isRanged: false,+ range: [0, 1],+ step: 0.05+ } as VisConfigNumber,pulseEnabled: {type: 'boolean',defaultValue: false,@@ -323,6 +359,9 @@ export default class PointLayer extends Layer {return [...super.noneLayerDataAffectingProps,'radius',+ 'glowEnabled',+ 'glowExtent',+ 'glowStrength','pulseEnabled','pulseMode','pulseSpeed',@@ -625,31 +664,67 @@ export default class PointLayer extends Layer {getPosition = this.geoArrowVector;}+ const {glowEnabled, glowExtent, glowStrength} = this.config.visConfig;+ const withGlow = (point: ScatterplotLayer<any, any> | GeoArrowScatterplotLayer<any>) => {+ if (!glowEnabled || (!point.props.filled && !point.props.stroked)) {+ return [point];+ }+ const colorAccessor = point.props.filled ? 'getFillColor' : 'getLineColor';+ return [+ point.clone({+ id: `${point.id}-glow`,+ pickable: false,+ // Only the core reports counts; removed halos must not leave stale count entries.+ onFilteredItemsChange: null,+ filled: true,+ getFillColor: point.props[colorAccessor],+ getLineColor: point.props[colorAccessor],+ updateTriggers: {+ ...point.props.updateTriggers,+ getFillColor: point.props.updateTriggers?.[colorAccessor],+ getLineColor: point.props.updateTriggers?.[colorAccessor]+ },+ // A transparent halo must not occlude other points at altitude.+ parameters: {...point.props.parameters, depthWriteEnabled: false},+ // Glow stays static even when the ordinary point pulses or ripples.+ extensions: [+ ...point.props.extensions.filter(extension => extension !== pulseRippleExtension),+ pointGlowExtension+ ],+ glowExtent,+ glowStrength+ }),+ point+ ];+ };+return [- // @ts-expect-error- new ScatterplotLayerClass({- ...defaultLayerProps,- ...brushingProps,- ...layerProps,- ...data,- data: deckLayerData,- getPosition,- parameters: {- // circles will be flat on the map when the altitude column is not used- depthTest: (this.config.columns.altitude?.fieldIdx as number) > -1,- ...(mapState?.layerParameters ?? {})- },- lineWidthUnits: 'pixels',- updateTriggers,- ...pulseProps,- extensions: [...extensions, ...(pulseEnabled ? [pulseRippleExtension] : [])],- opacity: hoveredObject && showNeighborOnHover ? 0.2 : this.config.visConfig.opacity,- pickable: allowHover,- autoHighlight: false- }),+ ...withGlow(+ // @ts-expect-error+ new ScatterplotLayerClass({+ ...defaultLayerProps,+ ...brushingProps,+ ...layerProps,+ ...data,+ data: deckLayerData,+ getPosition,+ parameters: {+ // circles will be flat on the map when the altitude column is not used+ depthTest: (this.config.columns.altitude?.fieldIdx as number) > -1,+ ...(mapState?.layerParameters ?? {})+ },+ lineWidthUnits: 'pixels',+ updateTriggers,+ ...pulseProps,+ extensions: [...extensions, ...(pulseEnabled ? [pulseRippleExtension] : [])],+ opacity: hoveredObject && showNeighborOnHover ? 0.2 : this.config.visConfig.opacity,+ pickable: allowHover,+ autoHighlight: false+ })+ ),// hover layer...(hoveredObject- ? [+ ? withGlow(new ScatterplotLayer({...this.getDefaultHoverLayerProps(),...layerProps,@@ -666,7 +741,7 @@ export default class PointLayer extends Layer {getRadius: data.getRadius,getPosition: data.getPosition})- ]+ ): []),// text label layer...this.renderTextLabelLayer(diff --git a/src/localization/src/translations/en.ts b/src/localization/src/translations/en.tsindex 1dabb08b6..ac6ec240c 100644--- a/src/localization/src/translations/en.ts+++ b/src/localization/src/translations/en.ts@@ -201,6 +201,11 @@ export default {boundsNorth: 'North',pointSize: 'Point Size',point: {+ visual: 'Visual',+ glow: 'Glow',+ glowExtent: 'Extent',+ glowExtentDescription: 'Halo radius as a multiple of the point radius.',+ glowStrength: 'Strength',pulseRipple: 'Pulse / Ripple',pulseMode: 'Effect',pulse: 'Pulse',diff --git a/test/browser/components/side-panel/layer-configurator-test.js b/test/browser/components/side-panel/layer-configurator-test.jsindex c65ca157d..7e5b110a5 100644--- a/test/browser/components/side-panel/layer-configurator-test.js+++ b/test/browser/components/side-panel/layer-configurator-test.js@@ -1422,111 +1422,165 @@ test('Components -> LayerConfigurator -> collapsed Heatmap surface toggle group'}});-test('Components -> LayerConfigurator -> Point Pulse / Ripple controls', async t => {- const layer = new KeplerGlLayers.PointLayer({id: 'pulse-controls', dataId: testCsvDataId});- const changed = sinon.spy();- function Editor() {- const [, setVersion] = React.useState(0);- return (- <IntlWrapper>- <LayerConfigurator- {...defaultProps}- layer={layer}- updateLayerVisConfig={value => {- changed(value);- layer.updateLayerVisConfig(value);- setVersion(version => version + 1);- }}- />- </IntlWrapper>- );- }- const view = renderWithTheme(<Editor />);- const group = within(view.container).getByText('Pulse / Ripple').closest('.layer-config-group');- const header = group.querySelector('.layer-config-group__header');- const toggle = within(header).getByRole('checkbox');- const content = group.querySelector('.layer-config-group__content');- const user = userEvent.setup();- const assertControlsSkipped = async message => {- toggle.focus();- await user.tab();- t.notOk(content.contains(document.activeElement), message);- };- try {- t.equal(group, group.parentElement.lastElementChild, 'effect is the last group');- t.notOk(toggle.checked, 'effect is off by default');- t.ok(group.classList.contains('collapsed'), 'effect controls start collapsed');- t.ok(content.classList.contains('disabled'), 'disabled effect controls cannot be edited');- await assertControlsSkipped('collapsed disabled controls are skipped by Tab');- fireEvent.click(header);- await assertControlsSkipped('expanded disabled controls are skipped by Tab');- const disabledSelector = content.querySelector('.item-selector');- fireEvent.keyDown(disabledSelector, {key: 'Enter'});- t.equal(- disabledSelector.getAttribute('aria-expanded'),- 'false',- 'disabled selector cannot open from the keyboard'- );- fireEvent.keyDown(disabledSelector, {key: 'Escape'});- fireEvent.click(header);- fireEvent.click(toggle);- t.deepEqual(changed.lastCall.args[0], {pulseEnabled: true}, 'toggle enables the effect');- t.notOk(group.classList.contains('collapsed'), 'enabling expands controls');- t.notOk(content.classList.contains('disabled'), 'enabled controls can be edited');- toggle.focus();- await user.tab();- const enabledSelector = content.querySelector('.item-selector');- t.equal(- document.activeElement,- enabledSelector,- 'enabled expanded selector is keyboard reachable'- );- await user.keyboard('{Enter}');- t.equal(- enabledSelector.getAttribute('aria-expanded'),- 'true',- 'enabled selector opens from the keyboard'- );- await user.keyboard('{Escape}');- fireEvent.click(content.querySelector('.item-selector__dropdown'));- fireEvent.click(view.getByText('Ripple'));- t.deepEqual(changed.lastCall.args[0], {pulseMode: 'ripple'}, 'effect selector chooses Ripple');- const inputs = Array.from(content.querySelectorAll('.kg-range-slider__input'));- const speed = inputs.find(input => input.value === '1');- const expansion = inputs.find(input => input.value === '2');- fireEvent.change(speed, {target: {value: '0.5'}});- fireEvent.blur(speed);- t.deepEqual(changed.lastCall.args[0], {pulseSpeed: 0.5}, 'speed can be adjusted');- fireEvent.change(expansion, {target: {value: '4'}});- fireEvent.blur(expansion);- t.deepEqual(changed.lastCall.args[0], {pulseExpansion: 4}, 'expansion can be adjusted');- const calls = changed.callCount;- fireEvent.click(header);- t.ok(group.classList.contains('collapsed'), 'header collapses the settings');- t.equal(changed.callCount, calls, 'collapse does not turn off animation');- await assertControlsSkipped('collapsed enabled controls are skipped by Tab');- fireEvent.click(toggle);- t.deepEqual(changed.lastCall.args[0], {pulseEnabled: false}, 'toggle disables the effect');- fireEvent.click(toggle);- t.equal(layer.config.visConfig.pulseMode, 'ripple', 'reenabling retains the style');- t.equal(layer.config.visConfig.pulseSpeed, 0.5, 'reenabling retains speed');- t.equal(layer.config.visConfig.pulseExpansion, 4, 'reenabling retains expansion');- } finally {- view.unmount();- }- const restored = renderWithTheme(<Editor />);- try {- const restoredGroup = within(restored.container)- .getByText('Pulse / Ripple')- .closest('.layer-config-group');- t.ok(- within(restoredGroup.querySelector('.layer-config-group__header')).getByRole('checkbox')- .checked,- 'saved effect restores the enabled toggle'- );- t.ok(restoredGroup.classList.contains('collapsed'), 'reopened controls start collapsed');- } finally {- restored.unmount();- t.end();+[+ {+ label: 'Glow',+ enabled: 'glowEnabled',+ other: 'pulseEnabled',+ values: [+ ['glowExtent', '2', '3'],+ ['glowStrength', '0.5', '0.7']+ ]+ },+ {+ label: 'Pulse / Ripple',+ enabled: 'pulseEnabled',+ other: 'glowEnabled',+ values: [+ ['pulseSpeed', '1', '0.5'],+ ['pulseExpansion', '2', '4']+ ]}+].forEach(({label, enabled, other, values}) => {+ test(`Components -> LayerConfigurator -> Point Visual -> ${label}`, async t => {+ const layer = new KeplerGlLayers.PointLayer({id: 'visual-controls', dataId: testCsvDataId});+ const changed = sinon.spy();+ function Editor() {+ const [, setVersion] = React.useState(0);+ return (+ <IntlWrapper>+ <LayerConfigurator+ {...defaultProps}+ layer={layer}+ updateLayerVisConfig={value => {+ changed(value);+ layer.updateLayerVisConfig(value);+ setVersion(version => version + 1);+ }}+ />+ </IntlWrapper>+ );+ }+ const view = renderWithTheme(<Editor />);+ const group = within(view.container).getByText('Visual').closest('.layer-config-group');+ const header = group.querySelector('.layer-config-group__header');+ const content = within(group).getByText(label).closest('fieldset');+ const toggle = within(content).getByRole('checkbox', {hidden: true});+ const otherToggle = within(group)+ .getAllByRole('checkbox', {hidden: true})+ .find(input => input !== toggle);+ const user = userEvent.setup();+ // A focusable marker immediately before the group checks the whole collapsed section.+ const tabStart = document.createElement('button');+ group.before(tabStart);+ const assertCollapsedSkipped = async message => {+ tabStart.focus();+ await user.tab();+ t.notOk(group.contains(document.activeElement), message);+ };+ try {+ t.equal(+ within(group).getAllByRole('checkbox', {hidden: true}).length,+ 2,+ 'both effects share one group'+ );+ t.notOk(group.querySelector('.layer-config-group'), 'effects do not add nested groups');+ t.notOk(toggle.checked, 'effect is off by default');+ t.ok(group.classList.contains('collapsed'), 'Visual starts collapsed');+ t.ok(content.disabled, 'effect settings start disabled');+ await assertCollapsedSkipped('collapsed toggles and settings are skipped by Tab');+ fireEvent.click(header);+ toggle.focus();+ await user.tab();+ t.notOk(+ content.contains(document.activeElement),+ 'expanded disabled settings are skipped by Tab'+ );+ const selector = content.querySelector('.item-selector');+ if (selector) {+ fireEvent.keyDown(selector, {key: 'Enter'});+ t.equal(+ selector.getAttribute('aria-expanded'),+ 'false',+ 'disabled selector cannot open from the keyboard'+ );+ }+ toggle.focus();+ await user.keyboard(' ');+ t.deepEqual(changed.lastCall.args[0], {[enabled]: true}, 'keyboard enables the effect');+ t.notOk(content.disabled, 'enabled settings can be edited');+ t.equal(layer.config.visConfig[other], false, 'enabling one effect leaves the other off');+ t.notOk(group.classList.contains('collapsed'), 'toggling an effect keeps Visual open');+ await user.tab();+ t.ok(content.contains(document.activeElement), 'enabled settings are keyboard reachable');+ if (selector) {+ t.equal(document.activeElement, selector, 'effect selector receives focus');+ await user.keyboard('{Enter}');+ t.equal(+ selector.getAttribute('aria-expanded'),+ 'true',+ 'enabled selector opens from the keyboard'+ );+ await user.keyboard('{Escape}');+ fireEvent.click(content.querySelector('.item-selector__dropdown'));+ fireEvent.click(view.getByText('Ripple'));+ t.deepEqual(changed.lastCall.args[0], {pulseMode: 'ripple'}, 'selector chooses Ripple');+ }+ for (const [property, initial, next] of values) {+ const input = Array.from(content.querySelectorAll('.kg-range-slider__input')).find(+ item => item.value === initial+ );+ input.focus();+ await user.clear(input);+ await user.type(input, next);+ await user.tab();+ t.deepEqual(+ changed.lastCall.args[0],+ {[property]: Number(next)},+ `keyboard adjusts ${property}`+ );+ }+ fireEvent.click(otherToggle);+ t.equal(+ layer.config.visConfig[enabled],+ true,+ 'enabling the other effect preserves this effect'+ );+ t.equal(layer.config.visConfig[other], true, 'both effects can be enabled');+ const calls = changed.callCount;+ fireEvent.click(header);+ t.ok(group.classList.contains('collapsed'), 'Visual collapses both sets of controls');+ t.equal(changed.callCount, calls, 'collapse does not change either effect');+ await assertCollapsedSkipped('collapsed enabled toggles and settings are skipped by Tab');+ fireEvent.click(header);+ fireEvent.click(toggle);+ t.deepEqual(changed.lastCall.args[0], {[enabled]: false}, 'toggle disables only its effect');+ t.equal(layer.config.visConfig[other], true, 'other effect remains enabled');+ t.ok(content.disabled, 'disabled settings cannot be edited');+ fireEvent.click(toggle);+ for (const [property, , next] of values) {+ t.equal(layer.config.visConfig[property], Number(next), `reenabling retains ${property}`);+ }+ if (selector)+ t.equal(layer.config.visConfig.pulseMode, 'ripple', 'reenabling retains Ripple');+ } finally {+ view.unmount();+ }+ const restored = renderWithTheme(<Editor />);+ try {+ const restoredGroup = within(restored.container)+ .getByText('Visual')+ .closest('.layer-config-group');+ t.ok(+ within(restoredGroup)+ .getAllByRole('checkbox', {hidden: true})+ .every(input => input.checked),+ 'saved effects restore both toggles'+ );+ t.ok(restoredGroup.classList.contains('collapsed'), 'reopened Visual starts collapsed');+ } finally {+ restored.unmount();+ t.end();+ }+ });});diff --git a/test/browser/layer-tests/point-layer-specs.js b/test/browser/layer-tests/point-layer-specs.jsindex 876db5290..94a134b75 100644--- a/test/browser/layer-tests/point-layer-specs.js+++ b/test/browser/layer-tests/point-layer-specs.js@@ -6,6 +6,7 @@ import {LayerManager, MapView, _GlobeView} from '@deck.gl/core';import {device} from '@deck.gl/test-utils';import {visStateSchemaV1} from '@kepler.gl/schemas';import PulseRippleExtension from '../../../src/layers/src/point-layer/pulse-ripple-extension';+import PointGlowExtension from '../../../src/layers/src/point-layer/point-glow-extension';import moment from 'moment';import {getDistanceScales, zoomToScale} from '@math.gl/web-mercator';import {scaleQuantize} from 'd3-scale';@@ -21,6 +22,7 @@ import {findDefaultLayer,INITIAL_MAP_STATE,INITIAL_VIS_STATE,+ layerFilteredItemsChangeUpdater,renderDeckGlLayer} from '@kepler.gl/reducers';import {copyTableAndUpdate, KeplerTable} from '@kepler.gl/table';@@ -366,6 +368,7 @@ test('#PointLayer -> native separated points preserve every coordinate through i[layer]);const formatted = layer.formatLayerData({[dataset.id]: dataset});+ const onFilteredItemsChange = () => {};const render = () =>layer.renderLayer({data: formatted,@@ -376,8 +379,8 @@ test('#PointLayer -> native separated points preserve every coordinate through igpuFilter: dataset.gpuFilter,interactionConfig: INITIAL_VIS_STATE.interactionConfig,visible: true,- layerCallbacks: {}- })[0];+ layerCallbacks: {onFilteredItemsChange}+ });const rowIndices =geometryType === 'multipoint'? [@@ -388,66 +391,104 @@ test('#PointLayer -> native separated points preserve every coordinate through i[0, 1, 2],[3, 4]];- for (const pulseEnabled of [false, true, false]) {+ for (const {pulseEnabled, glowEnabled} of [+ {pulseEnabled: false, glowEnabled: false},+ {pulseEnabled: false, glowEnabled: true},+ {pulseEnabled: true, glowEnabled: true},+ {pulseEnabled: true, glowEnabled: false},+ {pulseEnabled: false, glowEnabled: false}+ ]) {layer.updateLayerVisConfig({pulseEnabled,+ glowEnabled,+ glowExtent: 3,+ glowStrength: 0.7,pulseMode: 'ripple',pulseSpeed: 2,pulseExpansion: 3});- const composite = render();- const sublayers = composite.renderLayers();- t.equal(sublayers.length, 2, 'renders both Arrow record batches');- sublayers.forEach((sublayer, batchIndex) => {- const {props} = sublayer;- t.equal(- props.extensions.some(extension => extension instanceof PulseRippleExtension),- pulseEnabled,- 'Arrow batch enables animation only when selected'- );- t.equal(props.pulseMode, 'ripple', 'Arrow batch inherits effect style');- t.equal(props.pulseSpeed, 2, 'Arrow batch inherits speed');- t.equal(props.pulseExpansion, 3, 'Arrow batch inherits expansion');- t.equal(props.data.length, rowIndices[batchIndex].length, 'empty features add no points');- rowIndices[batchIndex].forEach((rowIndex, index) => {- const context = {index, data: props.data, target: []};- const expected = {index: rowIndex};+ const rendered = render();+ t.equal(rendered.length, glowEnabled ? 2 : 1, 'only enabled glow adds a renderer');+ for (const composite of rendered) {+ const isGlow = composite.id.endsWith('-glow');+ const sublayers = composite.renderLayers();+ t.equal(sublayers.length, 2, 'renders both Arrow record batches');+ sublayers.forEach((sublayer, batchIndex) => {+ const {props} = sublayer;t.equal(- props.getRadius(null, context),- formatted.getRadius(expected),- 'radius uses the feature row'- );- t.deepEqual(- props.getFillColor(null, context),- formatted.getFillColor(expected),- 'color uses the feature row'+ props.extensions.some(extension => extension instanceof PulseRippleExtension),+ pulseEnabled && !isGlow,+ 'only the ordinary Arrow points animate');t.equal(- props.getFiltered(null, context),- formatted.getFiltered(expected),- 'CPU mask uses the feature row'+ props.extensions.some(extension => extension instanceof PointGlowExtension),+ isGlow,+ 'only the halo batch has glow shaders');- const filterValues = props.getFilterValue(null, context);- t.deepEqual(- filterValues,- formatted.getFilterValue(expected),- 'GPU values use the feature row'+ if (isGlow) {+ t.notOk(props.pickable, 'halo batches do not change picking');+ t.equal(props.glowExtent, 3, 'Arrow batch inherits extent');+ t.equal(props.glowStrength, 0.7, 'Arrow batch inherits strength');+ t.notOk(props.onFilteredItemsChange, 'halo batches do not report data counts');+ } else {+ t.equal(+ props.onFilteredItemsChange,+ onFilteredItemsChange,+ 'core batches retain count reporting'+ );+ }+ t.equal(props.pulseMode, 'ripple', 'Arrow batch inherits effect style');+ t.equal(props.pulseSpeed, 2, 'Arrow batch inherits speed');+ t.equal(props.pulseExpansion, 3, 'Arrow batch inherits expansion');+ t.equal(+ props.data.length,+ rowIndices[batchIndex].length,+ 'empty features add no points');- const [min, max] = dataset.gpuFilter.filterRange[0];- const visible =- Boolean(props.getFiltered(null, context)) &&- filterValues[0] >= min &&- filterValues[0] <= max;- t.equal(visible, rowIndex === 3, 'only the matching later-batch feature is visible');- const picked = composite.getPickingInfo({info: {index}, sourceLayer: sublayer});- t.equal(picked.index, rowIndex, 'rendered attributes agree with the picked feature');+ rowIndices[batchIndex].forEach((rowIndex, index) => {+ const context = {index, data: props.data, target: []};+ const expected = {index: rowIndex};+ t.equal(+ props.getRadius(null, context),+ formatted.getRadius(expected),+ 'radius uses the feature row'+ );+ t.deepEqual(+ props.getFillColor(null, context),+ formatted.getFillColor(expected),+ 'color uses the feature row'+ );+ t.equal(+ props.getFiltered(null, context),+ formatted.getFiltered(expected),+ 'CPU mask uses the feature row'+ );+ const filterValues = props.getFilterValue(null, context);+ t.deepEqual(+ filterValues,+ formatted.getFilterValue(expected),+ 'GPU values use the feature row'+ );+ const [min, max] = dataset.gpuFilter.filterRange[0];+ const visible =+ Boolean(props.getFiltered(null, context)) &&+ filterValues[0] >= min &&+ filterValues[0] <= max;+ t.equal(visible, rowIndex === 3, 'only the matching later-batch feature is visible');+ const picked = composite.getPickingInfo({info: {index}, sourceLayer: sublayer});+ t.equal(picked.index, rowIndex, 'rendered attributes agree with the picked feature');+ });});- });- t.equal(- sublayers[1].props.getRadius(null, {index: 0, data: sublayers[1].props.data, target: []}),- 90,- 'later batch reads 90 rather than the first batch value 10'- );+ t.equal(+ sublayers[1].props.getRadius(null, {+ index: 0,+ data: sublayers[1].props.data,+ target: []+ }),+ 90,+ 'later batch reads 90 rather than the first batch value 10'+ );+ }}const vectorLayer = new GeoArrowScatterplotLayer({id: 'batched-vector-radius',@@ -2006,7 +2047,7 @@ test('#PointLayer -> formatLayerData -> Geojson column mode', async t => {t.end();});-test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {+test('#PointLayer -> Glow and Pulse / Ripple rendering and saved settings', t => {const datasets = {[dataId]: copyTableAndUpdate(preparedDataset, {filteredIndex: [0, 2, 4]})};const layer = testCreateLayerFromConfig(t,@@ -2017,6 +2058,9 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {config: {dataId,columns: {lat: 'lat', lng: 'lng'},+ colorField: {name: 'id', type: 'integer'},+ sizeField: {name: 'id', type: 'integer'},+ visConfig: {outline: true, opacity: 0.6},textLabel: [{field: {name: 'types', type: 'string'}}]}},@@ -2025,6 +2069,16 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {{point: PointLayer});const data = testFormatLayerData(t, layer, datasets);+ let filteredState = {...INITIAL_VIS_STATE, layers: [layer]};+ const onFilteredItemsChange = event => {+ filteredState = layerFilteredItemsChangeUpdater(filteredState, {layer, event});+ };+ // Simulate DataFilterExtension notifications in draw order, without requiring a GPU.+ const reportCounts = (deckLayers, count) => {+ deckLayers.forEach(deckLayer => {+ deckLayer.props.onFilteredItemsChange?.({id: deckLayer.id, count});+ });+ };const render = (globe = false, mapLayers) =>renderDeckGlLayer({@@ -2040,7 +2094,7 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {hoverInfo: {picked: true, layer: {props: {id: layer.id}}, object: data.data[0], index: 0},mapLayers},- {}+ {onFilteredItemsChange});const hasAnimation = deckLayer =>deckLayer.props.extensions.some(extension => extension instanceof PulseRippleExtension);@@ -2073,6 +2127,10 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {'brushingRadius','radiusScale','radiusMaxPixels',+ 'radiusMinPixels',+ 'radiusUnits',+ 'lineWidthScale',+ 'lineWidthUnits','filled','stroked','billboard',@@ -2113,6 +2171,104 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {t.notOk(hasAnimation(deckLayers[1]), 'regular hover has no animation extension');};assertRegular(regular);+ t.equal(layer.config.visConfig.glowEnabled, false, 'glow is off for older maps');+ const assertGlow = deckLayers => {+ const halos = deckLayers.filter(deckLayer => deckLayer.id.endsWith('-glow'));+ t.equal(halos.length, 2, 'adds a halo behind the point and hover renderers');+ for (const halo of halos) {+ const core = deckLayers.find(deckLayer => `${deckLayer.id}-glow` === halo.id);+ t.ok(deckLayers.indexOf(halo) < deckLayers.indexOf(core), 'halo is behind its core');+ t.notOk(halo.props.pickable, 'halo does not expand the picking area');+ t.notOk(halo.props.onFilteredItemsChange, 'halo does not report data counts');+ if (core.id === layer.id) {+ t.equal(+ core.props.onFilteredItemsChange,+ onFilteredItemsChange,+ 'core keeps count reporting'+ );+ }+ t.notOk(halo.props.parameters.depthWriteEnabled, 'halo does not occlude other points');+ t.notOk(hasAnimation(halo), 'halo stays static with either animation mode');+ for (const key of [+ 'data',+ 'getPosition',+ 'getRadius',+ 'getFillColor',+ 'getLineColor',+ 'getFilterValue',+ 'filterRange',+ 'brushingEnabled',+ 'brushingRadius',+ 'radiusScale',+ 'radiusMinPixels',+ 'radiusMaxPixels',+ 'radiusUnits',+ 'lineWidthScale',+ 'lineWidthUnits',+ 'stroked',+ 'billboard',+ 'opacity',+ 'visible'+ ]) {+ // Both halo channels use the point fill; outline width is still respected.+ if (key !== 'getLineColor') {+ t.deepEqual(halo.props[key], core.props[key], `halo preserves ${key}`);+ }+ }+ t.ok(+ halo.props.extensions.some(e => e instanceof PointGlowExtension),+ 'halo shader enabled'+ );+ t.notOk(+ core.props.extensions.some(e => e instanceof PointGlowExtension),+ 'ordinary core shader unchanged'+ );+ }+ const labels = deckLayers.filter(deckLayer => deckLayer.id.includes('-label-'));+ t.ok(labels.length, 'labels remain available');+ labels.forEach(label =>+ t.notOk(+ label.props.extensions.some(e => e instanceof PointGlowExtension),+ 'labels have no glow'+ )+ );+ };+ // A saved map can first draw with glow enabled, before any core count is recorded.+ layer.filteredItemCount = {};+ layer.updateLayerVisConfig({glowEnabled: true, glowExtent: 3, glowStrength: 0.7});+ const glowing = render(globe);+ testRenderDeckLayer(t, 'glowing points', glowing, {layerManager: manager});+ assertGlow(glowing);+ reportCounts(glowing, 3);+ t.equal(layer.getFilteredItemCount(), 3, 'initial count is correct with glow enabled');+ t.deepEqual(+ snapshot(glowing),+ baseline,+ 'glow leaves core/hover shaders, attributes and props unchanged'+ );+ const core = glowing.find(deckLayer => deckLayer.id === layer.id);+ t.equal(+ core.getPickingInfo({info: {index: 0}}).object,+ data.data[0],+ 'glow preserves core picking'+ );+ t.ok(+ render(globe, {[layer.id]: false}).every(deckLayer => !deckLayer.props.visible),+ 'hidden points and halos stay hidden'+ );+ layer.updateLayerVisConfig({glowEnabled: false});+ const disabledGlow = render(globe);+ testRenderDeckLayer(t, 'disabled glow', disabledGlow, {layerManager: manager});+ assertRegular(disabledGlow);+ reportCounts(disabledGlow, 1);+ t.equal(+ layer.getFilteredItemCount(),+ 1,+ 'count updates after glow is removed and GPU filters change'+ );+ t.equal(disabledGlow.length, regular.length, 'disabled glow removes its renderers');+ t.equal(layer.config.visConfig.glowExtent, 3, 'disabling retains extent');+ t.equal(layer.config.visConfig.glowStrength, 0.7, 'disabling retains strength');for (const pulseMode of ['pulse', 'ripple']) {layer.updateLayerVisConfig({pulseEnabled: true,@@ -2152,17 +2308,31 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {false,'hidden points stay hidden');- layer.updateLayerVisConfig({pulseEnabled: false});+ const animatedBaseline = snapshot(deckLayers);+ layer.updateLayerVisConfig({glowEnabled: true});+ const combined = render(globe);+ testRenderDeckLayer(t, 'glow with animation', combined, {layerManager: manager});+ assertGlow(combined);+ reportCounts(combined, 2);+ t.equal(layer.getFilteredItemCount(), 2, 'count updates after glow is reenabled');+ t.deepEqual(snapshot(combined), animatedBaseline, 'glow preserves existing animation');+ layer.updateLayerVisConfig({glowEnabled: false, pulseEnabled: false});const staticLayers = render(globe);testRenderDeckLayer(t, 'disabled pulse', staticLayers, {layerManager: manager});assertRegular(staticLayers);+ reportCounts(staticLayers, 0);+ t.equal(+ layer.getFilteredItemCount(),+ 0,+ 'empty filter results update after glow is disabled again'+ );t.equal(layer.config.visConfig.pulseExpansion, 3, 'turning off retains effect settings');}} finally {manager.finalize();}}- layer.updateLayerVisConfig({pulseEnabled: true});+ layer.updateLayerVisConfig({pulseEnabled: true, glowEnabled: true});const saved = visStateSchemaV1.save({...INITIAL_VIS_STATE,layers: [layer],@@ -2174,8 +2344,38 @@ test('#PointLayer -> Pulse / Ripple rendering and saved settings', t => {{layer: loaded.layers[0], datasets},{point: PointLayer});- for (const key of ['pulseEnabled', 'pulseMode', 'pulseSpeed', 'pulseExpansion']) {+ for (const key of [+ 'pulseEnabled',+ 'pulseMode',+ 'pulseSpeed',+ 'pulseExpansion',+ 'glowEnabled',+ 'glowExtent',+ 'glowStrength'+ ]) {t.equal(restored.config.visConfig[key], layer.config.visConfig[key], `restores ${key}`);}+ layer.updateLayerVisConfig({filled: false, outline: true, fixedRadius: true, billboard: true});+ const outlined = render();+ const halo = outlined.find(deckLayer => deckLayer.id === `${layer.id}-glow`);+ const point = outlined.find(deckLayer => deckLayer.id === layer.id);+ t.equal(halo.props.getFillColor, point.props.getLineColor, 'unfilled halo uses outline colors');+ t.deepEqual(+ halo.props.updateTriggers.getFillColor,+ point.props.updateTriggers.getLineColor,+ 'outline color changes refresh the halo'+ );+ t.equal(+ halo.props.radiusMaxPixels,+ point.props.radiusMaxPixels,+ 'fixed radii retain pixel limits'+ );+ t.equal(halo.props.radiusUnits, point.props.radiusUnits, 'fixed radii retain units');+ t.equal(halo.props.billboard, true, 'halo follows billboard orientation');+ layer.updateLayerVisConfig({outline: false});+ t.notOk(+ render().some(deckLayer => deckLayer.id.endsWith('-glow')),+ 'invisible fill and outline have no halo'+ );t.end();});diff --git a/test/fixtures/state-saved-v0.js b/test/fixtures/state-saved-v0.jsindex 323d9efd9..92462668f 100644--- a/test/fixtures/state-saved-v0.js+++ b/test/fixtures/state-saved-v0.js@@ -1073,6 +1073,9 @@ mergedLayer0.config = {allowHover: true,showNeighborOnHover: false,showHighlightColor: true,+ glowEnabled: false,+ glowExtent: 2,+ glowStrength: 0.5,pulseEnabled: false,pulseMode: 'pulse',pulseSpeed: 1,@@ -1229,6 +1232,9 @@ mergedLayer2.config = {allowHover: true,showNeighborOnHover: false,showHighlightColor: true,+ glowEnabled: false,+ glowExtent: 2,+ glowStrength: 0.5,pulseEnabled: false,pulseMode: 'pulse',pulseSpeed: 1,diff --git a/test/fixtures/state-saved-v1-3.js b/test/fixtures/state-saved-v1-3.jsindex d155c6fda..0be1aa596 100644--- a/test/fixtures/state-saved-v1-3.js+++ b/test/fixtures/state-saved-v1-3.js@@ -404,6 +404,9 @@ mergedLayer0.config = {allowHover: true,showNeighborOnHover: false,showHighlightColor: true,+ glowEnabled: false,+ glowExtent: 2,+ glowStrength: 0.5,pulseEnabled: false,pulseMode: 'pulse',pulseSpeed: 1,diff --git a/test/fixtures/state-saved-v1-4.js b/test/fixtures/state-saved-v1-4.jsindex 8ad23eb08..d6a23da65 100644--- a/test/fixtures/state-saved-v1-4.js+++ b/test/fixtures/state-saved-v1-4.js@@ -260,6 +260,9 @@ mergedLayer0.config = {allowHover: true,showNeighborOnHover: false,showHighlightColor: true,+ glowEnabled: false,+ glowExtent: 2,+ glowStrength: 0.5,pulseEnabled: false,pulseMode: 'pulse',pulseSpeed: 1,diff --git a/test/helpers/mock-state.js b/test/helpers/mock-state.jsindex 037a13b07..cf687eef0 100644--- a/test/helpers/mock-state.js+++ b/test/helpers/mock-state.js@@ -945,6 +945,9 @@ export const expectedSavedLayer1 = {allowHover: true,showNeighborOnHover: false,showHighlightColor: true,+ glowEnabled: false,+ glowExtent: 2,+ glowStrength: 0.5,pulseEnabled: false,pulseMode: 'pulse',pulseSpeed: 1,@@ -994,6 +997,9 @@ export const expectedLoadedLayer1 = {allowHover: true,showNeighborOnHover: false,showHighlightColor: true,+ glowEnabled: false,+ glowExtent: 2,+ glowStrength: 0.5,pulseEnabled: false,pulseMode: 'pulse',pulseSpeed: 1,