Graphora API
Preparing search index...
@graphora/engine
ClusteredGraphOptions
Interface ClusteredGraphOptions<NodeData, EdgeData>
interface
ClusteredGraphOptions
<
NodeData
=
unknown
,
EdgeData
=
unknown
>
{
minClusterSize
?:
number
;
clusterEdgeAttributes
?
(
group
:
ClusterEdgeGroup
<
EdgeData
>
,
)
:
GraphAttributes
|
undefined
;
clusterEdgeId
?
(
group
:
ClusterEdgeGroup
<
EdgeData
>
,
index
:
number
)
:
GraphId
;
clusterEdgeLabel
?
(
group
:
ClusterEdgeGroup
<
EdgeData
>
)
:
string
|
undefined
;
clusterNodeAttributes
?
(
cluster
:
ClusterGroup
<
NodeData
>
,
)
:
GraphAttributes
|
undefined
;
clusterNodeId
?
(
cluster
:
ClusterGroup
<
NodeData
>
)
:
GraphId
;
clusterNodeLabel
?
(
cluster
:
ClusterGroup
<
NodeData
>
)
:
string
|
undefined
;
getClusterId
(
node
:
GraphNode
<
NodeData
>
,
snapshot
:
GraphSnapshot
<
NodeData
,
EdgeData
>
,
)
:
GraphId
|
null
|
undefined
;
}
Type Parameters
NodeData
=
unknown
EdgeData
=
unknown
Index
Properties
min
Cluster
Size?
Methods
cluster
Edge
Attributes?
cluster
Edge
Id?
cluster
Edge
Label?
cluster
Node
Attributes?
cluster
Node
Id?
cluster
Node
Label?
get
Cluster
Id
Properties
Optional
min
Cluster
Size
minClusterSize
?:
number
Methods
Optional
cluster
Edge
Attributes
clusterEdgeAttributes
?
(
group
:
ClusterEdgeGroup
<
EdgeData
>
,
)
:
GraphAttributes
|
undefined
Parameters
group
:
ClusterEdgeGroup
<
EdgeData
>
Returns
GraphAttributes
|
undefined
Optional
cluster
Edge
Id
clusterEdgeId
?
(
group
:
ClusterEdgeGroup
<
EdgeData
>
,
index
:
number
)
:
GraphId
Parameters
group
:
ClusterEdgeGroup
<
EdgeData
>
index
:
number
Returns
GraphId
Optional
cluster
Edge
Label
clusterEdgeLabel
?
(
group
:
ClusterEdgeGroup
<
EdgeData
>
)
:
string
|
undefined
Parameters
group
:
ClusterEdgeGroup
<
EdgeData
>
Returns
string
|
undefined
Optional
cluster
Node
Attributes
clusterNodeAttributes
?
(
cluster
:
ClusterGroup
<
NodeData
>
,
)
:
GraphAttributes
|
undefined
Parameters
cluster
:
ClusterGroup
<
NodeData
>
Returns
GraphAttributes
|
undefined
Optional
cluster
Node
Id
clusterNodeId
?
(
cluster
:
ClusterGroup
<
NodeData
>
)
:
GraphId
Parameters
cluster
:
ClusterGroup
<
NodeData
>
Returns
GraphId
Optional
cluster
Node
Label
clusterNodeLabel
?
(
cluster
:
ClusterGroup
<
NodeData
>
)
:
string
|
undefined
Parameters
cluster
:
ClusterGroup
<
NodeData
>
Returns
string
|
undefined
get
Cluster
Id
getClusterId
(
node
:
GraphNode
<
NodeData
>
,
snapshot
:
GraphSnapshot
<
NodeData
,
EdgeData
>
,
)
:
GraphId
|
null
|
undefined
Parameters
node
:
GraphNode
<
NodeData
>
snapshot
:
GraphSnapshot
<
NodeData
,
EdgeData
>
Returns
GraphId
|
null
|
undefined
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
min
Cluster
Size
Methods
cluster
Edge
Attributes
cluster
Edge
Id
cluster
Edge
Label
cluster
Node
Attributes
cluster
Node
Id
cluster
Node
Label
get
Cluster
Id
Graphora API
Loading...