@visuallyjs/browser-ui 1.1.1 → 1.1.2

package/package.json

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

package/types/core/geom.d.ts

@@ -277,3 +277,8 @@ export declare const chebyshevDistance: (x1: number, y1: number, x2: number, y2:
  * @internal
  */
 export declare const octileDistance: (x1: number, y1: number, x2: number, y2: number) => number;
+/**
+ * Clamps the given angle to lie inside the range 0 - 360
+ * @param rangle
+ */
+export declare function clampAngle(angle: number): number;

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

@@ -92,9 +92,9 @@ export interface LabelOverlayOptions extends OverlayOptions {
      */
     font?: FontSpec;
     /**
-     * If true, the label can be rotated to match the gradient of the connector at that location at which it is positioned.
+     * Sets whether the label can be rotated to match the gradient of the connector at that location at which it is positioned. If you supply boolean true here, the label will be made rotatable in "legible" mode, in which VisuallyJs ensures that the label is always easy to read, by avoiding rotating the text so that it is upside down or other awkward to read. You can set "strict" mode, which will rotate the label to the appropriate angle regardless of whether or not it will make the label difficult to read.
      */
-    rotatable?: boolean;
+    rotatable?: boolean | "legible" | "strict" | null;
 }
 /**
  * An overlay specified by name and options.

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

@@ -12,9 +12,9 @@ import { BrowserUI } from "../../../browser-ui";
 export interface CustomOverlayOptions<EL> extends OverlayOptions {
     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.
+     * Sets whether the overlay can be rotated to match the gradient of the connector at that location at which it is positioned. If you supply boolean true here, the overlay will be made rotatable in "legible" mode, in which VisuallyJs ensures that the overlay is always mostly 'upright, by avoiding rotating it so that it is upside down or other awkward to read. You can set "strict" mode, which will rotate the overlay to the appropriate angle regardless of whether or not it will make any text on it difficult to read.
      */
-    rotatable?: boolean;
+    rotatable?: boolean | "strict" | "legible" | null;
 }
 /**
  * A custom overlay allows you to create the element that will be used to represent the overlay.
@@ -24,7 +24,7 @@ export interface CustomOverlayOptions<EL> extends OverlayOptions {
 export interface CustomOverlay<EL> extends Overlay<EL> {
     create: (c: Connection<EL>, edge: Edge, instance: BrowserUI, model: VisuallyJsModel) => EL;
     isSimpleShape: boolean;
-    rotatable: boolean;
+    rotatable: boolean | "strict" | "legible" | null;
 }
 /**
  * Custom overlay type.
@@ -42,7 +42,7 @@ export declare class CustomOverlayImpl<EL> extends Overlay<EL> implements Custom
      */
     create: (c: Connection<EL>, edge: Edge, instance: BrowserUI, model: VisuallyJsModel) => EL;
     isSimpleShape: boolean;
-    rotatable: boolean;
+    rotatable: boolean | "strict" | "legible" | null;
     constructor(instance: UICore<EL>, connection: Connection<EL>, p: CustomOverlayOptions<EL>);
     type: string;
     updateFrom(d: any, context: ObjectData): void;

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

@@ -16,7 +16,7 @@ export declare class LabelOverlay<EL> extends Overlay<EL> {
     static type: string;
     type: string;
     useHTMLElement: boolean;
-    rotatable: boolean;
+    rotatable: boolean | string;
     font: FontSpec;
     constructor(instance: UICore<EL>, connection: Connection<EL>, p: LabelOverlayOptions);
     isSimpleShape: boolean;

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

@@ -40,7 +40,7 @@ export interface ConnectParams<E> {
     /**
      * 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;
+    labelsRotatable?: boolean | "strict" | "legible" | null;
     /**
      * Spec for the connector used to paint the connection.
      */

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

@@ -80,9 +80,9 @@ export interface EdgeMapping extends BaseViewObjectMapping, LineStyle {
      */
     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.
+     * Sets whether the label can be rotated to match the gradient of the connector at that location at which it is positioned. If you supply boolean true here, the label will be made rotatable in "legible" mode, in which VisuallyJs ensures that the label is always easy to read, by avoiding rotating the text so that it is upside down or other awkward to read. You can set "strict" mode, which will rotate the label to the appropriate angle regardless of whether or not it will make the label difficult to read.
      */
-    labelsRotatable?: boolean;
+    labelsRotatable?: boolean | "strict" | "legible" | null;
     /**
      * Optional width of the edge's outline. Defaults to 0.
      */

package/types/version.d.ts

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