GridImageryProvider

new GridImageryProvider

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.

Parameters:

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

Source:

/Source/Scene/GridImageryProvider.js

Members

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.

extent :Extent

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

maximumLevel :Number

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

minimumLevel :Number

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

proxy :Proxy

Gets the proxy used by this provider.

ready :Boolean

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

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.

tileHeight :Number

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

tileWidth :Number

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

tilingScheme :TilingScheme

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

Methods

_createGridCanvas

Render a grid into a canvas with background and glow

_drawGrid

Draws a grid of lines into a canvas.

getTileCredits

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

Parameters:

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

Throws:

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

Returns:

Credit[] The credits to be displayed when the tile is displayed.

requestImage

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

Parameters:

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

Returns:

Promise 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.