@visuallyjs/browser-ui 1.1.0 → 1.1.1

package/package.json

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

package/types/browser-ui/browser-visuallyjs-instance.d.ts

@@ -577,6 +577,7 @@ export declare abstract class BrowserUI<EVT = any> extends UICore<BrowserElement
      * @param parentOrigin
      */
     $paintOverlay(o: Overlay<BrowserElement>, params: OverlayPaintParams, parentOrigin: PointXY): void;
+    private _positionHTMLElementOverlay;
     /**
      * Sets the visibility of some overlay.
      * @param o - Overlay to hide or show

package/types/browser-ui/html-element-overlay.d.ts

@@ -13,6 +13,8 @@ export declare function isHTMLLabelOverlay(o: Overlay<any>): o is HTMLElementOve
 export interface HTMLElementOverlayHolder extends Overlay<BrowserElement> {
     contentElement: VisuallyJSDOMElement;
     cachedDimensions: Size;
+    rotatable: boolean;
+    connection: Connection<BrowserElement>;
 }
 export interface HTMLElementOverlayPaintParams extends OverlayPaintParams {
     d: {
@@ -20,6 +22,7 @@ export interface HTMLElementOverlayPaintParams extends OverlayPaintParams {
         miny: number;
         td: Size;
         cxy: PointXY;
+        rotation?: number;
     };
 }
 export declare class HTMLElementOverlay {

package/types/browser-ui/surface-renderer/diagrams/definitions.d.ts

@@ -137,6 +137,10 @@ export interface DiagramOptions {
          * Whether or not to display labels on edges. Defaults to false. The value for an edge's label is sourced from the `label` field of the edge's data. You can change this via the `labelProperty` setting. The label is placed at location 0.5 by default. You can change that with either the `labelLocation` setting (to change every label), or the `labelLocationProperty` (to set location on a per-edge basis).
          */
         showLabels?: boolean;
+        /**
+         * Defaults to false. When true, edge labels are rotated to the angle matching the slope of the connector at the point at which they are located.
+         */
+        labelsRotatable?: boolean;
         /**
          * Whether or not to reattach this connection automatically should it be detached via user intervention and then dropped onto whitespace.
          */

package/types/browser-ui/svg-element-overlay.d.ts

@@ -20,6 +20,7 @@ export interface SvgSimpleShapeOverlayPaintParams<EL> extends SvgOverlayPaintPar
 export interface SVGLabelOverlayPaintParams extends OverlayPaintParams {
     d: {
         loc: PointXY;
+        rotation?: number;
     };
 }
 /**

package/types/ui/common/overlay.d.ts

@@ -91,6 +91,10 @@ export interface LabelOverlayOptions extends OverlayOptions {
      * Optional spec for the font to use on this label.
      */
     font?: FontSpec;
+    /**
+     * If true, the label can be rotated to match the gradient of the connector at that location at which it is positioned.
+     */
+    rotatable?: boolean;
 }
 /**
  * An overlay specified by name and options.

package/types/ui/core/overlay/custom-overlay.d.ts

@@ -2,33 +2,52 @@ import { Overlay } from "./overlay";
 import { UICore } from "../core";
 import { OverlayOptions } from "../../common";
 import { Connection } from "../connector/connection-impl";
-import { ObjectData } from "../../../core";
+import { Edge, ObjectData, VisuallyJsModel } from "../../../core";
+import { BrowserUI } from "../../../browser-ui";
 /**
  * Options for a custom overlay. You need to supply the `create` method, which is passed the current connection as an argument, and return a DOM element.
  * @group Edges
  * @category Overlays
  */
 export interface CustomOverlayOptions<EL> extends OverlayOptions {
-    create: (c: Connection<EL>) => EL;
+    create: (c: Connection<EL>, edge: Edge, instance: BrowserUI, model: VisuallyJsModel) => EL;
+    /**
+     * If true, the label can be rotated to match the gradient of the connector at that location at which it is positioned.
+     */
+    rotatable?: boolean;
 }
 /**
  * A custom overlay allows you to create the element that will be used to represent the overlay.
  * @group Edges
  * @category Overlays
  */
