Google2DImageryProvider
查阅Mars3D API

new Cesium.Google2DImageryProvider(options)
engine/Source/Scene/Google2DImageryProvider.js 67

This object is normally not instantiated directly, use Google2DImageryProvider.fromIonAssetId or Google2DImageryProvider.fromUrl.
Provides 2D image tiles from Google 2D Tiles. Google 2D Tiles can only be used with the Google geocoder.
参数名称 类型 描述信息
options Google2DImageryProvider.ConstructorOptions Object describing initialization options
使用示例s:
// Google 2D imagery provider
const googleTilesProvider = Cesium.Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184
});
// Use your own Google api key
Cesium.GoogleMaps.defaultApiKey = "your-api-key";

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

成员(属性)

readonly credit : Credit
engine/Source/Scene/Google2DImageryProvider.js 255

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

readonly errorEvent : Event
engine/Source/Scene/Google2DImageryProvider.js 242

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.

readonly hasAlphaChannel : boolean
engine/Source/Scene/Google2DImageryProvider.js 283

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.

readonly maximumLevel : number|undefined
engine/Source/Scene/Google2DImageryProvider.js 186

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

readonly minimumLevel : number
engine/Source/Scene/Google2DImageryProvider.js 202

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.

readonly proxy : Proxy
engine/Source/Scene/Google2DImageryProvider.js 267

Gets the proxy used by this provider.

readonly rectangle : Rectangle
engine/Source/Scene/Google2DImageryProvider.js 150

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

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/Google2DImageryProvider.js 228

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.

readonly tileHeight : number
engine/Source/Scene/Google2DImageryProvider.js 174

Gets the height of each tile, in pixels.

readonly tileWidth : number
engine/Source/Scene/Google2DImageryProvider.js 162

Gets the width of each tile, in pixels.

readonly tilingScheme : TilingScheme
engine/Source/Scene/Google2DImageryProvider.js 214

Gets the tiling scheme used by the provider.

readonly url : string
engine/Source/Scene/Google2DImageryProvider.js 138

Gets the URL of the Google 2D Imagery server.

方法

static Cesium.Google2DImageryProvider.fromIonAssetId(options) → Promise.<Google2DImageryProvider>
engine/Source/Scene/Google2DImageryProvider.js 331

Creates an ImageryProvider which provides 2D global tiled imagery from Google 2D Tiles, streamed using the Cesium ion REST API.
参数名称 类型 描述信息
options object Object with the following properties:
参数名称 类型 默认值 描述信息
assetId string The Cesium ion asset id.
mapType "satellite" | "terrain" | "roadmap" "satellite" 可选 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 "en_US" 可选 an IETF language tag that specifies the language used to display information on the tiles
region string "US" 可选 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 object 可选 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 Ellipsoid.default 可选 The ellipsoid. If not specified, the default ellipsoid is used.
minimumLevel number 0 可选 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 22 可选 The maximum level-of-detail supported by the imagery provider.
rectangle Rectangle Rectangle.MAX_VALUE 可选 The rectangle, in radians, covered by the image.
credit Credit | string 可选 A credit for the data source, which is displayed on the canvas.
返回值:
A promise that resolves to the created Google2DImageryProvider.
使用示例s:
// Google 2D imagery provider
const googleTilesProvider = Cesium.Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184
});
// Google 2D roadmap overlay with custom styles
const googleTileProvider = Cesium.Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184,
    overlayLayerType: "layerRoadmap",
    styles: [
        {
            stylers: [{ hue: "#00ffe6" }, { saturation: -20 }],
        },
        {
            featureType: "road",
            elementType: "geometry",
            stylers: [{ lightness: 100 }, { visibility: "simplified" }],
        },
    ],
});

static Cesium.Google2DImageryProvider.fromUrl(options) → Promise.<Google2DImageryProvider>
engine/Source/Scene/Google2DImageryProvider.js 421

Creates an ImageryProvider which provides 2D global tiled imagery from Google 2D Tiles.
参数名称 类型 描述信息
options object Object with the following properties:
参数名称 类型 默认值 描述信息
key string GoogleMaps.defaultApiKey 可选 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 "satellite" | "terrain" | "roadmap" "satellite" 可选 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 "en_US" 可选 an IETF language tag that specifies the language used to display information on the tiles
region string "US" 可选 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 object 可选 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 Ellipsoid.default 可选 The ellipsoid. If not specified, the default ellipsoid is used.
minimumLevel number 0 可选 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 22 可选 The maximum level-of-detail supported by the imagery provider.
rectangle Rectangle Rectangle.MAX_VALUE 可选 The rectangle, in radians, covered by the image.
credit Credit | string 可选 A credit for the data source, which is displayed on the canvas.
返回值:
A promise that resolves to the created Google2DImageryProvider.
使用示例s:
// Use your own Google api key
Cesium.GoogleMaps.defaultApiKey = "your-api-key";

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

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

getTileCredits(x, y, level) → Array.<Credit>|undefined
engine/Source/Scene/Google2DImageryProvider.js 457

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) → undefined
engine/Source/Scene/Google2DImageryProvider.js 502

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 since picking is not supported.

requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
engine/Source/Scene/Google2DImageryProvider.js 482

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.
返回值:
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.

定义的类型

Cesium.Google2DImageryProvider.ConstructorOptions
engine/Source/Scene/Google2DImageryProvider.js 13

Initialization options for the Google2DImageryProvider constructor
属性:
属性名称 类型 可选 默认值 描述信息
key string The Google api key to send with tile requests.
session string The Google session token that tracks the current state of your map and viewport.
url string | Resource | IonResource The Google 2D maps endpoint.
tileWidth string The width of each tile in pixels.
tileHeight string The height of each tile in pixels.
ellipsoid Ellipsoid <可选>
 Ellipsoid.default The ellipsoid. If not specified, the default ellipsoid is used.
minimumLevel number <可选>
 0 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 <可选>
 22 The maximum level-of-detail supported by the imagery provider.
rectangle Rectangle <可选>
 Rectangle.MAX_VALUE The rectangle, in radians, covered by the image.
CtrlK
packages/engine
packages/widgets