Interface LayoutGraph

Hierarchy

LayoutGraph

Implemented by

Methods

addEdge

addEdge(edge: ApiEdge): ApiEdge

- Defined in layoutGraph.ts:71
Parameters
- edge: ApiEdge
Returns ApiEdge

addEdges

addEdges(edges: ApiEdge[]): ApiEdge[]

- Defined in layoutGraph.ts:72
Parameters
- edges: ApiEdge[]
Returns ApiEdge[]

addNode

addNode(node: ApiNode): ApiNode

- Defined in layoutGraph.ts:61
Parameters
- node: ApiNode
Returns ApiNode

addNodes

addNodes(nodes: ApiNode[]): ApiNode[]

- Defined in layoutGraph.ts:62
Parameters
- nodes: ApiNode[]
Returns ApiNode[]

applyLayout

applyLayout(layout: LayoutFunction, tweenOverrides?: Partial<TweenLayoutOptions>): Promise<NodeIdToPosition>

- Defined in layoutGraph.ts:102
Parameters
- layout: LayoutFunction
- Optional tweenOverrides: Partial<TweenLayoutOptions>
Returns Promise<NodeIdToPosition>

applySnapshot

applySnapshot(snapshot: GraphSnapshot): void

- Defined in layoutGraph.ts:67
Parameters
- snapshot: GraphSnapshot
Returns void

applyTransform

applyTransform(transform: TransformFunction): void

- Defined in layoutGraph.ts:76
Parameters
- transform: TransformFunction
Returns void

assign

assign(graph: LayoutGraph): LayoutGraph

- Defined in layoutGraph.ts:77
Parameters
- graph: LayoutGraph
Returns LayoutGraph

clear

clear(): void

- Defined in layoutGraph.ts:55
Returns void

clone

clone(): LayoutGraph

- Defined in layoutGraph.ts:56
Returns LayoutGraph

findNeighbors

findNeighbors(id: NodeId, options?: FindNeighborsOptions): Neighbor[]

- Defined in layoutGraph.ts:75
Parameters
- id: NodeId
- Optional options: FindNeighborsOptions
Returns Neighbor[]

getAllEdges

getAllEdges(): ApiEdge[]

- Defined in layoutGraph.ts:65
Returns ApiEdge[]

getAllNodes

getAllNodes(): ApiNode[]

- Defined in layoutGraph.ts:57
Returns ApiNode[]

getEdge

getEdge(id: EdgeId): undefined | ApiEdge

- Defined in layoutGraph.ts:70
Parameters
- id: EdgeId
Returns undefined | ApiEdge

getEdgeStyle

getEdgeStyle<K>(id: EdgeId, key: K): Partial<EdgeStyles>[K]

- Defined in layoutGraph.ts:98
Type Parameters
- K extends keyof EdgeStyles
Parameters
- id: EdgeId
- key: K
Returns Partial<EdgeStyles>[K]

getEdgeStyles

getEdgeStyles(id: EdgeId): Partial<EdgeStyles>

- Defined in layoutGraph.ts:93
Parameters
- id: EdgeId
Returns Partial<EdgeStyles>

getEdges

getEdges(): ApiEdge[]

- Defined in layoutGraph.ts:66
Returns ApiEdge[]

getNode

getNode(id: NodeId): undefined | ApiNode

- Defined in layoutGraph.ts:60
Parameters
- id: NodeId
Returns undefined | ApiNode

getNodeStyle

getNodeStyle<K>(id: NodeId, key: K): Partial<NodeStyles>[K]

- Defined in layoutGraph.ts:96
Type Parameters
- K extends keyof NodeStyles
Parameters
- id: NodeId
- key: K
Returns Partial<NodeStyles>[K]

getNodeStyles

getNodeStyles(id: NodeId): Partial<NodeStyles>

- Defined in layoutGraph.ts:92
Parameters
- id: NodeId
Returns Partial<NodeStyles>

getNodes

getNodes(): ApiNode[]

- Defined in layoutGraph.ts:58
Returns ApiNode[]

getSnapshot

getSnapshot(options?: GraphSnapshotOptions): GraphSnapshot

