HtmlForgeX

API Reference

Class

VisNetworkRemoteDataPayload

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Server-side friendly payload for VisNetworkRemoteDataOptions>) endpoints.

Inheritance

  • Object
  • VisNetworkRemoteDataPayload

Constructors

Methods

AddEdge 3 overloads
public VisNetworkRemoteDataPayload AddEdge(VisNetworkEdgeOptions edge) #
Returns: VisNetworkRemoteDataPayload

Adds an edge.

Parameters

configure System.Action{HtmlForgeX.VisNetworkEdgeOptions} requiredposition: 0
public VisNetworkRemoteDataPayload AddEdge(Object from, Object to, Action<VisNetworkEdgeOptions> configure = null) #
Returns: VisNetworkRemoteDataPayload

Adds an edge between two nodes.

Parameters

from System.Object requiredposition: 0
to System.Object requiredposition: 1
configure System.Action{HtmlForgeX.VisNetworkEdgeOptions} = null optionalposition: 2
AddEdge(HtmlForgeX.VisNetworkEdgeOptions edge) #

Adds an edge options instance.

Parameters

edge HtmlForgeX.VisNetworkEdgeOptions required
AddNode 3 overloads
public VisNetworkRemoteDataPayload AddNode(VisNetworkNodeOptions node) #
Returns: VisNetworkRemoteDataPayload

Adds a node.

Parameters

configure System.Action{HtmlForgeX.VisNetworkNodeOptions} requiredposition: 0
public VisNetworkRemoteDataPayload AddNode(Object id, Action<VisNetworkNodeOptions> configure = null) #
Returns: VisNetworkRemoteDataPayload

Adds a node with the specified ID.

Parameters

id System.Object requiredposition: 0
configure System.Action{HtmlForgeX.VisNetworkNodeOptions} = null optionalposition: 1
AddNode(HtmlForgeX.VisNetworkNodeOptions node) #

Adds a node options instance.

Parameters

node HtmlForgeX.VisNetworkNodeOptions required
public VisNetworkRemoteDataPayload ResolveImages(Document document) #
Returns: VisNetworkRemoteDataPayload

Applies HtmlForgeX image pipeline to node/edge image fields (for example, to embed or copy local images).

Parameters

document HtmlForgeX.Document requiredposition: 0
public String ToJson(JsonSerializerOptions options = null) #
Returns: String

Serializes this payload to JSON suitable for vis-network remote mode.

Parameters

options System.Text.Json.JsonSerializerOptions = null optionalposition: 0

Properties

public List<VisNetworkNodeOptions> Nodes { get; } #
JsonPropertyName("nodes")

Nodes array. Serialized as nodes.

public List<VisNetworkEdgeOptions> Edges { get; } #
JsonPropertyName("edges")

Edges array. Serialized as edges.