Skip to content

feat(geo-layers): New geo-layers module, unbreak website #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ body:
value: |
Tips: Before filing a new bug:
Check [existing issues](https://github.com/visgl/deck.gl-community/issues)to avoid filing duplicate bugs.
You may find answers faster by searching in [the documentation](https://deck.gl-community/search).
You may find answers faster by searching in the documentation.
- type: checkboxes
id: flavor
attributes:
Expand Down
28 changes: 21 additions & 7 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,33 @@ jobs:

steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: volta-cli/action@5c175f92dea6f48441c436471e6479dbc192e194 # v4.2.1
q - uses: volta-cli/action@2d68418f32546fd191eb666e232b321d5726484d # v4.1.1
with:
node-version: ${{ matrix.node-version }}
cache: 'yarn'

- name: Install dependencies
run: |
yarn
yarn bootstrap
yarn install
env:
YARN_ENABLE_IMMUTABLE_INSTALLS: false

- name: Build packages
run: yarn build
- name: Build code
run: |
yarn build

- name: Run tests in Puppeteer and generage Coverage
run: |
yarn test cover

- name: Run tests
- name: Run tests on Node
run: |
yarn test node

- name: Run lint
run: |
yarn lint
yarn test

- name: Test website build
run: |
yarn test-website
20 changes: 20 additions & 0 deletions docs/modules/geo-layers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
![WebGPU not supported](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")

This module provides a suite of non-official geospatial layers for [deck.gl](https://deck.gl).

## Installation

```bash
npm install @deck.gl-community/geo-layers
```

## Background

This modules exports various geospatial deck.gl layers developed by the community that could be of use to others.
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# GlobalGridLayer

<!--
import {GlobalGridLayerDemo} from '@site/src/doc-demos/geo-layers';

<GlobalGridLayerDemo />
-->

The `GlobalGridLayer` renders filled and/or stroked polygons based on the specified DGGS geospatial indexing system.

`GlobalGridLayer` is a [CompositeLayer](../core/composite-layer.md).
`GlobalGridLayer` is a [CompositeLayer](https://deck.gl/docs/api-reference/core/composite-layer).


import Tabs from '@theme/Tabs';
Expand Down Expand Up @@ -169,11 +170,14 @@ new deck.GlobalGridLayer({});

## Properties

Inherits from all [Base Layer](../core/layer.md), [CompositeLayer](../core/composite-layer.md), and [PolygonLayer](../layers/polygon-layer.md) properties, plus the following:



Inherits from all [Base Layer](https://deck.gl/docs/api-reference/core/layer), [CompositeLayer](https://deck.gl/docs/api-reference/core/composite-layer), and [PolygonLayer](https://deck.gl/docs/api-reference/layers/polygon-layer) properties, plus the following:

### Data Accessors

#### `getPentagon` ([Accessor&lt;bigint | string&gt;](../../developer-guide/using-layers.md#accessors), optional) ![transition-enabled](https://img.shields.io/badge/transition-enabled-green.svg?style=flat-square") {#getpentagon}
#### `getPentagon` (Accessor&lt;bigint | string&gt;] ![transition-enabled](https://img.shields.io/badge/transition-enabled-green.svg?style=flat-square") {#getpentagon}

Called for each data object to retrieve the identifier of the DGGS cell id. May return one of the following:

Expand All @@ -188,7 +192,7 @@ Called for each data object to retrieve the identifier of the DGGS cell id. May

The `GlobalGridLayer` renders the following sublayers:

* `cell` - a [PolygonLayer](../layers/polygon-layer.md) rendering the DGGS cells.
* `cell` - a [PolygonLayer](https://deck.gl/docs/api-reference/layers/polygon-layer) rendering the DGGS cells.


## Source
Expand Down
9 changes: 9 additions & 0 deletions docs/modules/geo-layers/sidebar.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"type": "category",
"label": "@deck.gl-community/geo-layers",
"items": [
"modules/layers/README",
"modules/geo-layers/api-reference/global-grid-layer",
"modules/geo-layers/api-reference/tile-source-layer"
]
}
20 changes: 20 additions & 0 deletions docs/modules/infovis-layers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
![WebGPU not supported](https://img.shields.io/badge/webgpu-no-red.svg?style=flat-square")

This module provides a suite of non-official layers for [deck.gl](https://deck.gl).

## Installation

```bash
npm install @deck.gl-community/infovis-layers
```

## History

Various layers developed by deck.gl maintainers that could be of use to others.
7 changes: 7 additions & 0 deletions docs/modules/infovis-layers/sidebar.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "category",
"label": "@deck.gl-community/layers",
"items": [
"modules/infovis-layers/README"
]
}
3 changes: 1 addition & 2 deletions docs/modules/layers/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"items": [
"modules/layers/README",
"modules/layers/api-reference/path-marker-layer",
"modules/layers/api-reference/path-outline-layer",
"modules/layers/api-reference/tile-source-layer"
"modules/layers/api-reference/path-outline-layer"
]
}
7 changes: 1 addition & 6 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,4 @@

Modules in `@deck.gl-community` are independently maintained, so this page will only list occasional major changes.

Please refer the documentation of each module for detailed upgrade guides, e.g:

- [`graph-layers`](/docs/modules/graph-layers#upgrade-guide)
- [`arrow-layers`](/docs/modules/arrow-layers#upgrade-guide)
- [`editable-layers`](/docs/modules/editable-layers#upgrade-guide)
- [`layers`](/docs/modules/editable-layers#upgrade-guide)
Please refer the documentation of each module for detailed upgrade guides.
7 changes: 1 addition & 6 deletions docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

Modules in `@deck.gl-community` are independently maintained, so this page will only list occasional major changes.

Please refer the documentation of each module for detailed news, e.g:

- [`graph-layers`](/docs/modules/graph-layers#whats-new)
- [`arrow-layers`](/docs/modules/arrow-layers#whats-new)
- [`editable-layers`](/docs/modules/editable-layers#uhats-new)
- [`layers`](/docs/modules/editable-layers#whats-new)
Please refer the documentation of each module for detailed news.


## v9.2 - In Development
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
20 changes: 20 additions & 0 deletions modules/geo-layers/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2015 - 2021 Uber Technologies, Inc.
Copyright (c) 2022 - 2023 vis.gl contributors

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.
5 changes: 5 additions & 0 deletions modules/geo-layers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# @deck.gl-community/layers

This module contains a suite of non-official deck.gl layers.

They can be quite useful in applications, however they are not officially supported by the deck.gl team, so use at your own risk.
55 changes: 55 additions & 0 deletions modules/geo-layers/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"name": "@deck.gl-community/geo-layers",
"version": "9.1.0-beta.5",
"description": "Add-0n geospatial layers for deck.gl",
"license": "MIT",
"keywords": [
"layers",
"visualization",
"gpu",
"deck.gl"
],
"type": "module",
"sideEffects": false,
"types": "./dist/index.d.ts",
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"exports": {
".": {
"types": "./dist/index.d.ts",
"require": "./dist/index.cjs",
"import": "./dist/index.js"
}
},
"files": [
"dist",
"src"
],
"scripts": {
"test": "vitest run",
"test-watch": "vitest"
},
"dependencies": {
"@deck.gl/core": "^9.1.12",
"@deck.gl/extensions": "^9.1.0",
"@deck.gl/geo-layers": "^9.1.0",
"@deck.gl/layers": "^9.1.0",
"@deck.gl/mesh-layers": "^9.1.0",
"@deck.gl/react": "^9.1.0",
"@loaders.gl/core": "^4.2.0",
"@loaders.gl/i3s": "^4.2.0",
"@loaders.gl/loader-utils": "^4.2.0",
"@loaders.gl/schema": "^4.2.0",
"@loaders.gl/tiles": "^4.2.0",
"@luma.gl/constants": "^9.1.9",
"@luma.gl/core": "^9.1.9",
"@luma.gl/engine": "^9.1.9",
"@math.gl/core": "^4.0.0",
"a5-js": "^0.1.4",
"h3-js": "^4.2.1"
},
"devDependencies": {
"@deck.gl/test-utils": "^9.1.12",
"@luma.gl/webgpu": "^9.1.9"
}
}
15 changes: 15 additions & 0 deletions modules/geo-layers/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// deck.gl-community
// SPDX-License-Identifier: MIT
// Copyright (c) vis.gl contributors

export type {TileSourceLayerProps} from './tile-source-layer/tile-source-layer';
export {TileSourceLayer} from './tile-source-layer/tile-source-layer';

export {GlobalGridLayer, type GlobalGridLayerProps} from './global-grid-layer/global-grid-layer';

export {type GlobalGrid} from './global-grid-systems/grids/global-grid';
export {A5Grid} from './global-grid-systems/grids/a5-grid';
export {H3Grid} from './global-grid-systems/grids/h3-grid';
export {S2Grid} from './global-grid-systems/grids/s2-grid';
export {GeohashGrid} from './global-grid-systems/grids/geohash-grid';
export {QuadkeyGrid} from './global-grid-systems/grids/quadkey-grid';
11 changes: 11 additions & 0 deletions modules/geo-layers/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"exclude": ["node_modules"],
"compilerOptions": {
"composite": true,
"rootDir": "src",
"outDir": "dist",
"noEmit": false
}
}
20 changes: 20 additions & 0 deletions modules/infovis-layers/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2015 - 2021 Uber Technologies, Inc.
Copyright (c) 2022 - 2023 vis.gl contributors

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.
5 changes: 5 additions & 0 deletions modules/infovis-layers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# @deck.gl-community/layers

This module contains a suite of non-official deck.gl layers.

They can be quite useful in applications, however they are not officially supported by the deck.gl team, so use at your own risk.
54 changes: 54 additions & 0 deletions modules/infovis-layers/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"private": true,
"name": "@deck.gl-community/infovis-layers",
"version": "9.1.0-beta.5",
"description": "Infovis layers (non-geospatial) for deck.gl",
"license": "MIT",
"keywords": [
"layers",
"visualization",
"gpu",
"deck.gl"
],
"type": "module",
"sideEffects": false,
"types": "./dist/index.d.ts",
"main": "./dist/index.cjs",
"module": "./dist/index.js",
"exports": {
".": {
"types": "./dist/index.d.ts",
"require": "./dist/index.cjs",
"import": "./dist/index.js"
}
},
"files": [
"dist",
"src"
],
"scripts": {
"test": "vitest run",
"test-watch": "vitest"
},
"dependencies": {
"@deck.gl/core": "^9.1.12",
"@deck.gl/extensions": "^9.1.0",
"@deck.gl/layers": "^9.1.0",
"@deck.gl/mesh-layers": "^9.1.0",
"@deck.gl/react": "^9.1.0",
"@loaders.gl/core": "^4.2.0",
"@loaders.gl/i3s": "^4.2.0",
"@loaders.gl/loader-utils": "^4.2.0",
"@loaders.gl/schema": "^4.2.0",
"@luma.gl/constants": "^9.1.9",
"@luma.gl/core": "^9.1.9",
"@luma.gl/engine": "^9.1.9",
"@math.gl/core": "^4.0.0",
"a5-js": "^0.1.4",
"h3-js": "^4.2.1"
},
"devDependencies": {
"@deck.gl/test-utils": "^9.1.12",
"@luma.gl/webgpu": "^9.1.9"
}
}
5 changes: 5 additions & 0 deletions modules/infovis-layers/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// deck.gl-community
// SPDX-License-Identifier: MIT
// Copyright (c) vis.gl contributors

// TBA
7 changes: 7 additions & 0 deletions modules/infovis-layers/test/index.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {describe, it, expect} from 'vitest';

describe('Dummy Test', () => {
it('is empty', () => {
expect(true).toBeTruthy();
});
});
Loading