@carto/kepler.gl 0.0.1-alpha.map-libre

package/src/layers/index.d.ts

@@ -0,0 +1,126 @@
+import {RGBColor, RGBAColor} from '../reducers/types';
+import {Field, Datasets, KeplerTable} from '../reducers/vis-state-updaters';
+import {LayerTextLabel, ColorRange, ColorUI, LayerVisConfig} from './layer-factory';
+
+export enum PopupEvent {
+  Hover = 'hover',
+  Click = 'click'
+}
+
+export type LayerColumns = {
+  [key: string]: {value: string | null; fieldIdx: number; optional?: boolean};
+};
+export type VisualChannelDomain = number[] | string[];
+export type VisualChannelField = Field | null;
+
+export interface PopupFormatSettings {
+  fields: PopupField[];
+  style: PopupStyle;
+  templateMode?: boolean;
+  template?: string;
+  templateEdited?: boolean;
+}
+
+export type LayerConfig = {
+  dataId: string | null;
+  label: string;
+  color: RGBColor;
+
+  columns: LayerColumns;
+  isVisible: boolean;
+  isConfigActive: boolean;
+  highlightColor: RGBColor | RGBAColor;
+  hidden: boolean;
+  visibilityByZoom: {min: number; max: number};
+
+  colorField: VisualChannelField;
+  colorDomain: VisualChannelDomain;
+  colorScale: string;
+
+  // color by size, domain is set by filters, field, scale type
+  sizeDomain: VisualChannelDomain;
+  sizeScale: string;
+  sizeField: VisualChannelField;
+  radiusField: VisualChannelField | undefined;
+
+  visConfig: LayerVisConfig;
+  textLabel: LayerTextLabel[];
+
+  colorUI: {
+    color: ColorUI;
+    colorRange: ColorUI;
+  };
+  animation: {
+    enabled: boolean;
+  };
+};
+
+export type VisualChannel = {
+  property: string;
+  field: string;
+  scale: string;
+  domain: string;
+  range: string;
+  key: string;
+  channelScaleType: string;
+  nullValue: any;
+  defaultMeasure: any;
+  accessor?: string;
+  condition?: (config: any) => boolean;
+  getAttributeValue?: (config: any) => (d: any) => any;
+};
+
+export type VisualChannelDescription = {
+  label: string;
+  measure: string;
+};
+
+export class Layer {
+  constructor(
+    prop?: {
+      id?: string;
+    } & Partial<LayerConfig>
+  );
+  id: string;
+  type: string;
+  config: LayerConfig;
+  visConfigSettings: any;
+  visualChannels: {[key: string]: VisualChannel};
+  _oldDataUpdateTriggers: any;
+  _interactivitySettings?: { enabled: boolean, [PopupEvent.Click]?: PopupFormatSettings, [PopupEvent.Hover]?: PopupFormatSettings };
+  hasTooltip: boolean;
+  hasInteractivity: boolean;
+  hasAllColumns(): boolean;
+  updateLayerConfig(p: Partial<LayerConfig>): Layer;
+  updateLayerDomain(datasets: Datasets, filter?: Filter): Layer;
+  updateLayerVisualChannel(dataset: KeplerTable, channel: string): Layer;
+  shouldCalculateLayerData(props: string[]): boolean;
+  formatLayerData(datasets: Datasets, oldLayerData?: any);
+  updateLayerColorUI(prop: string, newConfig: Partial<ColorUI>): Layer;
+  isValidToSave(): boolean;
+  validateVisualChannel(channel: string);
+  getVisualChannelDescription(key: string): {label: string, measure: string};
+
+  static findDefaultLayerProps(dataset: KeplerTable, foundLayers?: any[]);
+  // static findDefaultColumnField(defaultFields, allFields)
+}
+
+export type LayerClassesType = {
+  point: Layer;
+  arc: Layer;
+  line: Layer;
+  grid: Layer;
+  hexagon: Layer;
+  geojson: Layer;
+  cluster: Layer;
+  icon: Layer;
+  heatmap: Layer;
+  hexagonId: Layer;
+  '3D': Layer;
+  trip: Layer;
+  s2: Layer;
+};
+export const LayerClasses: LayerClassesType;
+
+export type OVERLAY_TYPE = {[key: string]: string}
+export const LAYER_ID_LENGTH: number;

