API Reference
Command
New-ImageOrganizationChart
Creates an organization or team chart.
Remarks
Maps PowerShell-authored team members into the shared ChartForgeX hierarchy engine, including inherited standard, compact, and vertical subtree layouts.
Examples
Create an engineering organization chart
PS>
New-ImageOrganizationChart -TeamId engineering -TeamLabel 'Engineering' -MemberDefinition { New-ImageOrganizationMember -Id lead -Name 'Avery Stone' -Role 'Director'; New-ImageOrganizationMember -Id platform -Name 'Morgan Lee' -Role 'Platform Lead' -ParentId lead } -FilePath engineering.svg
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-ImageOrganizationChart [-Direction <TopToBottom|LeftToRight|BottomToTop|RightToLeft>] -FilePath <String> [-Height <Int32>] [-LayoutPolicy <Auto|Standard|Compact|Vertical>] [-MaxLevel <Int32>] -MemberDefinition <ScriptBlock> [-MinLevel <Int32>] [-NoAncestorContext] [-NodeDisplayMode <Card>] [-NoTeamNode] [-PassThru] [-Show] [-ShowLegend] [-Subtitle <String>] [-TeamId <String>] -TeamLabel <String> [-Theme <Light|Dark>] [-Transparent] [-Width <Int32>] [<CommonParameters>]Parameter set:
DefinitionParameters
- Direction TopologyLayoutDirection
- Layered organization-chart direction.
- Possible values:
TopToBottom,LeftToRight,BottomToTop,RightToLeft - FilePath String
- Output file path. Supported extensions are PNG, SVG, HTML, and HTM.
- Height Int32
- Output height in pixels.
- LayoutPolicy TopologyHierarchyLayoutPolicy
- Default sibling layout inherited by organization members that do not specify their own policy.
- Possible values:
Auto,Standard,Compact,Vertical - MaxLevel Int32
- Highest hierarchy level to include.
- MemberDefinition ScriptBlock
- Script block that emits members from New-ImageOrganizationMember.
- MinLevel Int32
- Lowest primary hierarchy level to include.
- NoAncestorContext SwitchParameter
- Omit ancestors below the requested minimum level.
- NodeDisplayMode TopologyNodeDisplayMode
- Organization member presentation mode.
- Possible values:
Card,CompactCard,Tile,Pill,Icon,Artwork,Dot,Hidden - NoTeamNode SwitchParameter
- Omit the generated team root node.
- PassThru SwitchParameter
- Write the generated ChartForgeX topology chart to the pipeline.
- Show SwitchParameter
- Open the generated organization chart.
- ShowLegend SwitchParameter
- Show the node-kind and status legend.
- Subtitle String
- Optional chart subtitle.
- TeamId String
- Stable team root identifier.
- TeamLabel String
- Team or organization label.
- Theme String
- Topology theme name.
- Possible values:
Light,Dark - Transparent SwitchParameter
- Use a transparent chart background.
- Width Int32
- Output width in pixels.
Outputs
ChartForgeX.Topology.TopologyChart
New-ImageOrganizationChart [-Direction <TopToBottom|LeftToRight|BottomToTop|RightToLeft>] -FilePath <String> [-Height <Int32>] [-LayoutPolicy <Auto|Standard|Compact|Vertical>] [-MaxLevel <Int32>] -Member <TopologyTeamMember[]> [-MinLevel <Int32>] [-NoAncestorContext] [-NodeDisplayMode <Card>] [-NoTeamNode] [-PassThru] [-Show] [-ShowLegend] [-Subtitle <String>] [-TeamId <String>] -TeamLabel <String> [-Theme <Light|Dark>] [-Transparent] [-Width <Int32>] [<CommonParameters>]Parameter set:
MemberParameters
- Direction TopologyLayoutDirection
- Layered organization-chart direction.
- Possible values:
TopToBottom,LeftToRight,BottomToTop,RightToLeft - FilePath String
- Output file path. Supported extensions are PNG, SVG, HTML, and HTM.
- Height Int32
- Output height in pixels.
- LayoutPolicy TopologyHierarchyLayoutPolicy
- Default sibling layout inherited by organization members that do not specify their own policy.
- Possible values:
Auto,Standard,Compact,Vertical - MaxLevel Int32
- Highest hierarchy level to include.
- Member TopologyTeamMember[]
- Members supplied directly or through the pipeline.
- MinLevel Int32
- Lowest primary hierarchy level to include.
- NoAncestorContext SwitchParameter
- Omit ancestors below the requested minimum level.
- NodeDisplayMode TopologyNodeDisplayMode
- Organization member presentation mode.
- Possible values:
Card,CompactCard,Tile,Pill,Icon,Artwork,Dot,Hidden - NoTeamNode SwitchParameter
- Omit the generated team root node.
- PassThru SwitchParameter
- Write the generated ChartForgeX topology chart to the pipeline.
- Show SwitchParameter
- Open the generated organization chart.
- ShowLegend SwitchParameter
- Show the node-kind and status legend.
- Subtitle String
- Optional chart subtitle.
- TeamId String
- Stable team root identifier.
- TeamLabel String
- Team or organization label.
- Theme String
- Topology theme name.
- Possible values:
Light,Dark - Transparent SwitchParameter
- Use a transparent chart background.
- Width Int32
- Output width in pixels.
Outputs
ChartForgeX.Topology.TopologyChart