An imagery provider that provides tiled imagery hosted by OpenStreetMap
or another provider of Slippy tiles. The default url connects to OpenStreetMap's volunteer-run
servers, so you must conform to their
Tile Usage Policy.
参数名称 | 类型 | 描述信息 |
---|---|---|
options |
OpenStreetMapImageryProvider.ConstructorOptions | Object describing initialization options |
Throws:
-
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.
使用示例:
const osm = new Cesium.OpenStreetMapImageryProvider({
url : 'https://tile.openstreetmap.org/'
});
参考:
继承
成员(属性)
readonly credit : Credit
Gets the credit to display when this imagery provider is active. Typically this is used to credit
the source of the imagery.
- 继承自:
- 默认值:
undefined
Gets or sets a value indicating whether feature picking is enabled. If true,
UrlTemplateImageryProvider#pickFeatures
will
request the options.pickFeaturesUrl
and attempt to interpret the features included in the response. If false,
UrlTemplateImageryProvider#pickFeatures
will immediately return undefined (indicating no pickable
features) without communicating with the server. Set this property to false if you know your data
source does not support picking features or if you don't want this provider's features to be pickable.
- 继承自:
- 默认值:
true
readonly errorEvent : Event
Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
to the event, you will be notified of the error and can potentially recover from it. Event listeners
are passed an instance of
TileProviderError
.
Gets a value indicating whether or not the images provided by this imagery provider
include an alpha channel. If this property is false, an alpha channel, if present, will
be ignored. If this property is true, any images without an alpha channel will be treated
as if their alpha is 1.0 everywhere. When this property is false, memory usage
and texture upload time are reduced.
- 继承自:
- 默认值:
true
Gets the maximum level-of-detail that can be requested, or undefined if there is no limit.
- 继承自:
- 默认值:
undefined
Gets the minimum level-of-detail that can be requested.
- 继承自:
- 默认值:
0
Gets the URL template to use to use to pick features. If this property is not specified,
UrlTemplateImageryProvider#pickFeatures
will immediately return undefined, indicating no
features picked. The URL template supports all of the keywords supported by the
UrlTemplateImageryProvider#url
property, plus the following:
{i}
: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.{j}
: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.{reverseI}
: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.{reverseJ}
: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.{longitudeDegrees}
: The longitude of the picked position in degrees.{latitudeDegrees}
: The latitude of the picked position in degrees.{longitudeProjected}
: The longitude of the picked position in the projected coordinates of the tiling scheme.{latitudeProjected}
: The latitude of the picked position in the projected coordinates of the tiling scheme.{format}
: The format in which to get feature information, as specified in theGetFeatureInfoFormat
.
readonly proxy : Proxy
Gets the proxy used by this provider.
- 继承自:
- 默认值:
undefined
readonly rectangle : Rectangle
Gets the rectangle, in radians, of the imagery provided by this instance.
- 继承自:
- 默认值:
tilingScheme.rectangle
readonly tileDiscardPolicy : TileDiscardPolicy
Gets the tile discard policy. If not undefined, the discard policy is responsible
for filtering out "missing" tiles via its shouldDiscardImage function. If this function
returns undefined, no tiles are filtered.
- 继承自:
- 默认值:
undefined
Gets the height of each tile, in pixels.
- 继承自:
- 默认值:
256
Gets the width of each tile, in pixels.
- 继承自:
- 默认值:
256
readonly tilingScheme : TilingScheme
Gets the tiling scheme used by this provider.
- 继承自:
- 默认值:
new WebMercatorTilingScheme()
Gets the URL template to use to request tiles. It has the following keywords:
-
{z}
: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid. -
{x}
: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile. -
{y}
: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile. -
{s}
: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host. -
{reverseX}
: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile. -
{reverseY}
: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile. -
{reverseZ}
: The level of the tile in the tiling scheme, where level zero is the maximum level of the quadtree pyramid. In order to use reverseZ, maximumLevel must be defined. -
{westDegrees}
: The Western edge of the tile in geodetic degrees. -
{southDegrees}
: The Southern edge of the tile in geodetic degrees. -
{eastDegrees}
: The Eastern edge of the tile in geodetic degrees. -
{northDegrees}
: The Northern edge of the tile in geodetic degrees. -
{westProjected}
: The Western edge of the tile in projected coordinates of the tiling scheme. -
{southProjected}
: The Southern edge of the tile in projected coordinates of the tiling scheme. -
{eastProjected}
: The Eastern edge of the tile in projected coordinates of the tiling scheme. -
{northProjected}
: The Northern edge of the tile in projected coordinates of the tiling scheme. -
{width}
: The width of each tile in pixels. -
{height}
: The height of each tile in pixels.
Gets the URL scheme zero padding for each tile coordinate. The format is '000' where each coordinate will be padded on
the left with zeros to match the width of the passed string of zeros. e.g. Setting:
urlSchemeZeroPadding : { '{x}' : '0000'}
will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL.
It has the following keywords:
-
{z}
: The zero padding for the level of the tile in the tiling scheme. -
{x}
: The zero padding for the tile X coordinate in the tiling scheme. -
{y}
: The zero padding for the the tile Y coordinate in the tiling scheme. -
{reverseX}
: The zero padding for the tile reverseX coordinate in the tiling scheme. -
{reverseY}
: The zero padding for the tile reverseY coordinate in the tiling scheme. -
{reverseZ}
: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.
方法
getTileCredits(x, y, level) → Array.<Credit>
Gets the credits to be displayed when a given tile is displayed.
参数名称 | 类型 | 描述信息 |
---|---|---|
x |
number | The tile X coordinate. |
y |
number | The tile Y coordinate. |
level |
number | The tile level; |
返回值:
The credits to be displayed when the tile is displayed.
pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Asynchronously determines what features, if any, are located at a given longitude and latitude within
a tile.
参数名称 | 类型 | 描述信息 |
---|---|---|
x |
number | The tile X coordinate. |
y |
number | The tile Y coordinate. |
level |
number | The tile level. |
longitude |
number | The longitude at which to pick features. |
latitude |
number | The latitude at which to pick features. |
返回值:
A promise for the picked features that will resolve when the asynchronous
picking completes. The resolved value is an array of
ImageryLayerFeatureInfo
instances. The array may be empty if no features are found at the given location.
It may also be undefined if picking is not supported.
requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
参数名称 | 类型 | 描述信息 |
---|---|---|
x |
number | The tile X coordinate. |
y |
number | The tile Y coordinate. |
level |
number | The tile level. |
request |
Request | 可选 The request object. Intended for internal use only. |
返回值:
A promise for the image that will resolve when the image is available, or
undefined if there are too many active requests to the server, and the request should be retried later.
定义的类型
Initialization options for the OpenStreetMapImageryProvider constructor
属性:
属性名称 | 类型 | 可选 | 默认值 | 描述信息 |
---|---|---|---|---|
url |
string |
<可选> |
'https://tile.openstreetmap.org' | The OpenStreetMap server url. |
fileExtension |
string |
<可选> |
'png' | The file extension for images on the server. |
retinaTiles |
boolean |
<可选> |
false | When true, request tiles at the 2x resolution for retina displays. |
rectangle |
Rectangle |
<可选> |
Rectangle.MAX_VALUE | The rectangle of the layer. |
minimumLevel |
number |
<可选> |
0 | The minimum level-of-detail supported by the imagery provider. |
maximumLevel |
number |
<可选> |
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. | |
ellipsoid |
Ellipsoid |
<可选> |
The ellipsoid. If not specified, the WGS84 ellipsoid is used. | |
credit |
Credit | string |
<可选> |
'MapQuest, Open Street Map and contributors, CC-BY-SA' | A credit for the data source, which is displayed on the canvas. |