package/src/layers/index.js

@@ -0,0 +1,72 @@
+// Copyright (c) 2022 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import {default as PointLayer} from './point-layer/point-layer';
+import {default as ArcLayer} from './arc-layer/arc-layer';
+import {default as LineLayer} from './line-layer/line-layer';
+import {default as GridLayer} from './grid-layer/grid-layer';
+import {default as HexagonLayer} from './hexagon-layer/hexagon-layer';
+import {default as GeojsonLayer} from './geojson-layer/geojson-layer';
+import {default as ClusterLayer} from './cluster-layer/cluster-layer';
+import {default as IconLayer} from './icon-layer/icon-layer';
+import {default as HeatmapLayer} from './heatmap-layer/heatmap-layer';
+import {default as H3Layer} from './h3-hexagon-layer/h3-hexagon-layer';
+import {default as ScenegraphLayer} from './scenegraph-layer/scenegraph-layer';
+import {default as TripLayer} from './trip-layer/trip-layer';
+import {default as S2GeometryLayer} from './s2-geometry-layer/s2-geometry-layer';
+import {LAYER_TYPES} from './types';
+
+// base layer
+export {default as Layer, OVERLAY_TYPE, LAYER_ID_LENGTH, colorMaker} from './base-layer';
+
+// individual layers
+export const KeplerGlLayers = {
+  PointLayer,
+  ArcLayer,
+  LineLayer,
+  GridLayer,
+  HexagonLayer,
+  GeojsonLayer,
+  ClusterLayer,
+  IconLayer,
+  HeatmapLayer,
+  H3Layer,
+  ScenegraphLayer,
+  TripLayer,
+  S2GeometryLayer
+};
+
+export const LayerClasses = {
+  [LAYER_TYPES.point]: PointLayer,
+  [LAYER_TYPES.arc]: ArcLayer,
+  [LAYER_TYPES.line]: LineLayer,
+  [LAYER_TYPES.grid]: GridLayer,
+  [LAYER_TYPES.hexagon]: HexagonLayer,
+  [LAYER_TYPES.geojson]: GeojsonLayer,
+  [LAYER_TYPES.cluster]: ClusterLayer,
+  [LAYER_TYPES.icon]: IconLayer,
+  [LAYER_TYPES.heatmap]: HeatmapLayer,
+  [LAYER_TYPES.hexagonId]: H3Layer,
+  [LAYER_TYPES['3D']]: ScenegraphLayer,
+  [LAYER_TYPES.trip]: TripLayer,
+  [LAYER_TYPES.s2]: S2GeometryLayer
+};
+
+export {LAYER_VIS_CONFIGS} from './layer-factory';

package/src/layers/layer-factory.d.ts

