HtmlForgeX

API Reference

Class

VisNetworkFocusOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Options for the focus() method.

Inheritance

  • Object
  • VisNetworkFocusOptions

Constructors

public VisNetworkFocusOptions() #

Methods

WithAnimation 2 overloads
public VisNetworkFocusOptions WithAnimation(Action<VisNetworkAnimationOptions> configure) #
Returns: VisNetworkFocusOptions

Enables animation with default settings.

Parameters

enabled System.Boolean = true requiredposition: 0
WithAnimation(System.Action{HtmlForgeX.VisNetworkAnimationOptions} configure) #

Configures animation options.

Parameters

configure System.Action{HtmlForgeX.VisNetworkAnimationOptions} required
public VisNetworkFocusOptions WithLocked(Boolean locked = true) #
Returns: VisNetworkFocusOptions

Sets whether the view remains locked to the node.

Parameters

locked System.Boolean = true optionalposition: 0
public VisNetworkFocusOptions WithOffset(Double x, Double y) #
Returns: VisNetworkFocusOptions

Sets the offset from center.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
public VisNetworkFocusOptions WithScale(Double scale) #
Returns: VisNetworkFocusOptions

Sets the zoom scale (1.0 = 100%).

Parameters

scale System.Double requiredposition: 0

Properties

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

Gets or sets the zoom scale where 1.0 represents 100%.

public VisNetworkPosition Offset { get; set; } #
JsonPropertyName("offset") JsonIgnore(Condition = 3)

Gets or sets the offset from the viewport center.

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

Gets or sets a value indicating whether the view remains locked to the node.

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

Gets or sets the animation configuration. Can be a boolean or a complex options object.