Command

New-ImageTopologyNode

Module imageplayground

Inputs

None

Outputs

ChartForgeX.Topology.TopologyNode

Creates a topology node definition.

Syntax

New-ImageTopologyNode [-BackgroundColor <String>] [-Badge <String>] [-Color <String>] [-Detail <TopologyNodeDetail[]>] [-DisplayMode <TopologyNodeDisplayMode>] [-GroupId <String>] [-Height <Double>] [-Href <String>] [-IconId <String>] [-Id] <String> [-Kind <TopologyNodeKind>] [-Label] <String> [-Latitude <Double>] [-Layer <Int32>] [-Longitude <Double>] [-Port <TopologyNodePort[]>] [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-Subtitle <String>] [-Symbol <String>] [-Tooltip <String>] [-Width <Double>] [-X <Double>] [-Y <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Use this cmdlet inside New-ImageTopology to describe a node in a topology diagram.

Examples

Authored help example

Create an API node

New-ImageTopologyNode -Id api -Label 'API' -Kind Service -Status Healthy -Symbol API

Creates a ChartForgeX topology node that can be rendered by New-ImageTopology.

Place tiers in columns with the Layered layout

New-ImageTopology -Layout Layered -Direction LeftToRight -FilePath tiers.png -TopologyDefinition {
    New-ImageTopologyNode gateway Gateway -Kind Gateway -Layer 0
    New-ImageTopologyNode orders Orders -Kind Service -Layer 1
    New-ImageTopologyNode sql 'Orders DB' -Kind Database -Layer 2
    New-ImageTopologyEdge gateway orders -Direction Forward
    New-ImageTopologyEdge orders sql -Direction Forward
}

-Layer pins each node to a column, so the diagram reads gateway, services, data from left to right.

Parameters

-BackgroundColor String optional: Optional node fill color as a CSS hex color.
-Badge String optional: Optional short badge text.
-Color String optional: Optional node accent color as a CSS hex color.
-Detail TopologyNodeDetail[] optional: Typed card detail rows created by New-ImageTopologyNodeDetail.
-DisplayMode TopologyNodeDisplayMode optional: Optional node display mode override.; Possible values: Card, CompactCard, Tile, Pill, Icon, Artwork, Dot, Hidden
-GroupId String optional: Optional parent group identifier.
-Height Double optional: Node height in pixels.
-Href String optional: Optional drill-down link for SVG and HTML outputs.
-IconId String optional: Reusable ChartForgeX icon identifier.
-Id String requiredposition: 0: Stable node identifier used by topology edges.
-Kind TopologyNodeKind optional: 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 requiredposition: 1: Node label rendered in the diagram.
-Latitude Double optional: Optional node latitude for geographic layouts.
-Layer Int32 optional: Layer (column or row) for the Layered layout, starting at 0. Nodes in the same layer line up; edges usually flow from lower to higher layers. Without it, Layered groups nodes by their Kind.
-Longitude Double optional: Optional node longitude for geographic layouts.
-Port TopologyNodePort[] optional: Named attachment ports created by New-ImageTopologyNodePort.
-Status TopologyHealthStatus optional: Node health or state.; Possible values: Healthy, Warning, Critical, Unknown, Disabled
-Subtitle String optional: Optional node subtitle.
-Symbol String optional: Short symbol rendered inside or near the node icon.
-Tooltip String optional: Optional tooltip for SVG and HTML outputs.
-Width Double optional: Node width in pixels.
-X Double optional: Manual X coordinate. Used by the Manual layout; automatic layouts ignore it.
-Y Double optional: Manual Y coordinate. Automatic layouts can ignore this value.

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.