Interface: Actions #

Hierarchy #

• ViewportFunctions

  ↳ Actions

Table of contents #

Properties #

• $destroy
• $reset
• addEdges
• addNodes
• addSelectedEdges
• addSelectedElements
• addSelectedNodes
• applyEdgeChanges
• applyNodeChanges
• endConnection
• findEdge
• findNode
• fitBounds
• fitView
• getIntersectingNodes
• getTransform
• isNodeIntersecting
• panBy
• project
• removeEdges
• removeNodes
• removeSelectedEdges
• removeSelectedElements
• removeSelectedNodes
• setCenter
• setEdges
• setElements
• setInteractive
• setMaxZoom
• setMinZoom
• setNodeExtent
• setNodes
• setState
• setTransform
• setTranslateExtent
• startConnection
• toObject
• updateConnection
• updateEdge
• updateNodeDimensions
• updateNodeInternals
• updateNodePositions
• zoomIn
• zoomOut
• zoomTo

Properties #

$destroy #

• $destroy: () => void

Type declaration #

▸ (): void

remove store instance from global storage and destroy it (will invalidate effect scopes)

Returns #

void

$reset #

• $reset: () => void

Type declaration #

▸ (): void

reset state to defaults

Returns #

void

addEdges #

• addEdges: AddEdges

parses edges and adds to state

addNodes #

• addNodes: AddNodes

parses nodes and adds to state

addSelectedEdges #

• addSelectedEdges: (edges: GraphEdge<any, any, string>[]) => void

Type declaration #

▸ (edges): void

manually select edges and add to state

Parameters #

Returns #

void

addSelectedElements #

• addSelectedElements: (elements: FlowElements<any, any, any, any>) => void

Type declaration #

▸ (elements): void

manually select elements and add to state

Parameters #

Returns #

void

addSelectedNodes #

• addSelectedNodes: (nodes: GraphNode<any, any, string>[]) => void

Type declaration #

▸ (nodes): void

manually select nodes and add to state

Parameters #

Returns #

void

applyEdgeChanges #

• applyEdgeChanges: (changes: EdgeChange[]) => GraphEdge<any, any, string>[]

Type declaration #

▸ (changes): GraphEdge<any, any, string>[]

applies default edge change handler

Parameters #

Returns #

GraphEdge<any, any, string>[]

applyNodeChanges #

• applyNodeChanges: (changes: NodeChange[]) => GraphNode<any, any, string>[]

Type declaration #

▸ (changes): GraphNode<any, any, string>[]

applies default node change handler

Parameters #

Returns #

GraphNode<any, any, string>[]

endConnection #

• endConnection: (event?: MouseEvent | TouchEvent, isClick?: boolean) => void

Type declaration #

▸ (event?, isClick?): void

end (or cancel) a connection

Parameters #

Returns #

void

findEdge #

• findEdge: FindEdge

find an edge by id

findNode #

• findNode: FindNode

find a node by id

fitBounds #

• fitBounds: FitBounds

Inherited from #

ViewportFunctions.fitBounds

fitView #

• fitView: FitView

Inherited from #

ViewportFunctions.fitView

getIntersectingNodes #

• getIntersectingNodes: GetIntersectingNodes

returns all node intersections

getTransform #

• getTransform: GetTransform

Inherited from #

ViewportFunctions.getTransform

isNodeIntersecting #

• isNodeIntersecting: IsNodeIntersecting

check if a node is intersecting with a defined area

panBy #

• panBy: (delta: XYPosition) => void

Type declaration #

▸ (delta): void

pan the viewport

Parameters #

Returns #

void

project #

• project: Project

Inherited from #

ViewportFunctions.project

removeEdges #

• removeEdges: RemoveEdges

remove edges from state

removeNodes #

• removeNodes: RemoveNodes

remove nodes (and possibly connected edges) from state

removeSelectedEdges #

• removeSelectedEdges: (edges: GraphEdge<any, any, string>[]) => void

Type declaration #

▸ (edges): void

manually unselect edges and remove from state

Parameters #

Returns #

void

removeSelectedElements #

• removeSelectedElements: (elements?: Elements<any, any, any, any>) => void

Type declaration #

▸ (elements?): void

unselect selected elements (if none are passed, all elements are unselected)

Parameters #

Returns #

void

removeSelectedNodes #

• removeSelectedNodes: (nodes: GraphNode<any, any, string>[]) => void

Type declaration #

▸ (nodes): void

manually unselect nodes and remove from state

Parameters #

Returns #

void

setCenter #

• setCenter: SetCenter

Inherited from #

ViewportFunctions.setCenter

setEdges #

• setEdges: SetEdges

parses edges and re-sets the state

setElements #

• setElements: SetElements

parses elements (nodes + edges) and re-sets the state

setInteractive #

• setInteractive: (isInteractive: boolean) => void

Type declaration #

▸ (isInteractive): void

enable/disable node interaction (dragging, selecting etc)

Parameters #

Returns #

void

setMaxZoom #

• setMaxZoom: (zoom: number) => void

Type declaration #

▸ (zoom): void

apply max zoom value to d3

Parameters #

Returns #

void

setMinZoom #

• setMinZoom: (zoom: number) => void

Type declaration #

▸ (zoom): void

apply min zoom value to d3

Parameters #

Returns #

void

setNodeExtent #

• setNodeExtent: (nodeExtent: CoordinateExtent) => void

Type declaration #

▸ (nodeExtent): void

apply extent to nodes

Parameters #

Returns #

void

setNodes #

• setNodes: SetNodes

parses nodes and re-sets the state

setState #

• setState: SetState

set new state

setTransform #

• setTransform: SetTransform

Inherited from #

ViewportFunctions.setTransform

setTranslateExtent #

• setTranslateExtent: (translateExtent: CoordinateExtent) => void

Type declaration #

▸ (translateExtent): void

apply translate extent to d3

Parameters #

Returns #

void

startConnection #

• startConnection: (startHandle: StartHandle, position?: XYPosition, event?: MouseEvent | TouchEvent, isClick?: boolean) => void

Type declaration #

▸ (startHandle, position?, event?, isClick?): void

start a connection

Parameters #

Returns #

void

toObject #

• toObject: () => FlowExportObject

Type declaration #

▸ (): FlowExportObject

return an object of graph values (elements, viewport transform) for storage and re-loading a graph

Returns #

FlowExportObject

updateConnection #

• updateConnection: (position: XYPosition, result?: ValidHandleResult, status?: null | ConnectionStatus) => void

Type declaration #

▸ (position, result?, status?): void

update connection position

Parameters #

Returns #

void

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 #

ViewportFunctions.zoomIn

zoomOut #

• zoomOut: ZoomInOut

Inherited from #

ViewportFunctions.zoomOut

zoomTo #

• zoomTo: ZoomTo

Inherited from #

ViewportFunctions.zoomTo