@flowmap.gl/data 8.0.0-y.14 → 8.0.2

package/src/selector-functions.ts

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) Flowmap.gl contributors
+ * Copyright (c) 2018-2020 Teralytics
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {WebMercatorViewport} from '@math.gl/web-mercator';
+import {
+  ClusterLevel,
+  isCluster,
+  LocationAccessors,
+  ViewportProps,
+} from './types';
+import {scaleLinear} from 'd3-scale';
+import {ClusterIndex, LocationWeightGetter} from './cluster/ClusterIndex';
+import {descending} from 'd3-array';
+
+// TODO: use re-reselect
+
+export const getViewportBoundingBox = (
+  viewport: ViewportProps,
+  maxLocationCircleSize = 0,
+): [number, number, number, number] => {
+  const pad = maxLocationCircleSize;
+  const bounds = new WebMercatorViewport({
+    ...viewport,
+    width: viewport.width + pad * 2,
+    height: viewport.height + pad * 2,
+  }).getBounds();
+  return [bounds[0][0], bounds[0][1], bounds[1][0], bounds[1][1]];
+};
+
+export const getFlowThicknessScale = (
+  magnitudeExtent: [number, number] | undefined,
+) => {
+  if (!magnitudeExtent) return undefined;
+  return scaleLinear()
+    .range([0.025, 0.5])
+    .domain([
+      0,
+      // should support diff mode too
+      Math.max.apply(
+        null,
+        magnitudeExtent.map((x: number | undefined) => Math.abs(x || 0)),
+      ),
+    ]);
+};
+
+/**
+ * Adding meaningful cluster names.
+ * NOTE: this will mutate the nodes in clusterIndex
+ */
+export function addClusterNames<L, F>(
+  clusterIndex: ClusterIndex<F>,
+  clusterLevels: ClusterLevel[],
+  locationsById: Map<string | number, L>,
+  locationAccessors: LocationAccessors<L>,
+  getLocationWeight: LocationWeightGetter,
+): void {
+  const {getLocationId, getLocationName, getLocationClusterName} =
+    locationAccessors;
+  const getName = (id: string | number) => {
+    const loc = locationsById.get(id);
+    if (loc) {
+      return getLocationName ? getLocationName(loc) : getLocationId(loc) || id;
+    }
+    return `"${id}"`;
+  };
+  for (const level of clusterLevels) {
+    for (const node of level.nodes) {
+      // Here mutating the nodes (adding names)
+      if (isCluster(node)) {
+        const leaves = clusterIndex.expandCluster(node);
+
+        leaves.sort((a, b) =>
+          descending(getLocationWeight(a), getLocationWeight(b)),
+        );
+
+        if (getLocationClusterName) {
+          node.name = getLocationClusterName(leaves);
+        } else {
+          const topId = leaves[0];
+          const otherId = leaves.length === 2 ? leaves[1] : undefined;
+          node.name = `"${getName(topId)}" and ${
+            otherId ? `"${getName(otherId)}"` : `${leaves.length - 1} others`
+          }`;
+        }
+      } else {
+        (node as any).name = getName(node.id);
+      }
+    }
+  }
+}

package/src/time.ts

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) Flowmap.gl contributors
+ * Copyright (c) 2018-2020 Teralytics
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import {timeFormat, timeParse} from 'd3-time-format';
 import {
   timeDay,

package/src/types.ts

@@ -1,6 +1,13 @@
+/*
+ * Copyright (c) Flowmap.gl contributors
+ * Copyright (c) 2018-2020 Teralytics
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 export type FlowmapData<L, F> = {
   locations: Iterable<L> | undefined;
   flows: Iterable<F> | undefined;
+  clusterLevels?: ClusterLevels;
 };
 
 export interface ViewState {
@@ -16,19 +23,19 @@ export type FlowAccessor<F, T> = (flow: F) => T; // objectInfo?: AccessorObjectI
 export type LocationAccessor<L, T> = (location: L) => T;
 
 export interface FlowAccessors<F> {
-  getFlowOriginId: FlowAccessor<F, string>;
-  getFlowDestId: FlowAccessor<F, string>;
+  getFlowOriginId: FlowAccessor<F, string | number>;
+  getFlowDestId: FlowAccessor<F, string | number>;
   getFlowMagnitude: FlowAccessor<F, number>;
   getFlowTime?: FlowAccessor<F, Date>; // TODO: use number instead of Date
   // getFlowColor?: FlowAccessor<string | undefined>;
 }
 
 export interface LocationAccessors<L> {
-  getLocationId: LocationAccessor<L, string>;
+  getLocationId: LocationAccessor<L, string | number>;
   getLocationName?: LocationAccessor<L, string>;
   getLocationLat: LocationAccessor<L, number>;
   getLocationLon: LocationAccessor<L, number>;
-  getLocationClusterName?: (locationIds: string[]) => string;
+  getLocationClusterName?: (locationIds: (string | number)[]) => string;
   // getLocationTotalIn?: LocationAccessor<number>;
   // getLocationTotalOut?: LocationAccessor<number>;
   // getLocationTotalInternal?: LocationAccessor<number>;
@@ -59,9 +66,9 @@ export interface ViewportProps {
   height: number;
   latitude: number;
   longitude: number;
-  zoom: number;
-  bearing: number;
-  pitch: number;
+  zoom?: number;
+  bearing?: number;
+  pitch?: number;
   altitude?: number;
   maxZoom?: number;
   minZoom?: number;
@@ -74,7 +81,7 @@ export interface ViewportProps {
 }
 
 export interface ClusterNode {
-  id: string;
+  id: string | number;
   zoom: number;
   lat: number;
   lon: number;
@@ -104,8 +111,8 @@ export function isLocationClusterNode<L>(l: L | ClusterNode): l is ClusterNode {
 }
 
 export interface AggregateFlow {
-  origin: string;
-  dest: string;
+  origin: string | number;
+  dest: string | number;
   count: number;
   aggregate: true;
 }
@@ -115,9 +122,9 @@ export function isAggregateFlow(
 ): flow is AggregateFlow {
   return (
     flow &&
-    flow.origin !== undefined &&
-    flow.dest !== undefined &&
-    flow.count !== undefined &&
+    // flow.origin !== undefined &&
+    // flow.dest !== undefined &&
+    // flow.count !== undefined &&
     (flow.aggregate ? true : false)
   );
 }
@@ -159,6 +166,7 @@ export interface FlowLinesLayerAttributes {
 export interface LayersData {
   circleAttributes: FlowCirclesLayerAttributes;
   lineAttributes: FlowLinesLayerAttributes;
+  locationLabels?: string[];
 }
 
 export type LayersDataAttrValues<T> = {value: T; size: number};

package/src/util.ts

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) Flowmap.gl contributors
+ * Copyright (c) 2018-2020 Teralytics
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import {createSelectorCreator, defaultMemoize} from 'reselect';
 
 export const createDebugSelector = createSelectorCreator(defaultMemoize, {