VisGraph (Sigma.NET) | Sigma.NET

VisGraph Type

Namespace: Sigma.NET
Assembly: Sigma.NET.dll
Base Type: obj

Module to manipulate and style a graph

Constructors

Constructor	Description
`VisGraph()` Full Usage: `VisGraph()` Returns: `VisGraph`	Returns: `VisGraph`

Static members

Static member	Description
`VisGraph.empty ()` Full Usage: `VisGraph.empty ()` Returns: `SigmaGraph` A new empty SigmaGraph	Creates an empty SigmaGraph instance Returns: `SigmaGraph` A new empty SigmaGraph
`VisGraph.show () graph` Full Usage: `VisGraph.show () graph` Parameters: () : `unit` graph : `SigmaGraph` - The SigmaGraph to display.	Shows the SigmaGraph as an HTML document. () : `unit` graph : `SigmaGraph` The SigmaGraph to display.
`VisGraph.withCircularLayout (?Scale, ?Center)` Full Usage: `VisGraph.withCircularLayout (?Scale, ?Center)` Parameters: ?Scale : `float` - Optional scale for the circular layout. ?Center : `float` - Optional center for the circular layout. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the circular layout.	Assigns a circular layout to a SigmaGraph. ?Scale : `float` Optional scale for the circular layout. ?Center : `float` Optional center for the circular layout. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the circular layout.
`VisGraph.withEdge edge graph` Full Usage: `VisGraph.withEdge edge graph` Parameters: edge : `Edge` - The edge to add. graph : `SigmaGraph` - The SigmaGraph to which the edge will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added edge.	Adds a single edge to a SigmaGraph. edge : `Edge` The edge to add. graph : `SigmaGraph` The SigmaGraph to which the edge will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added edge.
`VisGraph.withEdges edges graph` Full Usage: `VisGraph.withEdges edges graph` Parameters: edges : `Edge seq` - The sequence of edges to add. graph : `SigmaGraph` - The SigmaGraph to which the edges will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added edges.	Adds a sequence of edges to a SigmaGraph. edges : `Edge seq` The sequence of edges to add. graph : `SigmaGraph` The SigmaGraph to which the edges will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added edges.
`VisGraph.withForceAtlas2 (?Iterations, ?Settings, ?GetEdgeWeight)` Full Usage: `VisGraph.withForceAtlas2 (?Iterations, ?Settings, ?GetEdgeWeight)` Parameters: ?Iterations : `int` - Optional number of iterations for the layout algorithm. ?Settings : `FA2Settings` - Optional settings for the layout algorithm. ?GetEdgeWeight : `string` - Optional function to get edge weight. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the ForceAtlas2 layout.	Assigns a ForceAtlas2 layout to a SigmaGraph. ?Iterations : `int` Optional number of iterations for the layout algorithm. ?Settings : `FA2Settings` Optional settings for the layout algorithm. ?GetEdgeWeight : `string` Optional function to get edge weight. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the ForceAtlas2 layout.
`VisGraph.withHoverSelector ?enable` Full Usage: `VisGraph.withHoverSelector ?enable` Parameters: ?enable : `bool` - Optional flag to enable or disable the hover selector (default is true). Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the hover selector widget.	Adds a hover selector widget to the SigmaGraph. ?enable : `bool` Optional flag to enable or disable the hover selector (default is true). Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the hover selector widget.
`VisGraph.withNode node graph` Full Usage: `VisGraph.withNode node graph` Parameters: node : `Node` - The node to add. graph : `SigmaGraph` - The SigmaGraph to which the node will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added node.	Adds a single node to a SigmaGraph. node : `Node` The node to add. graph : `SigmaGraph` The SigmaGraph to which the node will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added node.
`VisGraph.withNodes nodes graph` Full Usage: `VisGraph.withNodes nodes graph` Parameters: nodes : `Node seq` - The sequence of nodes to add. graph : `SigmaGraph` - The SigmaGraph to which the nodes will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added nodes.	Adds a sequence of nodes to a SigmaGraph. nodes : `Node seq` The sequence of nodes to add. graph : `SigmaGraph` The SigmaGraph to which the nodes will be added. Returns: `SigmaGraph` The updated SigmaGraph with the added nodes.
`VisGraph.withNoverlap (?MaxIterations, ?Settings)` Full Usage: `VisGraph.withNoverlap (?MaxIterations, ?Settings)` Parameters: ?MaxIterations : `int` - Optional maximum number of iterations for the layout algorithm. ?Settings : `NoverlapSettings` - Optional settings for the layout algorithm. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the no-overlap layout.	Assigns a no-overlap layout to a SigmaGraph. ?MaxIterations : `int` Optional maximum number of iterations for the layout algorithm. ?Settings : `NoverlapSettings` Optional settings for the layout algorithm. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the no-overlap layout.
`VisGraph.withRandomLayout (?Scale, ?Center, ?Dimensions)` Full Usage: `VisGraph.withRandomLayout (?Scale, ?Center, ?Dimensions)` Parameters: ?Scale : `int` - Optional scale for the random layout. ?Center : `float` - Optional center for the random layout. ?Dimensions : `string` - Optional dimensions for the random layout. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the random layout.	Assigns a random layout to a SigmaGraph. ?Scale : `int` Optional scale for the random layout. ?Center : `float` Optional center for the random layout. ?Dimensions : `string` Optional dimensions for the random layout. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the random layout.
`VisGraph.withRenderer settings` Full Usage: `VisGraph.withRenderer settings` Parameters: settings : `Settings` - The renderer settings to apply. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the specified renderer settings.	Sets the renderer settings for the SigmaGraph. settings : `Settings` The renderer settings to apply. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the specified renderer settings.
`VisGraph.withSize (?Width, ?Height)` Full Usage: `VisGraph.withSize (?Width, ?Height)` Parameters: ?Width : `CssLength` - Optional width of the canvas. ?Height : `CssLength` - Optional height of the canvas. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the specified canvas size.	Sets the size of the SigmaGraph canvas. ?Width : `CssLength` Optional width of the canvas. ?Height : `CssLength` Optional height of the canvas. Returns: `SigmaGraph -> SigmaGraph` The updated SigmaGraph with the specified canvas size.