@carto/react-core/src/types.d.ts

CARTO for React - Core

import { AggregationTypes } from './operations/constants/AggregationTypes';
import { Polygon, MultiPolygon } from 'geojson';
import { SpatialIndex } from './operations/constants/SpatialIndexTypes';

export enum TILE_FORMATS {
  MVT = 'mvt',
  JSON = 'json',
  GEOJSON = 'geojson',
  BINARY = 'binary'
}

export type AggregationFunctions = Record<
  AggregationTypes,
  (
    values: Record<string, unknown>[],
    keys?: string | string[],
    joinOperation?: AggregationTypes
  ) => {}
>;

export type GroupByFeature =
  | {
      name: string;
      value: number;
    }[]
  | [];

export type HistogramFeature = {
  min?: number;
  max?: number;
  data?: number[];
  ticks?: number[];
};

export type ScatterPlotFeature = [number, number][];

export type Viewport = [number, number, number, number];

export type TileFeatures = {
  tiles?: any; // TODO: add proper deck.gl type
  viewport?: Viewport;
  geometry?: Polygon | MultiPolygon;
  uniqueIdProperty?: string;
  tileFormat: typeof TILE_FORMATS;
  geoColumName?: string;
  spatialIndex?: SpatialIndex;
  options?: { storeGeometry: boolean }
};

export type TileFeaturesResponse = Record<string, unknown>[] | [];