KBE3D

Appearance

KBE3D / KBCore / Cesium / Google2DImageryProvider

类: Google2DImageryProvider ​

<div class="notice"> This object is normally not instantiated directly, use Google2DImageryProvider.fromIonAssetId or Google2DImageryProvider.fromUrl. </div>

Provides 2D image tiles from Google 2D Tiles

.

Google 2D Tiles can only be used with the Google geocoder.

Examples ​

ts
// Google 2D imagery provider
const googleTilesProvider = Cesium.Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184
});
ts
// Use your own Google api key
Cesium.GoogleMaps.defaultApiKey = "your-api-key";

const googleTilesProvider = Cesium.Google2DImageryProvider.fromUrl({
    mapType: "SATELLITE"
});

参数 ​

Object describing initialization options

属性 ​

url ​

readonly url: string

Gets the URL of the Google 2D Imagery server.

rectangle ​

readonly rectangle: Rectangle

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

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.

minimumLevel ​

readonly minimumLevel: number

Gets the minimum level-of-detail that can be requested. Generally, a minimum level should only be used when the rectangle of the imagery is small enough that the number of tiles at the minimum level is small. An imagery provider with more than a few tiles at the minimum level will lead to rendering problems.

tilingScheme ​

readonly tilingScheme: TilingScheme

Gets the tiling scheme used by the provider.

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.

proxy ​

readonly proxy: Proxy

Gets the proxy used by this provider.

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.

方法 ​

fromIonAssetId() ​

static fromIonAssetId(options: { assetId: string; mapType?: "terrain" | "satellite" | "roadmap"; language?: string; region?: string; overlayLayerType?: "layerRoadmap" | "layerStreetview" | "layerTraffic"; styles?: any; ellipsoid?: Ellipsoid; minimumLevel?: number; maximumLevel?: number; rectangle?: Rectangle; credit?: string | Credit; }): Promise<Google2DImageryProvider>

Creates an ImageryProvider which provides 2D global tiled imagery from Google 2D Tiles

, streamed using the Cesium ion REST API.

参数 ​

options ​

Object with the following properties:

assetId ​

string

The Cesium ion asset id.

mapType? ​

"terrain" | "satellite" | "roadmap"

The map type of the Google map imagery. Valid options are satellite, terrain, and roadmap. If overlayLayerType is set, mapType is ignored and a transparent overlay is returned. If overlayMapType is undefined, then a basemap of mapType is returned. layerRoadmap overlayLayerType is included in terrain and roadmap mapTypes.

language? ​

string

an IETF language tag that specifies the language used to display information on the tiles

region? ​

string

A Common Locale Data Repository region identifier (two uppercase letters) that represents the physical location of the user.

overlayLayerType? ​

"layerRoadmap" | "layerStreetview" | "layerTraffic"

Returns a transparent overlay map with the specified layerType. If no value is provided, a basemap of mapType is returned. Use multiple instances of Google2DImageryProvider to add multiple Google Maps overlays to a scene. layerRoadmap is included in terrain and roadmap mapTypes, so adding as overlay to terrain or roadmap has no effect.

styles? ​

any

An array of JSON style objects that specify the appearance and detail level of map features such as roads, parks, and built-up areas. Styling is used to customize the standard Google base map. The styles parameter is valid only if the mapType is roadmap. For the complete style syntax, see the (Google Style Reference

).

ellipsoid? ​

Ellipsoid

The ellipsoid. If not specified, the default ellipsoid is used.

minimumLevel? ​

number

The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.

maximumLevel? ​

number

The maximum level-of-detail supported by the imagery provider.

rectangle? ​

Rectangle

The rectangle, in radians, covered by the image.

credit? ​

string | Credit

A credit for the data source, which is displayed on the canvas.

返回 ​

Promise<Google2DImageryProvider>

A promise that resolves to the created Google2DImageryProvider.

Examples ​

ts
// Google 2D imagery provider
const googleTilesProvider = Cesium.Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184
});
ts
// Google 2D roadmap overlay with custom styles
const googleTilesProvider = Cesium.Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184,
    overlayLayerType: "layerRoadmap",
    styles: [
        {
            stylers: [{ hue: "#00ffe6" }, { saturation: -20 }],
        },
        {
            featureType: "road",
            elementType: "geometry",
            stylers: [{ lightness: 100 }, { visibility: "simplified" }],
        },
    ],
});

