@braks/vue-flow / Actions
Interface: Actions
Hierarchy
↳
Actions
Table of contents
Properties
- addEdges
- addNodes
- fitBounds
- fitView
- getTransform
- project
- removeEdges
- removeNodes
- setCenter
- setEdges
- setElements
- setNodes
- setState
- setTransform
- updateEdge
- updateNodeDimensions
- updateNodeInternals
- updateNodePositions
- zoomIn
- zoomOut
- zoomTo
Methods
- $reset
- addSelectedEdges
- addSelectedElements
- addSelectedNodes
- applyEdgeChanges
- applyNodeChanges
- removeSelectedEdges
- removeSelectedElements
- removeSelectedNodes
- setInteractive
- setMaxZoom
- setMinZoom
- setTranslateExtent
- toObject
Properties
addEdges
• addEdges: AddEdges
parses edges and adds to state
addNodes
• addNodes: AddNodes
parses nodes and adds to state
fitBounds
• fitBounds: FitBounds
Inherited from
fitView
• fitView: FitView
Inherited from
getTransform
• getTransform: GetTransform
Inherited from
ViewportFunctions.getTransform
project
• project: Project
Inherited from
removeEdges
• removeEdges: RemoveEdges
remove edges from state
removeNodes
• removeNodes: RemoveNodes
remove nodes (and possibly connected edges) from state
setCenter
• setCenter: SetCenter
Inherited from
setEdges
• setEdges: SetEdges
parses edges and re-sets the state
setElements
• setElements: SetElements
parses elements (nodes + edges) and re-sets the state
setNodes
• setNodes: SetNodes
parses nodes and re-sets the state
setState
• setState: SetState
set new state
setTransform
• setTransform: SetTransform
Inherited from
ViewportFunctions.setTransform
updateEdge
• updateEdge: UpdateEdge
updates an edge
updateNodeDimensions
• updateNodeDimensions: UpdateNodeDimensions
internal dimensions' updater, you probably don't want to use this
updateNodeInternals
• updateNodeInternals: UpdateNodeInternals
force update node internal data, if handle bounds are incorrect, you might want to use this
updateNodePositions
• updateNodePositions: UpdateNodePosition
internal position updater, you probably don't want to use this
zoomIn
• zoomIn: ZoomInOut
Inherited from
zoomOut
• zoomOut: ZoomInOut
Inherited from
zoomTo
• zoomTo: ZoomTo
Inherited from
Methods
$reset
â–¸ $reset(): void
reset state to defaults
Returns
void
addSelectedEdges
â–¸ addSelectedEdges(edges
): void
manually select edges and add to state
Parameters
Name | Type |
---|---|
edges | GraphEdge <any , any >[] |
Returns
void
addSelectedElements
â–¸ addSelectedElements(elements
): void
manually select elements and add to state
Parameters
Name | Type |
---|---|
elements | FlowElements <any > |
Returns
void
addSelectedNodes
â–¸ addSelectedNodes(nodes
): void
manually select nodes and add to state
Parameters
Name | Type |
---|---|
nodes | GraphNode <any , any >[] |
Returns
void
applyEdgeChanges
â–¸ applyEdgeChanges(changes
): GraphEdge
<any
, any
>[]
applies default edge change handler
Parameters
Name | Type |
---|---|
changes | EdgeChange [] |
Returns
GraphEdge
<any
, any
>[]
applyNodeChanges
â–¸ applyNodeChanges(changes
): GraphNode
<any
, any
>[]
applies default node change handler
Parameters
Name | Type |
---|---|
changes | NodeChange [] |
Returns
GraphNode
<any
, any
>[]
removeSelectedEdges
â–¸ removeSelectedEdges(edges
): void
manually unselect edges and remove from state
Parameters
Name | Type |
---|---|
edges | GraphEdge <any , any >[] |
Returns
void
removeSelectedElements
â–¸ removeSelectedElements(elements?
): void
unselect selected elements (if none are passed, all elements are unselected)
Parameters
Name | Type |
---|---|
elements? | Object |
elements.edges? | GraphEdge <any , any >[] |
elements.nodes? | GraphNode <any , any >[] |
Returns
void
removeSelectedNodes
â–¸ removeSelectedNodes(nodes
): void
manually unselect nodes and remove from state
Parameters
Name | Type |
---|---|
nodes | GraphNode <any , any >[] |
Returns
void
setInteractive
â–¸ setInteractive(isInteractive
): void
enable/disable node interaction (dragging, selecting etc)
Parameters
Name | Type |
---|---|
isInteractive | boolean |
Returns
void
setMaxZoom
â–¸ setMaxZoom(zoom
): void
apply max zoom value to d3
Parameters
Name | Type |
---|---|
zoom | number |
Returns
void
setMinZoom
â–¸ setMinZoom(zoom
): void
apply min zoom value to d3
Parameters
Name | Type |
---|---|
zoom | number |
Returns
void
setTranslateExtent
â–¸ setTranslateExtent(translateExtent
): void
apply translate extent to d3
Parameters
Name | Type |
---|---|
translateExtent | CoordinateExtent |
Returns
void
toObject
â–¸ toObject(): FlowExportObject
return an object of graph values (elements, viewpane transform) for storage and re-loading a graph