Class ZoomController

A hook to customize animation options for the zoom animation. This allows you to change the duration of the zoom animation, or its easing function, or turn off animated zooms completely.

These options are passed to MapNavigatorZoomOptions.animate.

A hook to determine the zoom factor for a given gesture event. Factors larger than 1 zoom the map in, factors smaller than one zoom the map out. If 1 is returned, no zooming is performed.

For georeferenced maps, the x and y factor should be the same. For cartesian maps, the x factor can be different from the y factor, so you can zoom on just 1 axis. For example, on a timeline (which is a cartesian map), you may want to zoom on just the x-axis.

For incremental zooms, the factor is relative to the start of the zoom operation. For example, when the pinch started. For non-incremental zooms, the factor is relative to the current state of the map.

The default implementation:

• For scroll events, it keeps track how much the mouse wheel was scrolled during the current zoom animation, and returns a factor based on that. If the shift key is down, it zooms slower.
• For double click events, it zooms out (factor < 1) if the right mouse button was used, otherwise it zooms in (factor > 1).
• For pinch events, it uses PinchEvent.scaleFactorFromStart.

An example of getZoomFactor customization is inverting the original zooming, so the map zooms in when the original controller would've zoomed out:

/**
 * A controller that inverts the original zooming, ie. it zooms out when the original controller would've zoomed in.
 */
class InvertedZoomController extends ZoomController {

  getZoomFactor(gestureEvent: GestureEvent): ZoomFactor {
    const originalFactors = super.getZoomFactor(gestureEvent);
    return {
      x: 1 / originalFactors.x,
      y: 1 / originalFactors.y
    }
  }

}

map.controller = new InvertedZoomController();

Copy

See

MapNavigatorZoomOptions.factor

A hook to customize the zoom target for the given gesture event. This can be a point in view (pixel), model or the map's reference. If it's a point in view reference, a zoom target underneath that view point is determined automatically. For incremental zooms, the target is determined at the start of the interaction. For example, at the start of a touch pinch gesture.

A hook to customize if the zooming should snap to scale levels. The default implementation snaps to scale levels if CTRL is held down.

See

MapNavigatorZoomOptions.snapToScaleLevels

A hook to check if a gesture event is a zoom end event.

If an event is both a "zoom event" and a "zoom end event", a short zoom animation is played (or extended, if it was already running). An example is the default mouse scrollwheel zooming, which plays a zoom animation every time the event occurs.

If an event is a "zoom event" but not a "zoom end event", zooming happens "incrementally" until a "zoom end event" marks the end of the zoom. Examples include touch pinch zooming, which keeps zooming until a "pinch end" event occurs.

The default implementation returns true for scroll events, , "pinch end" events.

A hook to check if a gesture event is a zoom event.

If an event is both a "zoom event" and a "zoom end event", a short zoom animation is played (or extended, if it was already running). An example is the default mouse scrollwheel zooming, which plays a zoom animation every time the event occurs.

If an event is a "zoom event" but not a "zoom end event", zooming happens "incrementally" until a "zoom end event" marks the end of the zoom. An example is touch pinch zooming, which keeps zooming until a "pinch end" event occurs.

The default implementation returns true for scroll events, , pinch events and "pinch end" events.

Called when a gesture event has been received. This is not intended to be overridden by subclasses. You should override the hooks instead (isZoomEvent, isZoomEndEvent, getZoomFactor, getZoomTarget, getZoomAnimationOptions and isSnapToScaleLevels).