tslint-folders-diagrams
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Dot
Doc
Generator
constructor
config
filter
map
Name
ToId
outputter
styler
generate
Doc
generate
Graph
get
Color
Number
get
Prefixed
Package
Id
output
Cluster
output
Container
Node
End
output
Container
Node
Start
output
Edge
output
Edges
output
Footer
output
Graph
Node
output
Graph
Settings
output
Header
output
Node
output
Scope
Begin
output
Scope
End
output
Section
Separator
output
Sub
Nodes
Hierarchy
DocGeneratorBase
DotDocGenerator
Implements
IDocGenerator
Index
Constructors
constructor
Properties
config
filter
map
Name
ToId
outputter
styler
Methods
generate
Doc
generate
Graph
get
Color
Number
get
Prefixed
Package
Id
output
Cluster
output
Container
Node
End
output
Container
Node
Start
output
Edge
output
Edges
output
Footer
output
Graph
Node
output
Graph
Settings
output
Header
output
Node
output
Scope
Begin
output
Scope
End
output
Section
Separator
output
Sub
Nodes
Constructors
constructor
new
Dot
Doc
Generator
(
config
:
DocConfig
, outputter
:
IDocOutputter
)
:
DotDocGenerator
Parameters
config:
DocConfig
outputter:
IDocOutputter
Returns
DotDocGenerator
Properties
Protected
config
config
:
DocConfig
Protected
filter
filter
:
PackageFilter
Private
map
Name
ToId
map
Name
ToId
:
MapNameToId
= new MapNameToId()
Protected
outputter
outputter
:
IDocOutputter
Private
styler
styler
:
DotStyleGenerator
Methods
generate
Doc
generate
Doc
(
packageConfig
:
ImportsBetweenPackagesRuleConfig
)
:
void
Parameters
packageConfig:
ImportsBetweenPackagesRuleConfig
Returns
void
Private
generate
Graph
generate
Graph
(
packageConfig
:
ImportsBetweenPackagesRuleConfig
)
:
GraphCluster
Parameters
packageConfig:
ImportsBetweenPackagesRuleConfig
Returns
GraphCluster
Private
get
Color
Number
get
Color
Number
(
packageIdKey
:
string
)
:
number
Parameters
packageIdKey:
string
Returns
number
Private
get
Prefixed
Package
Id
get
Prefixed
Package
Id
(
packageName
:
string
, prefix
?:
undefined
|
string
)
:
string
Parameters
packageName:
string
Optional
prefix:
undefined
|
string
Returns
string
Private
output
Cluster
output
Cluster
(
cluster
:
GraphCluster
)
:
void
Output the separate graph cluster.
Parameters
cluster:
GraphCluster
Returns
void
Private
output
Container
Node
End
output
Container
Node
End
(
)
:
void
Returns
void
Private
output
Container
Node
Start
output
Container
Node
Start
(
cluster
:
GraphCluster
)
:
void
Parameters
cluster:
GraphCluster
Returns
void
Private
output
Edge
output
Edge
(
edge
:
Edge
)
:
void
Parameters
edge:
Edge
Returns
void
Private
output
Edges
output
Edges
(
root
:
GraphCluster
)
:
void
Parameters
root:
GraphCluster
Returns
void
Private
output
Footer
output
Footer
(
)
:
void
Returns
void
Private
output
Graph
Node
output
Graph
Node
(
node
:
GraphNode
, prefix
?:
undefined
|
string
)
:
void
Parameters
node:
GraphNode
Optional
prefix:
undefined
|
string
Returns
void
Private
output
Graph
Settings
output
Graph
Settings
(
)
:
void
Returns
void
Private
output
Header
output
Header
(
)
:
void
Returns
void
Private
output
Node
output
Node
(
node
:
GraphNode
, prefix
?:
undefined
|
string
)
:
void
Parameters
node:
GraphNode
Optional
prefix:
undefined
|
string
Returns
void
Private
output
Scope
Begin
output
Scope
Begin
(
)
:
void
Returns
void
Private
output
Scope
End
output
Scope
End
(
)
:
void
Returns
void
Private
output
Section
Separator
output
Section
Separator
(
sectionName
:
string
)
:
void
Parameters
sectionName:
string
Returns
void
Private
output
Sub
Nodes
output
Sub
Nodes
(
cluster
:
GraphCluster
)
:
void
Parameters
cluster:
GraphCluster
Returns
void
Generated using
TypeDoc
Output the separate graph cluster.