GridImageryProvider

new Cesium.GridImageryProvider(options)

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 Description
options GridImageryProvider.ConstructorOptions Object describing initialization options

Members

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.
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

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

Gets the maximum level-of-detail that can be requested.
Gets the minimum level-of-detail that can be requested.
Gets the proxy used by this provider.
Gets the rectangle, in radians, of the imagery provided by this instance.
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.
Gets the height of each tile, in pixels.
Gets the width of each tile, in pixels.
Gets the tiling scheme used by this provider.

Methods

Render a grid into a canvas with background and glow
Draws a grid of lines into a canvas.

getTileCredits(x, y, level)Array.<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.

pickFeatures(x, y, level, longitude, latitude)undefined

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
Name Type Description
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.
Returns:
Undefined since picking is not supported.

requestImage(x, y, level, request)Promise.<HTMLCanvasElement>

Requests the image for a given tile.
Name Type Description
x number The tile X coordinate.
y number The tile Y coordinate.
level number The tile level.
request Request optional The request object. Intended for internal use only.
Returns:
The resolved image as a Canvas DOM object.

Type Definitions

Cesium.GridImageryProvider.ConstructorOptions

Initialization options for the GridImageryProvider constructor
Properties:
Name Type Attributes Default Description
tilingScheme TilingScheme <optional>
new GeographicTilingScheme() The tiling scheme for which to draw tiles.
ellipsoid Ellipsoid <optional>
The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
cells number <optional>
8 The number of grids cells.
color Color <optional>
Color(1.0, 1.0, 1.0, 0.4) The color to draw grid lines.
glowColor Color <optional>
Color(0.0, 1.0, 0.0, 0.05) The color to draw glow for grid lines.
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.
tileWidth number <optional>
256 The width of the tile for level-of-detail selection purposes.
tileHeight number <optional>
256 The height of the tile for level-of-detail selection purposes.
canvasSize number <optional>
256 The size of the canvas used for rendering.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.