HtmlForgeX

API Reference

Command

New-HtmlXDiagramNode

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.VisNetworkNodeOptions

Adds a node to the current diagram.

Remarks

Use inside New-HtmlXDiagram { }.

Examples

Imported script example

New-HtmlXDiagramNode -Id 1 -Label "Web" -Color Primary
        

New-HtmlXDiagramNode -Id 2 -Label "API" -Color Info
        

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-HtmlXDiagramNode [-BorderColor <Blue>] [-Color <Blue>] [-Group <string>] [-Hidden] [-Id <object>] [-Label <string>] [-Level <int>] [-Physics] [-Shape <Ellipse>] [-Size <double>] [-Title <string>] [-X <double>] [-Y <double>] [<CommonParameters>]
#

Parameters

BorderColor TablerColor optionalposition: namedpipeline: falsevalues: 62
Node border 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
Color TablerColor optionalposition: namedpipeline: falsevalues: 62
Node background 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
Group string optionalposition: namedpipeline: false
Group name for shared styling.
Hidden SwitchParameter optionalposition: namedpipeline: false
Marks the node as hidden.
Id object optionalposition: namedpipeline: false
Node identifier.
Label string optionalposition: namedpipeline: false
Node label.
Level int optionalposition: namedpipeline: false
Hierarchical level for layout.
Physics SwitchParameter optionalposition: namedpipeline: false
Enables physics simulation for the node.
Shape VisNetworkNodeShape optionalposition: namedpipeline: falsevalues: 16
Node shape. Possible values: Ellipse, Circle, Database, Box, Text, Image, CircularImage, Diamond, Dot, Square, Triangle, TriangleDown, Hexagon, Star, Icon, Custom
Possible values: Ellipse, Circle, Database, Box, Text, Image, CircularImage, Diamond, Dot, Square, Triangle, TriangleDown, Hexagon, Star, Icon, Custom
Size double optionalposition: namedpipeline: false
Node size.
Title string optionalposition: namedpipeline: false
Tooltip text.
X double optionalposition: namedpipeline: false
Initial X position.
Y double optionalposition: namedpipeline: false
Initial Y position.

Outputs

HtmlForgeX.VisNetworkNodeOptions