Skip to content

New-ImageTopologyGroup.md

Latest commit

 

History

History
300 lines (239 loc) · 6.1 KB

New-ImageTopologyGroup.md

File metadata and controls

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

New-ImageTopologyGroup

SYNOPSIS

Creates a topology group definition.

SYNTAX

__AllParameterSets

New-ImageTopologyGroup [-Id] <string> [-Label] <string> [-Subtitle <string>] [-Status <TopologyHealthStatus>] [-X <double>] [-Y <double>] [-Width <double>] [-Height <double>] [-Longitude <double>] [-Latitude <double>] [-LayoutPolicy <TopologyGroupLayoutPolicy>] [-Symbol <string>] [-IconId <string>] [-Color <string>] [-Href <string>] [-Tooltip <string>] [<CommonParameters>]

DESCRIPTION

Use this cmdlet inside New-ImageTopology to describe a logical region or cluster.

EXAMPLES

EXAMPLE 1

PS> New-ImageTopologyGroup -Id site-a -Label 'Site A' -Status Healthy -Symbol region

Creates a ChartForgeX topology group that can contain topology nodes.

PARAMETERS

-Color

Optional group accent 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

-Height

Group height in pixels. When omitted, the layout sizes the group around its nodes.

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

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

-IconId

Reusable ChartForgeX icon identifier.

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

-Label

Group label rendered in the diagram.

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

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

-Latitude

Optional group latitude for geographic layouts.

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

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

-LayoutPolicy

Preferred node arrangement policy for dense grouped layouts.

Type: TopologyGroupLayoutPolicy
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Auto, HubAndBranch, Grid, PairRows, MiniMesh, CollapsedDots

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

-Longitude

Optional group longitude for geographic layouts.

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

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

-Status

Group 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

-Subtitle

Optional group subtitle.

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

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

-Symbol

Short symbol rendered near the group header.

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

-Width

Group width in pixels. When omitted, the layout sizes the group around its nodes.

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

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

-X

Manual X coordinate. Supplying X or Y pins the group; omit both so automatic layouts (Grouped, DenseGrouped) place it.

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

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

-Y

Manual Y coordinate. Supplying X or Y pins the group; omit both so automatic layouts place it.

Type: Double
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.TopologyGroup

RELATED LINKS

  • None