Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Enhancement] Add billboard and fadeTrail toggles (#2684)
Shan He9c82daae5d89
diff --git a/src/components/src/side-panel/layer-panel/layer-configurator.tsx b/src/components/src/side-panel/layer-panel/layer-configurator.tsxindex c9993adb8..7011fffeb 100644--- a/src/components/src/side-panel/layer-panel/layer-configurator.tsx+++ b/src/components/src/side-panel/layer-panel/layer-configurator.tsx@@ -253,6 +253,7 @@ export default function LayerConfiguratorFactory({...visConfiguratorProps}/>) : null}+ <VisConfigSwitch {...layer.visConfigSettings.billboard} {...visConfiguratorProps} /></ConfigGroupCollapsibleContent></LayerConfigGroup>@@ -711,6 +712,7 @@ export default function LayerConfiguratorFactory()}<ConfigGroupCollapsibleContent>+ <VisConfigSwitch {...layer.visConfigSettings.billboard} {...visConfiguratorProps} /><ChannelByValueSelectorchannel={layer.visualChannels.size}{...layerChannelConfigProps}@@ -724,12 +726,16 @@ export default function LayerConfiguratorFactory({...(featureTypes.polygon ? layer.visConfigSettings.stroked : {})}label="layer.trailLength"description="layer.trailLengthDescription"+ collapsible><VisConfigSlider{...layer.visConfigSettings.trailLength}{...visConfiguratorProps}label={false}/>+ <ConfigGroupCollapsibleContent>+ <VisConfigSwitch {...layer.visConfigSettings.fadeTrail} {...visConfiguratorProps} />+ </ConfigGroupCollapsibleContent></LayerConfigGroup></StyledLayerVisualConfigurator>);diff --git a/src/constants/src/layers.ts b/src/constants/src/layers.tsindex 365b10675..1ac207e5c 100644--- a/src/constants/src/layers.ts+++ b/src/constants/src/layers.ts@@ -106,6 +106,21 @@ export const LAYER_VIS_CONFIGS: LayerVisConfigSettings = {property: 'trailLength',allowCustomValue: true},+ fadeTrail: {+ defaultValue: true,+ type: 'boolean',+ label: 'layerVisConfigs.fadeTrail',+ group: PROPERTY_GROUPS.stroke,+ property: 'fadeTrail'+ },+ billboard: {+ defaultValue: false,+ type: 'boolean',+ label: 'layerVisConfigs.billboard',+ description: 'layerVisConfigs.billboardDescription',+ group: PROPERTY_GROUPS.display,+ property: 'billboard'+ },// radius is actually radiusScale in deck.glradius: {type: 'number',diff --git a/src/layers/src/icon-layer/icon-layer.ts b/src/layers/src/icon-layer/icon-layer.tsindex f6c5fb0f4..58412a258 100644--- a/src/layers/src/icon-layer/icon-layer.ts+++ b/src/layers/src/icon-layer/icon-layer.ts@@ -47,6 +47,7 @@ export type IconLayerVisConfig = {opacity: number;colorRange: ColorRange;radiusRange: [number, number];+ billboard: boolean;};export type IconLayerConfig = Merge<@@ -85,12 +86,14 @@ export const pointVisConfigs: {opacity: 'opacity';colorRange: 'colorRange';radiusRange: 'radiusRange';+ billboard: 'billboard';} = {radius: 'radius',fixedRadius: 'fixedRadius',opacity: 'opacity',colorRange: 'colorRange',- radiusRange: 'radiusRange'+ radiusRange: 'radiusRange',+ billboard: 'billboard'};function flatterIconPositions(icon) {@@ -326,6 +329,7 @@ export default class IconLayer extends Layer {const layerProps = {radiusScale,+ billboard: this.config.visConfig.billboard,...(this.config.visConfig.fixedRadius ? {} : {radiusMaxPixels: 500})};diff --git a/src/layers/src/point-layer/point-layer.ts b/src/layers/src/point-layer/point-layer.tsindex b354f43e8..d765cc826 100644--- a/src/layers/src/point-layer/point-layer.ts+++ b/src/layers/src/point-layer/point-layer.ts@@ -67,6 +67,7 @@ export type PointLayerVisConfig = {strokeColorRange: ColorRange;radiusRange: [number, number];filled: boolean;+ billboard: boolean;allowHover: boolean;showNeighborOnHover: boolean;showHighlightColor: boolean;@@ -147,6 +148,7 @@ export const pointVisConfigs: {strokeColorRange: 'strokeColorRange';radiusRange: 'radiusRange';filled: VisConfigBoolean;+ billboard: 'billboard';allowHover: 'allowHover';showNeighborOnHover: 'showNeighborOnHover';showHighlightColor: 'showHighlightColor';@@ -167,6 +169,7 @@ export const pointVisConfigs: {defaultValue: true,property: 'filled'},+ billboard: 'billboard',allowHover: 'allowHover',showNeighborOnHover: 'showNeighborOnHover',showHighlightColor: 'showHighlightColor'@@ -404,6 +407,7 @@ export default class PointLayer extends Layer {stroked: this.config.visConfig.outline,filled: this.config.visConfig.filled,lineWidthScale: this.config.visConfig.thickness,+ billboard: this.config.visConfig.billboard,radiusScale,...(this.config.visConfig.fixedRadius ? {} : {radiusMaxPixels: 500})};diff --git a/src/layers/src/trip-layer/trip-layer.ts b/src/layers/src/trip-layer/trip-layer.tsindex 22ddb177b..0b91275e1 100644--- a/src/layers/src/trip-layer/trip-layer.ts+++ b/src/layers/src/trip-layer/trip-layer.ts@@ -6,7 +6,7 @@ import uniq from 'lodash.uniq';import Layer, {LayerBaseConfig, defaultGetFieldValue} from '../base-layer';import {TripsLayer as DeckGLTripsLayer} from '@deck.gl/geo-layers';-import {GEOJSON_FIELDS, ColorRange} from '@kepler.gl/constants';+import {GEOJSON_FIELDS, ColorRange, PROJECTED_PIXEL_SIZE_MULTIPLIER} from '@kepler.gl/constants';import TripLayerIcon from './trip-layer-icon';import {@@ -50,6 +50,8 @@ export type TripLayerVisConfig = {colorRange: ColorRange;trailLength: number;sizeRange: [number, number];+ billboard: boolean;+ fadeTrail: boolean;};export type TripLayerConfig = Merge<@@ -71,6 +73,8 @@ export const tripVisConfigs: {thickness: VisConfigNumber;colorRange: 'colorRange';trailLength: 'trailLength';+ fadeTrail: 'fadeTrail';+ billboard: 'billboard';sizeRange: 'strokeWidthRange';} = {opacity: 'opacity',@@ -86,6 +90,8 @@ export const tripVisConfigs: {},colorRange: 'colorRange',trailLength: 'trailLength',+ fadeTrail: 'fadeTrail',+ billboard: 'billboard',sizeRange: 'strokeWidthRange'};@@ -433,11 +439,13 @@ export default class TripLayer extends Layer {};const defaultLayerProps = this.getDefaultDeckLayerProps(opts);+ const billboardWidthFactor = visConfig.billboard ? PROJECTED_PIXEL_SIZE_MULTIPLIER : 1;+const layerProps = {...defaultLayerProps,...data,getTimestamps: d => (data.getTimestamps(d) || []).map(ts => ts - domain0),- widthScale: visConfig.thickness * zoomFactor * zoomFactorValue,+ widthScale: visConfig.thickness * zoomFactor * zoomFactorValue * billboardWidthFactor,capRounded: true,jointRounded: true,wrapLongitude: false,@@ -446,6 +454,8 @@ export default class TripLayer extends Layer {depthMask: false},trailLength: visConfig.trailLength * 1000,+ fadeTrail: visConfig.fadeTrail,+ billboard: visConfig.billboard,currentTime: animationConfig.currentTime - domain0,updateTriggers,id: `${defaultLayerProps.id}${mapState.globe?.enabled ? '-globe' : ''}`diff --git a/src/localization/src/translations/ca.ts b/src/localization/src/translations/ca.tsindex 8760a4574..bca19845d 100644--- a/src/localization/src/translations/ca.ts+++ b/src/localization/src/translations/ca.ts@@ -117,6 +117,9 @@ export default {radiusRange: 'Rang de radi',clusterRadius: 'Radi Cluster en Pixels',radiusRangePixels: 'Rang del radi en pixels',+ billboard: 'Mode de cartellera',+ billboardDescription: 'Orientar la geometria cap a la càmera',+ fadeTrail: 'Rastre de desvaniment',opacity: 'Opacitat',coverage: 'Cobertura',outline: 'Outline',diff --git a/src/localization/src/translations/en.ts b/src/localization/src/translations/en.tsindex be09529d8..60b1ab10d 100644--- a/src/localization/src/translations/en.ts+++ b/src/localization/src/translations/en.ts@@ -127,6 +127,9 @@ export default {radiusRange: 'Radius Range',clusterRadius: 'Cluster Radius in Pixels',radiusRangePixels: 'Radius Range in pixels',+ billboard: 'Billboard',+ billboardDescription: 'Orient geometry towards the camera',+ fadeTrail: 'Fade trail',opacity: 'Opacity',coverage: 'Coverage',outline: 'Outline',diff --git a/src/localization/src/translations/es.ts b/src/localization/src/translations/es.tsindex feb19e105..57766ac23 100644--- a/src/localization/src/translations/es.ts+++ b/src/localization/src/translations/es.ts@@ -117,6 +117,9 @@ export default {radiusRange: 'Rango de radio',clusterRadius: 'Radio del cluster en píxeles',radiusRangePixels: 'Rango del radio en píxeles',+ billboard: 'Modo cartelera',+ billboardDescription: 'Oriente la geometría hacia la cámara',+ fadeTrail: 'Sendero de desvanecimiento',opacity: 'Opacidad',coverage: 'Cobertura',outline: 'Contorno',diff --git a/src/localization/src/translations/fi.ts b/src/localization/src/translations/fi.tsindex 62ebb3a54..cab3d4940 100644--- a/src/localization/src/translations/fi.ts+++ b/src/localization/src/translations/fi.ts@@ -115,6 +115,9 @@ export default {radiusRange: 'Säteen rajat',clusterRadius: 'Klusterien säde pikseleinä',radiusRangePixels: 'Säteen rajat pikseleinä',+ billboard: 'Billboard -tila',+ billboardDescription: 'Suuntaa geometria kameraa kohti',+ fadeTrail: 'Häipyvä polku',opacity: 'Läpinäkyvyys',coverage: 'Kattavuus',outline: 'Ääriviiva',diff --git a/src/localization/src/translations/ja.ts b/src/localization/src/translations/ja.tsindex d346cc659..06975374f 100644--- a/src/localization/src/translations/ja.ts+++ b/src/localization/src/translations/ja.ts@@ -115,6 +115,9 @@ export default {radiusRange: '半径の範囲',clusterRadius: 'クラスターの範囲[ピクセル]',radiusRangePixels: '半径の範囲[ピクセル]',+ billboard: 'ビルボードモード',+ billboardDescription: 'ジオメトリをカメラに向けます',+ fadeTrail: 'フェージングパス',opacity: '不透明度',coverage: 'カバー率',outline: '輪郭線',diff --git a/src/localization/src/translations/pt.ts b/src/localization/src/translations/pt.tsindex 2f15aeaa8..583b31762 100644--- a/src/localization/src/translations/pt.ts+++ b/src/localization/src/translations/pt.ts@@ -115,6 +115,9 @@ export default {radiusRange: 'Alcance do Raio',clusterRadius: 'Raio do Agrupamento em pixels',radiusRangePixels: 'Alcance do Raio em pixels',+ billboard: 'Câmera de rosto',+ billboardDescription: 'Oriente a geometria em direção à câmera',+ fadeTrail: 'Fade trilha',opacity: 'Opacidade',coverage: 'Cobertura',outline: 'Contorno',diff --git a/src/types/layers.d.ts b/src/types/layers.d.tsindex 1b37cf7e1..135510f8e 100644--- a/src/types/layers.d.ts+++ b/src/types/layers.d.ts@@ -224,6 +224,8 @@ export type LayerVisConfigSettings = {thickness: VisConfigNumber;strokeWidthRange: VisConfigRange;trailLength: VisConfigNumber;+ fadeTrail: VisConfigBoolean;+ billboard: VisConfigBoolean;radius: VisConfigNumber;fixedRadius: VisConfigBoolean;radiusRange: VisConfigRange;diff --git a/test/fixtures/state-saved-v0.js b/test/fixtures/state-saved-v0.jsindex f7d3b8ff2..c17b566d0 100644--- a/test/fixtures/state-saved-v0.js+++ b/test/fixtures/state-saved-v0.js@@ -1030,6 +1030,7 @@ mergedLayer0.config = {hidden: false,visConfig: {radius: 270.4,+ billboard: false,opacity: 0.8,outline: false,filled: true,@@ -1175,6 +1176,7 @@ mergedLayer2.config = {hidden: false,visConfig: {radius: 10,+ billboard: false,opacity: 0.8,outline: false,filled: true,diff --git a/test/fixtures/state-saved-v1-3.js b/test/fixtures/state-saved-v1-3.jsindex c26f6db73..b3c4198ac 100644--- a/test/fixtures/state-saved-v1-3.js+++ b/test/fixtures/state-saved-v1-3.js@@ -380,6 +380,7 @@ mergedLayer0.config = {radius: 10,fixedRadius: true,opacity: 0.29,+ billboard: false,outline: false,filled: true,thickness: 2,diff --git a/test/fixtures/state-saved-v1-4.js b/test/fixtures/state-saved-v1-4.jsindex dfb7a531b..1fbc579fd 100644--- a/test/fixtures/state-saved-v1-4.js+++ b/test/fixtures/state-saved-v1-4.js@@ -234,6 +234,7 @@ mergedLayer0.config = {},visConfig: {radius: 12.5,+ billboard: false,fixedRadius: false,opacity: 0.8,outline: false,diff --git a/test/fixtures/state-saved-v1-5.js b/test/fixtures/state-saved-v1-5.jsindex c4983ff9e..7b6a5859a 100644--- a/test/fixtures/state-saved-v1-5.js+++ b/test/fixtures/state-saved-v1-5.js@@ -167,7 +167,7 @@ export const savedStateV1TripGeoJson = {category: 'Uber',colors: ['#5A1846', '#900C3F', '#C70039', '#E3611C', '#F1920E', '#FFC300']},- trailLength: 180,+ billboard: false,sizeRange: [0, 10]},textLabel: [@@ -267,6 +267,8 @@ mergedLayer0.config = {thickness: 0.5,colorRange: DEFAULT_COLOR_RANGE,trailLength: 180,+ fadeTrail: true,+ billboard: false,sizeRange: [0, 10]},textLabel: [DEFAULT_TEXT_LABEL],diff --git a/test/helpers/mock-state.js b/test/helpers/mock-state.jsindex 4b64e49d5..ea44078d4 100644--- a/test/helpers/mock-state.js+++ b/test/helpers/mock-state.js@@ -772,6 +772,7 @@ export const expectedSavedLayer1 = {isVisible: true,visConfig: {radius: 10,+ billboard: false,fixedRadius: false,opacity: DEFAULT_LAYER_OPACITY,outline: false,@@ -821,6 +822,7 @@ export const expectedLoadedLayer1 = {isVisible: true,visConfig: {radius: 10,+ billboard: false,fixedRadius: false,opacity: DEFAULT_LAYER_OPACITY,outline: false,@@ -993,6 +995,8 @@ export const expectedSavedTripLayer = {thickness: 0.5,colorRange: DEFAULT_COLOR_RANGE,trailLength: 180,+ fadeTrail: true,+ billboard: false,sizeRange: [0, 10]},textLabel: [DEFAULT_TEXT_LABEL]