Chevron DownAPI Reference

OrthographicView

The OrthographicView class is a subclass of View that creates a top-down view of the XY plane. It is usually used for rendering 2D charts in non-geospatial use cases.

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

Constructor

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

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

flipY (Boolean)

Whether to use top-left coordinates (true) or bottom-left coordinates (false). Default true.

near (Number, optional)

Distance of near clipping plane. Default 0.1.

far (Number, optional)

Distance of far clipping plane. Default 1000.

View State

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

  • target (Number[3], optional) - The world position at the center of the viewport. Default [0, 0, 0].
  • zoom (Number|Number[2], optional) - The zoom level of the viewport. zoom: 0 maps one unit distance to one pixel on screen, and increasing zoom by 1 scales the same object to twice as large. To apply independent zoom levels to the X and Y axes, supply an array [zoomX, zoomY]. Default 0.
  • minZoom (Number, optional) - The min zoom level of the viewport. Default -Infinity.
  • maxZoom (Number, optional) - The max zoom level of the viewport. Default Infinity.

Controller

By default, OrthographicView uses the OrthographicController to handle interactivity. To enable the controller, use:

const view = new OrthographicView({id: '2d-scene', controller: true});

Visit the OrthographicController documentation for a full list of supported options.

Source

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