Chevron DownAPI Reference

GlobeView (Experimental)

This class is experimental, which means it does not provide the compatibility and stability that one would typically expect from other View classes. Use with caution and report any issues that you find on GitHub.

The GlobeView class is a subclass of View. This view projects the earth into a 3D globe.

It's recommended that you read the Views and Projections guide before using this class.

Limitations

The goal of GlobeView is to provide a generic solution to rendering and navigating data in the 3D space. In the initial release, this class mainly addresses the need to render an overview of the entire globe. The following limitations apply, as features are still under development:

  • No support for rotation (pitch or bearing). The camera always points towards the center of the earth, with north up.
  • No high-precision rendering at high zoom levels (> 12). Features at the city-block scale may not be rendered accurately.
  • Only supports COORDINATE_SYSTEM.LNGLAT (default of the coordinateSystem prop).
  • Known rendering issues when using multiple views mixing GlobeView and MapView, or switching between the two.
  • These layers currently do not work in this view:
    • Aggregation layers: HeatmapLayer, ContourLayer
    • Tiled layers: TerrainLayer, MVTLayer

When GeoJson paths and polygons are rendered with this view, the straight lines and flat surfaces are warped to the surface of the globe. Note that the warped edges still correspond to straight lines in the Mercator projection. To draw lines along the shortest distance on the globe, use the GreatCircleLayer.

Constructor

import {_GlobeView as GlobeView} from '@deck.gl/core';
const view = new GlobeView({id, ...});

GlobeView takes the same parameters as the View superclass constructor, plus the following:

  • resolution (Number, optional) - the resolution at which to turn flat features into 3D meshes, in degrees. Smaller numbers will generate more detailed mesh. Default 10.

View State

To render, GlobeView needs to be used together with a viewState with the following parameters:

  • longitude (Number) - longitude at the viewport center
  • latitude (Number) - latitude at the viewport center
  • zoom (Number) - zoom level
  • maxZoom (Number, optional) - max zoom level. Default 20.
  • minZoom (Number, optional) - min zoom level. Default 0.

GlobeController

By default, GlobeView uses the GlobeController to handle interactivity. To enable the controller, use:

const view = new GlobeView({id: 'globe', controller: true});

GlobeController supports the following interactions:

  • dragPan: Drag to pan
  • scrollZoom: Mouse wheel to zoom
  • doubleClickZoom: Double click to zoom in, with shift/ctrl down to zoom out
  • touchZoom: Pinch zoom
  • keyboard: Keyboard (arrow keys to pan, +/- to zoom)

You can further customize its behavior by extending the class:

import {_GlobeController as GlobeController} from '@deck.gl/core';

class MyGlobeController extends GlobeController {}

const view = new GlobeView({id: 'globe', controller: MyGlobeController});

See the documentation of Controller for implementation details.

Remarks

Occlusion

In the MapView, it is often sufficient to provide a solid background color where there is no geometry. In the GlobeView, the user can "see through" to the other side of the earth. There are two ways to fix this:

  • Render a polygon that represents the surface of the earth:
new SolidPolygonLayer({
  id: 'background',
  data: [
    [[-180, 90], [0, 90], [180, 90], [180, -90], [0, -90], [-180, -90]]
  ],
  getPolygon: d => d,
  stroked: false,
  filled: true,
  getFillColor: [40, 40, 40]
})
  • Discard all surfaces that face away from the camera by passing the following prop to Deck:
parameters: {
  cull: true
}

Source

modules/core/src/views/globe-view.js