Skip to content

Commit

Permalink
docs: Release notes for 4.3 (#3020)
Browse files Browse the repository at this point in the history
  • Loading branch information
ibgreen committed May 20, 2024
1 parent d98d21d commit bbe24a0
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 126 deletions.
22 changes: 15 additions & 7 deletions docs/developer-guide/using-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,22 @@ loaders.gl provides a number of `Source` exports that support multi-step data lo

**Sources** are designed encapsulates the following data access models:

| Encapsulated Data | Description |
| Data Access Model | Description |
| --------------------------- | ------------------------------------------------------------------------------- |
| ***web service** | interact with a web service that returns data assets for different regions etc. |
| **cloud storage** |
| **archive files** | read individual assets from a (very large) multi-asset archive files. |
| **dynamic data generation** |
| ***web service** | Interact with a web service that returns data assets for different regions etc. |
| **cloud storage** | Read static assets as-needed from large cloud-native file formats |
| **archive files** | Read individual assets from a (very large) multi-asset archive files. |
| **dynamic data generation** | Generate data (tiles, images etc) dynamically based on application requests. |

## Source

The `Source` instance provides methods to query metadata, and to query data for specific geospatial areas.
A `Source` object provides information for creating a `DataSource`

## DataSource Interfaces

A `Source` can (and sometimes must) expose a completely unique API. However a big advantages comes when a `Source` conforms to an existing Source interface.
A `DateSource` instance provides methods to query metadata, and to query data for specific geospatial areas.

A `DataSource` can (and sometimes must) expose a completely unique API. However a big advantages comes when a `DataSource` conforms to an existing Source interface.

This means that applications written against that interface can now support the new source without any changes to existing logic.

Expand All @@ -27,6 +30,11 @@ This means that applications written against that interface can now support the
| `ImageTileSource` | Load image covering a specific tile index | WMTS (N/A) |
| `VectorTileSource` | Load "features" in a specific tile index | Mapbox Vector Tiles, `PMTilesSource` |

## Metadata

A `DateSource` instance provides methods to query metadata: `await dataSource.getMetadata()`.


## Adapter Sources

While most `Source` implementations provide an interface for interacting with a specific web service or cloud archive file format (e.g. `PMtilesSource`), it is also possible to create adapters:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
"items": [
"modules/pmtiles/api-reference/pmtiles-source",
"modules/mvt/api-reference/mvt-source",
"modules/mvt/api-reference/geojson-tile-source",
"modules/mvt/api-reference/table-tile-source",
"modules/wms/api-reference/csw-service",
"modules/wms/api-reference/wms-service"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/mvt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ npm install @loaders.gl/core
| Component |
| ------------------------------------------------------------------------ |
| [`MVTSource`](/docs/modules/mvt/api-reference/mvt-source) |
| [`TableTileSource`](/docs/modules/mvt/api-reference/geojson-tile-source) |
| [`TableTileSource`](/docs/modules/mvt/api-reference/table-tile-source) |

## Attribution

Expand Down
113 changes: 0 additions & 113 deletions docs/modules/mvt/api-reference/geojson-tile-source.md

This file was deleted.

20 changes: 19 additions & 1 deletion docs/whats-new.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,27 @@

## v4.3 (in development)

Target Release Date: June 2024

A minor release that includes:

- **[`Source`](/docs/developer-guide/using-sources) support** - Improvements for multi-step data loading.
- **examples** - modernized to latest React and minimized boilerplate code.
- **website** - more format examples are now available.

**@loaders.gl/core**

- [`createDataSource`](/docs/modules/core/api-reference/create-data-source) - Create a `DataSource` from a list of `Source` objects.
- [`selectSource`](/docs/modules/core/api-reference/select-source) - Select the appropriate `Source` from a list of `Source` objects.

**@loaders.gl/mvt**

- `TableTileSource` - tables can be tiled dynamically in the browser for better rendering performance.
- [`TableTileSource`](/docs/modules/mvt/api-reference/table-tile-source) - tables can now be vector tiled dynamically in the app.

**@loaders.gl/textures**

- [`Comp[ressedTextureLoader]`](/docs/modules/textures/api-reference/compressed-texture-loader) - Now supports mipmaps in KTX2 textures.


## v4.2

Expand Down
6 changes: 3 additions & 3 deletions modules/mvt/test/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
// geojson-vt
import './lib/vector-tiler/clip-features.spec';
import './lib/vector-tiler/simplify-path.spec';
// './get-tile.spec.ts' Was used as basis for geojson-tile-source.spec
// './full.spec' Was used as basis for geojson-tile-source-full.spec
// './multi-world.spec' Was used as basis for geojson-tile-source-multi-world.spec
// './get-tile.spec.ts' Was used as basis for table-tile-source.spec
// './full.spec' Was used as basis for table-tile-source-full.spec
// './multi-world.spec' Was used as basis for table-tile-source-multi-world.spec

import './lib/utils/geometry-utils.spec';

Expand Down

0 comments on commit bbe24a0

Please sign in to comment.