Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Convert deckgl class components to functional #25177

Merged
merged 1 commit into from
Sep 7, 2023
Merged

chore: Convert deckgl class components to functional #25177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 118 additions & 148 deletions superset-frontend/plugins/legacy-preset-chart-deckgl/src/CategoricalDeckGLContainer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
*/
/* eslint no-underscore-dangle: ["error", { "allow": ["", "__timestamp"] }] */

import React from 'react';
import React, { memo, useCallback, useEffect, useRef, useState } from 'react';
import {
CategoricalColorNamespace,
Datasource,
Expand All @@ -40,7 +40,7 @@ import sandboxedEval from './utils/sandbox';
// eslint-disable-next-line import/extensions
import fitViewport, { Viewport } from './utils/fitViewport';
import {
DeckGLContainer,
DeckGLContainerHandle,
DeckGLContainerStyledWrapper,
} from './DeckGLContainer';
import { Point } from './types';
Expand Down Expand Up @@ -83,82 +83,72 @@ export type CategoricalDeckGLContainerProps = {
setControlValue: (control: string, value: JsonValue) => void;
};

export type CategoricalDeckGLContainerState = {
formData?: QueryFormData;
viewport: Viewport;
categories: JsonObject;
};

export default class CategoricalDeckGLContainer extends React.PureComponent<
CategoricalDeckGLContainerProps,
CategoricalDeckGLContainerState
> {
containerRef = React.createRef<DeckGLContainer>();

/*
* A Deck.gl container that handles categories.
*
* The container will have an interactive legend, populated from the
* categories present in the data.
*/
constructor(props: CategoricalDeckGLContainerProps) {
super(props);
this.state = this.getStateFromProps(props);

this.getLayers = this.getLayers.bind(this);
this.toggleCategory = this.toggleCategory.bind(this);
this.showSingleCategory = this.showSingleCategory.bind(this);
}

UNSAFE_componentWillReceiveProps(nextProps: CategoricalDeckGLContainerProps) {
if (nextProps.payload.form_data !== this.state.formData) {
this.setState({ ...this.getStateFromProps(nextProps) });
}
}
const CategoricalDeckGLContainer = (props: CategoricalDeckGLContainerProps) => {
const containerRef = useRef<DeckGLContainerHandle>(null);

// eslint-disable-next-line class-methods-use-this
getStateFromProps(
props: CategoricalDeckGLContainerProps,
state?: CategoricalDeckGLContainerState,
) {
const features = props.payload.data.features || [];
const categories = getCategories(props.formData, features);

// the state is computed only from the payload; if it hasn't changed, do
// not recompute state since this would reset selections and/or the play
// slider position due to changes in form controls
if (state && props.payload.form_data === state.formData) {
return { ...state, categories };
}

const { width, height, formData } = props;
let { viewport } = props;
if (formData.autozoom) {
const getAdjustedViewport = useCallback(() => {
let viewport = { ...props.viewport };
if (props.formData.autozoom) {
viewport = fitViewport(viewport, {
width,
height,
points: props.getPoints(features),
width: props.width,
height: props.height,
points: props.getPoints(props.payload.data.features || []),
});
}
if (viewport.zoom < 0) {
viewport.zoom = 0;
}
return viewport;
}, [props]);

const [categories, setCategories] = useState<JsonObject>(
getCategories(props.formData, props.payload.data.features || []),
);
const [stateFormData, setStateFormData] = useState<JsonObject>(
props.payload.form_data,
);
const [viewport, setViewport] = useState(getAdjustedViewport());

useEffect(() => {
if (props.payload.form_data !== stateFormData) {
const features = props.payload.data.features || [];
const categories = getCategories(props.formData, features);

setViewport(getAdjustedViewport());
setStateFormData(props.payload.form_data);
setCategories(categories);
}
}, [getAdjustedViewport, props, stateFormData]);

return {
viewport,
selected: [],
lastClick: 0,
formData: props.payload.form_data,
categories,
};
}
const setTooltip = useCallback((tooltip: TooltipProps['tooltip']) => {
const { current } = containerRef;
if (current) {
current.setTooltip(tooltip);
}
}, []);

const addColor = useCallback((data: JsonObject[], fd: QueryFormData) => {
const c = fd.color_picker || { r: 0, g: 0, b: 0, a: 1 };
const colorFn = getScale(fd.color_scheme);

return data.map(d => {
let color;
if (fd.dimension) {
color = hexToRGB(colorFn(d.cat_color, fd.sliceId), c.a * 255);

return { ...d, color };
}

return d;
});
}, []);

getLayers() {
const { getLayer, payload, formData: fd, onAddFilter } = this.props;
const getLayers = useCallback(() => {
const { getLayer, payload, formData: fd, onAddFilter } = props;
let features = payload.data.features ? [...payload.data.features] : [];

// Add colors from categories or fixed color
features = this.addColor(features, fd);
features = addColor(features, fd);

// Apply user defined data mutator if defined
if (fd.js_data_mutator) {
Expand All @@ -167,9 +157,8 @@ export default class CategoricalDeckGLContainer extends React.PureComponent<
}

// Show only categories selected in the legend
const cats = this.state.categories;
if (fd.dimension) {
features = features.filter(d => cats[d.cat_color]?.enabled);
features = features.filter(d => categories[d.cat_color]?.enabled);
}

const filteredPayload = {
Expand All @@ -182,88 +171,69 @@ export default class CategoricalDeckGLContainer extends React.PureComponent<
fd,
filteredPayload,
onAddFilter,
this.setTooltip,
this.props.datasource,
setTooltip,
props.datasource,
) as Layer,
];
}

// eslint-disable-next-line class-methods-use-this
addColor(data: JsonObject[], fd: QueryFormData) {
const c = fd.color_picker || { r: 0, g: 0, b: 0, a: 1 };
const colorFn = getScale(fd.color_scheme);

return data.map(d => {
let color;
if (fd.dimension) {
color = hexToRGB(colorFn(d.cat_color, fd.sliceId), c.a * 255);

return { ...d, color };
}, [addColor, categories, props, setTooltip]);

const toggleCategory = useCallback(
(category: string) => {
const categoryState = categories[category];
const categoriesExtended = {
...categories,
[category]: {
...categoryState,
enabled: !categoryState.enabled,
},
};

// if all categories are disabled, enable all -- similar to nvd3
if (Object.values(categoriesExtended).every(v => !v.enabled)) {
/* eslint-disable no-param-reassign */
Object.values(categoriesExtended).forEach(v => {
v.enabled = true;
});
}

return d;
});
}

toggleCategory(category: string) {
const categoryState = this.state.categories[category];
const categories = {
...this.state.categories,
[category]: {
...categoryState,
enabled: !categoryState.enabled,
},
};

// if all categories are disabled, enable all -- similar to nvd3
if (Object.values(categories).every(v => !v.enabled)) {
/* eslint-disable no-param-reassign */
Object.values(categories).forEach(v => {
v.enabled = true;
setCategories(categoriesExtended);
},
[categories],
);

const showSingleCategory = useCallback(
(category: string) => {
const modifiedCategories = { ...categories };
Object.values(modifiedCategories).forEach(v => {
v.enabled = false;
});
}
this.setState({ categories });
}

showSingleCategory(category: string) {
const categories = { ...this.state.categories };
/* eslint-disable no-param-reassign */
Object.values(categories).forEach(v => {
v.enabled = false;
});
categories[category].enabled = true;
this.setState({ categories });
}

setTooltip = (tooltip: TooltipProps['tooltip']) => {
const { current } = this.containerRef;
if (current) {
current.setTooltip(tooltip);
}
};
modifiedCategories[category].enabled = true;
setCategories(modifiedCategories);
},
[categories],
);

return (
<div style={{ position: 'relative' }}>
<DeckGLContainerStyledWrapper
ref={containerRef}
viewport={viewport}
layers={getLayers()}
setControlValue={props.setControlValue}
mapStyle={props.formData.mapbox_style}
mapboxApiAccessToken={props.mapboxApiKey}
width={props.width}
height={props.height}
/>
<Legend
forceCategorical
categories={categories}
format={props.formData.legend_format}
position={props.formData.legend_position}
showSingleCategory={showSingleCategory}
toggleCategory={toggleCategory}
/>
</div>
);
};

render() {
return (
<div style={{ position: 'relative' }}>
<DeckGLContainerStyledWrapper
ref={this.containerRef}
viewport={this.state.viewport}
layers={this.getLayers()}
setControlValue={this.props.setControlValue}
mapStyle={this.props.formData.mapbox_style}
mapboxApiAccessToken={this.props.mapboxApiKey}
width={this.props.width}
height={this.props.height}
/>
<Legend
forceCategorical
categories={this.state.categories}
format={this.props.formData.legend_format}
position={this.props.formData.legend_position}
showSingleCategory={this.showSingleCategory}
toggleCategory={this.toggleCategory}
/>
</div>
);
}
}
export default memo(CategoricalDeckGLContainer);
Loading