Skip to content
D
Documentation

generateAllComponentHierarchyDiagrams

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/generators/diagrams/component-hierarchy-diagram.generator.ts

Generate hierarchy diagrams for all root components

Signature

ts
function generateAllComponentHierarchyDiagrams(components: ComponentEntity[], relationships: Relationship[], options: ComponentHierarchyDiagramOptions): Array<{ componentName: string; componentId: string; result: HierarchyDiagramResult }>

Parameters

NameType
componentsComponentEntity[]
relationshipsRelationship[]
optionsComponentHierarchyDiagramOptions

Returns: Array<{ componentName: string; componentId: string; result: HierarchyDiagramResult }>

Was this page helpful?

Download as PDF
ADocs generated by Atloria — from the code, always in sync →