Graphora API
Preparing search index...
@graphora/core
GraphSelectors
Interface GraphSelectors<NodeData, EdgeData>
interface
GraphSelectors
<
NodeData
=
unknown
,
EdgeData
=
unknown
>
{
getBounds
()
:
GraphBounds
|
null
;
getEdge
(
id
:
GraphId
)
:
GraphEdge
<
EdgeData
>
|
undefined
;
getEdges
()
:
readonly
GraphEdge
<
EdgeData
>
[]
;
getEdgesBetween
(
sourceId
:
GraphId
,
targetId
:
GraphId
,
options
?:
EdgesBetweenOptions
,
)
:
readonly
GraphEdge
<
EdgeData
>
[]
;
getIncidentEdges
(
nodeId
:
GraphId
)
:
readonly
GraphEdge
<
EdgeData
>
[]
;
getIncomingEdges
(
nodeId
:
GraphId
)
:
readonly
GraphEdge
<
EdgeData
>
[]
;
getNeighbors
(
nodeId
:
GraphId
,
direction
?:
NeighborDirection
,
)
:
readonly
GraphNode
<
NodeData
>
[]
;
getNode
(
id
:
GraphId
)
:
GraphNode
<
NodeData
>
|
undefined
;
getNodes
()
:
readonly
GraphNode
<
NodeData
>
[]
;
getOutgoingEdges
(
nodeId
:
GraphId
)
:
readonly
GraphEdge
<
EdgeData
>
[]
;
getVersion
()
:
number
;
snapshot
()
:
GraphSnapshot
<
NodeData
,
EdgeData
>
;
}
Type Parameters
NodeData
=
unknown
EdgeData
=
unknown
Implemented by
GraphStore
Index
Methods
get
Bounds
get
Edge
get
Edges
get
Edges
Between
get
Incident
Edges
get
Incoming
Edges
get
Neighbors
get
Node
get
Nodes
get
Outgoing
Edges
get
Version
snapshot
Methods
get
Bounds
getBounds
()
:
GraphBounds
|
null
Returns
GraphBounds
|
null
get
Edge
getEdge
(
id
:
GraphId
)
:
GraphEdge
<
EdgeData
>
|
undefined
Parameters
id
:
GraphId
Returns
GraphEdge
<
EdgeData
>
|
undefined
get
Edges
getEdges
()
:
readonly
GraphEdge
<
EdgeData
>
[]
Returns
readonly
GraphEdge
<
EdgeData
>
[]
get
Edges
Between
getEdgesBetween
(
sourceId
:
GraphId
,
targetId
:
GraphId
,
options
?:
EdgesBetweenOptions
,
)
:
readonly
GraphEdge
<
EdgeData
>
[]
Parameters
sourceId
:
GraphId
targetId
:
GraphId
Optional
options
:
EdgesBetweenOptions
Returns
readonly
GraphEdge
<
EdgeData
>
[]
get
Incident
Edges
getIncidentEdges
(
nodeId
:
GraphId
)
:
readonly
GraphEdge
<
EdgeData
>
[]
Parameters
nodeId
:
GraphId
Returns
readonly
GraphEdge
<
EdgeData
>
[]
get
Incoming
Edges
getIncomingEdges
(
nodeId
:
GraphId
)
:
readonly
GraphEdge
<
EdgeData
>
[]
Parameters
nodeId
:
GraphId
Returns
readonly
GraphEdge
<
EdgeData
>
[]
get
Neighbors
getNeighbors
(
nodeId
:
GraphId
,
direction
?:
NeighborDirection
,
)
:
readonly
GraphNode
<
NodeData
>
[]
Parameters
nodeId
:
GraphId
Optional
direction
:
NeighborDirection
Returns
readonly
GraphNode
<
NodeData
>
[]
get
Node
getNode
(
id
:
GraphId
)
:
GraphNode
<
NodeData
>
|
undefined
Parameters
id
:
GraphId
Returns
GraphNode
<
NodeData
>
|
undefined
get
Nodes
getNodes
()
:
readonly
GraphNode
<
NodeData
>
[]
Returns
readonly
GraphNode
<
NodeData
>
[]
get
Outgoing
Edges
getOutgoingEdges
(
nodeId
:
GraphId
)
:
readonly
GraphEdge
<
EdgeData
>
[]
Parameters
nodeId
:
GraphId
Returns
readonly
GraphEdge
<
EdgeData
>
[]
get
Version
getVersion
()
:
number
Returns
number
snapshot
snapshot
()
:
GraphSnapshot
<
NodeData
,
EdgeData
>
Returns
GraphSnapshot
<
NodeData
,
EdgeData
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
get
Bounds
get
Edge
get
Edges
get
Edges
Between
get
Incident
Edges
get
Incoming
Edges
get
Neighbors
get
Node
get
Nodes
get
Outgoing
Edges
get
Version
snapshot
Graphora API
Loading...