API Reference

Class

VisNetworkIconOptions

Edit on GitHub

Namespace HtmlForgeX

Assembly HtmlForgeX

Source Containers/VisNetwork/VisNetworkIconOptions.cs:38

Icon configuration for icon-shaped nodes.

Inheritance

Object
VisNetworkIconOptions

Constructors

public VisNetworkIconOptions() #

Methods

public VisNetworkIconOptions WithCode(String code) #

Containers/VisNetwork/VisNetworkIconOptions.cs:46

Returns: VisNetworkIconOptions

Sets the icon code.

Parameters

code System.String requiredposition: 0: Icon code.

Returns

The icon options for method chaining.

public VisNetworkIconOptions WithColor(RGBColor color) #

Containers/VisNetwork/VisNetworkIconOptions.cs:62

Returns: VisNetworkIconOptions

Sets the icon color.

Parameters

color HtmlForgeX.RGBColor requiredposition: 0: Color value.

Returns

The icon options for method chaining.

public VisNetworkIconOptions WithFace(String face) #

Containers/VisNetwork/VisNetworkIconOptions.cs:38

Returns: VisNetworkIconOptions

Sets the icon face.

Parameters

face System.String requiredposition: 0: Font face.

Returns

The icon options for method chaining.

WithFontAwesome 3 overloads

public VisNetworkIconOptions WithFontAwesome(FontAwesomeBrands icon) #

Containers/VisNetwork/VisNetworkIconOptions.cs:104

Returns: VisNetworkIconOptions

Sets the icon using a FontAwesome Solid icon. Automatically sets face for Font Awesome 6.

Parameters

icon HtmlForgeX.FontAwesomeSolid requiredposition: 0: The FontAwesome solid icon to use

Returns

The icon options for method chaining

WithFontAwesome(HtmlForgeX.FontAwesomeRegular icon) #

Sets the icon using a FontAwesome Regular icon. Automatically sets face for Font Awesome 6.

Parameters

icon HtmlForgeX.FontAwesomeRegular required: The FontAwesome regular icon to use

Returns

The icon options for method chaining

WithFontAwesome(HtmlForgeX.FontAwesomeBrands icon) #

Sets the icon using a FontAwesome Brand icon. Automatically sets face for Font Awesome 6 Brands.

Parameters

icon HtmlForgeX.FontAwesomeBrands required: The FontAwesome brand icon to use

Returns

The icon options for method chaining

WithFontAwesome5 3 overloads

public VisNetworkIconOptions WithFontAwesome5(FontAwesome5Brands icon) #

Containers/VisNetwork/VisNetworkIconOptions.cs:142

Returns: VisNetworkIconOptions

Sets the icon using a FontAwesome 5 Solid icon. Uses proper face format for vis.js compatibility.

Parameters

icon HtmlForgeX.FontAwesome5Solid requiredposition: 0: The FontAwesome 5 solid icon to use

Returns

The icon options for method chaining

WithFontAwesome5(HtmlForgeX.FontAwesome5Regular icon) #

Sets the icon using a FontAwesome 5 Regular icon. Uses proper face format for vis.js compatibility.

Parameters

icon HtmlForgeX.FontAwesome5Regular required: The FontAwesome 5 regular icon to use

Returns

The icon options for method chaining

WithFontAwesome5(HtmlForgeX.FontAwesome5Brands icon) #

Sets the icon using a FontAwesome 5 Brand icon. Uses proper face format for vis.js compatibility.

Parameters

icon HtmlForgeX.FontAwesome5Brands required: The FontAwesome 5 brand icon to use

Returns

The icon options for method chaining

public VisNetworkIconOptions WithSize(Int32 size) #

Containers/VisNetwork/VisNetworkIconOptions.cs:54

Returns: VisNetworkIconOptions

Sets the icon size.

Parameters

size System.Int32 requiredposition: 0: Size value.

Returns

The icon options for method chaining.

public VisNetworkIconOptions WithWeight(String weight) #

Containers/VisNetwork/VisNetworkIconOptions.cs:70

Returns: VisNetworkIconOptions

Sets the font weight.

Parameters

weight System.String requiredposition: 0: Weight value.

Returns

The icon options for method chaining.

Inherited Methods

Properties

public String Face { get; set; } #

Containers/VisNetwork/VisNetworkIconOptions.cs:12

JsonPropertyName("face") JsonIgnore(Condition = 3)

Icon font face.

public String Code { get; set; } #

Containers/VisNetwork/VisNetworkIconOptions.cs:17

JsonPropertyName("code") JsonIgnore(Condition = 3)

Icon code.

public Nullable<Int32> Size { get; set; } #

Containers/VisNetwork/VisNetworkIconOptions.cs:22

JsonPropertyName("size") JsonIgnore(Condition = 3)

Icon size.

public String Color { get; set; } #

Containers/VisNetwork/VisNetworkIconOptions.cs:27

JsonPropertyName("color") JsonIgnore(Condition = 3)

Icon color.

public String Weight { get; set; } #

Containers/VisNetwork/VisNetworkIconOptions.cs:32

JsonPropertyName("weight") JsonIgnore(Condition = 3)

Font weight.