- Defined in layoutGraph.ts:68
Parameters
- Optional options: GraphSnapshotOptions
Returns GraphSnapshot

getVisibleEdges

getVisibleEdges(): ApiEdge[]

- Defined in layoutGraph.ts:69
Returns ApiEdge[]

getVisibleNodes

getVisibleNodes(): ApiNode[]

- Defined in layoutGraph.ts:59
Returns ApiNode[]

hideEdges

hideEdges(ids: EdgeId[]): void

- Defined in layoutGraph.ts:108
Parameters
- ids: EdgeId[]
Returns void

hideNodes

hideNodes(ids: NodeId[]): void

- Defined in layoutGraph.ts:106
Parameters
- ids: NodeId[]
Returns void

merge

merge(graph: LayoutGraph, options: GraphMergeOptions): LayoutGraph

- Defined in layoutGraph.ts:79
Parameters
- graph: LayoutGraph
- options: GraphMergeOptions
Returns LayoutGraph

removeEdge

removeEdge(id: EdgeId): undefined | ApiEdge

- Defined in layoutGraph.ts:73
Parameters
- id: EdgeId
Returns undefined | ApiEdge

removeEdges

removeEdges(ids: EdgeId[]): ApiEdge[]

- Defined in layoutGraph.ts:74
Parameters
- ids: EdgeId[]
Returns ApiEdge[]

removeNode

removeNode(id: NodeId): undefined | ApiNode

- Defined in layoutGraph.ts:63
Parameters
- id: NodeId
Returns undefined | ApiNode

removeNodes

removeNodes(ids: NodeId[]): ApiNode[]

- Defined in layoutGraph.ts:64
Parameters
- ids: NodeId[]
Returns ApiNode[]

replace

replace(graph: LayoutGraph): LayoutGraph

- Defined in layoutGraph.ts:78
Parameters
- graph: LayoutGraph
Returns LayoutGraph

setEdgeProperties

setEdgeProperties(id: EdgeId, properties: Properties): void

- Defined in layoutGraph.ts:89
Parameters
- id: EdgeId
- properties: Properties
Returns void

setEdgeStyle

setEdgeStyle<K>(id: EdgeId, key: K, value: EdgeStyles[K]): void

- Defined in layoutGraph.ts:99
Type Parameters
- K extends keyof EdgeStyles
Parameters
- id: EdgeId
- key: K
- value: EdgeStyles[K]
Returns void

setEdgeStyles

setEdgeStyles(id: EdgeId, styles: Partial<EdgeStyles>): void

- Defined in layoutGraph.ts:95
Parameters
- id: EdgeId
- styles: Partial<EdgeStyles>
Returns void

setNodeCategory

setNodeCategory(id: NodeId, category: CategoryId): void

- Defined in layoutGraph.ts:82
Parameters
- id: NodeId
- category: CategoryId
Returns void

setNodeCollection

setNodeCollection(id: NodeId, collection: NodeCollection): void

- Defined in layoutGraph.ts:85
Parameters
- id: NodeId
- collection: NodeCollection
Returns void

setNodeProperties

setNodeProperties(id: NodeId, properties: Properties): void

- Defined in layoutGraph.ts:88
Parameters
- id: NodeId
- properties: Properties
Returns void

setNodeStyle

setNodeStyle<K>(id: NodeId, key: K, value: NodeStyles[K]): void

- Defined in layoutGraph.ts:97
Type Parameters
- K extends keyof NodeStyles
Parameters
- id: NodeId
- key: K
- value: NodeStyles[K]
Returns void

setNodeStyles

setNodeStyles(id: NodeId, styles: Partial<NodeStyles>): void

- Defined in layoutGraph.ts:94
Parameters
- id: NodeId
- styles: Partial<NodeStyles>
Returns void

showEdges

showEdges(ids: EdgeId[]): void

- Defined in layoutGraph.ts:107
Parameters
- ids: EdgeId[]
Returns void

showNodes

showNodes(ids: NodeId[]): void

- Defined in layoutGraph.ts:105
Parameters
- ids: NodeId[]
Returns void

Generated using TypeDoc