New-BGInfoTopology

Namespace PowerBGInfo

Inputs

None

Outputs

PowerBGInfo.BgInfoTopology

Creates a BGInfo topology overlay definition.

Remarks

Creates a BGInfo topology overlay definition.

Examples

Authored help example

EXAMPLE 1


New-BGInfoTopology -Anchor '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.

Syntax

New-BGInfoTopology [-Anchor <TopLeft>] [-Direction <TopToBottom|LeftToRight|BottomToTop|RightToLeft>] [-Height <Int32>] [-Layout <Manual>] [-NodeDisplayMode <Card>] [-NoEdgeLabels] [-NoGroups] [-NoTitle] [-OffsetX <Int32>] [-OffsetY <Int32>] [-Opaque] [-PositionX <Int32>] [-PositionY <Int32>] [-ShowLegend] [-Subtitle <String>] [-Theme <Light|Dark>] [-Title <String>] -TopologyDefinition <ScriptBlock> [-Width <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Anchor BgInfoTextPosition optionalposition: namedpipeline: Falsevalues: 9: Anchor position for placement.; Possible values: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight
Direction TopologyLayoutDirection optionalposition: namedpipeline: Falsevalues: 4: Topology layout direction.; Possible values: TopToBottom, LeftToRight, BottomToTop, RightToLeft
Height Int32 optionalposition: namedpipeline: False: Topology height in pixels.
Layout TopologyLayoutMode optionalposition: namedpipeline: Falsevalues: 10: Topology layout mode.; Possible values: Manual, GroupGrid, HubAndSpoke, Layered, Matrix, DenseGrouped, Geographic, ForceDirected, RelationshipRadial, MindMap
NodeDisplayMode TopologyNodeDisplayMode optionalposition: namedpipeline: Falsevalues: 8: Node presentation mode.; Possible values: Card, CompactCard, Tile, Pill, Icon, Artwork, Dot, Hidden
NoEdgeLabels SwitchParameter optionalposition: namedpipeline: False: Hide edge labels.
NoGroups SwitchParameter optionalposition: namedpipeline: False: Hide group containers.
NoTitle SwitchParameter optionalposition: namedpipeline: False: Hide the topology title.
OffsetX Int32 optionalposition: namedpipeline: False: Horizontal offset from the anchor.
OffsetY Int32 optionalposition: namedpipeline: False: Vertical offset from the anchor.
Opaque SwitchParameter optionalposition: namedpipeline: False: Use an opaque topology canvas.
PositionX Int32 optionalposition: namedpipeline: False: Absolute X position.
PositionY Int32 optionalposition: namedpipeline: False: Absolute Y position.
ShowLegend SwitchParameter optionalposition: namedpipeline: False: Show the topology legend.
Subtitle String optionalposition: namedpipeline: False: Topology subtitle.
Theme String optionalposition: namedpipeline: Falsevalues: 2: Theme name.; Possible values: Light, Dark
Title String optionalposition: namedpipeline: False: Topology title.
TopologyDefinition ScriptBlock requiredposition: 0pipeline: False: Script block that emits topology groups, nodes, and edges.
Width Int32 optionalposition: namedpipeline: False: Topology width in pixels.

Outputs

PowerBGInfo.BgInfoTopology