reagraph

[ { "tags": {}, "filePath": "src/GraphScene.tsx", "description": "", "displayName": "GraphScene", "methods": [], "props": { "layoutType": { "defaultValue": null, "description": "Type of layout.", "name": "layoutType", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "LayoutTypes" } }, "selections": { "defaultValue": null, "description": "List of ids that are selected.", "name": "selections", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string[]" } }, "actives": { "defaultValue": null, "description": "List of ids that are active.", "name": "actives", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string[]" } }, "collapsedNodeIds": { "defaultValue": null, "description": "List of node ids that are collapsed.", "name": "collapsedNodeIds", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string[]" } }, "animated": { "defaultValue": null, "description": "Animate or not the graph positions.", "name": "animated", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "nodes": { "defaultValue": null, "description": "Nodes to pass to the graph.", "name": "nodes", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": true, "type": { "name": "GraphNode[]" } }, "edges": { "defaultValue": null, "description": "Edges to pass to the graph.", "name": "edges", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": true, "type": { "name": "GraphEdge[]" } }, "contextMenu": { "defaultValue": null, "description": "Context menu element.", "name": "contextMenu", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(event: ContextMenuEvent) => ReactNode" } }, "sizingType": { "defaultValue": null, "description": "Type of sizing for nodes.", "name": "sizingType", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "SizingType" } }, "labelType": { "defaultValue": null, "description": "Type of visibility for labels.", "name": "labelType", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "LabelVisibilityType" } }, "edgeLabelPosition": { "defaultValue": null, "description": "Place of visibility for edge labels.", "name": "edgeLabelPosition", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "EdgeLabelPosition" } }, "edgeArrowPosition": { "defaultValue": null, "description": "Placement of edge arrows.", "name": "edgeArrowPosition", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "EdgeArrowPosition" } }, "edgeInterpolation": { "defaultValue": { "value": "linear" }, "description": "Shape of edge.", "name": "edgeInterpolation", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "EdgeInterpolation" } }, "labelFontUrl": { "defaultValue": null, "description": "Font of label, same as troika-three-text\nThe URL of a custom font file to be used. Supported font formats are: * .ttf * .otf * .woff (.woff2 is not supported)\nDefault: The Roboto font loaded from Google Fonts CDN", "name": "labelFontUrl", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string" } }, "sizingAttribute": { "defaultValue": null, "description": "Attribute based sizing property.", "name": "sizingAttribute", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string" } }, "defaultNodeSize": { "defaultValue": null, "description": "The default size to size nodes to. Default is 7.", "name": "defaultNodeSize", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "number" } }, "minNodeSize": { "defaultValue": null, "description": "When using sizing attributes, the min size a node can be.", "name": "minNodeSize", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "number" } }, "maxNodeSize": { "defaultValue": null, "description": "When using sizing attributes, the max size a node can be.", "name": "maxNodeSize", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "number" } }, "clusterAttribute": { "defaultValue": null, "description": "Attribute used for clustering.", "name": "clusterAttribute", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string" } }, "disabled": { "defaultValue": null, "description": "Disable interactions or not.", "name": "disabled", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "draggable": { "defaultValue": null, "description": "Allow dragging of nodes.", "name": "draggable", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "constrainDragging": { "defaultValue": { "value": "false" }, "description": "Constrain dragging to the cluster bounds. Default is `false`.", "name": "constrainDragging", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "renderNode": { "defaultValue": null, "description": "Render a custom node", "name": "renderNode", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "NodeRenderer" } }, "onRenderCluster": { "defaultValue": null, "description": "Render a custom cluster", "name": "onRenderCluster", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "ClusterRenderer" } }, "layoutOverrides": { "defaultValue": null, "description": "Advanced overrides for the layout.", "name": "layoutOverrides", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "LayoutOverrides" } }, "aggregateEdges": { "defaultValue": null, "description": "Whether to aggregate edges with the same source and target.", "name": "aggregateEdges", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "onNodeClick": { "defaultValue": null, "description": "When a node was clicked.", "name": "onNodeClick", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, props?: CollapseProps, event?: ThreeEvent<MouseEvent>) => void" } }, "onNodeDoubleClick": { "defaultValue": null, "description": "When a node was double clicked.", "name": "onNodeDoubleClick", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, event: ThreeEvent<MouseEvent>) => void" } }, "onNodeContextMenu": { "defaultValue": null, "description": "When a node context menu happened.", "name": "onNodeContextMenu", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, props?: NodeContextMenuProps) => void" } }, "onNodePointerOver": { "defaultValue": null, "description": "When node got a pointer over.", "name": "onNodePointerOver", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, event: ThreeEvent<PointerEvent>) => void" } }, "onNodePointerOut": { "defaultValue": null, "description": "When node lost pointer over.", "name": "onNodePointerOut", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, event: ThreeEvent<PointerEvent>) => void" } }, "onNodeDragged": { "defaultValue": null, "description": "Triggered after a node was dragged.", "name": "onNodeDragged", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode) => void" } }, "onClusterDragged": { "defaultValue": null, "description": "Triggered after a cluster was dragged.", "name": "onClusterDragged", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(cluster: ClusterEventArgs) => void" } }, "onEdgeContextMenu": { "defaultValue": null, "description": "When a edge context menu happened.", "name": "onEdgeContextMenu", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(edge?: InternalGraphEdge) => void" } }, "onEdgeClick": { "defaultValue": null, "description": "When an edge was clicked.", "name": "onEdgeClick", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(edge: InternalGraphEdge, event?: ThreeEvent<MouseEvent>) => void" } }, "onEdgePointerOver": { "defaultValue": null, "description": "When edge got a pointer over.", "name": "onEdgePointerOver", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(edge: InternalGraphEdge, event?: ThreeEvent<PointerEvent>) => void" } }, "onEdgePointerOut": { "defaultValue": null, "description": "When edge lost pointer over.", "name": "onEdgePointerOut", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(edge: InternalGraphEdge, event?: ThreeEvent<PointerEvent>) => void" } }, "onClusterClick": { "defaultValue": null, "description": "When a cluster was clicked.", "name": "onClusterClick", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(cluster: ClusterEventArgs, event: ThreeEvent<MouseEvent>) => void" } }, "onClusterPointerOver": { "defaultValue": null, "description": "When a cluster receives a pointer over event.", "name": "onClusterPointerOver", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(cluster: ClusterEventArgs, event: ThreeEvent<PointerEvent>) => void" } }, "onClusterPointerOut": { "defaultValue": null, "description": "When cluster receives a pointer leave event.", "name": "onClusterPointerOut", "parent": { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(cluster: ClusterEventArgs, event: ThreeEvent<PointerEvent>) => void" } }, "ref": { "defaultValue": null, "description": "", "name": "ref", "declarations": [ { "fileName": "src/GraphScene.tsx", "name": "TypeLiteral" } ], "required": false, "type": { "name": "Ref<GraphSceneRef>" } } } }, { "tags": {}, "filePath": "src/CameraControls/CameraControls.tsx", "description": "", "displayName": "CameraControls", "methods": [], "props": { "mode": { "defaultValue": { "value": "rotate" }, "description": "Mode of the camera.", "name": "mode", "parent": { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" }, "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" } ], "required": false, "type": { "name": "CameraMode" } }, "children": { "defaultValue": null, "description": "Children symbols.", "name": "children", "parent": { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" }, "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" } ], "required": false, "type": { "name": "ReactNode" } }, "animated": { "defaultValue": null, "description": "Animate transitions to centering.", "name": "animated", "parent": { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" }, "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" } ], "required": false, "type": { "name": "boolean" } }, "disabled": { "defaultValue": null, "description": "Whether the controls are enabled.", "name": "disabled", "parent": { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" }, "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" } ], "required": false, "type": { "name": "boolean" } }, "maxDistance": { "defaultValue": { "value": "50000" }, "description": "The maximum distance for the camera.", "name": "maxDistance", "parent": { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" }, "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" } ], "required": false, "type": { "name": "number" } }, "minDistance": { "defaultValue": { "value": "1000" }, "description": "The minimum distance for the camera.", "name": "minDistance", "parent": { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" }, "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "CameraControlsProps" } ], "required": false, "type": { "name": "number" } }, "ref": { "defaultValue": null, "description": "", "name": "ref", "declarations": [ { "fileName": "src/CameraControls/CameraControls.tsx", "name": "TypeLiteral" } ], "required": false, "type": { "name": "Ref<CameraControlsContextProps>" } } } }, { "tags": {}, "filePath": "src/GraphCanvas/GraphCanvas.tsx", "description": "", "displayName": "GraphCanvas", "methods": [], "props": { "theme": { "defaultValue": { "value": "{\n canvas: { background: '#fff' },\n node: {\n fill: '#7CA0AB',\n activeFill: '#1DE9AC',\n opacity: 1,\n selectedOpacity: 1,\n inactiveOpacity: 0.2,\n label: { color: '#2A6475', stroke: '#fff', activeColor: '#1DE9AC' },\n subLabel: { color: '#ddd', stroke: 'transparent', activeColor: '#1DE9AC' }\n },\n lasso: { border: '1px solid #55aaff', background: 'rgba(75, 160, 255, 0.1)' },\n ring: { fill: '#D8E6EA', activeFill: '#1DE9AC' },\n edge: {\n fill: '#D8E6EA',\n activeFill: '#1DE9AC',\n opacity: 1,\n selectedOpacity: 1,\n inactiveOpacity: 0.1,\n label: {\n stroke: '#fff',\n color: '#2A6475',\n activeColor: '#1DE9AC',\n fontSize: 6\n },\n subLabel: {\n color: '#ddd',\n stroke: 'transparent',\n activeColor: '#1DE9AC'\n }\n },\n arrow: { fill: '#D8E6EA', activeFill: '#1DE9AC' },\n cluster: {\n stroke: '#D8E6EA',\n opacity: 1,\n selectedOpacity: 1,\n inactiveOpacity: 0.1,\n label: { stroke: '#fff', color: '#2A6475' }\n }\n}" }, "description": "Theme to use for the graph.", "name": "theme", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "Theme" } }, "cameraMode": { "defaultValue": { "value": "pan" }, "description": "Type of camera interaction.", "name": "cameraMode", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "CameraMode" } }, "maxDistance": { "defaultValue": null, "description": "The maximum distance for the camera. Default is 50000.", "name": "maxDistance", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "number" } }, "minDistance": { "defaultValue": null, "description": "The minimum distance for the camera. Default is 1000.", "name": "minDistance", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "number" } }, "lassoType": { "defaultValue": { "value": "none" }, "description": "The type of lasso selection.", "name": "lassoType", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "LassoType" } }, "children": { "defaultValue": null, "description": "Children to render in the canvas. Useful for things like lights.", "name": "children", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "ReactNode" } }, "glOptions": { "defaultValue": { "value": "{}" }, "description": "Ability to extend Cavas gl options. For example { preserveDrawingBuffer: true }", "name": "glOptions", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "Object" } }, "onLasso": { "defaultValue": null, "description": "When the canvas had a lasso selection.", "name": "onLasso", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "(selections: string[]) => void" } }, "onLassoEnd": { "defaultValue": null, "description": "When the canvas had a lasso selection end.", "name": "onLassoEnd", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "(selections: string[]) => void" } }, "onCanvasClick": { "defaultValue": null, "description": "When the canvas was clicked but didn't hit a node/edge.", "name": "onCanvasClick", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "(event: MouseEvent) => void" } }, "aggregateEdges": { "defaultValue": null, "description": "Whether to aggregate edges with the same source and target.", "name": "aggregateEdges", "parent": { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" }, "declarations": [ { "fileName": "src/GraphCanvas/GraphCanvas.tsx", "name": "GraphCanvasProps" } ], "required": false, "type": { "name": "boolean" } }, "layoutType": { "defaultValue": { "value": "forceDirected2d" }, "description": "Type of layout.", "name": "layoutType", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "LayoutTypes" } }, "selections": { "defaultValue": null, "description": "List of ids that are selected.", "name": "selections", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string[]" } }, "actives": { "defaultValue": null, "description": "List of ids that are active.", "name": "actives", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string[]" } }, "collapsedNodeIds": { "defaultValue": null, "description": "List of node ids that are collapsed.", "name": "collapsedNodeIds", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string[]" } }, "animated": { "defaultValue": { "value": "true" }, "description": "Animate or not the graph positions.", "name": "animated", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "nodes": { "defaultValue": null, "description": "Nodes to pass to the graph.", "name": "nodes", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": true, "type": { "name": "GraphNode[]" } }, "edges": { "defaultValue": null, "description": "Edges to pass to the graph.", "name": "edges", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": true, "type": { "name": "GraphEdge[]" } }, "contextMenu": { "defaultValue": null, "description": "Context menu element.", "name": "contextMenu", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(event: ContextMenuEvent) => ReactNode" } }, "sizingType": { "defaultValue": { "value": "default" }, "description": "Type of sizing for nodes.", "name": "sizingType", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "SizingType" } }, "labelType": { "defaultValue": { "value": "auto" }, "description": "Type of visibility for labels.", "name": "labelType", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "LabelVisibilityType" } }, "edgeLabelPosition": { "defaultValue": null, "description": "Place of visibility for edge labels.", "name": "edgeLabelPosition", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "EdgeLabelPosition" } }, "edgeArrowPosition": { "defaultValue": null, "description": "Placement of edge arrows.", "name": "edgeArrowPosition", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "EdgeArrowPosition" } }, "edgeInterpolation": { "defaultValue": null, "description": "Shape of edge.", "name": "edgeInterpolation", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "EdgeInterpolation" } }, "labelFontUrl": { "defaultValue": null, "description": "Font of label, same as troika-three-text\nThe URL of a custom font file to be used. Supported font formats are: * .ttf * .otf * .woff (.woff2 is not supported)\nDefault: The Roboto font loaded from Google Fonts CDN", "name": "labelFontUrl", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string" } }, "sizingAttribute": { "defaultValue": null, "description": "Attribute based sizing property.", "name": "sizingAttribute", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string" } }, "defaultNodeSize": { "defaultValue": { "value": "7" }, "description": "The default size to size nodes to. Default is 7.", "name": "defaultNodeSize", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "number" } }, "minNodeSize": { "defaultValue": { "value": "5" }, "description": "When using sizing attributes, the min size a node can be.", "name": "minNodeSize", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "number" } }, "maxNodeSize": { "defaultValue": { "value": "15" }, "description": "When using sizing attributes, the max size a node can be.", "name": "maxNodeSize", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "number" } }, "clusterAttribute": { "defaultValue": null, "description": "Attribute used for clustering.", "name": "clusterAttribute", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "string" } }, "disabled": { "defaultValue": null, "description": "Disable interactions or not.", "name": "disabled", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "draggable": { "defaultValue": null, "description": "Allow dragging of nodes.", "name": "draggable", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "constrainDragging": { "defaultValue": null, "description": "Constrain dragging to the cluster bounds. Default is `false`.", "name": "constrainDragging", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "boolean" } }, "renderNode": { "defaultValue": null, "description": "Render a custom node", "name": "renderNode", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "NodeRenderer" } }, "onRenderCluster": { "defaultValue": null, "description": "Render a custom cluster", "name": "onRenderCluster", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "ClusterRenderer" } }, "layoutOverrides": { "defaultValue": null, "description": "Advanced overrides for the layout.", "name": "layoutOverrides", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "LayoutOverrides" } }, "onNodeClick": { "defaultValue": null, "description": "When a node was clicked.", "name": "onNodeClick", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, props?: CollapseProps, event?: ThreeEvent<MouseEvent>) => void" } }, "onNodeDoubleClick": { "defaultValue": null, "description": "When a node was double clicked.", "name": "onNodeDoubleClick", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, event: ThreeEvent<MouseEvent>) => void" } }, "onNodeContextMenu": { "defaultValue": null, "description": "When a node context menu happened.", "name": "onNodeContextMenu", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, props?: NodeContextMenuProps) => void" } }, "onNodePointerOver": { "defaultValue": null, "description": "When node got a pointer over.", "name": "onNodePointerOver", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, event: ThreeEvent<PointerEvent>) => void" } }, "onNodePointerOut": { "defaultValue": null, "description": "When node lost pointer over.", "name": "onNodePointerOut", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode, event: ThreeEvent<PointerEvent>) => void" } }, "onNodeDragged": { "defaultValue": null, "description": "Triggered after a node was dragged.", "name": "onNodeDragged", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(node: InternalGraphNode) => void" } }, "onClusterDragged": { "defaultValue": null, "description": "Triggered after a cluster was dragged.", "name": "onClusterDragged", "parent": { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" }, "declarations": [ { "fileName": "reagraph/src/GraphScene.tsx", "name": "GraphSceneProps" } ], "required": false, "type": { "name": "(cluster: ClusterEventArgs) => void" } }, "onEdgeContextMenu": { "defaultValue": null, "description": "When a edge context menu happened.", "name": "onEdgeContextMenu", "parent": { "fileName":