API Reference
Function
New-DiagramLink
Creates a new diagram link between two nodes.
Remarks
Creates a new diagram link connecting two nodes in a visual representation.
Examples
EXAMPLE 1
An example of creating a new diagram link.
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-DiagramLink [-ArrowsFromEnabled] [-ArrowsFromScaleFactor <Nullable`1>] [-ArrowsFromType <arrow|bar|circle>] [-ArrowsMiddleEnabled] [-ArrowsMiddleScaleFactor <Nullable`1>] [-ArrowsMiddleType <arrow|bar|circle>] [-ArrowsToEnabled] [-ArrowsToScaleFacto <Nullable`1>] [-ArrowsToType <arrow|bar|circle>] [-ArrowStrikethrough] [-Chosen] [-Color <String>] [-ColorHighlight <String>] [-ColorHover <String>] [-ColorInherit <true|false|from|to|both>] [-ColorOpacity <Nullable`1>] [-Dashes] [-FontAlign <horizontal|top|middle|bottom>] [-FontBackground <String>] [-FontColor <String>] [-FontMulti <false|true|markdown|html>] [-FontName <String>] [-FontSize <Object>] [-FontStrokeColor <String>] [-FontStrokeWidth <Object>] [-FontVAdjust <Nullable`1>] [-From <String[]>] [-Label <String>] [-Length <String>] [-SmoothForceDirection <horizontal|vertical>] [-SmoothRoundness <String>] [-SmoothType <dynamic>] [-To <String[]>] [-WidthConstraint <Nullable`1>] [<CommonParameters>]Parameter set:
All Parameter SetsParameters
- ArrowsFromEnabled SwitchParameter
- Switch parameter to enable arrows at the start of the link.
- ArrowsFromScaleFactor Nullable`1
- Specifies the scale factor for the arrows at the start of the link.
- ArrowsFromType String
- Specifies the type of arrows at the start of the link. Valid values are 'arrow', 'bar', or 'circle'.
- Possible values:
arrow,bar,circle - ArrowsMiddleEnabled SwitchParameter
- Switch parameter to enable arrows in the middle of the link.
- ArrowsMiddleScaleFactor Nullable`1
- Specifies the scale factor for the arrows in the middle of the link.
- ArrowsMiddleType String
- Specifies the type of arrows in the middle of the link. Valid values are 'arrow', 'bar', or 'circle'.
- Possible values:
arrow,bar,circle - ArrowsToEnabled SwitchParameter
- Switch parameter to enable arrows at the end of the link.
- ArrowsToScaleFacto Nullable`1
- ArrowsToType String
- Specifies the type of arrows at the end of the link. Valid values are 'arrow', 'bar', or 'circle'.
- Possible values:
arrow,bar,circle - ArrowStrikethrough SwitchParameter
- Switch parameter to enable a strikethrough effect for the link.
- Chosen SwitchParameter
- Switch parameter to mark the link as chosen.
- Color String
- Specifies the color of the link.
- ColorHighlight String
- Specifies the highlight color of the link.
- ColorHover String
- Specifies the hover color of the link.
- ColorInherit String
- Specifies how the link color should inherit. Valid values are 'true', 'false', 'from', 'to', or 'both'.
- Possible values:
true,false,from,to,both - ColorOpacity Nullable`1
- Specifies the opacity of the link color. Range between 0 and 1.
- Dashes SwitchParameter
- Switch parameter to enable dashed line style for the link.
- FontAlign String
- Possible options: 'horizontal','top','middle','bottom'. The alignment determines how the label is aligned over the edge. The default value horizontal aligns the label horizontally, regardless of the orientation of the edge. When an option other than horizontal is chosen, the label will align itself according to the edge.
- Possible values:
horizontal,top,middle,bottom - FontBackground String
- Specifies the background color for the font.
- FontColor String
- Specifies the font color for the label.
- FontMulti String
- Specifies whether the label supports multiple lines or markdown/html formatting.
- Possible values:
false,true,markdown,html - FontName String
- Specifies the font name for the label.
- FontSize Object
- Specifies the font size for the label.
- FontStrokeColor String
- Specifies the stroke color for the font.
- FontStrokeWidth Object
- Specifies the stroke width for the font. (in pixels)
- FontVAdjust Nullable`1
- Specifies the vertical adjustment for the label.
- From String[]
- Specifies the starting node of the link.
- Label String
- Specifies the label text for the link.
- Length String
- Specifies the length of the link.
- SmoothForceDirection String
- Accepted options: ['horizontal', 'vertical', 'none']. This options is only used with the cubicBezier curves. When true, horizontal is chosen, when false, the direction that is larger (x distance between nodes vs y distance between nodes) is used. If the x distance is larger, horizontal. This is ment to be used with hierarchical layouts.
- Possible values:
horizontal,vertical - SmoothRoundness String
- Accepted range: 0 .. 1.0. This parameter tweaks the roundness of the smooth curves for all types EXCEPT dynamic.
- SmoothType String
- Possible options: 'dynamic', 'continuous', 'discrete', 'diagonalCross', 'straightCross', 'horizontal', 'vertical', 'curvedCW', 'curvedCCW', 'cubicBezier'. Take a look at this example to see what these look like and pick the one that you like best! When using dynamic, the edges will have an invisible support node guiding the shape. This node is part of the physics simulation.
- Possible values:
dynamic,continuous,discrete,diagonalCross,straightCross,horizontal,vertical,curvedCW,curvedCCW,cubicBezier - To String[]
- Specifies the ending node of the link.
- WidthConstraint Nullable`1
- Specifies the width constraint for the link.