getViewportForBounds()

Source on Github (opens in a new tab)

This util returns the viewport for the given bounds. You might use this to pre-calculate the viewport for a given set of nodes on the server or calculate the viewport for the given bounds without changing the viewport directly.

ℹ️

This function was previously called getTransformForBounds

import { getViewportForBounds } from '@xyflow/react';
 
const { x, y, zoom } = getViewportForBounds(
  {
    x: 0,
    y: 0,
    width: 100,
    height: 100,
  },
  1200,
  800,
  0.5,
  2,
);

Signature

Name	Type	Default
#Params
#`bounds`	`Rect`
#`width`	`number`
#`height`	`number`
#`minZoom`	`number`
#`maxZoom`	`number`
#`padding?`	`number`	`0.1`
#Returns
#`viewport`	`Viewport` The transformed viewport (`{ x: number, y: number, zoom: number }`).

Notes

This is quite a low-level utility. You might want to look at the fitView or fitBounds methods for a more practical api.

getStraightPath()isEdge()