-export declare class CustomOverlay<EL> extends Overlay<EL> {
-    connection: Connection<EL>;
-    create: (c: Connection<EL>) => EL;
+export interface CustomOverlay<EL> extends Overlay<EL> {
+    create: (c: Connection<EL>, edge: Edge, instance: BrowserUI, model: VisuallyJsModel) => EL;
     isSimpleShape: boolean;
-    constructor(instance: UICore<EL>, connection: Connection<EL>, p: CustomOverlayOptions<EL>);
+    rotatable: boolean;
+}
+/**
+ * Custom overlay type.
+ * @group Overlays
+ * @constant
+ */
+export declare const OVERLAY_TYPE_CUSTOM = "Custom";
+/**
+ * @internal
+ */
+export declare class CustomOverlayImpl<EL> extends Overlay<EL> implements CustomOverlay<EL> {
+    connection: Connection<EL>;
     /**
-     * Custom overlay type.
+     * This method is invoked to create the overlay.
      */
-    static type: string;
+    create: (c: Connection<EL>, edge: Edge, instance: BrowserUI, model: VisuallyJsModel) => EL;
+    isSimpleShape: boolean;
+    rotatable: boolean;
+    constructor(instance: UICore<EL>, connection: Connection<EL>, p: CustomOverlayOptions<EL>);
     type: string;
     updateFrom(d: any, context: ObjectData): void;
 }
-export interface CustomOverlayHolder<EL> extends CustomOverlay<EL> {
+export interface CustomOverlayHolder<EL> extends CustomOverlayImpl<EL> {
     contentElement: EL;
 }
 /**

package/types/ui/core/overlay/label-overlay.d.ts

@@ -11,13 +11,14 @@ import { FontSpec } from "../../../browser-ui";
  */
 export declare class LabelOverlay<EL> extends Overlay<EL> {
     private instance;
-    component: Connection<EL>;
+    connection: Connection<EL>;
     label: string | Function;
     static type: string;
     type: string;
     useHTMLElement: boolean;
+    rotatable: boolean;
     font: FontSpec;
-    constructor(instance: UICore<EL>, component: Connection<EL>, p: LabelOverlayOptions);
+    constructor(instance: UICore<EL>, connection: Connection<EL>, p: LabelOverlayOptions);
     isSimpleShape: boolean;
     getLabel(): string;
     setLabel(l: string | Function): void;

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

@@ -63,7 +63,7 @@ export declare function setOverlayLocation(o: Overlay<any>, l: number | string):
  * @internal
  */
 export declare abstract class Overlay<EL> {
-    component: Connection<EL>;
+    connection: Connection<EL>;
     id: string;
     abstract type: string;
     cssClass: string;
@@ -77,11 +77,11 @@ export declare abstract class Overlay<EL> {
      * types system.
      * @internal
      * @param instance
-     * @param component
+     * @param connection
      * @param p
      */
     ignoreTypes: boolean;
-    constructor(component: Connection<EL>, p: OverlayOptions);
+    constructor(connection: Connection<EL>, p: OverlayOptions);
     abstract updateFrom(opts: any, context: ObjectData): void;
     abstract isSimpleShape: boolean;
 }

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

@@ -37,6 +37,10 @@ export interface ConnectParams<E> {
      * Optional label to set on the connection. In the default browser UI implementation this is rendered as a `label` attribute on the SVG element representing the connection.
      */
     label?: string;
+    /**
+     * When true, the label will be rotated so that it is at the same angle as the slope of the connector at the point at which the label is located.
+     */
+    labelsRotatable?: boolean;
     /**
      * Spec for the connector used to paint the connection.
      */

package/types/ui/core/view/edge-options.d.ts

@@ -79,6 +79,10 @@ export interface EdgeMapping extends BaseViewObjectMapping, LineStyle {
      * Optional spec for label font. Will use browser defaults if not specified (or CSS, but remember that CSS is not taken into account when you export an SVG from a diagram or an app using an SVG container)
      */
     labelFont?: FontSpec;
+    /**
+     * When true, the label will be rotated so that it is at the same angle as the slope of the connector at the point at which the label is located.
+     */
+    labelsRotatable?: boolean;
     /**
      * Optional width of the edge's outline. Defaults to 0.
      */

package/types/version.d.ts

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