diff --git a/packages/system/src/types/general.ts b/packages/system/src/types/general.ts index 4e7cf910..367ca1d8 100644 --- a/packages/system/src/types/general.ts +++ b/packages/system/src/types/general.ts @@ -21,8 +21,33 @@ export type ZoomInOut = (options?: ViewportHelperFunctionOptions) => Promise Promise; export type GetZoom = () => number; export type GetViewport = () => Viewport; + +/** + * The `SetViewport` function is used to set the viewport of the flow. + * + * @inline + * @param viewport - The viewport to set. + * @param options - Optional parameters to control the animation and easing of the viewport change. + */ export type SetViewport = (viewport: Viewport, options?: ViewportHelperFunctionOptions) => Promise; + +/** + * The `SetCenter` function is used to set the center of the flow viewport to a specific position + * + * @inline + * @param x - x coordinate + * @param y - y coordinate + * @param options - Optional parameters to control the animation and easing of the viewport change. + */ export type SetCenter = (x: number, y: number, options?: SetCenterOptions) => Promise; + +/** + * The `FitBounds` function is used to fit the flow viewport to the bounds of the nodes. + * + * @inline + * @param bounds - The bounds to fit the viewport to. + * @param options - Optional parameters to control the animation and easing of the viewport change. + */ export type FitBounds = (bounds: Rect, options?: FitBoundsOptions) => Promise; /** @@ -179,10 +204,16 @@ export type ViewportHelperFunctionOptions = { interpolate?: 'smooth' | 'linear'; }; +/** + * @inline + */ export type SetCenterOptions = ViewportHelperFunctionOptions & { zoom?: number; }; +/** + * @inline + */ export type FitBoundsOptions = ViewportHelperFunctionOptions & { padding?: number; };