createOpenStreetMapImageryProvider.js 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. import deprecationWarning from '../Core/deprecationWarning.js';
  2. import OpenStreetMapImageryProvider from './OpenStreetMapImageryProvider.js';
  3. /**
  4. * Creates a {@link UrlTemplateImageryProvider} instance that provides tiled imagery hosted by OpenStreetMap
  5. * or another provider of Slippy tiles. The default url connects to OpenStreetMap's volunteer-run
  6. * servers, so you must conform to their
  7. * {@link http://wiki.openstreetmap.org/wiki/Tile_usage_policy|Tile Usage Policy}.
  8. *
  9. * @exports createOpenStreetMapImageryProvider
  10. *
  11. * @param {Object} [options] Object with the following properties:
  12. * @param {String} [options.url='https://a.tile.openstreetmap.org'] The OpenStreetMap server url.
  13. * @param {String} [options.fileExtension='png'] The file extension for images on the server.
  14. * @param {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle of the layer.
  15. * @param {Number} [options.minimumLevel=0] The minimum level-of-detail supported by the imagery provider.
  16. * @param {Number} [options.maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
  17. * @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used.
  18. * @param {Credit|String} [options.credit='MapQuest, Open Street Map and contributors, CC-BY-SA'] A credit for the data source, which is displayed on the canvas.
  19. * @returns {UrlTemplateImageryProvider} The imagery provider.
  20. *
  21. * @deprecated
  22. *
  23. * @exception {DeveloperError} The rectangle and minimumLevel indicate that there are more than four tiles at the minimum level. Imagery providers with more than four tiles at the minimum level are not supported.
  24. *
  25. * @see ArcGisMapServerImageryProvider
  26. * @see BingMapsImageryProvider
  27. * @see GoogleEarthEnterpriseMapsProvider
  28. * @see SingleTileImageryProvider
  29. * @see TileMapServiceImageryProvider
  30. * @see WebMapServiceImageryProvider
  31. * @see WebMapTileServiceImageryProvider
  32. * @see UrlTemplateImageryProvider
  33. *
  34. *
  35. * @example
  36. * var osm = new Cesium.OpenStreetMapImageryProvider({
  37. * url : 'https://a.tile.openstreetmap.org/'
  38. * });
  39. *
  40. * @see {@link http://wiki.openstreetmap.org/wiki/Main_Page|OpenStreetMap Wiki}
  41. * @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
  42. */
  43. function createOpenStreetMapImageryProvider(options) {
  44. deprecationWarning('createOpenStreetMapImageryProvider', 'createOpenStreetMapImageryProvider is deprecated and will be removed in Cesium 1.65. Please use OpenStreetMapImageryProvider instead.');
  45. return new OpenStreetMapImageryProvider(options);
  46. }
  47. export default createOpenStreetMapImageryProvider;