@visuallyjs/browser-ui 1.1.4 → 1.2.1

package/types/core/util.d.ts

@@ -362,6 +362,11 @@ export declare function isDate(o: any): o is Date;
  * @internal
  */
 export declare function isFunction(o: any): o is Function;
+/**
+ * return whether or not the given value is a Class
+ * @param o
+ */
+export declare function isClass(o: any): boolean;
 /**
  * Returns whether or not the given value is of type `Function` and is a named Function.
  * @param o

package/types/ui/core/constants.d.ts

@@ -23,6 +23,13 @@ export declare const ATTRIBUTE_MANAGED = "data-vjs-managed";
  * @context element-dragging
  */
 export declare const ATTRIBUTE_NOT_DRAGGABLE = "data-vjs-not-draggable";
+/**
+ * This attribute can be written onto DOM elements by node/group renderers to instruct VisuallyJs that the given element should not cause mouse events for the given vertex to be fired.
+ * @group Nodes and Groups
+ * @category DOM Attributes
+ * @domAttribute
+ */
+export declare const ATTRIBUTE_SUPPRESS_VERTEX_EVENTS = "data-vjs-no-events";
 /**
  * Written by the Surface when `elementsDraggable` is provided as a constructor option. The value of this attribute will match what you provide for `elementsDraggable`, but it's really only of any use if you set it to `false`, as `true` is the default.
  * @internal

package/types/ui/core/core.d.ts

@@ -643,6 +643,10 @@ export declare abstract class UICore<EL, EVT = CoreUIEvent> extends OptimisticEv
      * Gets the current bounds of the UI's viewport.
      */
     abstract getViewportBoundsInfo(): ViewportBounds;
+    /**
+     * If the UI has a fixed viewport (not panning, zooming etc), it can opt to return a value from this method. A background can use this information to place itself.
+     */
+    abstract $getFixedViewportBoundsInfo(): ViewportBounds | null;
     abstract getApparentCanvasLocation(): PointXY;
     abstract toFront(v: string | Vertex | EL, alsoBringAncestorsToFront?: boolean): void;
     abstract toBack(v: string | Vertex | EL, alsoSendAncestorsToBack?: boolean): void;

package/types/ui/core/definitions.d.ts

@@ -102,6 +102,10 @@ export type VertexDragFilter<E> = (p: {
  * @category Definitions
  */
 export type DragConstrainFunction<E> = (desiredLoc: PointXY, dragEl: E, modelObject: Node | Group, size: Size, currentLoc: PointXY, e: MouseEvent) => PointXY;
+/**
+ * Strategy for determining whether something that is moving is considered out of bounds. Options are 'contained', ie the element must be fully contained inside the root bounds, or 'intersecting', ie. the element must intersect the root bounds by some amount. Prior to 1.1.4 the behaviour was 'contained', but a change in 1.1.4 switched this to 'intersecting', which does not necessarily provide the best UX when the canvas is hard up against the edge of the screen, because it isnt always possible to move the mouse far enough that the element is not intersecting, and in those situations panning stops. From 1.2.1 onwards the default is once again `contained`, but you can change that via the `autoPanBoundsStrategy` option on the surface's dragOptions.
+ */
+export type AutoPanBoundsStrategy = "contained" | "intersecting";
 /**
  * Options for element drag
  * @group UI
@@ -136,6 +140,10 @@ export interface DragOptions<E> {
      * When auto-panning, this is the number of pixels that the canvas repositions itself on each tick. Defaults to 5.
      */
     autoPanDelta?: number;
+    /**
+     * When auto-panning, this flag instructs the auto pan how to determine if an element is inside the root bounds or not. A value of "contained" (the default), means the whole element has to be inside the root bounds. A value of "intersecting" means that the element needs to just intersect the root bounds by some amount.
+     */
+    autoPanBoundsStrategy?: AutoPanBoundsStrategy;
     /**
      * Optional function that is invoked at the start of a drag, and which identifies allowed drop targets. Each target - the canvas, nodes and groups - is passed in turn to this method; returning false indicates that the given target is not valid for that drag.
      * @param candidate
@@ -164,6 +172,7 @@ export interface SupportsElementDragging<E> {
     $startPanRepeat: (dirX: 1 | 0 | -1, dirY: 1 | 0 | -1, dx: number, dy: number, interval: number, cb?: (total: PointXY) => any) => void;
     $stopPanRepeat: () => void;
     $provisionallyMagnetize(focus: Vertex, repositionFocus: boolean, knownLocations: Record<string, PointXY>, knownSizes: Record<string, Size>, magnetizerIsAlreadyPrimed: boolean, invertTrackbackPreference: boolean): MagnetizeResult;
+    addVertexDragFilter(f: VertexDragFilter<E>): void;
 }
 /**
  * Payload for the node:move:start event that is fired when a node/group has just begun to be moved.

package/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.1.4";
+export declare const VERSION = "1.2.1";