Class NetworkViewer

Index

Methods

clearDecorations clearSelections collapseAll getOptions onSelectionDidChange removeDecoration resetFocus setDecoration setFocus setNetwork setSelection setSelections create

Methods

clearDecorations

clearDecorations(): void
Returns void
- Defined in src/lib/viewer.ts:139

clearSelections

clearSelections(): Promise<void>
Returns Promise<void>
- Defined in src/lib/viewer.ts:113

collapseAll

collapseAll(): Promise<void>
Returns Promise<void>
- Defined in src/lib/viewer.ts:109

getOptions

getOptions(): INetworkViewerOptions
Returns INetworkViewerOptions
- Defined in src/lib/viewer.ts:148

onSelectionDidChange

onSelectionDidChange(listener): void
Parameters
- listener: ((event) => void)
  - - (event): void
    - Parameters
      event: IEventSelectionChanged
      Returns void
Returns void
- Defined in src/lib/viewer.ts:95

removeDecoration

removeDecoration(nodeId): void
Parameters
- nodeId: NodeId
Returns void
- Defined in src/lib/viewer.ts:134

resetFocus

resetFocus(transition?): Promise<void>
Parameters
- Optional transition: boolean
Returns Promise<void>
- Defined in src/lib/viewer.ts:125

setDecoration

setDecoration(nodeId, decoration): void
Parameters
- nodeId: NodeId
- decoration: Partial<IRectOptions>
Returns void
- Defined in src/lib/viewer.ts:129

setFocus

setFocus(target, transition?): Promise<void>
Changes the view so that target is in the center.
Parameters
- target: NodeId | NodeId[]
  The NodeId of the node that the viewer will focus on. If target is undefined, the view will be reset to show the entire graph.
- Optional transition: boolean
Returns Promise<void>
- Defined in src/lib/viewer.ts:121

setNetwork

setNetwork(network): void
Parameters
- network: Network
Returns void
- Defined in src/lib/viewer.ts:144

setSelection

setSelection(nodeId, option?): Promise<void>
Parameters
- nodeId: NodeId
- Optional option: Partial<ISelectionOptions>
Returns Promise<void>
- Defined in src/lib/viewer.ts:101

setSelections

setSelections(nodeIds, option?): Promise<void>
Parameters
- nodeIds: NodeId[]
- Optional option: Partial<ISelectionOptions>
Returns Promise<void>
- Defined in src/lib/viewer.ts:105

`Static` create

create(network, domElement, options?): NetworkViewer
Creates an instance of the Mycelium viewer and attaches it to the DOM.
Parameters
- network: Network
- domElement: HTMLElement
- Optional options: Partial<INetworkViewerOptions>
Returns NetworkViewer
- Defined in src/lib/viewer.ts:52