Skip to content

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

[Chore]: Technical: add types for filters side panel (#1799)

dariaterekhovaae0d3c98c8eccf
diff --git a/src/components/side-panel/filter-panel/filter-panel-header.js b/src/components/side-panel/filter-panel/filter-panel-header.tsx
similarity index 80%
rename from src/components/side-panel/filter-panel/filter-panel-header.js
rename to src/components/side-panel/filter-panel/filter-panel-header.tsx
index e246ada39..0689ebf08 100644
--- a/src/components/side-panel/filter-panel/filter-panel-header.js
+++ b/src/components/side-panel/filter-panel/filter-panel-header.tsx
@@ -18,12 +18,14 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React from 'react';
+import React, {ComponentType} from 'react';
import styled from 'styled-components';
import PanelHeaderActionFactory from 'components/side-panel/panel-header-action';
import {Trash} from 'components/common/icons';
import {createLinearGradient} from 'utils/color-utils';
import {StyledPanelHeader} from 'components/common/styled-components';
+import {FilterPanelProps} from 'components/filters/filter-panels/filter-panel-types';
+import KeplerTable from 'utils/table-utils/kepler-table';
export const StyledFilterHeader = styled(StyledPanelHeader)`
cursor: pointer;
@@ -34,7 +36,7 @@ export const StyledFilterHeader = styled(StyledPanelHeader)`
}
border-left: 3px solid;
- ${props =>
+ ${(props: {labelRCGColorValues: KeplerTable['color'][]}) =>
props.labelRCGColorValues && props.labelRCGColorValues.length > 0
? `border-image: ${createLinearGradient('bottom', props.labelRCGColorValues)} 3;`
: 'border-color: transparent;'};
@@ -45,25 +47,28 @@ const StyledChildrenContainer = styled.div`
flex: 2;
`;
+interface FilterPanelHeaderProps extends FilterPanelProps {
+ children: React.ReactNode;
+ enlarged?: boolean;
+ actionIcons?: Record<string, ComponentType>;
+}
+
FilterPanelHeaderFactory.deps = [PanelHeaderActionFactory];
-function FilterPanelHeaderFactory(PanelHeaderAction) {
+function FilterPanelHeaderFactory(PanelHeaderAction: ReturnType<typeof PanelHeaderActionFactory>) {
const defaultActionIcons = {
delete: Trash
};
const FilterPanelHeader = ({
children,
datasets,
- allAvailableFields,
- setFilter,
- idx,
filter,
removeFilter,
actionIcons = defaultActionIcons
- }) => (
+ }: FilterPanelHeaderProps) => (
<StyledFilterHeader
className="filter-panel__header"
- labelRCGColorValues={datasets.map(d => d.color)}
+ labelRCGColorValues={datasets.map((d: KeplerTable) => d.color)}
>
<StyledChildrenContainer>{children}</StyledChildrenContainer>
<PanelHeaderAction
diff --git a/src/components/side-panel/filter-panel/filter-panel.js b/src/components/side-panel/filter-panel/filter-panel.tsx
similarity index 75%
rename from src/components/side-panel/filter-panel/filter-panel.js
rename to src/components/side-panel/filter-panel/filter-panel.tsx
index 4328b848b..013d2de76 100644
--- a/src/components/side-panel/filter-panel/filter-panel.js
+++ b/src/components/side-panel/filter-panel/filter-panel.tsx
@@ -19,7 +19,6 @@
// THE SOFTWARE.
import React, {Component} from 'react';
-import PropTypes from 'prop-types';
import {createSelector} from 'reselect';
import styled from 'styled-components';
import get from 'lodash.get';
@@ -32,11 +31,19 @@ import MultiSelectFilterPanelFactory from 'components/filters/filter-panels/mult
import RangeFilterPanelFactory from 'components/filters/filter-panels/range-filter-panel';
import PolygonFilterPanelFactory from 'components/filters/filter-panels/polygon-filter-panel';
+import {Filter} from 'reducers/vis-state-updaters';
+import {Field} from 'utils/table-utils/kepler-table';
+import {FilterPanelProps} from 'components/filters/filter-panels/filter-panel-types';
+
const StyledFilterPanel = styled.div`
margin-bottom: 12px;
border-radius: 1px;
`;
+interface FilterPanelPropsImpl extends Omit<FilterPanelProps, 'allAvailableFields'> {
+ filters: Filter[];
+}
+
FilterPanelFactory.deps = [
NewFilterPanelFactory,
TimeRangeFilterPanelFactory,
@@ -47,12 +54,12 @@ FilterPanelFactory.deps = [
];
function FilterPanelFactory(
- NewFilterPanel,
- TimeRangeFilterPanel,
- SingleSelectFilterPanel,
- MultiSelectFilterPanel,
- RangeFilterPanel,
- PolygonFilterPanel
+ NewFilterPanel: ReturnType<typeof NewFilterPanelFactory>,
+ TimeRangeFilterPanel: ReturnType<typeof TimeRangeFilterPanelFactory>,
+ SingleSelectFilterPanel: ReturnType<typeof SingleSelectFilterPanelFactory>,
+ MultiSelectFilterPanel: ReturnType<typeof MultiSelectFilterPanelFactory>,
+ RangeFilterPanel: ReturnType<typeof RangeFilterPanelFactory>,
+ PolygonFilterPanel: ReturnType<typeof PolygonFilterPanelFactory>
) {
const FilterPanelComponents = {
default: NewFilterPanel,
@@ -63,23 +70,9 @@ function FilterPanelFactory(
[FILTER_TYPES.polygon]: PolygonFilterPanel
};
- return class FilterPanel extends Component {
- static propTypes = {
- idx: PropTypes.number,
- filters: PropTypes.arrayOf(PropTypes.any).isRequired,
- filter: PropTypes.object.isRequired,
- setFilter: PropTypes.func.isRequired,
- removeFilter: PropTypes.func.isRequired,
- enlargeFilter: PropTypes.func.isRequired,
- toggleAnimation: PropTypes.func.isRequired,
- toggleFilterFeature: PropTypes.func.isRequired,
- datasets: PropTypes.object,
- showDatasetTable: PropTypes.func,
- isAnyFilterAnimating: PropTypes.bool
- };
-
+ return class FilterPanel extends Component<FilterPanelPropsImpl> {
/* selectors */
- fieldsSelector = props => {
+ fieldsSelector = (props: FilterPanelPropsImpl) => {
const datasetId = props.filter.dataId[0];
if (!datasetId) {
return [];
@@ -87,9 +80,9 @@ function FilterPanelFactory(
return get(props, ['datasets', datasetId, 'fields'], []);
};
- filterSelector = props => props.filters;
- nameSelector = props => props.filter.name;
- dataIdSelector = props => props.filter.dataId[0];
+ filterSelector = (props: FilterPanelPropsImpl) => props.filters;
+ nameSelector = (props: FilterPanelPropsImpl) => props.filter.name;
+ dataIdSelector = (props: FilterPanelPropsImpl) => props.filter.dataId[0];
// only show current field and field that's not already been used as a filter
availableFieldsSelector = createSelector(
@@ -99,10 +92,11 @@ function FilterPanelFactory(
this.dataIdSelector,
(fields, filters, name, dataId) =>
fields.filter(
- f =>
+ (f: Field) =>
f.type &&
f.type !== ALL_FIELD_TYPES.geojson &&
- (f.name === name || !filters.find(d => d.name === f.name && d.dataId === dataId))
+ (name.includes(f.name) ||
+ !filters.find(d => d.name.includes(f.name) && d.dataId.includes(dataId)))
)
);