GridImageryProvider

new GridImageryProvider(backgroundColor)

An ImageryProvider that draws a wireframe grid on every tile with controllable background and glow. May be useful for custom rendering effects or debugging terrain.

Name	Type	Default	Description
`options.tilingScheme`	TilingScheme	`new GeographicTilingScheme()`	optional The tiling scheme for which to draw tiles.
`options.cells`	Number	`8`	optional The number of grids cells.
`options.color`	Color	`Color(1.0, 1.0, 1.0, 0.4)`	optional The color to draw grid lines.
`options.glowColor`	Color	`Color(0.0, 1.0, 0.0, 0.05)`	optional The color to draw glow for grid lines.
`options.glowWidth`	Number	`6`	optional The width of lines used for rendering the line glow effect.
`backgroundColor`	Color	`Color(0.0, 0.5, 0.0, 0.2)`	optional Background fill color.
`options.tileWidth`	Number	`256`	optional The width of the tile for level-of-detail selection purposes.
`options.tileHeight`	Number	`256`	optional The height of the tile for level-of-detail selection purposes.
`options.canvasSize`	Number	`256`	optional The size of the canvas used for rendering.

Source: Scene/GridImageryProvider.js, line 33

Members

credit :Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 184

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.

Source: Scene/GridImageryProvider.js, line 161

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.

Source: Scene/GridImageryProvider.js, line 199

maximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 98

minimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 110

proxy :Proxy

Gets the proxy used by this provider.

Source: Scene/GridImageryProvider.js, line 61

ready :Boolean

Gets a value indicating whether or not the provider is ready for use.

Source: Scene/GridImageryProvider.js, line 172

rectangle :Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 134

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. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 148

tileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 85

tileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 73

tilingScheme :TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before GridImageryProvider#ready returns true.

Source: Scene/GridImageryProvider.js, line 122

Methods

_createGridCanvas()

Render a grid into a canvas with background and glow

Source: Scene/GridImageryProvider.js, line 231

_drawGrid()

Draws a grid of lines into a canvas.

Source: Scene/GridImageryProvider.js, line 211

getTileCredits(x, y, level) → Credit[]

Gets the credits to be displayed when a given tile is displayed.

Name	Type	Description
`x`	Number	The tile X coordinate.
`y`	Number	The tile Y coordinate.
`level`	Number	The tile level;

Returns:

The credits to be displayed when the tile is displayed.

Throws:

DeveloperError : getTileCredits must not be called before the imagery provider is ready.

Source: Scene/GridImageryProvider.js, line 284

requestImage(x, y, level) → Promise

Requests the image for a given tile. This function should not be called before GridImageryProvider#ready returns true.

Name	Type	Description
`x`	Number	The tile X coordinate.
`y`	Number	The tile Y coordinate.
`level`	Number	The tile level.

Returns:

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. The resolved image may be either an Image or a Canvas DOM object.

Source: Scene/GridImageryProvider.js, line 303