Added supported libraries overview (#76)

aws-geospatial · Jul 24, 2024 · a0bfb09 · a0bfb09
1 parent 9434846
commit a0bfb09
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -96,6 +96,10 @@ function initMap() {
 window.initMap = initMap;
 ```
 
+## Supported Google APIs
+
+For a full overview of supported Google Maps APIs and current limitations, please see the [Supported APIs documentation](documentation/supportedLibraries.md).
+
 ## Contributing
 
 We welcome community contributions and pull requests. See [CONTRIBUTING](CONTRIBUTING.md) for information on how to set up a development environment, run the examples and submit code.

diff --git a/documentation/infowindow.md b/documentation/infowindow.md
@@ -1,4 +1,4 @@
-## Supported Google API's
+## Supported Google APIs - InfoWindow
 
 ### [InfoWindow class](https://developers.google.com/maps/documentation/javascript/reference/info-window#InfoWindow)
 

diff --git a/documentation/maps.md b/documentation/maps.md
@@ -1,4 +1,4 @@
-## Supported Google API's
+## Supported Google APIs - Map
 
 ### [Map class](https://developers.google.com/maps/documentation/javascript/reference/map)
 

diff --git a/documentation/markers.md b/documentation/markers.md
@@ -1,4 +1,4 @@
-## Supported Google API's
+## Supported Google APIs - Markers
 
 ### [AdvancedMarkerElement class](https://developers.google.com/maps/documentation/javascript/reference/advanced-markers#AdvancedMarkerElement)
 

diff --git a/documentation/supportedLibraries.md b/documentation/supportedLibraries.md
@@ -0,0 +1,55 @@
+## Supported Google APIs
+
+### [CoreLibrary interface](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#CoreLibrary)
+
+| Interface                                                                                                                                                    | Supported          | Notes |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----- |
+| [ControlPosition](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#CoreLibrary.ControlPosition) | :white_check_mark: |       |
+| [LatLng](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#CoreLibrary.LatLng)                   | :white_check_mark: |
+| [LatLngAltitude](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#CoreLibrary.LatLngAltitude)   | :x:                |
+| [LatLngBounds](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#CoreLibrary.LatLngBounds)       | :white_check_mark: |
+| [event](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#CoreLibrary.event)                     | :white_check_mark: |
+
+### [MapsLibrary interface](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#MapsLibrary)
+
+| Interface                                                                                                                                          | Supported          | Notes                    |
+| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------ |
+| [InfoWindow](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#MapsLibrary.InfoWindow) | :white_check_mark: | [Details](infowindow.md) |
+| [Map](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#MapsLibrary.Map)               | :white_check_mark: | [Details](maps.md)       |
+
+### [PlacesLibrary interface](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary)
+
+| Interface                                                                                                                                                              | Supported          | Notes |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| [Autocomplete](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary.Autocomplete)               | :white_check_mark: |       |
+| [AutocompleteService](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary.AutocompleteService) | :white_check_mark: |       |
+| [Place](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary.Place)                             | :white_check_mark: |       |
+| [PlacesService](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary.PlacesService)             | :white_check_mark: |       |
+| [PlacesServiceStatus](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary.PlacesServiceStatus) | :white_check_mark: |       |
+| [SearchBox](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#PlacesLibrary.SearchBox)                     | :white_check_mark: |       |
+
+### [GeocodingLibrary interface](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#GeocodingLibrary)
+
+| Interface                                                                                                                                                       | Supported          | Notes |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| [Geocoder](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#GeocodingLibrary.Geocoder)             | :white_check_mark: |       |
+| [GeocoderStatus](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#GeocodingLibrary.GeocoderStatus) | :white_check_mark: |       |
+
+### [RoutesLibrary interface](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary)
+
+| Interface                                                                                                                                                                              | Supported          | Notes |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| [DirectionsRenderer](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.DirectionsRenderer)                   | :white_check_mark: |       |
+| [DirectionsService](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.DirectionsService)                     | :white_check_mark: |       |
+| [DirectionsStatus](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.DirectionsStatus)                       | :white_check_mark: |       |
+| [DistanceMatrixElementStatus](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.DistanceMatrixElementStatus) | :white_check_mark: |       |
+| [DistanceMatrixService](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.DistanceMatrixService)             | :white_check_mark: |       |
+| [DistanceMatrixStatus](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.DistanceMatrixStatus)               | :white_check_mark: |       |
+| [TravelMode](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#RoutesLibrary.TravelMode)                                   | :white_check_mark: |       |
+
+### [MarkerLibrary interface](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#MarkerLibrary)
+
+| Interface                                                                                                                                                                  | Supported          | Notes                                             |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------- |
+| [AdvancedMarkerElement](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#MarkerLibrary.AdvancedMarkerElement) | :white_check_mark: | [Details](markers.md#advancedmarkerelement-class) |
+| [Marker](https://developers-dot-devsite-v2-prod.appspot.com/maps/documentation/javascript/reference/library-interfaces#MarkerLibrary.Marker)                               | :white_check_mark: | [Details](markers.md#marker-class)                |