HtmlForgeX

API Reference

Class

VisNetworkImageOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Image configuration options for image nodes.

Inheritance

  • Object
  • VisNetworkImageOptions

Constructors

public VisNetworkImageOptions() #

Methods

public VisNetworkImageOptions WithBrokenImage(String url) #
Returns: VisNetworkImageOptions

Sets the URL of the image to use when the main image cannot be loaded.

Parameters

url System.String requiredposition: 0
The URL of the broken image placeholder

Returns

The image options for method chaining

WithImagePadding 2 overloads
public VisNetworkImageOptions WithImagePadding(Int32 padding) #
Returns: VisNetworkImageOptions

Sets uniform padding around the image in pixels.

Parameters

padding System.Int32 requiredposition: 0
The padding value in pixels

Returns

The image options for method chaining

public VisNetworkImageOptions WithImagePadding(Int32 top, Int32 right, Int32 bottom, Int32 left) #
Returns: VisNetworkImageOptions

Sets individual padding values for each side of the image.

Parameters

top System.Int32 requiredposition: 0
Top padding in pixels
right System.Int32 requiredposition: 1
Right padding in pixels
bottom System.Int32 requiredposition: 2
Bottom padding in pixels
left System.Int32 requiredposition: 3
Left padding in pixels

Returns

The image options for method chaining

public VisNetworkImageOptions WithSelected(String url) #
Returns: VisNetworkImageOptions

Sets the image displayed when selected.

Parameters

url System.String requiredposition: 0
Image URL.

Returns

The image options for method chaining.

public VisNetworkImageOptions WithUnselected(String url) #
Returns: VisNetworkImageOptions

Sets the image displayed when not selected.

Parameters

url System.String requiredposition: 0
Image URL.

Returns

The image options for method chaining.

Properties

public String Unselected { get; set; } #
JsonPropertyName("unselected") JsonIgnore(Condition = 3)

Image URL when the node is not selected.

public String Selected { get; set; } #
JsonPropertyName("selected") JsonIgnore(Condition = 3)

Image URL when the node is selected.

public String BrokenImage { get; set; } #
JsonPropertyName("brokenImage") JsonIgnore(Condition = 3)

Fallback image URL when the main image fails.

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

Padding around the image.