fromUrl() ​

static fromUrl(options: { key?: string; mapType?: "terrain" | "satellite" | "roadmap"; language?: string; region?: string; overlayLayerType?: "layerRoadmap" | "layerStreetview" | "layerTraffic"; styles?: any; ellipsoid?: Ellipsoid; minimumLevel?: number; maximumLevel?: number; rectangle?: Rectangle; credit?: string | Credit; }): Promise<Google2DImageryProvider>

Creates an ImageryProvider which provides 2D global tiled imagery from Google 2D Tiles

.

参数 ​

options ​

Object with the following properties:

key? ​

string

Your API key to access Google 2D Tiles. See https://developers.google.com/maps/documentation/javascript/get-api-key

for instructions on how to create your own key.

mapType? ​

"terrain" | "satellite" | "roadmap"

The map type of the Google map imagery. Valid options are satellite, terrain, and roadmap. If overlayLayerType is set, mapType is ignored and a transparent overlay is returned. If overlayMapType is undefined, then a basemap of mapType is returned. layerRoadmap overlayLayerType is included in terrain and roadmap mapTypes.

language? ​

string

an IETF language tag that specifies the language used to display information on the tiles

region? ​

string

A Common Locale Data Repository region identifier (two uppercase letters) that represents the physical location of the user.

overlayLayerType? ​

"layerRoadmap" | "layerStreetview" | "layerTraffic"

Returns a transparent overlay map with the specified layerType. If no value is provided, a basemap of mapType is returned. Use multiple instances of Google2DImageryProvider to add multiple Google Maps overlays to a scene. layerRoadmap is included in terrain and roadmap mapTypes, so adding as overlay to terrain or roadmap has no effect.

styles? ​

any

An array of JSON style objects that specify the appearance and detail level of map features such as roads, parks, and built-up areas. Styling is used to customize the standard Google base map. The styles parameter is valid only if the mapType is roadmap. For the complete style syntax, see the (Google Style Reference

).

ellipsoid? ​

Ellipsoid

The ellipsoid. If not specified, the default ellipsoid is used.

minimumLevel? ​

number

The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.

maximumLevel? ​

number

The maximum level-of-detail supported by the imagery provider.

rectangle? ​

Rectangle

The rectangle, in radians, covered by the image.

credit? ​

string | Credit

A credit for the data source, which is displayed on the canvas.

返回 ​

Promise<Google2DImageryProvider>

A promise that resolves to the created Google2DImageryProvider.

Examples ​

ts
// Use your own Google api key
Cesium.GoogleMaps.defaultApiKey = "your-api-key";

const googleTilesProvider = Cesium.Google2DImageryProvider.fromUrl({
    mapType: "satellite"
});
ts
// Google 2D roadmap overlay with custom styles
Cesium.GoogleMaps.defaultApiKey = "your-api-key";

const googleTilesProvider = Cesium.Google2DImageryProvider.fromUrl({
    overlayLayerType: "layerRoadmap",
    styles: [
        {
            stylers: [{ hue: "#00ffe6" }, { saturation: -20 }],
        },
        {
            featureType: "road",
            elementType: "geometry",
            stylers: [{ lightness: 100 }, { visibility: "simplified" }],
        },
    ],
});

getTileCredits() ​

getTileCredits(x: number, y: number, level: number): Credit[] | undefined

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[] | undefined

The credits to be displayed when the tile is displayed.

requestImage() ​

requestImage(x: number, y: number, level: number, request?: Request): Promise<ImageryTypes> | undefined

Requests the image for a given tile.

参数 ​

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): undefined

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

参数 ​

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.

返回 ​

undefined

Undefined since picking is not supported.

构造函数 ​

构造函数 ​

new Google2DImageryProvider(options: ConstructorOptions): Google2DImageryProvider

参数 ​

options ​

ConstructorOptions

返回 ​

Google2DImageryProvider

KBE3D @3.0.0 Copyright © 2024-present KBE3D

京ICP备2026003052号-1