@visuallyjs/browser-ui 1.2.3 → 1.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visuallyjs/browser-ui",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "license": "Commercial",
   "main": "js/visuallyjs.browser-ui.cjs.js",
   "module": "js/visuallyjs.browser-ui.esm.js",

package/types/browser-ui/pan-zoom-options.d.ts

@@ -236,8 +236,7 @@ export interface PanZoomOptions {
      */
     enabled?: boolean;
     /**
-     * Optional filter that will be called on down event, with the event target and the event. Returning true
-     * from this function means the widget should respond to the event.
+     * Optional filter that will be called on down event, with the event target and the event. Returning true from this function means the widget should respond to the event.
      */
     filter?: Function;
     /**

package/types/browser-ui/pan-zoom.d.ts

@@ -183,6 +183,7 @@ export declare class PanZoom {
     private _apparentOffset;
     private _canStartPanning;
     private handlers;
+    private _endPan;
     private _call;
     /**
      * Programmatically report a down event in order to kick the widget into action.
@@ -499,7 +500,7 @@ export declare class PanZoom {
      */
     mapEventLocation(event: MouseEvent): PointXY;
     /**
-     * Sets whether or not the component should respond to mouse events.
+     * Sets whether or not the component should respond to mouse events. Resets any active pan operation - this can be invoked via the lasso arming itself after a long press.
      * @param state Whether or not to respond to mouse events.
      */
     setEnabled(state: boolean): void;

package/types/browser-ui/surface-renderer/plugins/lasso/lasso-plugin.d.ts

@@ -59,6 +59,14 @@ export interface LassoPluginOptions extends BrowserUIPluginOptions {
      * Optional setting for whether lasso inside groups is enabled - it is by default. Setting this to `false` will mean that the user cannot lasso items inside a group. Setting to `"metaKey"` will mean that lasso is supported inside groups if the user is holding the meta key down (ie the Window key, or Cmd on macs).
      */
     enableInGroups?: false | true | "metaKey";
+    /**
+     * Defaults to false. If true, the lasso will arm itself after a long press.
+     */
+    autoArm?: boolean;
+    /**
+     * Timeout in ms for autoArm long press. Defaults to 500ms.
+     */
+    armTimeout?: number;
 }
 /**
  * A Surface plugin that allows the user to select multiple elements with the mouse.

package/types/browser-ui/surface-renderer/plugins/lasso/lasso.d.ts

@@ -3,6 +3,9 @@ import { ViewportElement } from "../../../../ui";
 import { BrowserElement } from "../../../util";
 import { PointXY, Size } from "../../../../core";
 import { AutoPanHandler } from "../../../auto-pan-handler";
+/**
+ * Options for a lasso
+ */
 export interface LassoOptions {
     canvas: Element;
     onStart?: (pagePosition: PointXY, canvasPosition: PointXY, shiftKey: boolean, e: MouseEvent, viewportElement: ViewportElement<BrowserElement> | null) => any;
@@ -14,6 +17,9 @@ export interface LassoOptions {
      * @param e
      */
     onClick?: (p: PointXY, e: MouseEvent) => any;
+    /**
+     * Set this to true to have the lasso drawn as set of overlays which mask the whole browser window except for the lassoed area.
+     */
     invert?: boolean;
     surface: Surface;
     filter?: ((e: MouseEvent) => boolean) | string;
@@ -34,6 +40,14 @@ export interface LassoOptions {
      * Defaults to true, meaning the canvas will pan automatically to track the lasso
      */
     autoPan?: boolean;
+    /**
+     * Defaults to false. If true, the lasso will arm itself after a long press.
+     */
+    autoArm?: boolean;
+    /**
+     * Timeout in ms for autoArm long press. Defaults to 500ms.
+     */
+    armTimeout?: number;
 }
 export declare class Lasso {
     visibleOrigin: PointXY;
@@ -69,6 +83,10 @@ export declare class Lasso {
     _enableInGroups: false | true | "metaKey";
     _generatedLassoContent: BrowserElement;
     _lastPageLocation: PointXY;
+    _autoArm: boolean;
+    _armTimeout: number;
+    _armTimer: any;
+    _armClickTriggered: boolean;
     constructor(options: LassoOptions);
     /**
      * list of selectors that should be filtered regardless of user preference

package/types/core/io.d.ts

@@ -94,7 +94,13 @@ export interface VisuallyJsDefaultJSON {
      */
     groups?: Array<GroupData>;
 }
+/**
+ * Defines the default JSON datatype
+ */
 export declare const JSON_DATATYPE = "json";
+/**
+ * Defines the hierarchical json datatype
+ */
 export declare const HIERARCHICAL_JSON_DATATYPE = "hierarchical-json";
 /**
  * Register a parser for some given datatype

package/types/core/layout/bowtie/bowtie-layout.d.ts

@@ -0,0 +1,69 @@
+import { AbstractLayout, InternalLayoutOptions, LayoutParameters } from "../abstract-layout";
+import { HasIdAndType, Vertex } from "../../model/graph";
+import { PointXY, Size } from "../../util";
+import { DataSource } from "../../datasource";
+import { CircularLayoutParameters } from "../circular";
+/**
+ * Bowtie layout type.
+ * @group Layouts
+ * @category Bowtie
+ */
+export declare const LAYOUT_TYPE_BOWTIE = "Bowtie";
+/**
+ * Options for the Bowtie layout
+ * @group Layouts
+ * @category Hierarchy
+ */
+export interface BowtieLayoutParameters extends LayoutParameters {
+    /**
+     * Whether to draw the layout horizontally or vertically. Defaults to "horizontal".
+     */
+    axis?: "horizontal" | "vertical";
+    /**
+     * Optional node to use as the root. You must provide this or `getRootNode`.
+     */
+    rootNode?: Vertex | string;
+    /**
+     * Optional function you can provide that will dynamically be invoked to get the root node to use. You must provide this or `rootNode`.
+     */
+    getRootNode?: (dataSource: DataSource) => Vertex | string;
+    /**
+     * Gets immediate upstream nodes for the focus vertex. Only invoked with the focus vertex.
+     * @param dataSource
+     * @param vertex
+     */
+    getUpstream: (dataSource: DataSource, vertex: HasIdAndType) => Array<HasIdAndType>;
+    /**
+     * Gets immediate downstream nodes for the focus vertex. Only invoked with the focus vertex.
+     * @param dataSource
+     * @param vertex
+     */
+    getDownstream: (dataSource: DataSource, vertex: HasIdAndType) => Array<HasIdAndType>;
+    /**
+     * Optional function to invoke on any non-focus vertex, to get the vertex's children. Will not be invoked with the focus vertex. If this function returns the focus vertex in its set it will be filtered out. When you do not provide this function, VisuallyJs will find all vertices that are targets of edges for which this vertex is a source.
+     */
+    childVerticesFunction?: (node: HasIdAndType, dataSource: DataSource) => Array<HasIdAndType>;
+}
+/**
+ * Places the focus vertex in the center of the canvas and then branches out to the left and right - or top and bottom - with children of the focus. You are expected to supply a `getUpstream` and `getDownstream` function for this layout, as well as either `getRootNode` or `rootNode`. `getUpstream` is used to get the immediate children of the focus vertex that will be painted to the left or above, depending on axis. `getDownstream` is used to get the immediate children of the focus vertex that will be painted to the right or below. By default this layout will draw horizontally, which you can change by setting `axis:"vertical"`.
+ * @group Layouts
+ * @category Bowtie
+ */
+export declare class BowtieLayout extends AbstractLayout<BowtieLayoutParameters> {
+    focusVertex: Vertex;
+    static type: string;
+    readonly type = "Bowtie";
+    private readonly _getRootNode;
+    private readonly _rootNode;
+    private _axis;
+    private _getUpstreamVertices;
+    private _getDownstreamVertices;
+    private _childVerticesFunction;
+    private _defaultGetDownstream;
+    constructor(params: InternalLayoutOptions<BowtieLayoutParameters>);
+    begin(dataSource: DataSource, positionGetter: (id: string) => PointXY, positionSetter: (id: string, x: number, y: number) => void, sizes: Record<string, Size>, parameters: CircularLayoutParameters): void;
+    end(dataSource: DataSource, getPosition: (id: string) => PointXY, setPosition: (id: string, x: number, y: number) => void, sizes: Record<string, Size>, parameters: BowtieLayoutParameters): void;
+    getDefaultParameters(): BowtieLayoutParameters;
+    reset(): void;
+    step(dataSource: DataSource, getPosition: (id: string) => PointXY, setPosition: (id: string, x: number, y: number) => void, sizes: Record<string, Size>, parameters: BowtieLayoutParameters): void;
+}

package/types/core/layout/bowtie/index.d.ts

@@ -0,0 +1 @@
+export * from "./bowtie-layout";

package/types/core/layout/hierarchy/definitions.d.ts

@@ -1,5 +1,4 @@
 import { AbstractEdgeTerminus, Edge, Group, HasId, HasIdAndType, Node } from "../../model/graph";
-import { VisuallyJsModel } from "../../toolkit";
 import { AbsoluteBackedLayoutParameters } from "../absolute-layout";
 import { PlacementStageStrategy } from "./placement-stage";
 import { HierarchyLayout } from "./hierarchy-layout";
@@ -7,6 +6,7 @@ import { VertexSet } from "./vertex-set";
 import { LayoutLayerEntry, LayoutLayerOrdering } from "../abstract-layout";
 import { GatedPath } from "../../router";
 import { PointXY, Size } from "../../util";
+import { DataSource } from "../../datasource";
 /**
  * @internal
  */
@@ -21,7 +21,7 @@ export declare const VERTEX = "vertex";
  * @category Hierarchy
  * @typeParam T Defines the type of the object from which child vertices will be retrieved, and the type of the child vertices.
  */
-export type ChildVerticesFunction<T extends HasId> = (node: T, layer: number, instance: VisuallyJsModel) => Array<T>;
+export type ChildVerticesFunction<T extends HasId> = (node: T, layer: number, instance: DataSource) => Array<T>;
 /**
  * Axis types for a {@link HierarchyLayout}
  * @group Layouts

package/types/core/layout/hierarchy/parent-relative-placement.d.ts

@@ -1,7 +1,7 @@
 import { ParentRelativePlacementStrategyOptions } from "./definitions";
 import { HasIdAndType } from "../../model/graph";
 import { PointXY } from "../../util";
-import { VisuallyJsModel } from "../../toolkit";
+import { DataSource } from "../../datasource";
 /**
  * Places elements with respect to their parents, aligning them at parent start/end/center depending on the value of `alignment`.
  * @internal
@@ -34,7 +34,7 @@ export declare class ParentRelativePlacementStrategy<T extends HasIdAndType> {
     private readonly _getSize;
     private readonly _getChildVertices;
     private readonly _absolutePositionFunction;
-    constructor(model: VisuallyJsModel, parameters: ParentRelativePlacementStrategyOptions<T>);
+    constructor(model: DataSource, parameters: ParentRelativePlacementStrategyOptions<T>);
     execute(): Map<string, {
         position: PointXY;
         layer: number;

package/types/core/layout/index.d.ts

@@ -8,3 +8,4 @@ export * from './grid';
 export * from './force-directed';
 export * from './hierarchical';
 export * from './hierarchy';
+export * from './bowtie';

package/types/core/model/graph.d.ts

@@ -836,6 +836,8 @@ export declare abstract class Vertex extends Base implements AbstractEdgeTerminu
      * Gets all Edges where this Vertex is the target.
      */
     getTargetEdges(): Array<Edge>;
+    getAllSourceEdges(): Edge[];
+    getAllTargetEdges(): Edge[];
     /**
      * Adds an Edge to the vertex.
      * @param edge The Edge to add.

package/types/test-support/test-support.d.ts

@@ -41,6 +41,7 @@ export interface SynthesizedEvent {
     pageX: number;
     pageY: number;
 }
+declare function _createMouseEventWithPageLoc(el: Element, evt: string, pageLoc: PointXY, metaKeys?: Record<string, boolean>, button?: number): void;
 /**
  * Callbacks you can provide to connection drag methods in the TestHarness to interrupt the process
  * and inspect what's going on.
@@ -97,6 +98,7 @@ export declare const VisuallyJsTestSupport: {
     nudgeEvent: typeof _nudgeEvent;
     getEdgeCanvas: typeof getEdgeCanvas;
     defaultEventManager: EventManager;
+    createMouseEventWithPageLoc: typeof _createMouseEventWithPageLoc;
     /**
      * Drag any DOM element around, not just elements managed by the surface.
      * @param el

package/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.2.3";
+export declare const VERSION = "1.2.4";