Skip to content

Commit c5c91c1

Browse files
Merge pull request #19 from geoadmin/feat-PB-1798-polish-js-api-page
PB-1798 Rework content of page JS API
2 parents d335eaa + 5a61681 commit c5c91c1

File tree

1 file changed

+15
-34
lines changed

1 file changed

+15
-34
lines changed

docs/js-api.md

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,24 @@
1-
# JS API Doc
1+
# JS API
22

33
The GeoAdmin JS API extends OpenLayers with Swiss specific configurations and layers.
44

5-
::: warning
5+
For more details, see [the GeoAdmin JS API specs](https://geoadmin.github.io/ol3/apidoc/).
66

7-
The GeoAdmin JS API is now very mature and not updated anymore. It’s default version is based on Openlayers 3.6.0 (released on 7 Jun 2015), and the subsequent ones on Openlayers 3.18.2 (1 Sep 2016) and 4.4.2 (released on 6 Oct 2017). We urge you to use your favorite webmapping framework for new development, like OpenLayers , Leaflets , Google Maps, Yandex Map, Bing Map or anything implementing the OGC WMTS
7+
::: warning
88

9+
The GeoAdmin JS API is about to be decommissioned and is not updated anymore.
10+
The default version is based on OpenLayers 3.6.0 from 2015.
11+
We strongly recommend using a different web mapping framework implementing the OGC WMTS, like Leaflet or plain OpenLayers.
912
:::
1013

11-
The API is available in multiple versions:
12-
13-
Versions using LV95:
14-
15-
- 4.4.2
16-
17-
Versions using LV03:
18-
19-
- 4.3.2
20-
21-
- 3.18.2
22-
23-
- 3.6.0 (default)
24-
25-
The version number refers to the same version in OpenLayers.
26-
27-
You can access a specific version using the version parameter in the url of the loader:
28-
29-
https://api3.geo.admin.ch/loader.js?version=4.4.2
30-
31-
https://api3.geo.admin.ch/loader.js?version=4.3.2
32-
33-
https://api3.geo.admin.ch/loader.js?version=3.18.2
34-
35-
https://api3.geo.admin.ch/loader.js (default: 3.6.0)
36-
37-
More examples of use are available on the API Examples page.
38-
39-
Other useful links:
14+
## Available Versions
4015

41-
- [GeoAdmin API documentation](http://geoadmin.github.io/ol3/apidoc/)
16+
The version of the GeoAdmin JS API corresponds to the version of OpenLayers it extends.
17+
The following versions of the GeoAdmin JS API are available:
4218

43-
- OpenLayers API documentation: for [version 3](https://openlayers.org/en/v3.20.1/doc/) or [version 4](https://openlayers.org/en/v4.6.5/doc/)
19+
- Versions using LV95:
20+
- 4.4.2 → https://api3.geo.admin.ch/loader.js?version=4.4.2
21+
- Versions using LV03:
22+
- 4.3.2 → https://api3.geo.admin.ch/loader.js?version=4.3.2
23+
- 3.18.2 → https://api3.geo.admin.ch/loader.js?version=3.18.2
24+
- 3.6.0 (default) → https://api3.geo.admin.ch/loader.js

0 commit comments

Comments
 (0)