Command

New-ImageTopologyGroup

Module imageplayground

Inputs

None

Outputs

ChartForgeX.Topology.TopologyGroup

Creates a topology group definition.

Syntax

New-ImageTopologyGroup [-Color <String>] [-Height <Double>] [-Href <String>] [-IconId <String>] [-Id] <String> [-Label] <String> [-Latitude <Double>] [-LayoutPolicy <TopologyGroupLayoutPolicy>] [-Longitude <Double>] [-Status <Healthy|Warning|Critical|Unknown|Disabled>] [-Subtitle <String>] [-Symbol <String>] [-Tooltip <String>] [-Width <Double>] [-X <Double>] [-Y <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

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

Examples

Authored help example

Create a site group

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

Creates a ChartForgeX topology group that can contain topology nodes.

Parameters

-Color String optional: Optional group accent color as a CSS hex color.
-Height Double optional: Group height in pixels. When omitted, the layout sizes the group around its nodes.
-Href String optional: Optional drill-down link for SVG and HTML outputs.
-IconId String optional: Reusable ChartForgeX icon identifier.
-Id String requiredposition: 0: Stable group identifier.
-Label String requiredposition: 1: Group label rendered in the diagram.
-Latitude Double optional: Optional group latitude for geographic layouts.
-LayoutPolicy TopologyGroupLayoutPolicy optional: Preferred node arrangement policy for dense grouped layouts.; Possible values: Auto, HubAndBranch, Grid, PairRows, MiniMesh, CollapsedDots
-Longitude Double optional: Optional group longitude for geographic layouts.
-Status TopologyHealthStatus optional: Group health or state.; Possible values: Healthy, Warning, Critical, Unknown, Disabled
-Subtitle String optional: Optional group subtitle.
-Symbol String optional: Short symbol rendered near the group header.
-Tooltip String optional: Optional tooltip for SVG and HTML outputs.
-Width Double optional: Group width in pixels. When omitted, the layout sizes the group around its nodes.
-X Double optional: Manual X coordinate. Supplying X or Y pins the group; omit both so automatic layouts (Grouped, DenseGrouped) place it.
-Y Double optional: Manual Y coordinate. Supplying X or Y pins the group; omit both so automatic layouts place it.

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.