Chevron DownAPI Reference

OrbitController

Inherits from Base Controller.

The OrbitController class can be passed to either the Deck class's controller prop or a View class's controller prop to specify that viewport interaction should be enabled.

OrbitController is the default controller for OrbitView.

Usage

Use with the default view:

import {Deck, OrbitView} from '@deck.gl/core';

new Deck({
  views: new OrbitView(),
  controller: {dragPan: false, inertia: true},
  initialViewState: viewState
});

is equivalent to:

import {Deck, OrbitView} from '@deck.gl/core';

new Deck({
  views: new OrbitView({
    controller: {dragPan: false,  inertia: true}
  }),
  initialViewState: viewState
})

Options

Supports all Controller options with the following default behavior:

  • dragMode: default 'rotate' (drag to rotate, shift/ctrl + drag to pan)
  • keyboard: arrow keys to pan, arrow keys with shift/ctrl down to rotate, +/- to zoom

Custom OrbitController

You can further customize the OrbitController's behavior by extending the class:

import {Deck, OrbitView, OrbitController} from '@deck.gl/core';

class MyOrbitController extends OrbitController {

  handleEvent(event) {
    if (event.type === 'pan') {
      // do something
    } else {
      super.handleEvent(event);
    }
  }
}

new Deck({
  views: new OrbitView(),
  controller: {type: MyOrbitController},
  initialViewState: viewState
})

See the Controller class documentation for the methods that you can use and/or override.

Source

modules/core/src/controllers/orbit-controller.js