Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/teralytics/flowmap.gl

Flow map drawing layer for deck.gl
https://github.com/teralytics/flowmap.gl

Last synced: 3 months ago
JSON representation

Flow map drawing layer for deck.gl

Awesome Lists containing this project

README 

        
# flowmap.gl



## IMPORTANT: This repository is in maintenance-only mode. 



## > [The next version of the library is being developed here](https://github.com/FlowmapBlue/flowmap.gl) <



[Flow map](https://en.wikipedia.org/wiki/Flow_map) drawing layer for [deck.gl](http://uber.github.io/deck.gl). Can be used for visualizing movement of people (e.g. migration) or objects between geographic locations. The layer is rendered in WebGL and can handle large numbers of flows with a good rendering performance.



Try [flowmap.blue](https://flowmap.blue/) for an easy way of publishing a flow map backed by a Google Sheets spreadsheet (no programming skills required).



Check out the [live examples Storybook](https://teralytics.github.io/flowmap.gl/index.html) or the minimal example apps: [with React](https://github.com/ilyabo/flowmap.gl-example), [without React](https://github.com/ilyabo/flowmap.gl-purejs-example/).






## Features



Given an array of locations and an array of flows between these locations the layer will do the following:



- Represent the flows as lines of varying thickness depending on the flow magnitudes

- The flow lines are sorted so that the larger flows are drawn above

- GeoJSON geometries of the location areas are rendered as polygons

- Total incoming and outgoing flows for the locations are calculated and represented as circles of varying sizes.



### Location totals

Both the incoming and outgoing totals for the locations are represented.

A darker outline means that there are more incoming flows, a lighter outline means that there are more outgoing flows.



For instance, below we compare between the evening and the morning commuting behaviors of a large city:






### Difference mode

The layer can be used to show the [difference between two moments in time](https://teralytics.github.io/flowmap.gl/index.html?path=/story/basic--difference-mode).



## Usage

First install the required dependencies:



```

npm install @flowmap.gl/core deck.gl react-map-gl

```



Then, you can either use as a deck.gl layer or flowmap.gl as a React component:



###  Usage as a deck.gl layer



With this approach you can use flowmap.gl together with other deck.gl layers.



```jsx harmony

import { StaticMap } from 'react-map-gl';

import { DeckGL } from 'deck.gl';

import FlowMapLayer from '@flowmap.gl/core';             

import * as ReactDOM from 'react-dom';



ReactDOM.render(

   flow.count || 0,

        getFlowOriginId: (flow) => flow.origin,

        getFlowDestId: (flow) => flow.dest,

        getLocationId: (loc) => loc.id,

        getLocationCentroid: (location) => [location.lon, location.lat],

      })

    ]}

  >

    

  ,

  document.body

)

```



###  Usage as a React component



Install this additional dependency:

```

npm install @flowmap.gl/react

```



```jsx harmony



import FlowMap, { getViewStateForLocations } from '@flowmap.gl/react'



const MapVis = ({ width, height }) =>

    


         l.properties.centroid, [ width, height ]

          )}

          mapboxAccessToken={mapboxAccessToken}

          flows={flows}

          locations={locations}

          getLocationId={l => l.id}

          getLocationCentroid={l => l.properties.centroid}

          getFlowOriginId={f => f.origin}

          getFlowDestId={f => f.dest}

          getFlowMagnitude={f => f.count}

          pickable={true} 

        />

    


```



The full list of supported props:

```typescript

interface Props {

  id: string;

  locations: Locations;

  flows: Flow[];

  diffMode?: boolean;

  animate?: boolean;    

  animationCurrentTime?: number;

  animationTailLength?: number;

  colors?: Colors | DiffColors;

  getLocationId?: LocationAccessor;

  getLocationCentroid?: LocationAccessor<[number, number]>;

  getLocationTotalIn?: LocationAccessor;

  getLocationTotalOut?: LocationAccessor;

  getLocationTotalWithin?: LocationAccessor;

  getFlowOriginId?: FlowAccessor;

  getFlowDestId?: FlowAccessor;

  getFlowMagnitude?: FlowAccessor;

  getAnimatedFlowLineStaggering?: FlowAccessor;

  getFlowColor?: FlowAccessor;

  maxFlowThickness?: number;

  flowMagnitudeExtent?: [number, number];

  locationTotalsExtent?: [number, number];

  maxLocationCircleSize?: number;

  minPickableFlowThickness?: number;

  showTotals?: boolean;

  showLocationAreas?: boolean;

  showOnlyTopFlows?: number;

  selectedLocationIds?: string[];

  highlightedLocationId?: string;

  highlightedLocationAreaId?: string;

  highlightedFlow?: Flow;

  outlineThickness?: number;

  pickable?: boolean;

  onClick?: PickingHandler;

  onHover?: PickingHandler;

}

```



## Development



Create an `.env` file in the project root

containing one line:



    MapboxAccessToken=



Then, run:



    yarn install

    yarn start

    open http://localhost:6006

    

If you want to make changes to the `core` and `react` packages and have them automatically recompiled, run the following: 



    yarn core-dev

    yarn react-dev



## Acknowledgements



Many thanks to [Philippe Voinov](https://github.com/tehwalris)

for his help with the first version of the FlowLinesLayer.



## License

flowmap.gl

Copyright 2018 Teralytics



This product includes software developed at

The Apache Software Foundation (http://www.apache.org/).



Portions of this software were developed at Teralytics (http://www.teralytics.net)