@visuallyjs/browser-ui 1.0.3 → 1.1.1

package/types/ui/property-mappings/definitions.d.ts

@@ -2,6 +2,8 @@ import { EdgeMapping } from "../core";
 /**
  * A mapping of some property/properties to a set of appearance values. Currently only used by edges.
  * @typeParam D Identifies the type that each mapping has. For instance, for {@link EdgePropertyMappings}, this type is {@link EdgeDefinition}.
+ * @group UI
+ * @category Definitions
  */
 export interface PropertyMapping<D> {
     /**
@@ -15,10 +17,14 @@ export interface PropertyMapping<D> {
 }
 /**
  * A set of property mappings for edges.
+ * @group UI
+ * @category Definitions
  */
 export type EdgePropertyMappings = Array<PropertyMapping<EdgeMapping>>;
 /**
  * A set of {@link PropertyMapping}s - currently only edges are supported, but future versions will support nodes, groups and ports
+ * @group UI
+ * @category Definitions
  */
 export interface PropertyMappings {
     /**

package/types/ui/util/util.d.ts

@@ -6,7 +6,6 @@
  * @internal
  */
 import { PointXY, Size } from "../../core";
-export declare function filterList(list: Array<any> | string, value: any, missingIsFalse?: boolean): boolean;
 /**
  * Equivalent of Object.assign, which IE11 does not support.
  * @param o1
@@ -23,13 +22,6 @@ export interface RotatedPointXY extends PointXY {
     cr: number;
     sr: number;
 }
-/**
- * Internal method used to rotate an anchor orientation.
- * @param orientation
- * @param rotation
- * @internal
- */
-export declare function rotateAnchorOrientation(orientation: [number, number], rotation: any): [number, number];
 /**
  * Iterates through the given `obj` and applies the given function. if `obj` is not ArrayLike then the function is
  * executed directly on `obj`.
@@ -46,24 +38,19 @@ export declare function each(obj: any, fn: Function): void;
  * @internal
  */
 export declare function wrap(wrappedFunction: Function, newFunction: Function, returnOnThisValue?: any): () => any;
-/**
- * A copy of a concept from a later version of Typescript than jsPlumb can currently use.
- * @internal
- */
 /**
  * Defines a function that can be used to sort an array.
  * @internal
  */
 export type SortFunction<T> = (a: T, b: T) => number;
 /**
- * Definition of a function that can be used to constrain the movement of an element that is being dragged. The function is
- * given the "desiredLoc", which is the location the element would be moved to if not constrained, and it is expected to return
- * either some other value, meaning place the element at that position, or null, meaning for the given desired location there
- * is no preferred position and the element should not be moved.
+ * Definition of a function that can be used to constrain the movement of an element that is being dragged. The function is given the "desiredLoc", which is the location the element would be moved to if not constrained, and it is expected to return either some other value, meaning place the element at that position, or null, meaning for the given desired location there is no preferred position and the element should not be moved.
  *
  * @param desiredLoc - Position the element will be placed at if unconstrained
  * @param dragEl - the element that is being dragged
  * @param size - The size of the element being dragged
  * @param e - The event associated with this tick of the drag lifecycle.
+ * @group UI
+ * @category Definitions
  */
 export type ConstrainFunction<EL, E> = (desiredLoc: PointXY, dragEl: EL, constrainRect: Size, size: Size, currentPos: PointXY, e: E) => PointXY;

package/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.0.3";
+export declare const VERSION = "1.1.1";

package/types/ui/core/router/base-router.d.ts

@@ -1,100 +0,0 @@
-import { AnchorPlacement, Geometry, Edge } from "../../../core";
-import { ConnectionDetachedParams } from "../callbacks";
-import { RedrawResult, Router } from "./router";
-import { Connection } from "../connector/connection-impl";
-import { UICore } from "../core";
-import { ViewportElement } from "../viewport";
-import { AnchorSpec, Connector, AnchorComputeParams, LightweightAnchor, LightweightContinuousAnchor } from "../../common";
-import { AStarGrid } from "../../../core";
-import { ConnectorComputeParams } from "../connector/abstract-connector";
-import { AnchorLists } from "./router-utils";
-/**
- * Base router options. Placeholder interface for subclasses.
- * @internal
- */
-export interface BaseRouterOptions {
-    gridCellSize?: number;
-    avoidVertices?: boolean;
-    vertexBuffer?: number;
-    vertexBorder?: number;
-}
-/**
- * @internal
- */
-export declare abstract class BaseRouter<EL> implements Router<EL, LightweightAnchor> {
-    instance: UICore<any, any>;
-    anchorLists: Map<string, AnchorLists>;
-    protected _avoidVertices: boolean;
-    protected _gridCellSize: number;
-    protected _vertexBuffer: number;
-    protected _vertexBorder: number;
-    protected _grid: AStarGrid;
-    protected constructor(instance: UICore<any, any>, options?: BaseRouterOptions);
-    /**
-     * Notification that a connection was removed.
-     * @param params
-     */
-    $connectionRemoved(params: ConnectionDetachedParams<any>): void;
-    elementRemoved(el: ViewportElement<EL>): void;
-    private _removeConnection;
-    $connectionDetachedFromElement(connection: Connection<EL>, el: ViewportElement<any>): void;
-    /**
-     * Sets the current anchor index in an anchor that has more than one location
-     * @internal
-     * @param anchor
-     * @param idx
-     * @param connection
-     */
-    $setCurrentLocation(anchor: LightweightAnchor, idx: number, connection?: Connection<any>): void;
-    /**
-     * Computes the position for an anchor that is neither floating nor continuous, or is currently fixed. This case
-     * covers what was previously both DynamicAnchor and Anchor, since those concepts have now been folded into
-     * a single concept - any given anchor has one or more locations.
-     * @param anchor
-     * @param params
-     */
-    private _defaultAnchorCompute;
-    private _placeContinuousAnchors;
-    private _updateContinuousAnchorList;
-    /**
-     * Remove the given anchor from the continuous anchor lists. This method is invoked when a connection is detached.
-     * @param elementId
-     * @param anchor
-     * @private
-     * @internal
-     */
-    $_removeAnchorFromAnchorLists(elementId: string, anchor: LightweightContinuousAnchor): void;
-    computeAnchorLocation(anchor: LightweightAnchor, params: AnchorComputeParams): AnchorPlacement;
-    computePath(connection: Connection<any>, timestamp: string): void;
-    abstract _doComputePath(connection: Connection<EL>, connector: Connector, params: ConnectorComputeParams, timestamp: string): Geometry;
-    abstract _doUpdatePath(connection: Connection<EL>, connector: Connector, params: ConnectorComputeParams, timestamp: string, sourceMoved: boolean, targetMoved: boolean): Geometry;
-    prepareAnchor(params: AnchorSpec | Array<AnchorSpec>): LightweightAnchor;
-    private _orientationCache;
-    private _orientationCacheTimestamp;
-    /**
-     * @internal
-     * @param c
-     * @private
-     */
-    protected _computeObstaclePadding(c: Connector): number;
-    private _calculateOrientation;
-    /**
-     * Redraws every connection. Does not update element positions.
-     * @internal
-     */
-    $redrawEveryConnection(): RedrawResult;
-    $redrawConnection(edge: Edge, timestamp?: string): RedrawResult;
-    /**
-     * Redraws connections for the given element. Does not update element positions.
-     * @internal
-     */
-    $redraw(viewportElement: ViewportElement<EL>, timestamp?: string): RedrawResult;
-    /**
-     * Redraws a list of connections. Does not update element positions.
-     * @internal
-     */
-    private _redrawConnections;
-    reset(): void;
-    setConnectionAnchors(conn: Connection<any>, anchors: [LightweightAnchor, LightweightAnchor]): void;
-    private _anchorSelector;
-}