KBE3D

Appearance

KBE3D / KBCore / Cesium / UrlTemplateImageryProvider

类: UrlTemplateImageryProvider ​

Provides imagery by requesting tiles using a specified URL template.

示例 ​

ts
// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
const tms = new Cesium.UrlTemplateImageryProvider({
    url : Cesium.buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
    tilingScheme : new Cesium.GeographicTilingScheme(),
    maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
const positron = new Cesium.UrlTemplateImageryProvider({
    url : 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png',
    credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.'
});
// Access a Web Map Service (WMS) server.
const wms = new Cesium.UrlTemplateImageryProvider({
   url : 'https://services.ga.gov.au/gis/services/NM_Hydrology_and_Marine_Points/MapServer/WMSServer?' +
         'tiled=true&transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
         'styles=&service=WMS&version=1.3.0&request=GetMap&' +
         'layers=Bores&crs=EPSG%3A3857&' +
         'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
         'width=256&height=256',
   rectangle : Cesium.Rectangle.fromDegrees(95.0, -55.0, 170.0, -1.0)  // From GetCapabilities EX_GeographicBoundingBox
});
// Using custom tags in your template url.
const custom = new Cesium.UrlTemplateImageryProvider({
   url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
   customTags : {
       Time: function(imageryProvider, x, y, level) {
           return '20171231'
       }
   }
});

参数 ​

Object describing initialization options

继承于 ​

属性 ​

enablePickFeatures ​

enablePickFeatures: boolean

Gets or sets a value indicating whether feature picking is enabled. If true, UrlTemplateImageryProvider#pickFeatures will request the <code>options.pickFeaturesUrl</code> 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.

url ​

readonly url: string

Gets the URL template to use to request tiles. It has the following keywords: <ul> <li> <code>{z}</code>: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid.</li> <li> <code>{x}</code>: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile.</li> <li> <code>{y}</code>: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile.</li> <li> <code>{s}</code>: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host.</li> <li> <code>{reverseX}</code>: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile.</li> <li> <code>{reverseY}</code>: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile.</li> <li> <code>{reverseZ}</code>: 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.</li> <li> <code>{westDegrees}</code>: The Western edge of the tile in geodetic degrees.</li> <li> <code>{southDegrees}</code>: The Southern edge of the tile in geodetic degrees.</li> <li> <code>{eastDegrees}</code>: The Eastern edge of the tile in geodetic degrees.</li> <li> <code>{northDegrees}</code>: The Northern edge of the tile in geodetic degrees.</li> <li> <code>{westProjected}</code>: The Western edge of the tile in projected coordinates of the tiling scheme.</li> <li> <code>{southProjected}</code>: The Southern edge of the tile in projected coordinates of the tiling scheme.</li> <li> <code>{eastProjected}</code>: The Eastern edge of the tile in projected coordinates of the tiling scheme.</li> <li> <code>{northProjected}</code>: The Northern edge of the tile in projected coordinates of the tiling scheme.</li> <li> <code>{width}</code>: The width of each tile in pixels.</li> <li> <code>{height}</code>: The height of each tile in pixels.</li> </ul>

urlSchemeZeroPadding ​

readonly urlSchemeZeroPadding: any

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: <ul> <li> <code>{z}</code>: The zero padding for the level of the tile in the tiling scheme.</li> <li> <code>{x}</code>: The zero padding for the tile X coordinate in the tiling scheme.</li> <li> <code>{y}</code>: The zero padding for the the tile Y coordinate in the tiling scheme.</li> <li> <code>{reverseX}</code>: The zero padding for the tile reverseX coordinate in the tiling scheme.</li> <li> <code>{reverseY}</code>: The zero padding for the tile reverseY coordinate in the tiling scheme.</li> <li> <code>{reverseZ}</code>: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.</li> </ul>

pickFeaturesUrl ​

readonly pickFeaturesUrl: string

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: <ul> <li><code>{i}</code>: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.</li> <li><code>{j}</code>: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.</li> <li><code>{reverseI}</code>: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.</li> <li><code>{reverseJ}</code>: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.</li> <li><code>{longitudeDegrees}</code>: The longitude of the picked position in degrees.</li> <li><code>{latitudeDegrees}</code>: The latitude of the picked position in degrees.</li> <li><code>{longitudeProjected}</code>: The longitude of the picked position in the projected coordinates of the tiling scheme.</li> <li><code>{latitudeProjected}</code>: The latitude of the picked position in the projected coordinates of the tiling scheme.</li> <li><code>{format}</code>: The format in which to get feature information, as specified in the GetFeatureInfoFormat.</li> </ul>

proxy ​

readonly proxy: Proxy

Gets the proxy used by this provider.

tileWidth ​

readonly tileWidth: number

Gets the width of each tile, in pixels.

tileHeight ​

readonly tileHeight: number

Gets the height of each tile, in pixels.

maximumLevel ​

readonly maximumLevel: number | undefined

Gets the maximum level-of-detail that can be requested, or undefined if there is no limit.

minimumLevel ​

readonly minimumLevel: number

Gets the minimum level-of-detail that can be requested.

tilingScheme ​

readonly tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

rectangle ​

readonly rectangle: Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance.

tileDiscardPolicy ​

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.

errorEvent ​

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.

credit ​

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.

hasAlphaChannel ​

readonly hasAlphaChannel: boolean

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.

方法 ​

getTileCredits() ​

getTileCredits(x: number, y: number, level: number): 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;

返回 ​

Credit[]

The credits to be displayed when the tile is displayed.

requestImage() ​

requestImage(x: number, y: number, level: number, request?: 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.

返回 ​

Promise<ImageryTypes> | undefined

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.

pickFeatures() ​

pickFeatures(x: number, y: number, level: number, longitude: number, latitude: number): Promise<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.

返回 ​

Promise<ImageryLayerFeatureInfo[]> | undefined

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.

构造函数 ​

构造函数 ​

new UrlTemplateImageryProvider(options: ConstructorOptions): UrlTemplateImageryProvider

参数 ​

options ​

ConstructorOptions

返回 ​

UrlTemplateImageryProvider

KBE3D @3.0.0 Copyright © 2024-present KBE3D

京ICP备2026003052号-1