Skip to content

New-ImageTopologyEdge.md

Latest commit

 

History

History
572 lines (460 loc) · 11.7 KB

New-ImageTopologyEdge.md

File metadata and controls

572 lines (460 loc) · 11.7 KB
Raw
external help file ImagePlayground-help.xml
Module Name ImagePlayground
online version https://github.com/EvotecIT/ImagePlayground
schema 2.0.0

New-ImageTopologyEdge

SYNOPSIS

Creates a topology edge definition.

SYNTAX

__AllParameterSets

New-ImageTopologyEdge [-SourceNodeId] <string> [-TargetNodeId] <string> [[-Label] <string>] [-Id <string>] [-SecondaryLabel <string>] [-TertiaryLabel <string>] [-Kind <TopologyEdgeKind>] [-Status <TopologyHealthStatus>] [-Direction <VisualLinkDirection>] [-Routing <TopologyEdgeRouting>] [-LineStyle <TopologyEdgeLineStyle>] [-Emphasis <TopologyEdgeEmphasis>] [-SourcePort <TopologyEdgePort>] [-TargetPort <TopologyEdgePort>] [-RouteLane <double>] [-LabelOffsetX <double>] [-LabelOffsetY <double>] [-Color <string>] [-Muted] [-Href <string>] [-Tooltip <string>] [-SourcePortId <string>] [-TargetPortId <string>] [-SourceMarker <TopologyMarkerKind>] [-TargetMarker <TopologyMarkerKind>] [-StrokeWidth <Double>] [-Opacity <Double>] [-DashPattern <double[]>] [-PreferredLength <Double>] [-MinimumRankSpan <int>] [-RoutingPriority <int>] [-SourceLabel <string>] [-TargetLabel <string>] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

PS> 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

Optional edge color as a CSS hex color.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DashPattern

Alternating dash and gap lengths in pixels.

Type: Double[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Direction

Direction marker behavior.

Type: VisualLinkDirection
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: None, Forward, Backward, Bidirectional

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Emphasis

Edge visual emphasis.

Type: TopologyEdgeEmphasis
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Normal, Subtle, Strong

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Href

Optional drill-down link for SVG and HTML outputs.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Stable edge identifier. When omitted, a unique identifier is derived from source and target node ids.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Kind

Relationship kind.

Type: TopologyEdgeKind
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Generic, Link, Replication, Connectivity, Dependency, Trust, Mapping, AuthenticationPath, CertificateChain, DataFlow, Ownership, Membership

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Label

Primary edge label.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LabelOffsetX

Optional horizontal edge-label offset in pixels.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LabelOffsetY

Optional vertical edge-label offset in pixels.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LineStyle

Edge line style.

Type: TopologyEdgeLineStyle
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Auto, Solid, Dashed, Dotted

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MinimumRankSpan

Preferred minimum layer separation for layered layout.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Muted

Render the edge as a quiet structural relationship.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Opacity

Optional edge opacity from zero to one.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreferredLength

Preferred spring length for force-directed layout.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RouteLane

Optional route lane offset in pixels.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Routing

Edge routing mode.

Type: TopologyEdgeRouting
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Straight, Curved, Orthogonal, ObstacleAvoidingOrthogonal

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RoutingPriority

Caller-defined routing and rendering priority. Higher values render above lower values.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecondaryLabel

Secondary edge label.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceLabel

Optional label rendered near the source endpoint.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceMarker

Optional source endpoint marker.

Type: TopologyMarkerKind
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: None, Arrow, Circle, Diamond, OpenTriangle, OpenDiamond, ExactlyOne, ZeroOrOne, OneOrMany, ZeroOrMany, Cross

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceNodeId

Source node identifier.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourcePort

Preferred source attachment side.

Type: TopologyEdgePort
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Auto, Top, Right, Bottom, Left

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourcePortId

Named port id on the source node.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

Relationship health or state.

Type: TopologyHealthStatus
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Healthy, Warning, Critical, Unknown, Disabled

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StrokeWidth

Optional edge stroke width in pixels.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetLabel

Optional label rendered near the target endpoint.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetMarker

Optional target endpoint marker.

Type: TopologyMarkerKind
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: None, Arrow, Circle, Diamond, OpenTriangle, OpenDiamond, ExactlyOne, ZeroOrOne, OneOrMany, ZeroOrMany, Cross

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetNodeId

Target node identifier.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetPort

Preferred target attachment side.

Type: TopologyEdgePort
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Auto, Top, Right, Bottom, Left

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetPortId

Named port id on the target node.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TertiaryLabel

Tertiary edge label.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tooltip

Optional tooltip for SVG and HTML outputs.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • None

OUTPUTS

  • ChartForgeX.Topology.TopologyEdge

RELATED LINKS

  • None