@cosmos.gl/graph 3.0.0-beta.4 → 3.0.0-beta.6

package/dist/config.d.ts

@@ -16,8 +16,8 @@ export interface GraphConfigInterface {
      */
     backgroundColor?: string | [number, number, number, number];
     /**
-     * Simulation space size (max 8192).
-     * Default value: `8192`
+     * Simulation space size.
+     * Default value: `4096` (larger values may crash on some devices, e.g. iOS; see https://github.com/cosmosgl/graph/issues/203).
      */
     spaceSize?: number;
     /**
@@ -28,8 +28,6 @@ export interface GraphConfigInterface {
      * Default value: '#b3b3b3'
      */
     pointDefaultColor?: string | [number, number, number, number];
-    /** @deprecated Use `pointDefaultColor` instead */
-    pointColor?: string | [number, number, number, number];
     /**
      * The color to use for points when they are greyed out (when selection is active).
      * This can be either a hex color string (e.g., '#b3b3b3') or an array of RGBA values
@@ -59,8 +57,6 @@ export interface GraphConfigInterface {
      * Default value: `4`
     */
     pointDefaultSize?: number;
-    /** @deprecated Use `pointDefaultSize` instead */
-    pointSize?: number;
     /**
      * Universal opacity value applied to all points.
      * This value multiplies with individual point alpha values (if set via setPointColors).
@@ -119,8 +115,6 @@ export interface GraphConfigInterface {
      * Default value: '#666666'
      */
     linkDefaultColor?: string | [number, number, number, number];
-    /** @deprecated Use `linkDefaultColor` instead */
-    linkColor?: string | [number, number, number, number];
     /**
      * Universal opacity value applied to all links.
      * This value multiplies with individual link alpha values (if set via setLinkColors).
@@ -138,8 +132,6 @@ export interface GraphConfigInterface {
      * Default value: `1`
     */
     linkDefaultWidth?: number;
-    /** @deprecated Use `linkDefaultWidth` instead */
-    linkWidth?: number;
     /**
      * The color to use for links when they are hovered.
      * This can be either a hex color string (e.g., '#ff3333') or an array of RGBA values
@@ -190,8 +182,6 @@ export interface GraphConfigInterface {
      * Default value: `false`
      */
     linkDefaultArrows?: boolean;
-    /** @deprecated Use `linkDefaultArrows` instead */
-    linkArrows?: boolean;
     /**
      * Scale factor for the link arrows size.
      * Default value: `1`
@@ -301,12 +291,6 @@ export interface GraphConfigInterface {
      * Default value: `undefined`
      */
     onSimulationPause?: () => void;
-    /**
-     * Callback function that will be called when the simulation is restarted.
-     * @deprecated Use `onSimulationUnpause` instead. This callback will be removed in a future version.
-     * Default value: `undefined`
-     */
-    onSimulationRestart?: () => void;
     /**
      * Callback function that will be called when the simulation is unpaused.
      * Default value: `undefined`
@@ -546,6 +530,12 @@ export interface GraphConfigInterface {
      * Default value: `150`
     */
     pointSamplingDistance?: number;
+    /**
+     * Link sampling distance in pixels between neighboring links when calling the `getSampledLinks` method.
+     * This parameter determines how many links will be included in the sample (based on link midpoints in screen space).
+     * Default value: `150`
+     */
+    linkSamplingDistance?: number;
     /**
      * Controls automatic position adjustment of points in the visible space.
      *
@@ -570,12 +560,10 @@ export declare class GraphConfig implements GraphConfigInterface {
     enableSimulation: boolean;
     backgroundColor: string;
     spaceSize: number;
-    pointColor: string;
-    pointDefaultColor: undefined;
+    pointDefaultColor: string;
     pointGreyoutOpacity: undefined;
     pointGreyoutColor: undefined;
-    pointSize: number;
-    pointDefaultSize: undefined;
+    pointDefaultSize: number;
     pointOpacity: number;
     pointSizeScale: number;
     hoveredPointCursor: string;
@@ -584,12 +572,10 @@ export declare class GraphConfig implements GraphConfigInterface {
     hoveredPointRingColor: string;
     focusedPointRingColor: string;
     focusedPointIndex: undefined;
-    linkColor: string;
-    linkDefaultColor: undefined;
+    linkDefaultColor: string;
     linkOpacity: number;
     linkGreyoutOpacity: number;
-    linkWidth: number;
-    linkDefaultWidth: undefined;
+    linkDefaultWidth: number;
     linkWidthScale: number;
     hoveredLinkColor: undefined;
     hoveredLinkWidthIncrease: number;
@@ -598,8 +584,7 @@ export declare class GraphConfig implements GraphConfigInterface {
     curvedLinkSegments: number;
     curvedLinkWeight: number;
     curvedLinkControlPointDistance: number;
-    linkArrows: boolean;
-    linkDefaultArrows: undefined;
+    linkDefaultArrows: boolean;
     linkArrowsSizeScale: number;
     scaleLinksOnZoom: boolean;
     linkVisibilityDistanceRange: number[];
@@ -620,7 +605,6 @@ export declare class GraphConfig implements GraphConfigInterface {
     onSimulationTick: GraphConfigInterface['onSimulationTick'];
     onSimulationEnd: GraphConfigInterface['onSimulationEnd'];
     onSimulationPause: GraphConfigInterface['onSimulationPause'];
-    onSimulationRestart: GraphConfigInterface['onSimulationRestart'];
     onSimulationUnpause: GraphConfigInterface['onSimulationUnpause'];
     onClick: GraphConfigInterface['onClick'];
     onPointClick: GraphConfigInterface['onPointClick'];
@@ -656,6 +640,7 @@ export declare class GraphConfig implements GraphConfigInterface {
     fitViewByPointIndices: undefined;
     randomSeed: undefined;
     pointSamplingDistance: number;
+    linkSamplingDistance: number;
     attribution: string;
     rescalePositions: undefined;
     init(config: GraphConfigInterface): void;

package/dist/index.d.ts

@@ -4,8 +4,11 @@ import { GraphData } from './modules/GraphData';
 export declare class Graph {
     config: GraphConfig;
     graph: GraphData;
-    /** Promise that resolves with the luma device when the graph is ready. Await or `.then()` to run after init. */
-    readonly deviceInitPromise: Promise<Device>;
+    /** Promise that resolves when the graph is fully initialized and ready to use */
+    readonly ready: Promise<void>;
+    /** Whether the graph has completed initialization */
+    isReady: boolean;
+    private readonly deviceInitPromise;
     /** Canvas element, assigned asynchronously during device initialization */
     private canvas;
     private attributionDivElement;
@@ -362,15 +365,6 @@ export declare class Graph {
      * @returns A Float32Array containing the indices of points inside a rectangular area.
      */
     getPointsInRect(selection: [[number, number], [number, number]]): Float32Array;
-    /**
-     * Get points indices inside a rectangular area.
-     * @param selection - Array of two corner points `[[left, top], [right, bottom]]`.
-     * The `left` and `right` coordinates should be from 0 to the width of the canvas.
-     * The `top` and `bottom` coordinates should be from 0 to the height of the canvas.
-     * @returns A Float32Array containing the indices of points inside a rectangular area.
-     * @deprecated Use `getPointsInRect` instead. This method will be removed in a future version.
-     */
-    getPointsInRange(selection: [[number, number], [number, number]]): Float32Array;
     /**
      * Get points indices inside a polygon area.
      * @param polygonPath - Array of points `[[x1, y1], [x2, y2], ..., [xn, yn]]` that defines the polygon.
@@ -383,13 +377,6 @@ export declare class Graph {
      * The `left` and `right` coordinates should be from 0 to the width of the canvas.
      * The `top` and `bottom` coordinates should be from 0 to the height of the canvas. */
     selectPointsInRect(selection: [[number, number], [number, number]] | null): void;
-    /** Select points inside a rectangular area.
-     * @param selection - Array of two corner points `[[left, top], [right, bottom]]`.
-     * The `left` and `right` coordinates should be from 0 to the width of the canvas.
-     * The `top` and `bottom` coordinates should be from 0 to the height of the canvas.
-     * @deprecated Use `selectPointsInRect` instead. This method will be removed in a future version.
-     */
-    selectPointsInRange(selection: [[number, number], [number, number]] | null): void;
     /** Select points inside a polygon area.
      * @param polygonPath - Array of points `[[x1, y1], [x2, y2], ..., [xn, yn]]` that defines the polygon.
      * The coordinates should be from 0 to the width/height of the canvas.
@@ -481,6 +468,24 @@ export declare class Graph {
         indices: number[];
         positions: number[];
     };
+    /**
+     * For the links that are currently visible on the screen, get a sample of link indices with their midpoint coordinates and angle.
+     * The resulting number of links will depend on the `linkSamplingDistance` configuration property,
+     * and the sampled links will be evenly distributed (one link per grid cell, based on link midpoint in screen space).
+     * Each value is [x, y, angle]: position in data space; angle in radians for screen-space rotation (0 = right, positive = clockwise, e.g. for CSS rotation).
+     */
+    getSampledLinkPositionsMap(): Map<number, [number, number, number]>;
+    /**
+     * For the links that are currently visible on the screen, get a sample of link indices, midpoint positions, and angles.
+     * The resulting number of links will depend on the `linkSamplingDistance` configuration property,
+     * and the sampled links will be evenly distributed.
+     * Positions are in data space; angles are in radians for screen-space rotation (0 = right, positive = clockwise, e.g. for CSS rotation).
+     */
+    getSampledLinks(): {
+        indices: number[];
+        positions: number[];
+        angles: number[];
+    };
     /**
      * Gets the X-axis of rescaling function.
      *
@@ -515,12 +520,6 @@ export declare class Graph {
      * simulation and continues its execution.
      */
     unpause(): void;
-    /**
-     * Restart/Resume the simulation. This method unpauses a paused
-     * simulation and resumes its execution.
-     * @deprecated Use `unpause()` instead. This method will be removed in a future version.
-     */
-    restart(): void;
     /**
      * Run one step of the simulation manually.
      * Works even when the simulation is paused.
@@ -618,4 +617,5 @@ export declare class Graph {
 }
 export type { GraphConfigInterface } from './config';
 export { PointShape } from './modules/GraphData';
+export * from './variables';
 export * from './helper';