@@ -0,0 +1,148 @@
+import {RGBColor, RGBAColor, HexColor, Field} from 'reducers';
+
+export type ColorRange = {
+  name: string;
+  type: string;
+  category: string;
+  colors: HexColor[];
+  reversed?: boolean;
+  colorMap?: Map | object;
+};
+
+export type LayerTextLabel = {
+  field: Field | null;
+  color: RGBColor;
+  size: number;
+  offset: [number, number];
+  anchor: string;
+  alignment: string;
+};
+
+export type ColorUI = {
+  // customPalette in edit
+  customPalette: ColorRange;
+  // show color sketcher modal
+  showSketcher: boolean;
+  // show color range selection panel
+  showDropdown: boolean;
+  // color range selector config
+  colorRangeConfig: {
+    type: string;
+    steps: number;
+    reversed: boolean;
+    custom: boolean;
+  };
+};
+
+export type VisConfig = {
+  label: string | ((config: LayerConfig) => string);
+  group: string;
+  property: string;
+  description?: string;
+  condition?: (config: LayerConfig) => boolean;
+};
+
+export type VisConfigNumber = VisConfig & {
+  type: 'number';
+  isRanged: false;
+  defaultValue: number;
+  range: [number, number];
+  step: number;
+};
+
+export type VisConfigBoolean = VisConfig & {
+  type: 'boolean';
+  defaultValue: boolean;
+};
+
+export type VisConfigSelection = VisConfig & {
+  type: 'select';
+  defaultValue: string;
+  options: string[];
+};
+
+export type VisConfigRange = VisConfig & {
+  type: 'number';
+  isRanged: boolean;
+  range: [number, number];
+  defaultValue: [number, number];
+  step: number;
+};
+
+export type VisConfigColorSelect = VisConfig & {
+  type: 'color-select';
+  defaultValue: null;
+};
+
+export type VisConfigColorRange = VisConfig & {
+  type: 'color-range-select';
+  defaultValue: ColorRange;
+};
+
+export type LayerVisConfig = {
+  thickness: VisConfigNumber;
+  strokeWidthRange: VisConfigRange;
+  trailLength: VisConfigNumber;
+  radius: VisConfigNumber;
+  radiusRange: VisConfigRange;
+  clusterRadius: VisConfigNumber;
+  clusterRadiusRange: VisConfigRange;
+  opacity: VisConfigNumber;
+  coverage: VisConfigNumber;
+  outline: VisConfigBoolean;
+  colorRange: VisConfigColorRange;
+  strokeColorRange: VisConfigColorRange;
+  targetColor: VisConfigColorSelect;
+  strokeColor: VisConfigColorSelect;
+  aggregation: VisConfigSelect;
+  sizeAggregation: VisConfigSelect;
+  percentile: VisConfigRange;
+  elevationPercentile: VisConfigRange;
+  resolution: VisConfigNumber;
+  sizeScale: VisConfigNumber;
+  angle: VisConfigNumber;
+  worldUnitSize: VisConfigNumber;
+  elevationScale: VisConfigNumber;
+  enableElevationZoomFactor: VisConfigBoolean;
+  elevationRange: VisConfigRange;
+  heightRange: VisConfigRange;
+  coverageRange: VisConfigRange;
+  'hi-precision': VisConfigBoolean;
+  enable3d: VisConfigBoolean;
+  stroked: VisConfigBoolean;
+  filled: VisConfigBoolean;
+  extruded: VisConfigBoolean;
+  wireframe: VisConfigBoolean;
+  weight: VisConfigNumber;
+  heatmapRadius: VisConfigNumber;
+};
+
+export type TextConfigSelect = {
+  type: 'select';
+  options: string[];
+  multiSelect: boolean;
+  searchable: boolean;
+};
+export type TextConfigNumber = {
+  type: 'number';
+  range: number[];
+  value0: number;
+  step: number;
+  isRanged: boolean;
+  label: string;
+  showInput: boolean;
+};
+export type LayerTextConfig = {
+  fontSize: TextConfigNumber;
+  textAnchor: TextConfigSelect;
+  textAlignment: TextConfigSelect;
+};
+
+export const DEFAULT_TEXT_LABEL: LayerTextLabel;
+export const DEFAULT_CUSTOM_PALETTE: ColorRange;
+export const DEFAULT_COLOR_UI: ColorUI;
+export const DEFAULT_HIGHLIGHT_COLOR: RGBAColor;
+export const DEFAULT_LAYER_LABEL: string;
+export const LAYER_VIS_CONFIGS: LayerVisConfig;
+export const LAYER_TEXT_CONFIGS: LayerTextConfig;
+export const UNKNOWN_COLOR_KEY: string;