# eatlas

> Turing Geovisualization Engine (TGVE) front-end npm package.

Latest version **1.3.5-beta.0** (published 2021-12-02) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install eatlas
pnpm add eatlas
yarn add eatlas
bun add eatlas
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.3.5-beta.0 |
| Published | 2021-12-02 |
| First published | 2020-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 27 |
| Unpacked size | 578.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 35 |
| Author | L Hama |
| Maintainers | layik |

## Links

- npm: https://www.npmjs.com/package/eatlas
- Repository: https://github.com/layik/eatlas.git#npm
- Homepage: https://github.com/layik/eatlas/tree/npm#readme
- Issues: https://github.com/layik/eatlas/issues
- npm.io page: https://npm.io/package/eatlas

## Dependencies (27)

- [luxon](https://npm.io/package/luxon.md) ^1.25.0
- [baseui](https://npm.io/package/baseui.md) ^10.3.0
- [marked](https://npm.io/package/marked.md) ^0.7.0
- [deck.gl](https://npm.io/package/deck.gl.md) ^8.3.14
- [d3-array](https://npm.io/package/d3-array.md) ^2.9.1
- [d3-scale](https://npm.io/package/d3-scale.md) ^3.2.3
- [d3-shape](https://npm.io/package/d3-shape.md) ^1.3.7
- [d3-format](https://npm.io/package/d3-format.md) ^1.4.5
- [plotly.js](https://npm.io/package/plotly.js.md) ^1.58.4
- [react-vis](https://npm.io/package/react-vis.md) ^1.11.7
- [@turf/bbox](https://npm.io/package/@turf/bbox.md) ^6.3.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.2
- [underscore](https://npm.io/package/underscore.md) ^1.12.0
- [csv2geojson](https://npm.io/package/csv2geojson.md) ^5.1.1
- [html2canvas](https://npm.io/package/html2canvas.md) ^1.3.2
- [react-map-gl](https://npm.io/package/react-map-gl.md) 5.2.1
- [react-router](https://npm.io/package/react-router.md) ^4.3.1
- [react-leaflet](https://npm.io/package/react-leaflet.md) ^2.8.0
- [react-scripts](https://npm.io/package/react-scripts.md) 3.4.0
- [@turf/centroid](https://npm.io/package/@turf/centroid.md) ^6.2.0
- [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^0.32.4
- [styletron-react](https://npm.io/package/styletron-react.md) >=5.2.2 < 7
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^4.3.1
- [d3-scale-chromatic](https://npm.io/package/d3-scale-chromatic.md) ^1.5.0
- [@turf/bezier-spline](https://npm.io/package/@turf/bezier-spline.md) ^6.2.0
- [react-leaflet-control](https://npm.io/package/react-leaflet-control.md) ^2.1.2
- [styletron-engine-atomic](https://npm.io/package/styletron-engine-atomic.md) ^1.4.6

## Recent versions

- 1.3.5-beta.0 (latest) — 2021-12-02
- 0.0.2 (beta) — 2020-05-11
- 1.3.4-beta.4 — 2021-11-24
- 1.3.4-beta.3 — 2021-10-23
- 1.3.4-beta.2 — 2021-09-23
- 1.3.4-beta.1 — 2021-09-22
- 1.3.4-beta.0 — 2021-09-18
- 1.3.3-beta.0 — 2021-09-16
- 1.3.2-beta.0 — 2021-09-15
- 1.3.1-beta.0 — 2021-09-14
- 1.3.0-beta.2 — 2021-08-25
- 1.3.0-beta.1 — 2021-08-02
- 1.3.0-beta.0 — 2021-07-12
- 1.2.0-beta.0 — 2021-06-20
- 1.1.0-beta.5 — 2021-06-17
- … 9 more at https://npm.io/package/eatlas/versions

## README

02 December, 2021

# TGVE · [![Node CI](https://github.com/tgve/eAtlas/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/tgve/tgve/actions?query=workflow%3A%22Node+CI%22) [![npm version](https://badge.fury.io/js/eatlas.svg)](https://badge.fury.io/js/eatlas)

This is a React Component ES Module that can be embedded in your React
applications. This is an npm package output of TGVE (eAtlas) project.

Currently these variables can be passed to the eAtlas app, each (except
objects) can be passed as an environment variable like
`REACT_APP_LAYER_NAME` or when using eAtlas as a component
`<Eatlas layerName="geojson">`. As of version `1.3.5-beta.0`, they can
also be passed to the TGVE as URL query parameters. For instance
`localhost:3000?dark=false`.

The exception is that `leftSidebarContent` cannot be passed as an
environment variable. For more on passing variables to a React app and
the prefix of `REACT_App_` please see React docs
[here](https://create-react-app.dev/docs/adding-custom-environment-variables).

As of version `1.3.4-beta.1` these API variables can be passed to TGVE:

-   `data`: valid geojson object. If a valid GeoJSON object is provided
    both `defaultURL` and `geographyURL` will be ignored, which also
    means `geographyColumn` would be ignored, too.

-   `defaultURL`: which returns a valid geojson object when `fetched`.
    It can be used to fetch CSVs which is converted to `geojson` by
    eAtlas after fetching.

-   `geographyURL`: which returns a valid `geojson` dataset. If this
    variable is provided, data is fetched separately along with
    `defaultURL`, eAtlas uses the `geographyColumn` to join them. eAtlas
    does this oth on initialization and when `reset` button is pressed.

-   `geographyColumn`: a column name which is shared between data within
    the `defaultURL` and `geographyURL` or a mapping between the two. If
    a mapping is provided it must be in this format:
    `defaultURLColumnName:geographyURLColumnName`. This is the joining
    column that will result in dynamically generating `geojson` data for
    eAtlas to consume. If a valid column name is not provided TGVE will
    fail to load any data to the given geography.

-   `column`: if provided, and if the geometry is of particular type
    which would need a column, it would be used. Defaults on to the
    second column as often first column is an ID of sort.

-   `layerName`: if provided, and if the given name is in the list of
    DeckGL layers supported by eAtlas, will be passed to generate the
    layer with the name given.

-   `dark`: by default `baseui/baseweb` is set to dark, you can change
    the theme to other (e.g. light)

-   `leftSidebarContent`: is based on React standard children. This is
    where users can add their own UI and more, though this requires
    competent React concepts. A simple use would be to pass plain text
    description of data/project etc. Please see TGVE documentations.

-   `viewport`: TGVE’s main functionality is to auto-adjust the viewport
    (see DeckGL docs). However, the initial viewport can be set using
    this JSON parameter. The default values are:
    `{longitude: -1.6362, latitude: 53.8321, zoom: 10, pitch: 55, bearing: 0}`.
    If any of these are missing, they will be populated from these
    default values.

-   `hideChartGenerator` boolean value which would hide the sidebar
    component which generates charts from the data.

-   `hideCharts` boolean value which would hide all charts. This takes
    priority over `hideChartGenerator` parameter.

None of the above is necessary and in the current release “Add data”
button will allow loading data into eAtlas.

See the main repo for more about the project.

## Using github pages

See the main [repo
guide](https://github.com/tgve/eAtlas/blob/master/notes/guide.md) for
more details but you can use a template
([`tgve/eatlas-template`](https://github.com/tgve/eatlas-template)) repo
to publish your data using eAtlas.

## Development

See the main repo for more details but the package is a fork from a
`create-react-app` boilerplate.

## Tests

The package follows `create-react-app` testing kits and uses mainly
`jest`. Run `npm run test`.

## Change log

-   `1.3.5-beta.0`
    -   The TGVE now accepts the API variables as URL query parameters.
-   `1.3.4.beta.4`
    -   Minor issues and post tgver package Tests
    -   Path layer API in
-   `1.3.4.beta.0`
    -   API value `hideChartGenerator` is one of the few from the wider
        and potentially `hideSidebar`.
    -   Added basic version of “screenshot” or save. The future plan for
        this is a full analytic report (PDF) generation.
    -   Minor fixes and changes
-   `1.3.3-beta.0`
    -   More APIs as TGVE is in showcase driven development.
    -   Added `viewport` API JSON variable.
-   `1.3.2-beta.0`
    -   Better history management and respects host paths.
-   `1.3.1-beta.0`
    -   Preparing to remove the `beta` tag.
    -   TGVE has now been migrated to its organisation on github.com
    -   Added two new API variables (`dark`, `leftSidebarContent`)
    -   Lots of improvements and minor fixes
-   `1.3.0-beta.2`
    -   Minor fix for initial analysis of data column name.
-   `1.1.0-beta.0`
    -   support for separating data from geography.
    -   minor improvements elsewhere

---
_Source: https://npm.io/package/eatlas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
