API Reference
Command
New-ImageTopologyNode
Creates a topology node definition.
Remarks
Use this cmdlet inside New-ImageTopology to describe a node in a topology diagram.
Examples
Create an API node
PS>
New-ImageTopologyNode -Id api -Label 'API' -Kind Service -Status Healthy -Symbol API
Creates a ChartForgeX topology node that can be rendered by New-ImageTopology.
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-ImageTopologyNode [-BackgroundColor <String>] [-Badge <String>] [-Color <String>] [-DisplayMode <Card>] [-GroupId <String>] [-Height <Double>] [-Href <String>] [-IconId <String>] -Id <String> [-Kind <Generic>] -Label <String> [-Latitude <Double>] [-Longitude <Double>] [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-Subtitle <String>] [-Symbol <String>] [-Tooltip <String>] [-Width <Double>] [-X <Double>] [-Y <Double>] [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- BackgroundColor String
- Optional node fill color as a CSS hex color.
- Badge String
- Optional short badge text.
- Color String
- Optional node accent color as a CSS hex color.
- DisplayMode TopologyNodeDisplayMode
- Optional node display mode override.
- Possible values:
Card,CompactCard,Tile,Pill,Icon,Artwork,Dot,Hidden - GroupId String
- Optional parent group identifier.
- Height Double
- Node height in pixels.
- Href String
- Optional drill-down link for SVG and HTML outputs.
- IconId String
- Reusable ChartForgeX icon identifier.
- Id String
- Stable node identifier used by topology edges.
- Kind TopologyNodeKind
- Node kind used for icon and legend selection.
- Possible values:
Generic,Group,Location,Hub,Branch,Server,Service,Endpoint,Gateway,Cloud,Database,Storage,Network,NetworkSegment,Namespace,Application,Process,Queue,Person,Team,Certificate - Label String
- Node label rendered in the diagram.
- Latitude Double
- Optional node latitude for geographic layouts.
- Longitude Double
- Optional node longitude for geographic layouts.
- Status TopologyHealthStatus
- Node health or state.
- Possible values:
Healthy,Warning,Critical,Unknown,Disabled - Subtitle String
- Optional node subtitle.
- Symbol String
- Short symbol rendered inside or near the node icon.
- Tooltip String
- Optional tooltip for SVG and HTML outputs.
- Width Double
- Node width in pixels.
- X Double
- Manual X coordinate. Automatic layouts can ignore this value.
- Y Double
- Manual Y coordinate. Automatic layouts can ignore this value.
Outputs
ChartForgeX.Topology.TopologyNode