@elicdavis/node-flow 0.1.11 → 0.1.13

package/README.md

@@ -164,6 +164,16 @@ node.addInput({ name: "c", type: "float32" })
 node.addOutput({ name: "sum", type: "float32" })
 ```
 
+### Note API
+
+```javascript
+note.setText("...");
+note.setPosition({ x, y });
+graph.removeNote(note);
+graph.removeAllNotes();
+graph.getNotes();
+```
+
 ## Library Development
 
 Just run

package/dist/index.d.mts

@@ -19,10 +19,21 @@ interface TextStyleConfig {
     style?: FontStyle;
 }
 
+declare enum ContextMenuItemState {
+    Enabled = 0,
+    Disabled = 1,
+    Hidden = 2
+}
 interface ContextMenuItemConfig {
     name?: string;
     textStyle?: TextStyleConfig;
     group?: string;
+    /**
+     * Evaluated when the menu is opened. Defaults to Enabled when omitted.
+     * Hidden items are omitted from the menu; Disabled items are shown muted
+     * and are not clickable.
+     */
+    enabled?: () => ContextMenuItemState;
     callback?: () => void;
 }
 interface ContextMenuConfig {
@@ -343,6 +354,11 @@ declare class NodeSubsystem {
     clickEnd(): void;
     connectNodes(nodeOut: FlowNode, outPort: number, nodeIn: FlowNode, inPort: number): Connection | undefined;
     getNodes(): Array<FlowNode>;
+    /**
+     * Returns currently selected nodes in stable graph order (same selection
+     * state used by Ctrl+click and box-select styling via FlowNode.selected()).
+     */
+    getSelectedNodes(): Array<FlowNode>;
     /**
      * Returns all nodes who are connected to the inputs of the
      * node in question
@@ -479,17 +495,30 @@ declare class NodeFlowGraph {
     addNoteRemovedListener(callback: NoteRemovedCallback): void;
     addNoteDragStartListener(callback: NoteDragStartCallback): void;
     addNoteDragStopListener(callback: NoteDragStopCallback): void;
-    zoom(amount: number): void;
+    zoom(amount: number, anchor?: Vector2): void;
     currentView(): GraphView;
     organize(): void;
     addPublisher(identifier: string, publisher: Publisher): void;
     getNodes(): Array<FlowNode>;
+    /**
+     * Returns currently selected nodes in stable graph order (same selection
+     * state used by Ctrl+click and box-select styling via FlowNode.selected()).
+     */
+    getSelectedNodes(): Array<FlowNode>;
+    /**
+     * Adjusts camera position and zoom so all nodes fit in view (~10% padding).
+     * Falls back to camera.reset() when there are no nodes.
+     */
+    centerOnGraph(): void;
     connectedInputsNodeReferences(nodeIndex: number): Array<FlowNode>;
     connectedOutputsNodeReferences(nodeIndex: number): Array<FlowNode>;
     connectNodes(nodeOut: FlowNode, outPort: number, nodeIn: FlowNode, inPort: number): Connection | undefined;
     addNode(node: FlowNode): void;
     removeNode(node: FlowNode): void;
     addNote(note: FlowNote): void;
+    removeNote(note: FlowNote): void;
+    removeAllNotes(): void;
+    getNotes(): Array<FlowNote>;
     addOnNodeCreatedListener(callback: NodeCreatedCallback): void;
     addOnNodeAddedListener(callback: NodeAddedCallback): void;
     addOnNodeRemovedListener(callback: NodeRemovedCallback): void;
@@ -554,6 +583,7 @@ declare const Theme: {
         BackgroundColor: string;
         HighlightColor: string;
         FontColor: string;
+        DisabledFontColor: string;
     };
     Note: {
         FontColor: string;
@@ -798,4 +828,4 @@ declare class WidgetFactory {
 }
 declare const GlobalWidgetFactory: WidgetFactory;
 
-export { ButtonWidget, ColorWidget, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, GlobalWidgetFactory, type GraphRenderer, ImageWidget, MessageType, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, NumberWidget, Publisher, type PublisherConfig, SliderWidget, StringWidget, TextWidget, Theme, ToggleWidget, type WidgetConfig };
+export { ButtonWidget, ColorWidget, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, ImageWidget, MessageType, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, Publisher, type PublisherConfig, SliderWidget, StringWidget, TextWidget, Theme, ToggleWidget, type WidgetConfig };

package/dist/index.d.ts

@@ -19,10 +19,21 @@ interface TextStyleConfig {
     style?: FontStyle;
 }
 
+declare enum ContextMenuItemState {
+    Enabled = 0,
+    Disabled = 1,
+    Hidden = 2
+}
 interface ContextMenuItemConfig {
     name?: string;
     textStyle?: TextStyleConfig;
     group?: string;
+    /**
+     * Evaluated when the menu is opened. Defaults to Enabled when omitted.
+     * Hidden items are omitted from the menu; Disabled items are shown muted
+     * and are not clickable.
+     */
+    enabled?: () => ContextMenuItemState;
     callback?: () => void;
 }
 interface ContextMenuConfig {
@@ -343,6 +354,11 @@ declare class NodeSubsystem {
     clickEnd(): void;
     connectNodes(nodeOut: FlowNode, outPort: number, nodeIn: FlowNode, inPort: number): Connection | undefined;
     getNodes(): Array<FlowNode>;
+    /**
+     * Returns currently selected nodes in stable graph order (same selection
+     * state used by Ctrl+click and box-select styling via FlowNode.selected()).
+     */
+    getSelectedNodes(): Array<FlowNode>;
     /**
      * Returns all nodes who are connected to the inputs of the
      * node in question
@@ -479,17 +495,30 @@ declare class NodeFlowGraph {
     addNoteRemovedListener(callback: NoteRemovedCallback): void;
     addNoteDragStartListener(callback: NoteDragStartCallback): void;
     addNoteDragStopListener(callback: NoteDragStopCallback): void;
-    zoom(amount: number): void;
+    zoom(amount: number, anchor?: Vector2): void;
     currentView(): GraphView;
     organize(): void;
     addPublisher(identifier: string, publisher: Publisher): void;
     getNodes(): Array<FlowNode>;
+    /**
+     * Returns currently selected nodes in stable graph order (same selection
+     * state used by Ctrl+click and box-select styling via FlowNode.selected()).
+     */
+    getSelectedNodes(): Array<FlowNode>;
+    /**
+     * Adjusts camera position and zoom so all nodes fit in view (~10% padding).
+     * Falls back to camera.reset() when there are no nodes.
+     */
+    centerOnGraph(): void;
     connectedInputsNodeReferences(nodeIndex: number): Array<FlowNode>;
     connectedOutputsNodeReferences(nodeIndex: number): Array<FlowNode>;
     connectNodes(nodeOut: FlowNode, outPort: number, nodeIn: FlowNode, inPort: number): Connection | undefined;
     addNode(node: FlowNode): void;
     removeNode(node: FlowNode): void;
     addNote(note: FlowNote): void;
+    removeNote(note: FlowNote): void;
+    removeAllNotes(): void;
+    getNotes(): Array<FlowNote>;
     addOnNodeCreatedListener(callback: NodeCreatedCallback): void;
     addOnNodeAddedListener(callback: NodeAddedCallback): void;
     addOnNodeRemovedListener(callback: NodeRemovedCallback): void;
@@ -554,6 +583,7 @@ declare const Theme: {
         BackgroundColor: string;
         HighlightColor: string;
         FontColor: string;
+        DisabledFontColor: string;
     };
     Note: {
         FontColor: string;
@@ -798,4 +828,4 @@ declare class WidgetFactory {
 }
 declare const GlobalWidgetFactory: WidgetFactory;
 
-export { ButtonWidget, ColorWidget, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, GlobalWidgetFactory, type GraphRenderer, ImageWidget, MessageType, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, NumberWidget, Publisher, type PublisherConfig, SliderWidget, StringWidget, TextWidget, Theme, ToggleWidget, type WidgetConfig };
+export { ButtonWidget, ColorWidget, type ContextMenuConfig, type ContextMenuItemConfig, ContextMenuItemState, FlowNode, type FlowNodeConfig, type FlowNodeGraphConfiguration, type FlowNodeStyle, type FlowNodeTitleConfig, FlowNote, type FlowNoteConfig, GlobalWidgetFactory, type GraphRenderer, ImageWidget, MessageType, NodeFlowGraph, type NodeIntersection, type NodeMessageConfig, NodeState, type NoteAddedCallback, type NoteContentChangeCallback, type NoteDragStartCallback, type NoteDragStopCallback, type NoteRemovedCallback, type NoteSubsystemConfig, type NoteWidthChangeCallback, NumberWidget, Publisher, type PublisherConfig, SliderWidget, StringWidget, TextWidget, Theme, ToggleWidget, type WidgetConfig };