@kepler.gl/types 3.3.0-alpha.16 → 3.3.0-alpha.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/actions.d.ts CHANGED
@@ -14,6 +14,8 @@ export type ExportFileOptions = {
14
14
  isPublic?: boolean;
15
15
  overwrite?: boolean;
16
16
  mapIdToOverwrite?: string | null;
17
+ /** Download name, without extension. Separate from the map title. */
18
+ fileName?: string;
17
19
  };
18
20
  export type OnErrorCallBack = (error: Error) => any;
19
21
  export type OnSuccessCallBack = (p: {
package/layers.d.ts CHANGED
@@ -339,6 +339,7 @@ export type LayerVisConfigSettings = {
339
339
  radiusRange: VisConfigRange;
340
340
  clusterRadius: VisConfigNumber;
341
341
  clusterRadiusRange: VisConfigRange;
342
+ minClusterSize: VisConfigNumber;
342
343
  opacity: VisConfigNumber;
343
344
  coverage: VisConfigNumber;
344
345
  outline: VisConfigBoolean;
@@ -371,6 +372,7 @@ export type LayerVisConfigSettings = {
371
372
  heatmapRadius: VisConfigNumber;
372
373
  darkBaseMapEnabled: VisConfigBoolean;
373
374
  fixedHeight: VisConfigBoolean;
375
+ invertHeight: VisConfigBoolean;
374
376
  fixedElevation: VisConfigBoolean;
375
377
  allowHover: VisConfigBoolean;
376
378
  showNeighborOnHover: VisConfigBoolean;
@@ -518,6 +520,8 @@ export type VisualChannel = {
518
520
 
519
521
  // TODO: define fixed
520
522
  fixed?: any;
523
+ // visConfig key that reverses this channel's scale output (e.g. invertHeight)
524
+ invert?: string;
521
525
 
522
526
  supportedFieldTypes?: Array<SupportedFieldTypes>;
523
527
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@kepler.gl/types",
3
3
  "author": "Shan He <shan@uber.com>",
4
- "version": "3.3.0-alpha.16",
4
+ "version": "3.3.0-alpha.17",
5
5
  "description": "kepler.gl types used by kepler.gl components, actions and reducers",
6
6
  "license": "MIT",
7
7
  "types": "index.d.ts",
@@ -35,7 +35,7 @@
35
35
  "node": ">=20"
36
36
  },
37
37
  "volta": {
38
- "node": "20.19.3",
38
+ "node": "24.21.0",
39
39
  "yarn": "4.4.0"
40
40
  },
41
41
  "packageManager": "yarn@4.4.0"
package/reducers.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // SPDX-License-Identifier: MIT
2
2
  // Copyright contributors to the kepler.gl project
3
3
 
4
- import {Field, Millisecond} from './types';
4
+ import {Field, Millisecond, RGBColor} from './types';
5
5
  import {ColorMap, ColorRange, ColorUI} from './layers';
6
6
  import {MapSplitMode, MapViewMode} from '@kepler.gl/constants';
7
7
  type MapViewState = {
@@ -171,6 +171,11 @@ export type FilterBase<L extends LineChart> = {
171
171
  dataId: string[];
172
172
  id: string;
173
173
  enabled: boolean;
174
+ /**
175
+ * When true, rows that match the filter are hidden and the rest are kept.
176
+ * Undefined is treated as false so older saved maps stay unchanged.
177
+ */
178
+ inverted?: boolean;
174
179
 
175
180
  // time range filter specific
176
181
  fixedDomain: boolean;
@@ -415,6 +420,7 @@ export type TooltipInfo = BaseInteraction & {
415
420
  fieldsToShow: {
416
421
  [key: string]: TooltipField[];
417
422
  };
423
+ timezone?: string | null;
418
424
  compareMode: boolean;
419
425
  compareType: CompareType;
420
426
  };
@@ -424,6 +430,7 @@ export type Geocoder = BaseInteraction & {
424
430
  position: number[] | null;
425
431
  config: {
426
432
  limitSearch: boolean;
433
+ color: RGBColor;
427
434
  };
428
435
  };
429
436
  export type Brush = BaseInteraction & {
@@ -456,7 +463,7 @@ export type ZoomOpacityStops = {
456
463
  /** Zoom where opacity returns to 0. */
457
464
  gone: number;
458
465
  };
459
- /** Layers that share one zoom envelope. */
466
+ /** Layers and reserved map targets that share one zoom envelope. */
460
467
  export type ZoomOpacityController = {
461
468
  id: string;
462
469
  layerIds: string[];
@@ -478,8 +485,8 @@ export type InteractionConfig = {
478
485
  zoomOpacity: ZoomOpacityInteraction;
479
486
  };
480
487
  export type MapInfo = {
481
- title: string;
482
- description: string;
488
+ title?: string;
489
+ description?: string;
483
490
  };
484
491
  /** Options captured when a file load starts and forwarded to `addDataToMap`. */
485
492
  export type FileLoadingOptions = {
@@ -539,6 +546,8 @@ export declare type ExportImage = {
539
546
  legend: boolean;
540
547
  /** When true, include the charts panel in the exported image. */
541
548
  charts: boolean;
549
+ /** When true, omit the basemap and preserve transparent pixels in the exported image. */
550
+ transparentBackground?: boolean;
542
551
  mapH: number;
543
552
  mapW: number;
544
553
  imageSize: {
@@ -577,6 +586,10 @@ export type ExportMap = {
577
586
  fileName: string;
578
587
  /** When false, dataset access tokens are omitted from exported HTML and JSON. */
579
588
  includeLayerApiKeys: boolean;
589
+ /** Optional application name override for exported HTML and JSON. */
590
+ appName?: string;
591
+ /** Optional application website override for exported HTML and JSON. */
592
+ appWebsite?: string;
580
593
  };
581
594
 
582
595
  export type ExportVideo = {
@@ -623,6 +636,7 @@ export type MapControls = {
623
636
  annotation?: MapControlItem;
624
637
  chart?: MapControlItem;
625
638
  viewportJson?: MapControlItem;
639
+ mapInfo?: MapControlItem;
626
640
  sqlPanel?: MapControlItem;
627
641
  aiAssistant?: MapControlItem;
628
642
  [key: string]: MapControlItem | MapControlMapLegend | undefined;
package/schemas.d.ts CHANGED
@@ -27,6 +27,8 @@ export type SavedFilter = {
27
27
  layerId: Filter['layerId'];
28
28
  syncedWithLayerTimeline: Filter['syncedWithLayerTimeline'];
29
29
  syncTimelineMode: Filter['syncTimelineMode'];
30
+ /** Hide rows that match the filter instead of keeping them. */
31
+ inverted?: boolean;
30
32
  };
31
33
  export type MinSavedFilter = RequireFrom<SavedFilter, 'dataId' | 'id' | 'name' | 'type' | 'value'>;
32
34
  export type ParsedFilter = SavedFilter | MinSavedFilter;
@@ -38,6 +40,7 @@ export type SavedInteractionConfig = {
38
40
  geocoder: {
39
41
  enabled: boolean;
40
42
  limitSearch?: boolean;
43
+ color?: RGBColor;
41
44
  };
42
45
  brush: InteractionConfig['brush']['config'] & {
43
46
  enabled: boolean;
@@ -174,6 +177,10 @@ export type ParsedUiState = {
174
177
  chart?: {
175
178
  active?: boolean;
176
179
  };
180
+ mapInfo?: {
181
+ active?: boolean;
182
+ show?: boolean;
183
+ };
177
184
  };
178
185
  locale?: string;
179
186
  theme?: string;
@@ -289,9 +296,19 @@ export type SavedMap = {
289
296
  info: {
290
297
  app: string;
291
298
  created_at: string;
292
- title: string;
293
- description: string;
299
+ title?: string;
300
+ description?: string;
301
+ source?: string;
302
+ appName?: string;
303
+ appWebsite?: string;
294
304
  };
295
305
  };
296
306
 
297
- export type LoadedMap = {datasets?: ParsedDataset[] | null; config?: ParsedConfig | null};
307
+ export type LoadedMap = {
308
+ datasets?: ParsedDataset[] | null;
309
+ config?: ParsedConfig | null;
310
+ info?: {
311
+ title?: string;
312
+ description?: string;
313
+ };
314
+ };