Skip to content

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

[Chore] Export more type def (#1890)

Igor Dykhta8d35d9b8331f
diff --git a/src/components/common/data-table/cell-size.ts b/src/components/common/data-table/cell-size.ts
index 2d214edcf..0ef09103d 100644
--- a/src/components/common/data-table/cell-size.ts
+++ b/src/components/common/data-table/cell-size.ts
@@ -20,12 +20,34 @@
import document from 'global/document';
import {parseFieldValue} from 'utils/data-utils';
-
-const MIN_GHOST_CELL_SIZE = 200;
+import {DataContainerInterface} from 'utils/table-utils/data-container-interface';
+
+const MIN_GHOST_CELL_SIZE: number = 200;
+
+type RenderSizeParam = {
+ text: {dataContainer: DataContainerInterface; column: string};
+ type?: string;
+ colIdx: number;
+ numRowsToCalculate?: number;
+ fontSize?: number;
+ font?: string;
+ cellPadding?: number;
+ maxCellSize?: number;
+ maxHeaderSize?: number;
+ minCellSize?: number;
+ optionsButton?: number;
+};
+
+export type CellSizeCache = {
+ [key: string]: {
+ row: number;
+ header: number;
+ };
+};
/**
* Measure rows and column content to determine min width for each column
- * @param {*} param0
+ * @param {RenderSizeParam} param0
*/
export function renderedSize({
text: {dataContainer, column},
@@ -39,7 +61,7 @@ export function renderedSize({
maxHeaderSize = 150,
minCellSize = 45,
optionsButton = 30
-}) {
+}: RenderSizeParam): {row: number; header: number} {
if (!document) {
return {
row: 0,
@@ -94,7 +116,7 @@ function getColumnOrder(pinnedColumns: string[] = [], unpinnedColumns: string[]
return [...pinnedColumns, ...unpinnedColumns];
}
-function getMinCellSize(cellSizeCache) {
+function getMinCellSize(cellSizeCache: CellSizeCache) {
return Object.keys(cellSizeCache).reduce(
(accu, col) => ({
...accu,
@@ -114,17 +136,20 @@ function getSizeSum(sizeCache, key) {
/**
* Expand cell to fit both row and header, if there is still room left,
* expand last cell to fit the entire width of the container
- * @param {object} cellSizeCache
+ * @param {CellSizeCache} cellSizeCache
* @param {string[]} columnOrder
* @param {number} containerWidth
* @param {number} roomToFill
*/
function expandCellSize(
- cellSizeCache: object,
+ cellSizeCache: CellSizeCache,
columnOrder: string[],
containerWidth: number,
roomToFill: number
-) {
+): {
+ cellSizeCache: CellSizeCache;
+ ghost: number | null;
+} {
let remaining = roomToFill;
const expandedCellSize = columnOrder.reduce((accu, col) => {
@@ -163,16 +188,19 @@ function expandCellSize(
/**
* Adjust cell size based on container width
* @param {number} containerWidth
- * @param {Object} cellSizeCache
+ * @param {CellSizeCache} cellSizeCache
* @param {string[]} pinnedColumns
* @param {string[]} unpinnedColumns
*/
export function adjustCellsToContainer(
containerWidth: number,
- cellSizeCache: object,
+ cellSizeCache: CellSizeCache,
pinnedColumns: string[],
unpinnedColumns: string[]
-) {
+): {
+ cellSizeCache: CellSizeCache;
+ ghost?: number | null;
+} {
const minRowSum = getSizeSum(cellSizeCache, 'row');
if (minRowSum >= containerWidth) {
// we apply the min Width to all cells
diff --git a/src/components/common/data-table/index.tsx b/src/components/common/data-table/index.tsx
index 51da236f6..c8c71ea3f 100644
--- a/src/components/common/data-table/index.tsx
+++ b/src/components/common/data-table/index.tsx
@@ -27,6 +27,7 @@ import get from 'lodash.get';
import debounce from 'lodash.debounce';
import OptionDropdown from './option-dropdown';
+import {CellSizeCache} from './cell-size';
import Grid from './grid';
import Button from './button';
@@ -226,6 +227,20 @@ export const Container = styled.div`
const defaultColumnWidth = 200;
+export type ColMeta = {
+ [key: string]: {
+ colIdx: number;
+ name: string;
+ displayName: string;
+ type: string;
+ };
+};
+
+export type SortColumn = {
+ column?: string;
+ mode?: string;
+};
+
const columnWidthFunction = (columns, cellSizeCache, ghost?) => ({index}) => {
return (columns[index] || {}).ghost ? ghost : cellSizeCache[columns[index]] || defaultColumnWidth;
};
@@ -338,8 +353,6 @@ export const TableSection = ({
</AutoSizer>
);
-type CellSizeCache = {[id: string]: number};
-
interface DataTableProps {
cellSizeCache?: CellSizeCache;
pinnedColumns?: string[];
@@ -348,16 +361,11 @@ interface DataTableProps {
theme?: any;
dataContainer: DataContainerInterface;
fixedHeight?: number;
- colMeta: {
- [id: string]: {
- name: string;
- type: string;
- };
- };
- sortColumn?: {[id: string]: string};
- sortTableColumn: (id: string, mode?: string) => void;
- pinTableColumn: (id: string) => void;
- copyTableColumn: (id: string) => void;
+ colMeta: ColMeta;
+ sortColumn?: SortColumn;
+ sortTableColumn: (column: string, mode?: string) => void;
+ pinTableColumn: (column: string) => void;
+ copyTableColumn: (column: string) => void;
sortOrder?: number[] | null;
}
@@ -581,7 +589,7 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {
? [...unpinnedColumns, {ghost: true} as string & {ghost: boolean}]
: unpinnedColumns;
const pinnedColumnsWidth = pinnedColumns.reduce(
- (acc, val) => acc + get(cellSizeCache, val, 0),
+ (acc, val) => acc + (get(cellSizeCache, val, 0) as number),
0
);
diff --git a/src/components/common/field-token.tsx b/src/components/common/field-token.tsx
index fe27cb99b..c2f99592d 100644
--- a/src/components/common/field-token.tsx
+++ b/src/components/common/field-token.tsx
@@ -22,10 +22,14 @@ import React from 'react';
import styled from 'styled-components';
import {FIELD_TYPE_DISPLAY, FIELD_COLORS} from '@kepler.gl/constants';
+export type FieldTokenProps = {
+ type: string;
+};
+
function FieldTokenFactory(
fieldTypeDisplay: ReturnType<typeof getFieldTypes>,
fieldColors: ReturnType<typeof getFieldColors>
-) {
+): React.FC<FieldTokenProps> {
const FieldTag = styled.div`
background-color: rgba(${props => props.color}, 0.2);
border-radius: 2px;
@@ -40,7 +44,7 @@ function FieldTokenFactory(
line-height: 20px;
`;
- const FieldToken = ({type}) => (
+ const FieldToken = ({type}: FieldTokenProps) => (
<FieldTag
color={(fieldTypeDisplay[type] && fieldTypeDisplay[type].color) || fieldColors.default}
>
diff --git a/src/components/common/item-selector/item-selector.d.ts b/src/components/common/item-selector/item-selector.d.ts
deleted file mode 100644
index 814bb3a6c..000000000
--- a/src/components/common/item-selector/item-selector.d.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-import {FunctionComponent, ComponentType} from 'react';
-
-export type ItemSelectorProps = {
- selectedItems: ReadonlyArray<string | number | boolean | object>;
- options: ReadonlyArray<string | number | boolean | object>;
- onChange: (items: ReadonlyArray<string | number | boolean | object>) => void;
- fixedOptions?: any[];
- erasable?: boolean;
- showArrow?: boolean;
- searchable?: boolean;
- displayOption?: string | ((opt: any) => any);
- getOptionValue?: string | ((opt: any) => any);
- filterOption?: string | ((opt: any) => any);
- placement?: string;
- disabled?: boolean;
- isError?: boolean;
- multiSelect?: boolean;
- inputTheme?: string;
- size?: string;
- onBlur?: () => void;
- placeholder?: string;
- closeOnSelect?: boolean;
- typeaheadPlaceholder?: string;
- DropdownHeaderComponent?: ComponentType<any> | null;
- DropDownRenderComponent?: ComponentType<any>;
- DropDownLineItemRenderComponent?: ComponentType<any>;
- CustomChickletComponent?: ComponentType<any>;
-};
-
-const ItemSelector: FunctionComponent<ItemSelectorProps>;
-export default ItemSelector;
diff --git a/src/components/common/item-selector/item-selector.tsx b/src/components/common/item-selector/item-selector.tsx
index 68ba4be30..5af3c43bc 100644
--- a/src/components/common/item-selector/item-selector.tsx
+++ b/src/components/common/item-selector/item-selector.tsx
@@ -115,7 +115,7 @@ const DropdownWrapper = styled.div<DropdownWrapperProps>`
props.placement === 'top' ? `${props.theme.dropdownWapperMargin}px` : 'auto'};
`;
-type ItemSelectorProps = {
+export type ItemSelectorProps = {
selectedItems?:
| ReadonlyArray<string | number | boolean | object>
| string
diff --git a/src/components/side-panel/common/dataset-tag.tsx b/src/components/side-panel/common/dataset-tag.tsx
index 9a57c9b8c..46953a397 100644
--- a/src/components/side-panel/common/dataset-tag.tsx
+++ b/src/components/side-panel/common/dataset-tag.tsx
@@ -57,7 +57,7 @@ const UpdateTableColor = ({children, id}: UpdateTableColorTypes) => (
</DatasetColorPicker>
);
-export default function DatasetTagFactory() {
+export default function DatasetTagFactory(): React.FC<DatasetTagProps> {
const DatasetTag = ({onClick, onClickSquare, dataset, updateTableColor, id}: DatasetTagProps) => (
<DatasetTagWrapper className="source-data-tag">
<UpdateTableColor id={dataset.id}>
diff --git a/src/components/side-panel/common/source-data-selector.tsx b/src/components/side-panel/common/source-data-selector.tsx
index 0a6eaef99..c7e86b065 100644
--- a/src/components/side-panel/common/source-data-selector.tsx
+++ b/src/components/side-panel/common/source-data-selector.tsx
@@ -18,73 +18,69 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import React, {Component} from 'react';
-import {createSelector} from 'reselect';
-
+import React, {useMemo} from 'react';
import {PanelLabel, SidePanelSection} from 'components/common/styled-components';
import ItemSelector from 'components/common/item-selector/item-selector';
import DatasetTagFactory from 'components/side-panel/common/dataset-tag';
import {FormattedMessage} from '@kepler.gl/localization';
import {DatasetItemProps, SourceDataSelectorProps} from './types';
-const defaultPlaceHolder = 'Select A Data Source';
+const defaultPlaceHolder = 'Select A Dataset';
SourceDataSelectorFactory.deps = [DatasetTagFactory];
export default function SourceDataSelectorFactory(
DatasetTag: ReturnType<typeof DatasetTagFactory>
-): React.ComponentType<SourceDataSelectorProps> {
+): React.FC<SourceDataSelectorProps> {
const DatasetItem = ({value}: DatasetItemProps) => <DatasetTag dataset={value} />;
- class SourceDataSelector extends Component<SourceDataSelectorProps> {
- static defaultProps = {
- defaultValue: defaultPlaceHolder
- };
-
- /* selectors */
- dataIdSelector = (props: SourceDataSelectorProps) => props.dataId;
- datasetsSelector = (props: SourceDataSelectorProps) => props.datasets;
- dsOptionsSelector = createSelector(this.datasetsSelector, datasets =>
- Object.values(datasets).map(ds => ({
- label: ds.label,
- value: ds.id,
- color: ds.color
- }))
- );
- dsSelectedItemsSelector = createSelector(
- this.dataIdSelector,
- this.datasetsSelector,
- (dataId, datasets) =>
- dataId ? ((Array.isArray(dataId) && dataId) || [dataId]).map(id => datasets[id]) : []
+ const SourceDataSelector: React.FC<SourceDataSelectorProps> = ({
+ dataId,
+ datasets,
+ disabled,
+ onSelect,
+ defaultValue,
+ inputTheme
+ }: SourceDataSelectorProps) => {
+ const dsOptions = useMemo(
+ () =>
+ Object.values(datasets).map(ds => ({
+ label: ds.label,
+ value: ds.id,
+ color: ds.color
+ })),
+ [datasets]
);
- render() {
- const {disabled, onSelect, defaultValue, inputTheme} = this.props;
- const dsOptions = this.dsOptionsSelector(this.props);
- const selectedItems = this.dsSelectedItemsSelector(this.props);
+ const selectedItems = useMemo(
+ () => (dataId ? ((Array.isArray(dataId) && dataId) || [dataId]).map(id => datasets[id]) : []),
+ [dataId, datasets]
+ );
- return (
- <SidePanelSection className="data-source-selector">
- <PanelLabel>
- <FormattedMessage id={'misc.dataSource'} />
- </PanelLabel>
- <ItemSelector
- inputTheme={inputTheme}
- selectedItems={selectedItems}
- options={dsOptions}
- getOptionValue={'value'}
- filterOption={'label'}
- multiSelect={false}
- onChange={onSelect}
- placeholder={defaultValue}
- disabled={Boolean(disabled)}
- displayOption={'label'}
- DropDownLineItemRenderComponent={DatasetItem}
- />
- </SidePanelSection>
- );
- }
- }
+ return (
+ <SidePanelSection className="data-source-selector">
+ <PanelLabel>
+ <FormattedMessage id={'misc.dataSource'} />
+ </PanelLabel>
+ <ItemSelector
+ inputTheme={inputTheme}
+ selectedItems={selectedItems}
+ options={dsOptions}
+ getOptionValue={'value'}
+ filterOption={'label'}
+ multiSelect={false}
+ onChange={onSelect}
+ placeholder={defaultValue}
+ disabled={Boolean(disabled)}
+ displayOption={'label'}
+ DropDownLineItemRenderComponent={DatasetItem}
+ />
+ </SidePanelSection>
+ );
+ };
+ SourceDataSelector.defaultProps = {
+ defaultValue: defaultPlaceHolder
+ };
return SourceDataSelector;
}
diff --git a/src/components/side-panel/common/types.ts b/src/components/side-panel/common/types.ts
index 123503103..24a785ee1 100644
--- a/src/components/side-panel/common/types.ts
+++ b/src/components/side-panel/common/types.ts
@@ -61,9 +61,9 @@ export type DatasetItemProps = {
export type SourceDataSelectorProps = {
dataId: string | string[] | null;
datasets: Datasets;
- disabled: boolean;
+ disabled?: boolean;
defaultValue?: string;
- inputTheme: string;
+ inputTheme?: string;
onSelect: (
items:
| ReadonlyArray<string | number | boolean | object>