HtmlForgeX

API Reference

Class

VisNetworkInteractionOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Interaction configuration options.

Inheritance

  • Object
  • VisNetworkInteractionOptions

Constructors

public VisNetworkInteractionOptions() #

Methods

public VisNetworkInteractionOptions WithDragNodes(Boolean enabled = true) #
Returns: VisNetworkInteractionOptions

Enables or disables node dragging.

Parameters

enabled System.Boolean = true optionalposition: 0
True to allow dragging nodes.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithDragView(Boolean enabled = true) #
Returns: VisNetworkInteractionOptions

Enables or disables view dragging.

Parameters

enabled System.Boolean = true optionalposition: 0
True to allow dragging the view.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithHideEdgesOnDrag(Boolean hide = true) #
Returns: VisNetworkInteractionOptions

Sets HideEdgesOnDrag.

Parameters

hide System.Boolean = true optionalposition: 0
Whether to hide edges while dragging.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithHideEdgesOnZoom(Boolean hide = true) #
Returns: VisNetworkInteractionOptions

Sets HideEdgesOnZoom.

Parameters

hide System.Boolean = true optionalposition: 0
Whether to hide edges when zooming.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithHideNodesOnDrag(Boolean hide = true) #
Returns: VisNetworkInteractionOptions

Sets HideNodesOnDrag.

Parameters

hide System.Boolean = true optionalposition: 0
Whether to hide nodes when dragging.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithHover(Boolean enabled = true) #
Returns: VisNetworkInteractionOptions

Enables or disables hover events.

Parameters

enabled System.Boolean = true optionalposition: 0
True to enable hover events.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithHoverConnectedEdges(Boolean enabled = true) #
Returns: VisNetworkInteractionOptions

Enables or disables highlighting of edges connected to a hovered node.

Parameters

enabled System.Boolean = true optionalposition: 0
True to highlight connected edges.

Returns

The current VisNetworkInteractionOptions instance.

WithKeyboard 3 overloads
public VisNetworkInteractionOptions WithKeyboard(Action<VisNetworkKeyboardOptions> configure) #
Returns: VisNetworkInteractionOptions

Enables or disables basic keyboard navigation.

Parameters

enabled System.Boolean = true requiredposition: 0
True to enable keyboard navigation.

Returns

The current VisNetworkInteractionOptions instance.

WithKeyboard(HtmlForgeX.VisNetworkKeyboardOptions keyboardOptions) #

Sets keyboard options.

Parameters

keyboardOptions HtmlForgeX.VisNetworkKeyboardOptions required
Options to apply.

Returns

The current VisNetworkInteractionOptions instance.

WithKeyboard(System.Action{HtmlForgeX.VisNetworkKeyboardOptions} configure) #

Configures keyboard options via delegate.

Parameters

configure System.Action{HtmlForgeX.VisNetworkKeyboardOptions} required
Delegate to configure keyboard options.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithMultiselect(Boolean enabled = true) #
Returns: VisNetworkInteractionOptions

Enables or disables multiple selection of nodes.

Parameters

enabled System.Boolean = true optionalposition: 0
True to allow multiple selection.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithNavigationButtons(Boolean show = true) #
Returns: VisNetworkInteractionOptions

Shows or hides navigation buttons.

Parameters

show System.Boolean = true optionalposition: 0
True to show navigation buttons.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithSelectable(Boolean selectable = true) #
Returns: VisNetworkInteractionOptions

Sets whether nodes can be selected.

Parameters

selectable System.Boolean = true optionalposition: 0
True to allow selection.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithSelectConnectedEdges(Boolean select = true) #
Returns: VisNetworkInteractionOptions

Sets whether selecting a node also selects connected edges.

Parameters

select System.Boolean = true optionalposition: 0
True to select connected edges.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithTooltipDelay(Int32 delay) #
Returns: VisNetworkInteractionOptions

Sets the tooltip delay.

Parameters

delay System.Int32 requiredposition: 0
Delay in milliseconds.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithZoomSpeed(Double speed) #
Returns: VisNetworkInteractionOptions

Sets the ZoomSpeed value.

Parameters

speed System.Double requiredposition: 0
Zoom speed factor.

Returns

The current VisNetworkInteractionOptions instance.

public VisNetworkInteractionOptions WithZoomView(Boolean enabled = true) #
Returns: VisNetworkInteractionOptions

Enables or disables zooming of the view.

Parameters

enabled System.Boolean = true optionalposition: 0
True to enable zooming.

Returns

The current VisNetworkInteractionOptions instance.

Properties

public Nullable<Boolean> DragNodes { get; set; } #
JsonPropertyName("dragNodes") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether nodes can be dragged.

public Nullable<Boolean> DragView { get; set; } #
JsonPropertyName("dragView") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether the view can be panned by dragging.

public Nullable<Boolean> HideEdgesOnDrag { get; set; } #
JsonPropertyName("hideEdgesOnDrag") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether edges are hidden during dragging.

public Nullable<Boolean> HideEdgesOnZoom { get; set; } #
JsonPropertyName("hideEdgesOnZoom") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether edges are hidden while zooming.

public Nullable<Boolean> HideNodesOnDrag { get; set; } #
JsonPropertyName("hideNodesOnDrag") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether nodes are hidden while dragging.

public Nullable<Boolean> Hover { get; set; } #
JsonPropertyName("hover") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether hover interactions are enabled.

public Nullable<Boolean> HoverConnectedEdges { get; set; } #
JsonPropertyName("hoverConnectedEdges") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether edges connected to a hovered node are highlighted.

public Object Keyboard { get; set; } #
JsonPropertyName("keyboard") JsonIgnore(Condition = 3)

Gets or sets keyboard interaction options or a boolean value.

public Nullable<Boolean> Multiselect { get; set; } #
JsonPropertyName("multiselect") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether multiple nodes can be selected.

public Nullable<Boolean> NavigationButtons { get; set; } #
JsonPropertyName("navigationButtons") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether navigation buttons are displayed.

public Nullable<Boolean> Selectable { get; set; } #
JsonPropertyName("selectable") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether nodes are selectable.

public Nullable<Boolean> SelectConnectedEdges { get; set; } #
JsonPropertyName("selectConnectedEdges") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether selecting a node also selects connected edges.

public Nullable<Int32> TooltipDelay { get; set; } #
JsonPropertyName("tooltipDelay") JsonIgnore(Condition = 3)

Gets or sets the delay before tooltips appear in milliseconds.

public Nullable<Boolean> ZoomView { get; set; } #
JsonPropertyName("zoomView") JsonIgnore(Condition = 3)

Gets or sets a value indicating whether zooming is allowed.

public Nullable<Double> ZoomSpeed { get; set; } #
JsonPropertyName("zoomSpeed") JsonIgnore(Condition = 3)

Gets or sets the zoom speed factor.