Skip to content

Commit

Permalink
Merge commit 'b8faecf2e07d539b7a3566387216e9238e300e0b' into dt/appen…
Browse files Browse the repository at this point in the history
…d_truncate
  • Loading branch information
dariaterekhova-actionengine committed Dec 1, 2023
2 parents 4ee7ba0 + b8faecf commit 9e479b1
Show file tree
Hide file tree
Showing 163 changed files with 1,818 additions and 1,246 deletions.
190 changes: 96 additions & 94 deletions docs/docs-sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,100 +9,6 @@
"upgrade-guide"
]
},
{
"type": "category",
"label": "Developer Guide",
"items": [
{
"type": "category",
"label": "Basics",
"items": [
"developer-guide/using-loaders",
"developer-guide/using-writers",
"developer-guide/loader-categories",
"developer-guide/using-worker-loaders",
"developer-guide/using-streaming-loaders",
"developer-guide/node"
]
},
{
"type": "category",
"label": "Advanced Topics",
"items": [
"developer-guide/dependencies",
"developer-guide/creating-loaders-and-writers",
"developer-guide/composite-loaders",
"developer-guide/error-handling",
"developer-guide/dev-env"
]
},
{
"type": "category",
"label": "Concepts",
"items": [
"developer-guide/concepts/javascript-apis",
"developer-guide/concepts/binary-data",
"developer-guide/concepts/streaming",
"developer-guide/concepts/async-iterators",
"developer-guide/concepts/worker-threads"
]
}
]
},
{
"type": "category",
"label": "Tutorials",
"items": [
{
"type": "category",
"label": "I3S",
"items": [
"modules/i3s/recipes/building-scene-layer",
"modules/i3s/recipes/attribute-driven-colorization"
]
}
]
},
{
"type": "category",
"label": "Formats",
"items": [
"formats/README",
"modules/arrow/formats/arrow",
"modules/arrow/formats/geoarrow",
"modules/bson/formats/bson",
"modules/csv/formats/csv",
"modules/pcd/formats/pcd",
"modules/ply/formats/ply",
"modules/json/formats/geojson",
"modules/json/formats/geojson-geometry",
"modules/gltf/formats/glb",
"modules/gltf/formats/gltf",
"modules/geopackage/formats/geopackage",
"modules/kml/formats/kml",
"modules/kml/formats/gpx",
"modules/kml/formats/tcx",
"modules/las/formats/las",
"modules/mvt/formats/mvt",
"modules/mvt/formats/tilejson",
"modules/parquet/formats/parquet",
"modules/parquet/formats/geoparquet",
"modules/pmtiles/formats/pmtiles",
"modules/shapefile/formats/shapefile",
"modules/textures/formats/compressed-textures",
"modules/wms/formats/csw",
"modules/wms/formats/wms",
"modules/wms/formats/wmts",
"modules/wms/formats/wfs",
"modules/wms/formats/gml",
"modules/lerc/formats/lerc",
"modules/wkt/formats/wkt",
"modules/wkt/formats/wkb",
"modules/wkt/formats/wkt-crs",
"modules/xml/formats/xml",
"modules/zip/formats/zip"
]
},
{
"type": "category",
"label": "Loader Catalog",
Expand Down Expand Up @@ -131,6 +37,7 @@
"modules/3d-tiles/api-reference/cesium-ion-loader",
"modules/arrow/api-reference/arrow-loader",
"modules/arrow/api-reference/arrow-writer",
"modules/arrow/api-reference/geoarrow-loader",
"modules/bson/api-reference/bson-loader",
"modules/bson/api-reference/bson-writer",
"modules/csv/api-reference/csv-loader",
Expand Down Expand Up @@ -184,6 +91,101 @@
"modules/zip/api-reference/zip-writer"
]
},
{
"type": "category",
"label": "Formats",
"items": [
"formats/README",
"modules/arrow/formats/arrow",
"modules/arrow/formats/geoarrow",
"modules/bson/formats/bson",
"modules/csv/formats/csv",
"modules/pcd/formats/pcd",
"modules/ply/formats/ply",
"modules/flatgeobuf/formats/flatgeobuf",
"modules/json/formats/geojson",
"modules/json/formats/geojson-geometry",
"modules/gltf/formats/glb",
"modules/gltf/formats/gltf",
"modules/geopackage/formats/geopackage",
"modules/kml/formats/kml",
"modules/kml/formats/gpx",
"modules/kml/formats/tcx",
"modules/las/formats/las",
"modules/mvt/formats/mvt",
"modules/mvt/formats/tilejson",
"modules/parquet/formats/parquet",
"modules/parquet/formats/geoparquet",
"modules/pmtiles/formats/pmtiles",
"modules/shapefile/formats/shapefile",
"modules/textures/formats/compressed-textures",
"modules/wms/formats/csw",
"modules/wms/formats/wms",
"modules/wms/formats/wmts",
"modules/wms/formats/wfs",
"modules/wms/formats/gml",
"modules/lerc/formats/lerc",
"modules/wkt/formats/wkt",
"modules/wkt/formats/wkb",
"modules/wkt/formats/wkt-crs",
"modules/xml/formats/xml",
"modules/zip/formats/zip"
]
},
{
"type": "category",
"label": "Developer Guide",
"items": [
{
"type": "category",
"label": "Basics",
"items": [
"developer-guide/using-loaders",
"developer-guide/using-writers",
"developer-guide/loader-categories",
"developer-guide/using-worker-loaders",
"developer-guide/using-streaming-loaders",
"developer-guide/node"
]
},
{
"type": "category",
"label": "Advanced Topics",
"items": [
"developer-guide/dependencies",
"developer-guide/creating-loaders-and-writers",
"developer-guide/composite-loaders",
"developer-guide/error-handling",
"developer-guide/dev-env"
]
},
{
"type": "category",
"label": "Concepts",
"items": [
"developer-guide/concepts/javascript-apis",
"developer-guide/concepts/binary-data",
"developer-guide/concepts/streaming",
"developer-guide/concepts/async-iterators",
"developer-guide/concepts/worker-threads"
]
}
]
},
{
"type": "category",
"label": "Tutorials",
"items": [
{
"type": "category",
"label": "I3S",
"items": [
"modules/i3s/recipes/building-scene-layer",
"modules/i3s/recipes/attribute-driven-colorization"
]
}
]
},
{
"type": "category",
"label": "Submodule API Reference",
Expand Down
1 change: 1 addition & 0 deletions docs/modules/arrow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ npm install @loaders.gl/core @loaders.gl/arrow
| -------------------------------------------------------------------- |
| [`ArrowLoader`](/docs/modules/arrow/api-reference/arrow-loader) |
| [`ArrowWorkerLoader`](/docs/modules/arrow/api-reference/arrow-loader) |
| [`GeoArrowLoader`](/docs/modules/arrow/api-reference/geoarrow-loader) |

| Writer |
| -------------------------------------------------------------- |
Expand Down
2 changes: 0 additions & 2 deletions docs/modules/arrow/api-reference/arrow-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

![arrow-logo](../images/apache-arrow-small.png)

> The Arrow loaders are still under development.
The `ArrowLoader` parses the Apache Arrow columnar table format.

| Loader | Characteristic |
Expand Down
33 changes: 33 additions & 0 deletions docs/modules/arrow/api-reference/geoarrow-loader.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# GeoArrowLoader

![arrow-logo](../images/apache-arrow-small.png)

<p class="badges">
<img src="https://img.shields.io/badge/From-v4.1-blue.svg?style=flat-square" alt="From-v4.1" />
</p>

The `GeoArrowLoader` parses Apache Arrow columnar table format files, and looks for `GeoArrow` type extensions to parse geometries from the table.

| Loader | Characteristic |
| --------------------- | ------------------------------------------------------------------------- |
| File Format | [IPC: Encapsulated Message Format](https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc) |
| Data Format | [Geometry Table](/docs/specifications/category-table) |
| File Extension | `.arrow` |
| File Type | Binary |
| Decoder Type | `load`, `parse`, `parseSync`, `parseInBatches` |
| Worker Thread Support | Yes |
| Streaming Support | Yes |

## Usage

```typescript
import {GeoArrowLoader} from '@loaders.gl/arrow';
import {load} from '@loaders.gl/core';

const data = await load(url, GeoArrowLoader, options);
```

## Options

| Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- |
28 changes: 14 additions & 14 deletions docs/modules/arrow/formats/geoarrow.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ Geospatial tabular data where one or more columns contains feature geometries an
Note that GeoArrow is not a separate format from Apache Arrow rather, the GeoArrow specification simply describes additional conventions for metadata and layout of geospatial data. This means that a valid GeoArrow file is always a valid Arrow file. This is done through [Arrow extension type](https://arrow.apache.org/docs/format/Columnar.html#extension-types) definitions that ensure type-level metadata (e.g., CRS) is propagated when used in Arrow implementations.


## Geometry Types

| Geometry type | Read | Write | Description |
| -------------------------- | ---- | ----- | -------------------- |
| `geoarrow.point` ||| |
| `geoarrow.multipoint` ||| |
| `geoarrow.linestring` ||| |
| `geoarrow.multilinestring` ||| |
| `geoarrow.polygon` ||| |
| `geoarrow.multipolygon` ||| |
| `geoarrow.wkb` ||| `WKB` also supported |
| `geoarrow.wkt` ||| `WKT` also supported |

## Relationship with GeoParquet

The [GeoParquet specification](https://github.com/opengeospatial/geoparquet) is closely related to GeoArrow. Notable differences:
The [GeoParquet](/docs/modules/parquet/formats/geoparquet) [specification](https://github.com/opengeospatial/geoparquet) is closely related to GeoArrow. Notable differences:

- GeoParquet is a file-level metadata specification
- GeoArrow is a field-level metadata and memory layout specification

## Geometry Types

| Geometry type | Read | Write | Description |
| -------------------------- | ---- | ----- | ----------- |
| `geoarrow.multipolygon` ||| |
| `geoarrow.polygon` ||| |
| `geoarrow.multipoint` ||| |
| `geoarrow.point` ||| |
| `geoarrow.multilinestring` ||| |
| `geoarrow.linestring` ||| |
| `geoarrow.wkb` ||| |
| `geoarrow.wkt` ||| |
8 changes: 4 additions & 4 deletions docs/modules/flatgeobuf/api-reference/flatgeobuf-loader.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# FlatGeobufLoader 🚧
# FlatGeobufLoader

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.1-blue.svg?style=flat-square" alt="From-v3.1" />
&nbsp;
<img src="https://img.shields.io/badge/-BETA-teal.svg" alt="BETA" />
</p>

Loader for the [FlatGeobuf](http://flatgeobuf.org/) format, a binary FlatBuffers-encoded format that defines geospatial geometries.
Loader for the [FlatGeobuf](/docs/modules/flatgeobuf/formats/flatgeobuf) format, a binary FlatBuffers-encoded format that defines geospatial geometries.

| Loader | Characteristic |
| -------------- | --------------------------------------------------------------- |
| File Extension | `.fgb`, |
| File Type | Binary |
| File Format | [FlatGeobuf](http://flatgeobuf.org/) |
| File Format | [FlatGeobuf](/docs/modules/flatgeobuf/formats/flatgeobuf) |
| Data Format | [Geometry](/docs/specifications/category-gis) |
| Supported APIs | `load`, `loadInBatches`, `parse`, `parseSync`, `parseInBatches` |

Expand All @@ -39,4 +39,4 @@ The parser will return an array of [GeoJSON `features`](https://tools.ietf.org/h

## Attribution

The `FlatGeobufLoader` wraps the [`flatgeobuf`](https://github.com/bjornharrtell/flatgeobuf) NPM module under the ISC license.
The `FlatGeobufLoader` wraps the [`flatgeobuf`](https://github.com/bjornharrtell/flatgeobuf) NPM module which is published under the ISC license.
17 changes: 17 additions & 0 deletions docs/modules/flatgeobuf/formats/flatgeobuf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# FlatGeobuf

- *[`@loaders.gl/flatgeobuf`](/docs/moodules/flatgeobuf)*
- *[FlatGeobuf](http://flatgeobuf.org/)*

FlatGeobuf is a binary (FlatBuffers-encoded) format that defines geospatial geometries. It is row-oriented rather than columnar (like GeoParquet and GeoArrow) and offers a different set of trade-offs.

FlatGeobuf was inspired by [geobuf](https://github.com/mapbox/geobuf) and [flatbush](https://github.com/mourner/flatbush).

## Characteristics

- binary
- row oriented
- supports appends, but no random writes

Goals are to be suitable for large volumes of static data, significantly faster than legacy formats without size limitations for contents or metainformation and to be suitable for streaming/random access.

2 changes: 1 addition & 1 deletion docs/modules/geopackage/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview 🚧
# Overview

![ogc-logo](../../images/logos/ogc-logo-60.png)

Expand Down
6 changes: 5 additions & 1 deletion docs/modules/geopackage/api-reference/geopackage-loader.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# GeoPackageLoader 🚧
# GeoPackageLoader

![ogc-logo](../../../images/logos/ogc-logo-60.png)

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.0-blue.svg?style=flat-square" alt="From-v3.0" />
</p>

:::caution
The `GeoPackageLoader` depends on the [`sql.js`](https://github.com/sql-js/sql.js) npm module which has caused issues with certain JavaScript bundlers. It is recommended that you do your own tests before using the `GeoPackageLoader` in your project.
:::

GeoPackage loader

| Loader | Characteristic |
Expand Down
7 changes: 6 additions & 1 deletion docs/modules/las/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Overview

The `@loaders.gl/las` module handles the [LASER file format](https://www.asprs.org/divisions-committees/lidar-division/laser-las-file-format-exchange-activities) (LAS) or its compressed version (LAZ), a public format for the interchange of 3-dimensional point cloud data data, developed for LIDAR mapping purposes.
The `@loaders.gl/las` module supports the [LASER file format](/docs/modules/las/formats/las) (LAS) and its compressed version (LAZ).

:::caution
The `@loaders.gl/las` module only supports LAS/lAZ files up to LAS v1.3. It does not support LAS v1.4 files.
For more detail, see the discussion in [Github Issues](https://github.com/visgl/loaders.gl/issues/591).
:::

## Installation

Expand Down
5 changes: 5 additions & 0 deletions docs/modules/las/api-reference/las-loader.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# LASLoader

:::caution
The `@loaders.gl/las` module only supports LAS/lAZ files up to LAS v1.3. It does not support LAS v1.4 files.
For more detail, see the discussion in [Github Issues](https://github.com/visgl/loaders.gl/issues/591).
:::

The `LASLoader` parses a point cloud in the LASER file format.

| Loader | Characteristic |
Expand Down
Loading

0 comments on commit 9e479b1

Please sign in to comment.