Class: DiGraph
Defined in: mobjects/graph/DiGraph.ts:32
Base mathematical object class. All visible objects in manimweb inherit from this class.
Extends
Constructors
Constructor
new DiGraph(
options):DiGraph
Defined in: mobjects/graph/DiGraph.ts:33
Parameters
options
GenericGraphOptions = {}
Returns
DiGraph
Overrides
Properties
__savedMobjectState
__savedMobjectState:
unknown=null
Defined in: core/Mobject.ts:95
JSON-serializable saved state (used by restoreState()).
Inherited from
GenericGraph.__savedMobjectState
_color
protected_color:string='#ffffff'
Defined in: core/Mobject.ts:70
Inherited from
_directed
protected_directed:boolean=false
Defined in: mobjects/graph/GenericGraph.ts:59
Whether this is a directed graph
Inherited from
_dirty
_dirty:
boolean=true
Defined in: core/Mobject.ts:88
Inherited from
_disableChildZLayering
protected_disableChildZLayering:boolean=false
Defined in: core/Mobject.ts:85
When true, children skip the 2D z-layering offset in _syncToThree.
Inherited from
GenericGraph._disableChildZLayering
_edgeConfig
protected_edgeConfig:Map<string,EdgeConfig>
Defined in: mobjects/graph/GenericGraph.ts:56
Per-edge configuration
Inherited from
_edgeMobjects
protected_edgeMobjects:Map<string,Mobject>
Defined in: mobjects/graph/GenericGraph.ts:41
Map of edge key to Line/Arrow mobject
Inherited from
_edges
protected_edges:EdgeTuple[] =[]
Defined in: mobjects/graph/GenericGraph.ts:32
List of edges as [source, target] tuples
Inherited from
_edgeStyle
protected_edgeStyle:EdgeStyleOptions
Defined in: mobjects/graph/GenericGraph.ts:50
Default edge style
Inherited from
_group
protected_group:Group<Object3DEventMap> =null
Defined in: mobjects/graph/GenericGraph.ts:62
Three.js group for this graph
Inherited from
_layoutConfig
protected_layoutConfig:LayoutConfig
Defined in: mobjects/graph/GenericGraph.ts:44
Layout configuration
Inherited from
_opacity
protected_opacity:number=1
Defined in: core/Mobject.ts:81
Inherited from
_positions
protected_positions:Map<VertexId,Vector3Tuple>
Defined in: mobjects/graph/GenericGraph.ts:35
Map of vertex id to position
Inherited from
_style
protected_style:MobjectStyle
Defined in: core/Mobject.ts:86
Inherited from
_threeObject
_threeObject:
Object3D<Object3DEventMap> =null
Defined in: core/Mobject.ts:87
Inherited from
_vertexConfig
protected_vertexConfig:Map<VertexId,VertexConfig>
Defined in: mobjects/graph/GenericGraph.ts:53
Per-vertex configuration
Inherited from
_vertexMobjects
Defined in: mobjects/graph/GenericGraph.ts:38
Map of vertex id to Dot mobject
Inherited from
_vertexStyle
protected_vertexStyle:VertexStyleOptions
Defined in: mobjects/graph/GenericGraph.ts:47
Default vertex style
Inherited from
_vertices
protected_vertices:VertexId[] =[]
Defined in: mobjects/graph/GenericGraph.ts:29
List of vertex identifiers
Inherited from
children
children:
Mobject[] =[]
Defined in: core/Mobject.ts:65
Inherited from
createdAtBeginning
createdAtBeginning:
boolean=false
Defined in: core/Mobject.ts:69
Inherited from
GenericGraph.createdAtBeginning
fillOpacity
fillOpacity:
number=0
Defined in: core/Mobject.ts:83
Inherited from
id
readonlyid:string
Defined in: core/Mobject.ts:63
Inherited from
parent
parent:
Mobject=null
Defined in: core/Mobject.ts:64
Inherited from
position
position:
Vector3
Defined in: core/Mobject.ts:66
Inherited from
rotation
rotation:
Euler
Defined in: core/Mobject.ts:67
Inherited from
savedState
savedState:
Mobject=null
Defined in: core/Mobject.ts:91
Saved mobject copy (used by Restore animation). Set by saveState().
Inherited from
scaleVector
scaleVector:
Vector3
Defined in: core/Mobject.ts:68
Inherited from
strokeWidth
strokeWidth:
number=4
Defined in: core/Mobject.ts:82
Inherited from
targetCopy
targetCopy:
Mobject=null
Defined in: core/Mobject.ts:93
Target copy used by generateTarget() / MoveToTarget animation.
Inherited from
Accessors
animate
Get Signature
get animate():
any
Defined in: core/Mobject.ts:497
Returns an AnimateProxy that records method calls.
Pass the proxy to scene.play() to animate from the current state
to the state after all recorded calls are applied.
Example
scene.play(circle.animate.shift([2, 0, 0]));
scene.play(circle.animate.setColor('#ff0000').scale(2));
Returns
any
Inherited from
color
Get Signature
get color():
string
Defined in: core/Mobject.ts:71
Returns
string
Set Signature
set color(
value):void
Defined in: core/Mobject.ts:74
Parameters
value
string
Returns
void
Inherited from
fillColor
Get Signature
get fillColor():
string
Defined in: core/Mobject.ts:184
Returns
string
Set Signature
set fillColor(
color):void
Defined in: core/Mobject.ts:188
Parameters
color
string
Returns
void
Inherited from
isDirty
Get Signature
get isDirty():
boolean
Defined in: core/Mobject.ts:551
Returns
boolean
Inherited from
numEdges
Get Signature
get numEdges():
number
Defined in: mobjects/graph/GenericGraph.ts:535
Get the number of edges
Returns
number
Inherited from
numVertices
Get Signature
get numVertices():
number
Defined in: mobjects/graph/GenericGraph.ts:360
Get the number of vertices
Returns
number
Inherited from
opacity
Get Signature
get opacity():
number
Defined in: core/Mobject.ts:114
Returns
number
Set Signature
set opacity(
value):void
Defined in: core/Mobject.ts:118
Parameters
value
number
Returns
void
Inherited from
strokeColor
Get Signature
get strokeColor():
string
Defined in: core/Mobject.ts:195
Returns
string
Set Signature
set strokeColor(
color):void
Defined in: core/Mobject.ts:199
Parameters
color
string
Returns
void
Inherited from
style
Get Signature
get style():
MobjectStyle
Defined in: core/Mobject.ts:122
Returns
Inherited from
submobjects
Get Signature
get submobjects():
Mobject[]
Defined in: core/Mobject.ts:136
Returns
Mobject[]
Inherited from
Methods
_computeLayout()
protected_computeLayout():void
Defined in: mobjects/graph/GenericGraph.ts:153
Compute vertex positions using the layout algorithm
Returns
void
Inherited from
_createCopy()
protected_createCopy():DiGraph
Defined in: mobjects/graph/DiGraph.ts:91
Create a copy of this digraph
Returns
DiGraph
Overrides
_createEdgeMobject()
protected_createEdgeMobject(source,target):void
Defined in: mobjects/graph/GenericGraph.ts:216
Create a single edge mobject
Parameters
source
target
Returns
void
Inherited from
GenericGraph._createEdgeMobject
_createMobjects()
protected_createMobjects():void
Defined in: mobjects/graph/GenericGraph.ts:165
Create vertex and edge mobjects
Returns
void
Inherited from
_createThreeObject()
protected_createThreeObject():Object3D
Defined in: mobjects/graph/GenericGraph.ts:666
Create the Three.js backing object
Returns
Object3D
Inherited from
GenericGraph._createThreeObject
_createVertexMobject()
protected_createVertexMobject(v):void
Defined in: mobjects/graph/GenericGraph.ts:192
Create a single vertex mobject
Parameters
v
Returns
void
Inherited from
GenericGraph._createVertexMobject
_getBoundingBox()
_getBoundingBox():
object
Defined in: core/Mobject.ts:449
Returns
object
depth
depth:
number
height
height:
number
width
width:
number
Deprecated
Use getBoundingBox() instead.
Inherited from
_getEdgeInDirection()
_getEdgeInDirection(
direction):Vector3Tuple
Defined in: core/Mobject.ts:442
Parameters
direction
Returns
Inherited from
GenericGraph._getEdgeInDirection
_getEdgeKey()
protected_getEdgeKey(source,target):string
Defined in: mobjects/graph/GenericGraph.ts:140
Get edge key from vertex pair
Parameters
source
target
Returns
string
Inherited from
_markDirty()
_markDirty():
void
Defined in: core/Mobject.ts:541
Returns
void
Inherited from
_markDirtyUpward()
_markDirtyUpward():
void
Defined in: core/Mobject.ts:545
Returns
void
Inherited from
_shortenEdge()
protected_shortenEdge(start,end,radius): [Vector3Tuple,Vector3Tuple]
Defined in: mobjects/graph/GenericGraph.ts:253
Shorten an edge to not overlap with vertex circles
Parameters
start
end
radius
number
Returns
Inherited from
_syncMaterialToThree()
protected_syncMaterialToThree():void
Defined in: core/Mobject.ts:539
Returns
void
Inherited from
GenericGraph._syncMaterialToThree
_syncToThree()
_syncToThree():
void
Defined in: core/Mobject.ts:519
Returns
void
Inherited from
add()
add(...
mobjects):this
Defined in: core/Mobject.ts:329
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
addEdge()
addEdge(
source,target,config?):this
Defined in: mobjects/graph/GenericGraph.ts:447
Add an edge to the graph
Parameters
source
Source vertex
target
Target vertex
config?
Optional edge configuration
Returns
this
this for chaining
Inherited from
addEdges()
addEdges(...
edges):this
Defined in: mobjects/graph/GenericGraph.ts:478
Add multiple edges to the graph
Parameters
edges
...EdgeTuple[]
Array of [source, target] tuples
Returns
this
this for chaining
Inherited from
addUpdater()
addUpdater(
updater,callOnAdd):this
Defined in: core/Mobject.ts:589
Parameters
updater
callOnAdd
boolean = false
Returns
this
Inherited from
addVertex()
addVertex(
v,config?):this
Defined in: mobjects/graph/GenericGraph.ts:292
Add a vertex to the graph
Parameters
v
Vertex identifier
config?
Optional vertex configuration
Returns
this
this for chaining
Inherited from
addVertices()
addVertices(...
vertices):this
Defined in: mobjects/graph/GenericGraph.ts:314
Add multiple vertices to the graph
Parameters
vertices
...VertexId[]
Array of vertex identifiers
Returns
this
this for chaining
Inherited from
alignTo()
alignTo(
target,direction):this
Defined in: core/Mobject.ts:427
Parameters
target
direction
Returns
this
Inherited from
applyFunction()
applyFunction(
fn,options?):this
Defined in: core/Mobject.ts:619
Parameters
fn
(point) => number[]
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
applyMatrix()
applyMatrix(
matrix,options?):this
Defined in: core/Mobject.ts:627
Parameters
matrix
number[][]
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
applyToFamily()
applyToFamily(
func):this
Defined in: core/Mobject.ts:577
Parameters
func
(mobject) => void
Returns
this
Inherited from
become()
become(
other):this
Defined in: core/Mobject.ts:376
Parameters
other
Returns
this
Inherited from
center()
center():
this
Defined in: core/Mobject.ts:479
Returns
this
Inherited from
clearUpdaters()
clearUpdaters():
this
Defined in: core/Mobject.ts:601
Returns
this
Inherited from
copy()
copy():
Mobject
Defined in: core/Mobject.ts:358
Returns
Inherited from
dispose()
dispose():
void
Defined in: core/Mobject.ts:658
Returns
void
Inherited from
flip()
flip(
axis,options?):this
Defined in: core/Mobject.ts:257
Parameters
axis
Vector3Tuple = ...
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
generateTarget()
generateTarget():
Mobject
Defined in: core/Mobject.ts:642
Returns
Inherited from
getBottom()
getBottom():
Vector3Tuple
Defined in: core/Mobject.ts:458
Returns
Inherited from
getBoundingBox()
getBoundingBox():
object
Defined in: core/Mobject.ts:445
Returns
object
depth
depth:
number
height
height:
number
width
width:
number
Inherited from
getBounds()
getBounds():
object
Defined in: core/Mobject.ts:392
Returns
object
max
max:
object
max.x
x:
number
max.y
y:
number
max.z
z:
number
min
min:
object
min.x
x:
number
min.y
y:
number
min.z
z:
number
Inherited from
getCenter()
getCenter():
Vector3Tuple
Defined in: core/Mobject.ts:388
Returns
Inherited from
getDegree()
getDegree(
v):number
Defined in: mobjects/graph/GenericGraph.ts:434
Get the degree of a vertex (number of edges)
Parameters
v
Returns
number
Inherited from
getDisplayMeshes()
getDisplayMeshes():
Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap>[]
Defined in: core/Mobject.ts:569
Returns
Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>[]
Inherited from
getDisplayMeshLength()
getDisplayMeshLength():
number
Defined in: core/Mobject.ts:565
Number of visible display meshes this mobject contributes when rendered. Used for Transform eligibility checks without forcing Three.js object creation.
Returns
number
Inherited from
GenericGraph.getDisplayMeshLength
getEdge()
getEdge(
direction):Vector3Tuple
Defined in: core/Mobject.ts:452
Parameters
direction
Returns
Inherited from
getEdgeMobject()
getEdgeMobject(
source,target):Mobject
Defined in: mobjects/graph/GenericGraph.ts:550
Get the Line/Arrow mobject for an edge
Parameters
source
target
Returns
Inherited from
getEdges()
getEdges():
EdgeTuple[]
Defined in: mobjects/graph/GenericGraph.ts:528
Get all edges
Returns
Inherited from
getFamily()
getFamily():
Mobject[]
Defined in: core/Mobject.ts:583
Returns
Mobject[]
Inherited from
getInDegree()
getInDegree(
v):number
Defined in: mobjects/graph/DiGraph.ts:84
Get in-degree (number of incoming edges)
Parameters
v
Returns
number
getInNeighbors()
getInNeighbors(
v):VertexId[]
Defined in: mobjects/graph/DiGraph.ts:64
Get in-neighbors (vertices that point to this vertex)
Parameters
v
Returns
VertexId[]
getLeft()
getLeft():
Vector3Tuple
Defined in: core/Mobject.ts:461
Returns
Inherited from
getNeighbors()
getNeighbors(
v):VertexId[]
Defined in: mobjects/graph/GenericGraph.ts:419
Get neighbors of a vertex (adjacent vertices)
Parameters
v
Returns
VertexId[]
Inherited from
getOutDegree()
getOutDegree(
v):number
Defined in: mobjects/graph/DiGraph.ts:77
Get out-degree (number of outgoing edges)
Parameters
v
Returns
number
getOutNeighbors()
getOutNeighbors(
v):VertexId[]
Defined in: mobjects/graph/DiGraph.ts:51
Get out-neighbors (vertices this vertex points to)
Parameters
v
Returns
VertexId[]
getPositions()
getPositions():
Map<VertexId,Vector3Tuple>
Defined in: mobjects/graph/GenericGraph.ts:598
Get all vertex positions
Returns
Map<VertexId, Vector3Tuple>
Inherited from
getRight()
getRight():
Vector3Tuple
Defined in: core/Mobject.ts:464
Returns
Inherited from
getThreeObject()
getThreeObject():
Object3D
Defined in: core/Mobject.ts:555
Returns
Object3D
Inherited from
getTop()
getTop():
Vector3Tuple
Defined in: core/Mobject.ts:455
Returns
Inherited from
getUpdaters()
getUpdaters():
UpdaterFunction[]
Defined in: core/Mobject.ts:608
Returns
Inherited from
getVertexMobject()
getVertexMobject(
v):Dot
Defined in: mobjects/graph/GenericGraph.ts:374
Get the Dot mobject for a vertex
Parameters
v
Returns
Inherited from
getVertexPosition()
getVertexPosition(
v):Vector3Tuple
Defined in: mobjects/graph/GenericGraph.ts:381
Get the position of a vertex
Parameters
v
Returns
Inherited from
GenericGraph.getVertexPosition
getVertices()
getVertices():
VertexId[]
Defined in: mobjects/graph/GenericGraph.ts:353
Get all vertex identifiers
Returns
VertexId[]
Inherited from
hasEdge()
hasEdge(
source,target):boolean
Defined in: mobjects/graph/GenericGraph.ts:542
Check if the graph contains an edge
Parameters
source
target
Returns
boolean
Inherited from
hasUpdaters()
hasUpdaters():
boolean
Defined in: core/Mobject.ts:605
Returns
boolean
Inherited from
hasVertex()
hasVertex(
v):boolean
Defined in: mobjects/graph/GenericGraph.ts:367
Check if the graph contains a vertex
Parameters
v
Returns
boolean
Inherited from
highlightPath()
highlightPath(
path,vertexColor,edgeColor):this
Defined in: mobjects/graph/GenericGraph.ts:631
Highlight a path (sequence of vertices)
Parameters
path
VertexId[]
vertexColor
string = RED
edgeColor
string = RED
Returns
this
Inherited from
moveTo()
moveTo(
target,alignedEdge?):this
Defined in: core/Mobject.ts:216
Parameters
target
alignedEdge?
Returns
this
Inherited from
moveToAligned()
moveToAligned(
target,alignedEdge?):this
Defined in: core/Mobject.ts:437
Parameters
target
alignedEdge?
Returns
this
Inherited from
nextTo()
nextTo(
target,direction,buff):this
Defined in: core/Mobject.ts:410
Parameters
target
direction
Vector3Tuple = RIGHT
buff
number = 0.25
Returns
this
Inherited from
prepareForNonlinearTransform()
prepareForNonlinearTransform(
numPieces):this
Defined in: core/Mobject.ts:635
Parameters
numPieces
number = 50
Returns
this
Inherited from
GenericGraph.prepareForNonlinearTransform
remove()
remove(...
mobjects):this
Defined in: core/Mobject.ts:342
Parameters
mobjects
...Mobject[]
Returns
this
Inherited from
removeEdge()
removeEdge(
source,target):this
Defined in: mobjects/graph/GenericGraph.ts:505
Remove an edge from the graph
Parameters
source
Source vertex
target
Target vertex
Returns
this
this for chaining
Inherited from
removeUpdater()
removeUpdater(
updater):this
Defined in: core/Mobject.ts:595
Parameters
updater
Returns
this
Inherited from
removeVertex()
removeVertex(
v):this
Defined in: mobjects/graph/GenericGraph.ts:332
Remove a vertex from the graph
Parameters
v
Vertex identifier
Returns
this
this for chaining
Inherited from
replace()
replace(
target,stretch):this
Defined in: core/Mobject.ts:381
Parameters
target
stretch
boolean = false
Returns
this
Inherited from
resetColors()
resetColors():
this
Defined in: mobjects/graph/GenericGraph.ts:644
Reset all colors to default
Returns
this
Inherited from
restoreState()
restoreState():
boolean
Defined in: core/Mobject.ts:652
Returns
boolean
Inherited from
rotate()
rotate(
angle,axisOrOptions?):this
Defined in: core/Mobject.ts:237
Rotate the mobject by angle around an axis. Accepts aboutPoint or aboutEdge to specify the rotation center.
Parameters
angle
number
axisOrOptions?
Vector3Tuple | { aboutEdge?: Vector3Tuple; aboutPoint?: Vector3Tuple; axis?: Vector3Tuple; }
Returns
this
Inherited from
rotateAboutOrigin()
rotateAboutOrigin(
angle,axis):this
Defined in: core/Mobject.ts:253
Parameters
angle
number
axis
Vector3Tuple = ...
Returns
this
Inherited from
GenericGraph.rotateAboutOrigin
saveState()
saveState():
this
Defined in: core/Mobject.ts:647
Returns
this
Inherited from
scale()
scale(
factor,options?):this
Defined in: core/Mobject.ts:283
Parameters
factor
number | Vector3Tuple
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
setColor()
setColor(
color):this
Defined in: core/Mobject.ts:140
Parameters
color
string
Returns
this
Inherited from
setEdgeColor()
setEdgeColor(
source,target,color):this
Defined in: mobjects/graph/GenericGraph.ts:619
Set the color of a specific edge
Parameters
source
target
color
string
Returns
this
Inherited from
setFill()
setFill(
color?,opacity?):this
Defined in: core/Mobject.ts:178
Parameters
color?
string
opacity?
number
Returns
this
Inherited from
setFillOpacity()
setFillOpacity(
opacity):this
Defined in: core/Mobject.ts:168
Parameters
opacity
number
Returns
this
Inherited from
setLayout()
setLayout(
layout):this
Defined in: mobjects/graph/GenericGraph.ts:562
Change the layout algorithm
Parameters
layout
Layout type or configuration
Returns
this
this for chaining
Inherited from
setStrokeOpacity()
setStrokeOpacity(
opacity):this
Defined in: core/Mobject.ts:148
Parameters
opacity
number
Returns
this
Inherited from
setStrokeWidth()
setStrokeWidth(
width):this
Defined in: core/Mobject.ts:158
Parameters
width
number
Returns
this
Inherited from
setStyle()
setStyle(
style):this
Defined in: core/Mobject.ts:126
Parameters
style
Partial<MobjectStyle>
Returns
this
Inherited from
setVertexColor()
setVertexColor(
v,color):this
Defined in: mobjects/graph/GenericGraph.ts:607
Set the color of a specific vertex
Parameters
v
color
string
Returns
this
Inherited from
setVertexPosition()
setVertexPosition(
v,position):this
Defined in: mobjects/graph/GenericGraph.ts:388
Set the position of a vertex
Parameters
v
position
Returns
this
Inherited from
GenericGraph.setVertexPosition
setX()
setX(
x):this
Defined in: core/Mobject.ts:467
Parameters
x
number
Returns
this
Inherited from
setY()
setY(
y):this
Defined in: core/Mobject.ts:471
Parameters
y
number
Returns
this
Inherited from
setZ()
setZ(
z):this
Defined in: core/Mobject.ts:475
Parameters
z
number
Returns
this
Inherited from
shift()
shift(
delta):this
Defined in: core/Mobject.ts:208
Parameters
delta
Returns
this
Inherited from
stretch()
stretch(
factor,dim,options?):this
Defined in: core/Mobject.ts:310
Parameters
factor
number
dim
number
options?
aboutEdge?
aboutPoint?
Returns
this
Inherited from
toCorner()
toCorner(
direction,buff,frameDimensions?):this
Defined in: core/Mobject.ts:509
Parameters
direction
Vector3Tuple = ...
buff
number = 0.5
frameDimensions?
[number, number]
Returns
this
Inherited from
toEdge()
toEdge(
direction,buff,frameDimensions?):this
Defined in: core/Mobject.ts:504
Parameters
direction
buff
number = 0.5
frameDimensions?
[number, number]
Returns
this
Inherited from
update()
update(
dt):void
Defined in: core/Mobject.ts:612
Parameters
dt
number
Returns
void