Command

New-ImageTopologyEdge

Module imageplayground

Inputs

None

Outputs

ChartForgeX.Topology.TopologyEdge

Creates a topology edge definition.

Syntax

New-ImageTopologyEdge [-Color <String>] [-DashPattern <Double[]>] [-Direction <Forward|Backward|Bidirectional>] [-Emphasis <Normal|Subtle|Strong>] [-Href <String>] [-Id <String>] [-Kind <TopologyEdgeKind>] [[-Label] <String>] [-LabelOffsetX <Double>] [-LabelOffsetY <Double>] [-LineStyle <Auto|Solid|Dashed|Dotted>] [-MinimumRankSpan <Int32>] [-Muted] [-Opacity <Double>] [-PreferredLength <Double>] [-RouteLane <Double>] [-Routing <Straight|Curved|Orthogonal|ObstacleAvoidingOrthogonal>] [-RoutingPriority <Int32>] [-SecondaryLabel <String>] [-SourceLabel <String>] [-SourceMarker <TopologyMarkerKind>] [-SourceNodeId] <String> [-SourcePort <Auto|Top|Right|Bottom|Left>] [-SourcePortId <String>] [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-StrokeWidth <Double>] [-TargetLabel <String>] [-TargetMarker <TopologyMarkerKind>] [-TargetNodeId] <String> [-TargetPort <Auto|Top|Right|Bottom|Left>] [-TargetPortId <String>] [-TertiaryLabel <String>] [-Tooltip <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Use this cmdlet inside New-ImageTopology to describe a relationship between topology nodes.

Examples

Authored help example

Create a dependency edge

New-ImageTopologyEdge -SourceNodeId api -TargetNodeId database -Label '32 ms' -Kind Dependency -Status Warning -Direction Forward

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

Parameters

-Color String optional: Optional edge color as a CSS hex color.
-DashPattern Double[] optional: Alternating dash and gap lengths in pixels.
-Direction VisualLinkDirection optional: Direction marker behavior.; Possible values: Forward, Backward, Bidirectional
-Emphasis TopologyEdgeEmphasis optional: Edge visual emphasis.; Possible values: Normal, Subtle, Strong
-Href String optional: Optional drill-down link for SVG and HTML outputs.
-Id String optional: Stable edge identifier. When omitted, a unique identifier is derived from source and target node ids.
-Kind TopologyEdgeKind optional: Relationship kind.; Possible values: Generic, Link, Replication, Connectivity, Dependency, Trust, Mapping, AuthenticationPath, CertificateChain, DataFlow, Ownership, Membership
-Label String optionalposition: 2: Primary edge label.
-LabelOffsetX Double optional: Optional horizontal edge-label offset in pixels.
-LabelOffsetY Double optional: Optional vertical edge-label offset in pixels.
-LineStyle TopologyEdgeLineStyle optional: Edge line style.; Possible values: Auto, Solid, Dashed, Dotted
-MinimumRankSpan Int32 optional: Preferred minimum layer separation for layered layout.
-Muted SwitchParameter optional: Render the edge as a quiet structural relationship.
-Opacity Double optional: Optional edge opacity from zero to one.
-PreferredLength Double optional: Preferred spring length for force-directed layout.
-RouteLane Double optional: Optional route lane offset in pixels.
-Routing TopologyEdgeRouting optional: Edge routing mode.; Possible values: Straight, Curved, Orthogonal, ObstacleAvoidingOrthogonal
-RoutingPriority Int32 optional: Caller-defined routing and rendering priority. Higher values render above lower values.
-SecondaryLabel String optional: Secondary edge label.
-SourceLabel String optional: Optional label rendered near the source endpoint.
-SourceMarker TopologyMarkerKind optional: Optional source endpoint marker.; Possible values: Arrow, Circle, Diamond, OpenTriangle, OpenDiamond, ExactlyOne, ZeroOrOne, OneOrMany, ZeroOrMany
-SourceNodeId String requiredposition: 0: Source node identifier.
-SourcePort TopologyEdgePort optional: Preferred source attachment side.; Possible values: Auto, Top, Right, Bottom, Left
-SourcePortId String optional: Named port id on the source node.
-Status TopologyHealthStatus optional: Relationship health or state.; Possible values: Healthy, Warning, Critical, Unknown, Disabled
-StrokeWidth Double optional: Optional edge stroke width in pixels.
-TargetLabel String optional: Optional label rendered near the target endpoint.
-TargetMarker TopologyMarkerKind optional: Optional target endpoint marker.; Possible values: Arrow, Circle, Diamond, OpenTriangle, OpenDiamond, ExactlyOne, ZeroOrOne, OneOrMany, ZeroOrMany
-TargetNodeId String requiredposition: 1: Target node identifier.
-TargetPort TopologyEdgePort optional: Preferred target attachment side.; Possible values: Auto, Top, Right, Bottom, Left
-TargetPortId String optional: Named port id on the target node.
-TertiaryLabel String optional: Tertiary edge label.
-Tooltip String optional: Optional tooltip for SVG and HTML outputs.

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.