From 00b8bbd521a8f44fbb4dc62d25732de2c4f5045a Mon Sep 17 00:00:00 2001 From: allyoucanmap Date: Wed, 2 Oct 2024 09:55:24 +0200 Subject: [PATCH] Review street view plugin jsdoc --- web/client/plugins/StreetView/StreetView.jsx | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/web/client/plugins/StreetView/StreetView.jsx b/web/client/plugins/StreetView/StreetView.jsx index f1be0081b6..9e93a8732e 100644 --- a/web/client/plugins/StreetView/StreetView.jsx +++ b/web/client/plugins/StreetView/StreetView.jsx @@ -51,7 +51,7 @@ const StreetViewPluginContainer = connect(() => ({}), { * StreetView Plugin. Uses Google Street View services to provide the navigation of Google panoramic photos of street view service through the map. * @name StreetView * @memberof plugins - * @property {string} provider the Street View provider. Can be `google`, `cyclomedia` or `mapillary`. It is set to `google` by default. + * @property {string} provider the Street View provider. Can be `google` or `cyclomedia`. It is set to `google` by default. * @property {string} cfg.apiKey The API key to use. This is generically valid for all the providers. * It is Mandatory in production. Depending on the provider, this can be also configured globally: * - `google` provider: In order to allow fine billing strategies (with different API keys), the API key can be defined and customized here in this configuration option or in `localConfig.json` with the following order of priority: @@ -59,14 +59,11 @@ const StreetViewPluginContainer = connect(() => ({}), { * - `apiKeys.googleAPIKey` - Use this if you have a general API key enabled for all Google APIs in MapStore. * - `googleAPIKey` (for retro-compatibility only) * - `cyclomedia` provider: The API key is mandatory and can be configured only in the plugin configuration. It is not possible to configure it globally in `localConfig.json`, in `apiKeys.cyclomediaAPIKey`. - * - `mapillary` provider: currently supporting only the custom GeoJSON data provider * @property {string} providerSettings The settings specific for the provider. Depending on the `provider` property, the following settings are available: * - `cyclomedia` provider: * - `providerSettings.StreetSmartApiURL` (optional). The URL of the StreetSmart API. Default: `https://streetsmart.cyclomedia.com/api/v23.7/StreetSmartApi.js`. * - `providerSettings.srs` (optional). Coordinate reference system code to use for the API. Default: `EPSG:4326`. Note that the SRS used here must be supported by the StreetSmart API **and** defined in `localConfig.json` file, in `projectionDefs`. * - * - `mapillary` provider: - * - `providerSettings.ApiURL` The URL of the the custom Geojson endpoint API. Currently is only supported a custom GeoJSON format. Example of endpoint is `https://hostname/directory-with-images/`, ensure the directory contains all the images and the index.json (GeoJSON) file * Generally speaking, you should prefer general settings in `localConfig.json` over the plugin configuration, in order to reuse the same configuration for default viewer and all the contexts, automatically. This way you will not need to configure the `apiKey` in every context. *
**Important**: You can use only **one** API-key for a MapStore instance. The api-key can be configured replicated in every plugin configuration or using one of the unique global settings (suggested) in `localConfig.json`). @see {@link https://github.com/googlemaps/js-api-loader/issues/5|here} and @see {@link https://github.com/googlemaps/js-api-loader/issues/100|here} * @property {boolean} [cfg.useDataLayer=true] If true, adds to the map a layer for street view data availability when the plugin is turned on.