Header menu logo Sigma.NET

VisGraphElement Type

Constructors

Constructor Description

VisGraphElement()

Full Usage: VisGraphElement()

Returns: VisGraphElement
Returns: VisGraphElement

Static members

Static member Description

VisGraphElement.edge source target

Full Usage: VisGraphElement.edge source target

Parameters:
    source : string - The key of the source node of the edge.
    target : string - The key of the target node of the edge.

Returns: Edge A new Edge instance connecting the source and target nodes.

Initializes a new edge with the given source and target nodes.

source : string

The key of the source node of the edge.

target : string

The key of the target node of the edge.

Returns: Edge

A new Edge instance connecting the source and target nodes.

VisGraphElement.node key

Full Usage: VisGraphElement.node key

Parameters:
    key : string - The unique identifier for the node.

Returns: Node A new Node instance with the specified key.

Initializes a new node with the given key.

key : string

The unique identifier for the node.

Returns: Node

A new Node instance with the specified key.

VisGraphElement.withEdgeData (?Label, ?Size, ?Color, ?Hidden, ?ForceLabel, ?ZIndex, ?StyleType, ?X, ?Y)

Full Usage: VisGraphElement.withEdgeData (?Label, ?Size, ?Color, ?Hidden, ?ForceLabel, ?ZIndex, ?StyleType, ?X, ?Y)

Parameters:
    ?Label : string - Optional label for the edge.
    ?Size : 'a - Optional size of the edge.
    ?Color : string - Optional color of the edge. Needs HTML color codes.
    ?Hidden : bool - Optional flag to hide the edge.
    ?ForceLabel : bool - Optional flag to force the label visibility.
    ?ZIndex : int - Optional z-index of the edge(controles the stacking order of overlapping HTML elements, higher index appears in front of lower index).
    ?StyleType : EdgeType - Optional style type of the edge.
    ?X : 'b - Optional X coordinate for the edge.
    ?Y : 'c - Optional Y coordinate for the edge.

Returns: Edge -> Edge A function that updates the edge with the specified data.

Sets additional data for an edge.

?Label : string

Optional label for the edge.

?Size : 'a

Optional size of the edge.

?Color : string

Optional color of the edge. Needs HTML color codes.

?Hidden : bool

Optional flag to hide the edge.

?ForceLabel : bool

Optional flag to force the label visibility.

?ZIndex : int

Optional z-index of the edge(controles the stacking order of overlapping HTML elements, higher index appears in front of lower index).

?StyleType : EdgeType

Optional style type of the edge.

?X : 'b

Optional X coordinate for the edge.

?Y : 'c

Optional Y coordinate for the edge.

Returns: Edge -> Edge

A function that updates the edge with the specified data.

VisGraphElement.withNodeData (?Label, ?Size, ?Color, ?Hidden, ?ForceLabel, ?ZIndex, ?StyleType, ?X, ?Y)

Full Usage: VisGraphElement.withNodeData (?Label, ?Size, ?Color, ?Hidden, ?ForceLabel, ?ZIndex, ?StyleType, ?X, ?Y)

Parameters:
    ?Label : string - Optional label for the node.
    ?Size : 'a - Optional size of the node.
    ?Color : string - Optional color of the node.Needs HTML color codes
    ?Hidden : bool - Optional flag to hide the node.
    ?ForceLabel : bool - Optional flag to force the label visibility.
    ?ZIndex : int - Optional z-index of the node(controles the stacking order of overlapping HTML elements, higher index appears in front of lower index).
    ?StyleType : NodeType - Optional style type of the node.
    ?X : 'b - Optional X coordinate for the node.
    ?Y : 'c - Optional Y coordinate for the node.

Returns: Node -> Node A function that updates the node with the specified data.

Sets additional data for a node.

?Label : string

Optional label for the node.

?Size : 'a

Optional size of the node.

?Color : string

Optional color of the node.Needs HTML color codes

?Hidden : bool

Optional flag to hide the node.

?ForceLabel : bool

Optional flag to force the label visibility.

?ZIndex : int

Optional z-index of the node(controles the stacking order of overlapping HTML elements, higher index appears in front of lower index).

?StyleType : NodeType

Optional style type of the node.

?X : 'b

Optional X coordinate for the node.

?Y : 'c

Optional Y coordinate for the node.

Returns: Node -> Node

A function that updates the node with the specified data.

Type something to start searching.