HtmlForgeX

API Reference

Command

New-HtmlXDiagramEdge

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.VisNetworkEdgeOptions

Adds an edge to the current diagram.

Remarks

Use inside New-HtmlXDiagram { }.

Examples

Imported script example

New-HtmlXDiagramEdge -From 1 -To 2 -Label "calls" -Color Secondary
        

New-HtmlXDiagramEdge -From 2 -To 3 -Label "queries" -Color Secondary
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-HtmlXDiagramEdge [-Color <Blue>] [-From <object>] [-Hidden] [-HighlightColor <Blue>] [-HoverColor <Blue>] [-Id <object>] [-Label <string>] [-Opacity <double>] [-Title <string>] [-To <object>] [-Width <double>] [<CommonParameters>]
#

Parameters

Color TablerColor optionalposition: namedpipeline: falsevalues: 62
Edge color (Tabler palette). Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
From object optionalposition: namedpipeline: false
Source node identifier.
Hidden SwitchParameter optionalposition: namedpipeline: false
Marks the edge as hidden.
HighlightColor TablerColor optionalposition: namedpipeline: falsevalues: 62
Edge highlight color (Tabler palette). Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
HoverColor TablerColor optionalposition: namedpipeline: falsevalues: 62
Edge hover color (Tabler palette). Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Id object optionalposition: namedpipeline: false
Edge identifier.
Label string optionalposition: namedpipeline: false
Edge label.
Opacity double optionalposition: namedpipeline: false
Edge opacity (0.0 to 1.0).
Title string optionalposition: namedpipeline: false
Tooltip text.
To object optionalposition: namedpipeline: false
Target node identifier.
Width double optionalposition: namedpipeline: false
Edge width.

Outputs

HtmlForgeX.VisNetworkEdgeOptions